RelatedPerson
The RelatedPerson resource represents relatives, next of kin, and other persons connected to a patient in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 RelatedPerson resource. A formal Aidn profile may be published later.
Standards and profiles
- HL7 FHIR R4: RelatedPerson
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/RelatedPerson/_search |
patient.search |
Search using application/x-www-form-urlencoded body parameters. |
RelatedPerson search currently returns a JSON array of FHIR RelatedPerson resources.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to find related persons for one patient. |
patient.Identifier is required for search.
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
RelatedPerson identifier. |
active |
Whether the relation is active. |
patient.reference |
Reference to the patient. |
relationship |
Relationship coding and display text when available. |
identifier |
National identifier when available. |
name |
Related person’s name. |
telecom |
Contact points. |
gender |
Administrative gender. |
birthDate |
Birth date when available. |
address |
Addresses when available. |
Example search
POST /RelatedPerson/_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>The response is a JSON array of matching RelatedPerson resources for the patient.