Please note:
- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
An example to illustrate a person who is related to the patient
Table View
RelatedPerson.id[0] | UKCore-RelatedPerson-JoySmith-Example |
RelatedPerson.text[0].status[0] | additional |
RelatedPerson.text[0].div[0] | <div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate a person who is related to the patient</div> |
RelatedPerson.extension[0].extension[0].url[0] | PreferredContactMethod |
RelatedPerson.extension[0].extension[0].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
RelatedPerson.extension[0].extension[0].value[0].coding[0].code[0] | 3 |
RelatedPerson.extension[0].extension[0].value[0].coding[0].display[0] | Telephone |
RelatedPerson.extension[0].extension[1].url[0] | PreferredContactTimes |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].frequency[0] | 1 |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].period[0] | 1 |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].periodUnit[0] | d |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].dayOfWeek[0] | mon |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].dayOfWeek[1] | wed |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].dayOfWeek[2] | fri |
RelatedPerson.extension[0].extension[1].value[0].repeat[0].when[0] | AFT |
RelatedPerson.extension[0].extension[2].url[0] | PreferredWrittenCommunicationFormat |
RelatedPerson.extension[0].extension[2].value[0].coding[0].system[0] | https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
RelatedPerson.extension[0].extension[2].value[0].coding[0].code[0] | 11 |
RelatedPerson.extension[0].extension[2].value[0].coding[0].display[0] | Large print |
RelatedPerson.extension[0].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
RelatedPerson.extension[1].url[0] | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
RelatedPerson.extension[1].value[0] | True |
RelatedPerson.patient[0].reference[0] | Patient/UKCore-Patient-RichardSmith-Example |
RelatedPerson.relationship[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
RelatedPerson.relationship[0].coding[0].code[0] | WIFE |
RelatedPerson.relationship[0].coding[0].display[0] | wife |
RelatedPerson.name[0].use[0] | official |
RelatedPerson.name[0].family[0] | SMITH |
RelatedPerson.name[0].given[0] | Joy |
Tree View
RelatedPerson |
id : UKCore-RelatedPerson-JoySmith-Example |
text |
status : additional |
extension |
url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
extension |
url : PreferredContactMethod |
value |
coding |
system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod |
code : 3 |
display : Telephone |
extension |
url : PreferredContactTimes |
value |
repeat |
frequency : 1 |
period : 1 |
periodUnit : d |
dayOfWeek : mon |
dayOfWeek : wed |
dayOfWeek : fri |
when : AFT |
extension |
url : PreferredWrittenCommunicationFormat |
value |
coding |
system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat |
code : 11 |
display : Large print |
extension |
url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
value : True |
patient |
reference : Patient/UKCore-Patient-RichardSmith-Example |
relationship |
coding |
system : http://terminology.hl7.org/CodeSystem/v3-RoleCode |
code : WIFE |
display : wife |
name |
use : official |
family : SMITH |
given : Joy |
XML View
<RelatedPerson xmlns="http://hl7.org/fhir"> <id value="UKCore-RelatedPerson-JoySmith-Example" /> <text> <status value="additional" /> --- We have skipped the narrative for better readability of the resource --- </text> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"> <extension url="PreferredContactMethod"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" /> <code value="3" /> <display value="Telephone" /> </coding> </valueCodeableConcept> </extension> <extension url="PreferredContactTimes"> <valueTiming> <repeat> <frequency value="1" /> <period value="1" /> <periodUnit value="d" /> <dayOfWeek value="mon" /> <dayOfWeek value="wed" /> <dayOfWeek value="fri" /> <when value="AFT" /> </repeat> </valueTiming> </extension> <extension url="PreferredWrittenCommunicationFormat"> <valueCodeableConcept> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" /> <code value="11" /> <display value="Large print" /> </coding> </valueCodeableConcept> </extension> </extension> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"> <valueBoolean value="true" /> </extension> <patient> <reference value="Patient/UKCore-Patient-RichardSmith-Example" /> </patient> <relationship> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> <code value="WIFE" /> <display value="wife" /> </coding> </relationship> <name> <use value="official" /> <family value="SMITH" /> <given value="Joy" /> </name> </RelatedPerson>
JSON View
{ "resourceType": "RelatedPerson", "id": "UKCore-RelatedPerson-JoySmith-Example", "text": { "status": "additional", --- We have skipped the narrative for better readability of the resource --- }, "extension": [ { "extension": [ { "url": "PreferredContactMethod", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod", "code": "3", "display": "Telephone" } ] } }, { "url": "PreferredContactTimes", "valueTiming": { "repeat": { "frequency": 1, "period": 1, "periodUnit": "d", "dayOfWeek": [ "mon", "wed", "fri" ], "when": [ "AFT" ] } } }, { "url": "PreferredWrittenCommunicationFormat", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat", "code": "11", "display": "Large print" } ] } } ], "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" }, { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator", "valueBoolean": true } ], "patient": { "reference": "Patient/UKCore-Patient-RichardSmith-Example" }, "relationship": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "WIFE", "display": "wife" } ] } ], "name": [ { "use": "official", "family": "SMITH", "given": [ "Joy" ] } ] }