> 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/v1.5/technology/architecture/low-level-design/services/referral.md).
# Referral
## API Spec
[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" %}
Side Effect Create
Side Effect Bulk Create
Side Effect Update
Side Effect Bulk Update
Side Effect Delete
Side Effect Bulk Delete
{% endtab %}
{% tab title="Referral" %}
Referral Create
Referral Bulk Create
Referral Update
Referral Bulk Update
Referral Delete
Referral Bulk Delete
{% endtab %}
{% tab title="HFReferral" %}
HFReferral Create
HFReferral Bulk Create
HFReferral Update
HFReferral Bulk Update
HFReferral Delete
HFReferral Bulk Delete
{% 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 by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.digit.org/health/v1.5/technology/architecture/low-level-design/services/referral.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.
