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-45B0DF3F-Example

Tree View

RelatedPerson

Table View

RelatedPerson.id[0]PDS-RelatedPerson-45B0DF3F-Example
RelatedPerson.active[0]True
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]FTH
RelatedPerson.relationship[0].coding[0].display[0]father
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.name[0].use[0]usual
RelatedPerson.name[0].family[0]WILLAN
RelatedPerson.name[0].given[0]Virgil
RelatedPerson.name[0].given[1]Morris
RelatedPerson.name[0].prefix[0]Mr
RelatedPerson.name[0].period[0].start[0]2024-05-15
RelatedPerson.address[0].use[0]home
RelatedPerson.address[0].line[0]1 BEECH GARTH
RelatedPerson.address[0].line[1]BARROW-UPON-HUMBER
RelatedPerson.address[0].line[2]S HUMBERSIDE
RelatedPerson.address[0].postalCode[0]DN19 7DR
RelatedPerson.address[0].period[0].start[0]2024-05-15
RelatedPerson.period[0].start[0]2024-05-15

XML View

<RelatedPerson xmlns="http://hl7.org/fhir">
<id value="PDS-RelatedPerson-45B0DF3F-Example" />
<active value="true" />
<patient>
<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="FTH" />
<display value="father" />
</coding>
</relationship>
<relationship>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" />
<code value="Guardian" />
<display value="Guardian of patient" />
</coding>
</relationship>
<name>
<use value="usual" />
<family value="WILLAN" />
<given value="Virgil" />
<given value="Morris" />
<prefix value="Mr" />
<period>
<start value="2024-05-15" />
</period>
</name>
<address>
<use value="home" />
<line value="1 BEECH GARTH" />
<line value="BARROW-UPON-HUMBER" />
<line value="S HUMBERSIDE" />
<postalCode value="DN19 7DR" />
<period>
<start value="2024-05-15" />
</period>
</address>
<period>
<start value="2024-05-15" />
</period>
</RelatedPerson>

JSON View

{
"resourceType": "RelatedPerson",
"id": "PDS-RelatedPerson-45B0DF3F-Example",
"active": true,
"patient": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9732017996"
}
},
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "FTH",
"display": "father"
}
]
},
{
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole",
"code": "Guardian",
"display": "Guardian of patient"
}
]
}
],
"name": [
{
"use": "usual",
"family": "WILLAN",
"given": [
"Virgil",
"Morris"
],
"prefix": [
"Mr"
],
"period": {
"start": "2024-05-15"
}
}
],
"address": [
{
"use": "home",
"line": [
"1 BEECH GARTH",
"BARROW-UPON-HUMBER",
"S HUMBERSIDE"
],
"postalCode": "DN19 7DR",
"period": {
"start": "2024-05-15"
}
}
],
"period": {
"start": "2024-05-15"
}
}