> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/ph-v1.7/design/architecture/low-level-design/services/referral.md).

# Referral

## API Spec <a href="#api-spec" id="api-spec"></a>

[![](https://editor.swagger.io/dist/favicon-32x32.png)Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/health-campaign-services/master/docs/health-api-specs/contracts/referral-management.yml)

## Sequence DIagrams

{% tabs %}
{% tab title="Side Effect" %}

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/anBg7SjHYhq30OKdzboW/image.png" alt=""><figcaption><p>Side Effect Create</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/lPP2SfZilNo51unR4QQz/image.png" alt=""><figcaption><p>Side Effect Bulk Create<br></p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/mgjHHgZJwrzSaTxHYC36/image.png" alt=""><figcaption><p>Side Effect Update<br></p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/kzuHXk30SRZOC7Q39OIg/image.png" alt=""><figcaption><p>Side Effect Bulk Update</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/NZnzdzW2mLqXcZrPMMGr/image.png" alt=""><figcaption><p>Side Effect Delete</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/7IA5dKh0MYvcKIWIBFBX/image.png" alt=""><figcaption><p>Side Effect Bulk Delete</p></figcaption></figure>
{% endtab %}

{% tab title="Referral" %}

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/X2IUdW6rxBcKNn9Q8w2g/image.png" alt=""><figcaption><p>Referral Create</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/DsA822JIlT471btWBH4X/image.png" alt=""><figcaption><p>Referral Bulk Create</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/ZXwzl4yhhPhWRPnpTlCH/image.png" alt=""><figcaption><p>Referral Update</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/5ahMY2CzYA8nFg9q2xt9/image.png" alt=""><figcaption><p>Referral Bulk Update</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/4WMYRaKwy7YbjOBqDcyJ/image.png" alt=""><figcaption><p>Referral Delete</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/dSPX3V5UrnsUUjbFDDZ8/image.png" alt=""><figcaption><p>Referral Bulk Delete</p></figcaption></figure>
{% endtab %}

{% tab title="HFReferral" %}

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/dtSQBJhgNBQUOvHY3ng9/image.png" alt=""><figcaption><p>HFReferral Create</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/eglF13cbU2s8EJySvVij/image.png" alt=""><figcaption><p>HFReferral Bulk Create</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/T0toS05PdCgtRZIPMaLI/image.png" alt=""><figcaption><p>HFReferral Update</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/oz2kSfVt9qBbcc2bI7am/image.png" alt=""><figcaption><p>HFReferral Bulk Update</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/awMhlKWCgviUsPpT9T4J/image.png" alt=""><figcaption><p>HFReferral Delete</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/ugLvZh3s3IGcc8JYqNN7/blobs/SgmmQzGuFw4smXaBDBva/image.png" alt=""><figcaption><p>HFReferral Bulk Delete</p></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/health/ph-v1.7/design/architecture/low-level-design/services/referral.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.