Actions18
- Analytics Actions
- Data Value Set Actions
- Enrollment Actions
- Event Actions
- FHIR Actions
- Organisation Unit Actions
- Program Actions
- Tracked Entity Actions
FHIR → Read Patient
AI-generatedSummary
Fetches a single FHIR Patient resource from the DHIS2 FHIR endpoint by ID, where the ID corresponds to a DHIS2 tracked entity UID.
Inputs
- Patient ID (required) — FHIR Patient resource ID, which maps to the DHIS2 tracked entity UID. It is inserted into the request URL as /fhir/Patient/{id}. Can be set per input item with an expression.
Output shape
One output item per input item. Its json is the FHIR Patient resource returned by DHIS2, unmodified.
Sends an authenticated GET to {baseUrl}/fhir/Patient/{id} using the dhis2Api credentials. The ID is not URL-encoded. If the request fails, the node throws a NodeApiError. With Continue On Fail enabled, it instead outputs an item with an error message.
Examples
Example 1: Look up a patient record for a tracked entity UID received from a webhook.
Resource: FHIR; Operation: Read Patient; Patient ID: {{$json.trackedEntityUid}}
Example 2: Read one known patient as FHIR for downstream interoperability mapping.
Resource: FHIR; Operation: Read Patient; Patient ID: a fixed 11-character DHIS2 UID