Actions18
- Analytics Actions
- Data Value Set Actions
- Enrollment Actions
- Event Actions
- FHIR Actions
- Organisation Unit Actions
- Program Actions
- Tracked Entity Actions
FHIR → Search Patients
AI-generatedSummary
Searches FHIR Patient resources on a DHIS2 server's /fhir/Patient endpoint using a single key=value search parameter, and returns each matching patient as its own item.
Inputs
- Search Parameter (required) — A single FHIR search parameter as key=value, e.g. identifier=ABC123 or name=John. The string is split on '=', both parts are trimmed, and they are sent as a query-string parameter. Only one parameter is supported. If the value itself contains '=', everything after the second '=' is dropped. If no '=' is present, the value is undefined and the query parameter is not sent with a value.
Output shape
A list of items, one per Patient resource in the returned FHIR Bundle (the entry[].resource object is the item's JSON).
If the Bundle has no entries, no items are output for that input item. Only the first page of results returned by the server is fetched; there is no pagination handling. Uses the DHIS2 API credential, with requests going to {baseUrl}/fhir/Patient. With Continue On Fail enabled, errors are output as an item with an 'error' message. The search runs once per input item.
Examples
Example 1: Look up a patient by their identifier
Resource: FHIR; Operation: Search Patients; Search Parameter: identifier=ABC123
Example 2: Find patients by name
Resource: FHIR; Operation: Search Patients; Search Parameter: name=John