This is an updated version of an example from Personal Demographics Service - FHIR API Get a patient's related people which meets the latest HL7 UK Core requirements.

The resource is documented on England RelatedPerson PDS

RelatedPerson-D1EDA4B8-Example

Tree View

RelatedPerson

Table View

RelatedPerson.id[0]PDS-RelatedPerson-D1EDA4B8-Example
RelatedPerson.meta[0].profile[0]https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS
RelatedPerson.extension[0].url[0]https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status
RelatedPerson.extension[0].value[0]True
RelatedPerson.extension[1].extension[0].url[0]dateType
RelatedPerson.extension[1].extension[0].value[0].system[0]https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
RelatedPerson.extension[1].extension[0].value[0].code[0]system-effective
RelatedPerson.extension[1].extension[0].value[0].display[0]System Effective
RelatedPerson.extension[1].extension[1].url[0]period
RelatedPerson.extension[1].extension[1].value[0].start[0]2025-06-25T16:01:19+00:00
RelatedPerson.extension[1].url[0]https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
RelatedPerson.identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
RelatedPerson.identifier[0].value[0]9732017945
RelatedPerson.active[0]True
RelatedPerson.patient[0].reference[0]Patient/Patient-NHS-9732017996-Canon-Smith
RelatedPerson.patient[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
RelatedPerson.patient[0].identifier[0].value[0]9732017996
RelatedPerson.relationship[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-RoleCode
RelatedPerson.relationship[0].coding[0].code[0]MTH
RelatedPerson.relationship[0].coding[0].display[0]mother
RelatedPerson.relationship[1].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole
RelatedPerson.relationship[1].coding[0].code[0]Guardian
RelatedPerson.relationship[1].coding[0].display[0]Guardian of patient
RelatedPerson.relationship[2].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v2-0131
RelatedPerson.relationship[2].coding[0].code[0]N
RelatedPerson.relationship[2].coding[0].display[0]Next-of-Kin
RelatedPerson.name[0].use[0]usual
RelatedPerson.name[0].period[0].start[0]2024-05-13
RelatedPerson.period[0].start[0]2017-02-17

XML View

<RelatedPerson xmlns="http://hl7.org/fhir">
<id value="PDS-RelatedPerson-D1EDA4B8-Example" />
<meta>
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS" />
</meta>
<extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status">
<valueBoolean value="true" />
</extension>
<extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod">
<extension url="dateType">
<valueCoding>
<system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" />
<code value="system-effective" />
<display value="System Effective" />
</valueCoding>
</extension>
<extension url="period">
<valuePeriod>
<start value="2025-06-25T16:01:19+00:00" />
</valuePeriod>
</extension>
</extension>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9732017945" />
</identifier>
<active value="true" />
<patient>
<reference value="Patient/Patient-NHS-9732017996-Canon-Smith" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9732017996" />
</identifier>
</patient>
<relationship>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
<code value="MTH" />
<display value="mother" />
</coding>
</relationship>
<relationship>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" />
<code value="Guardian" />
<display value="Guardian of patient" />
</coding>
</relationship>
<relationship>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0131" />
<code value="N" />
<display value="Next-of-Kin" />
</coding>
</relationship>
<name>
<use value="usual" />
<period>
<start value="2024-05-13" />
</period>
</name>
<period>
<start value="2017-02-17" />
</period>
</RelatedPerson>

JSON View

{
"resourceType": "RelatedPerson",
"id": "PDS-RelatedPerson-D1EDA4B8-Example",
"meta": {
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status",
"valueBoolean": true
},
{
"extension": [
{
"url": "dateType",
"valueCoding": {
"system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType",
"code": "system-effective",
"display": "System Effective"
}
},
{
"url": "period",
"valuePeriod": {
"start": "2025-06-25T16:01:19+00:00"
}
}
],
"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"
}
],
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9732017945"
}
],
"active": true,
"patient": {
"reference": "Patient/Patient-NHS-9732017996-Canon-Smith",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9732017996"
}
},
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "MTH",
"display": "mother"
}
]
},
{
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole",
"code": "Guardian",
"display": "Guardian of patient"
}
]
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"code": "N",
"display": "Next-of-Kin"
}
]
}
],
"name": [
{
"use": "usual",
"period": {
"start": "2024-05-13"
}
}
],
"period": {
"start": "2017-02-17"
}
}