Common queries

Use the narrowest query that matches the integration’s purpose. This helps the caller get useful results and avoids exposing patient data that is not relevant to the workflow.

Look up one patient

Use the FHIR Patient endpoint when the integration needs demographic information about a single patient.

Search by patient.Identifier. National identifiers should normally be used for this lookup. Send the search as POST /Patient/_search with an application/x-www-form-urlencoded body, so the identifier is not exposed in URL or query logs.

POST /Patient/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>

patient.Identifier=<NATIONAL_IDENTIFIER>

Do not use the Patient endpoint to build patient lists. A patient search only identifies a person; it does not describe why that patient is relevant to the caller. Use a contextual resource such as EpisodeOfCare when you need a list.

Get a relevant patient list

Use the FHIR EpisodeOfCare endpoint when the integration needs a list of patients relevant to a department, organization, or service.

Filter by organization or organization.Identifier to scope the result to the organization or department the caller works with. Add one or more type parameters when the integration should only include selected service types. Current type values map to IPLOS codes where applicable.

POST /EpisodeOfCare/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>

organization=<DEPARTMENT_ID>&type=<IPLOS_CODE>&_include=EpisodeOfCare:patient

Filtering on organization and service type keeps the list aligned with the caller’s need and reduces the risk of returning patients who are not relevant for that integration.

Back to home