Patient
The Patient resource represents a person receiving health and care services in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 Patient resource and aims to align with the Norwegian no-basis-Patient profile where applicable.
Standards and profiles
- HL7 FHIR R4: Patient
- HL7 Norway no-basis: no-basis-Patient
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/Patient/_search |
patient.search |
Search using application/x-www-form-urlencoded body parameters. |
GET |
/Patient/{id} |
patient.read |
Read one Patient by ID. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to find one patient. |
_include |
token, repeatable | Adds supported related resources to the response. |
patient.Identifier is required for search.
Read parameters
| Parameter | Type | Description |
|---|---|---|
_include |
token, repeatable | Patient:contact or RelatedPersons can include related persons for the patient. |
Supported includes
_include value |
Included resource | Description |
|---|---|---|
Patient:contact |
RelatedPerson |
Adds related persons connected to the patient. |
RelatedPersons |
RelatedPerson |
Alias for including related persons. |
Patient:practitioner |
PractitionerRole |
Adds practitioner relationships for search responses. |
PractitionerRole |
PractitionerRole |
Alias for including practitioner relationships for search responses. |
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
Patient identifier. |
identifier |
National identifiers when available, Aidn patient short reference, and migrated external identifiers where relevant. |
name |
Patient name. |
gender |
Administrative gender. |
birthDate |
Birth date when available. |
deceased[x] |
Deceased status or date when available. |
maritalStatus |
Marital status using Norwegian basis coding. |
telecom |
Contact points. |
address |
Patient addresses. |
communication |
Registered languages. |
generalPractitioner |
Reference to contained general practitioner role when available. |
contained |
Contained general practitioner resources when available. |
Example search
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=<PATIENT_IDENTIFIER>&_include=Patient:contactThe response is a FHIR search bundle with matching Patient resources. Included related resources are returned as separate bundle entries.