Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
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-507B7621-Example
Important: This page is under development by NHS England
Tree View
| RelatedPerson |
| id : PDS-RelatedPerson-507B7621-Example |
| extension |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| value : True |
| extension |
| extension |
| url : PreferredWrittenCommunicationFormat |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| code : 12 |
| display : Braille |
| extension |
| url : PreferredContactMethod |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| code : 1 |
| display : Letter |
| extension |
| url : PreferredContactTimes |
| value : Not after 7pm |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| active : True |
| patient |
| reference : Patient/Patient-NHS-9459304130-Jane-Smith |
| identifier |
| system : https://fhir.nhs.uk/Id/nhs-number |
| value : 9100000009 |
| relationship |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole |
| code : Guardian |
| display : Guardian of patient |
| name |
| use : usual |
| family : Smith |
| given : Jane |
| prefix : Mrs |
| suffix : MBE |
| period |
| start : 2020-01-01 |
| end : 2021-12-31 |
| telecom |
| system : phone |
| value : 01632960587 |
| use : home |
| period |
| start : 2020-01-01 |
| end : 2021-12-31 |
| address |
| extension |
| extension |
| url : type |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| code : PAF |
| extension |
| url : value |
| value : 12345678 |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| extension |
| extension |
| url : type |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| code : UPRN |
| extension |
| url : value |
| value : 123456789012 |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| use : home |
| line : 1 Trevelyan Square |
| line : Boar Lane |
| line : City Centre |
| line : Leeds |
| line : West Yorkshire |
| postalCode : LS1 6AE |
| period |
| start : 2020-01-01 |
| end : 2021-12-31 |
| period |
| start : 2020-01-01 |
| end : 2021-12-31 |
| communication |
| language |
| coding |
| system : urn:ietf:bcp:47 |
| code : fr |
| display : French |
Table View
| RelatedPerson.id[0] | PDS-RelatedPerson-507B7621-Example |
| RelatedPerson.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
| RelatedPerson.extension[0].value[0] | True |
| RelatedPerson.extension[1].extension[0].url[0] | PreferredWrittenCommunicationFormat |
| RelatedPerson.extension[1].extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
| RelatedPerson.extension[1].extension[0].value[0].coding[0].code[0] | 12 |
| RelatedPerson.extension[1].extension[0].value[0].coding[0].display[0] | Braille |
| RelatedPerson.extension[1].extension[1].url[0] | PreferredContactMethod |
| RelatedPerson.extension[1].extension[1].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
| RelatedPerson.extension[1].extension[1].value[0].coding[0].code[0] | 1 |
| RelatedPerson.extension[1].extension[1].value[0].coding[0].display[0] | Letter |
| RelatedPerson.extension[1].extension[2].url[0] | PreferredContactTimes |
| RelatedPerson.extension[1].extension[2].value[0] | Not after 7pm |
| RelatedPerson.extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
| RelatedPerson.active[0] | True |
| RelatedPerson.patient[0].reference[0] | Patient/Patient-NHS-9459304130-Jane-Smith |
| RelatedPerson.patient[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/nhs-number |
| RelatedPerson.patient[0].identifier[0].value[0] | 9100000009 |
| RelatedPerson.relationship[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole |
| RelatedPerson.relationship[0].coding[0].code[0] | Guardian |
| RelatedPerson.relationship[0].coding[0].display[0] | Guardian of patient |
| RelatedPerson.name[0].use[0] | usual |
| RelatedPerson.name[0].family[0] | Smith |
| RelatedPerson.name[0].given[0] | Jane |
| RelatedPerson.name[0].prefix[0] | Mrs |
| RelatedPerson.name[0].suffix[0] | MBE |
| RelatedPerson.name[0].period[0].start[0] | 2020-01-01 |
| RelatedPerson.name[0].period[0].end[0] | 2021-12-31 |
| RelatedPerson.telecom[0].system[0] | phone |
| RelatedPerson.telecom[0].value[0] | 01632960587 |
| RelatedPerson.telecom[0].use[0] | home |
| RelatedPerson.telecom[0].period[0].start[0] | 2020-01-01 |
| RelatedPerson.telecom[0].period[0].end[0] | 2021-12-31 |
| RelatedPerson.address[0].extension[0].extension[0].url[0] | type |
| RelatedPerson.address[0].extension[0].extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| RelatedPerson.address[0].extension[0].extension[0].value[0].coding[0].code[0] | PAF |
| RelatedPerson.address[0].extension[0].extension[1].url[0] | value |
| RelatedPerson.address[0].extension[0].extension[1].value[0] | 12345678 |
| RelatedPerson.address[0].extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| RelatedPerson.address[0].extension[1].extension[0].url[0] | type |
| RelatedPerson.address[0].extension[1].extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType |
| RelatedPerson.address[0].extension[1].extension[0].value[0].coding[0].code[0] | UPRN |
| RelatedPerson.address[0].extension[1].extension[1].url[0] | value |
| RelatedPerson.address[0].extension[1].extension[1].value[0] | 123456789012 |
| RelatedPerson.address[0].extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
| RelatedPerson.address[0].use[0] | home |
| RelatedPerson.address[0].line[0] | 1 Trevelyan Square |
| RelatedPerson.address[0].line[1] | Boar Lane |
| RelatedPerson.address[0].line[2] | City Centre |
| RelatedPerson.address[0].line[3] | Leeds |
| RelatedPerson.address[0].line[4] | West Yorkshire |
| RelatedPerson.address[0].postalCode[0] | LS1 6AE |
| RelatedPerson.address[0].period[0].start[0] | 2020-01-01 |
| RelatedPerson.address[0].period[0].end[0] | 2021-12-31 |
| RelatedPerson.period[0].start[0] | 2020-01-01 |
| RelatedPerson.period[0].end[0] | 2021-12-31 |
| RelatedPerson.communication[0].language[0].coding[0].system[0] | urn:ietf:bcp:47 |
| RelatedPerson.communication[0].language[0].coding[0].code[0] | fr |
| RelatedPerson.communication[0].language[0].coding[0].display[0] | French |
XML View
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator">
</extension>
</coding>
</valueCodeableConcept>
</extension>
</coding>
</valueCodeableConcept>
</extension>
</extension>
</extension>
</identifier>
</patient>
</coding>
</relationship>
</period>
</name>
</period>
</telecom>
</coding>
</valueCodeableConcept>
</extension>
</extension>
</extension>
</coding>
</valueCodeableConcept>
</extension>
</extension>
</extension>
</period>
</address>
</period>
</coding>
</language>
</communication>
</RelatedPerson>
JSON View
{
{
},
{
{
{
}
]
}
},
{
{
}
]
}
},
{
}
],
}
],
}
},
{
{
}
]
}
],
{
"Jane"
],
"Mrs"
],
"MBE"
],
}
}
],
{
}
}
],
{
{
{
]
}
},
{
}
],
},
{
{
]
}
},
{
}
],
}
],
"1 Trevelyan Square",
"Boar Lane",
"City Centre",
"Leeds",
"West Yorkshire"
],
}
}
],
},
{
}
]
}