Patient
The Patient resource represents a person receiving healthcare services in Open Aidn.
Open Aidn supports selected fields from the base HL7 FHIR R4 Patient resource. Where applicable,
these fields are intended to align with the Norwegian no-basis-Patient profile.
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 results are returned in a FHIR Bundle 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 Bundle. |
patient.Identifier is required for search.
Read parameters
| Parameter | Type | Description |
|---|---|---|
_include |
token, repeatable | Use Patient:contact or RelatedPersons to 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 roles to search responses. |
PractitionerRole |
PractitionerRole |
Alias for including practitioner roles in search responses. |
Response fields
Open Aidn may add fields over time. Integrations should expect the following fields to be available:
| Field | Description |
|---|---|
id |
Patient identifier. |
identifier |
National identifiers, Aidn’s short patient reference, and migrated external identifiers, when available. |
name |
Patient name. |
gender |
Administrative gender, when available. |
birthDate |
Birth date when available. |
deceased[x] |
Whether the patient is deceased or the date of death, when available. |
maritalStatus |
Marital status using Norwegian base coding. |
telecom |
Contact points. |
address |
Patient addresses. |
communication |
Registered languages. |
generalPractitioner |
Reference to a 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 Bundle containing matching Patient resources. Included related resources
are returned as separate entries in the bundle.