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

Tree View

RelatedPerson

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

<RelatedPerson xmlns="http://hl7.org/fhir">
    <id value="PDS-RelatedPerson-507B7621-Example" />
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator">
        <valueBoolean value="true" />
    </extension>
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference">
        <extension url="PreferredWrittenCommunicationFormat">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" />
                    <code value="12" />
                    <display value="Braille" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="PreferredContactMethod">
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" />
                    <code value="1" />
                    <display value="Letter" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="PreferredContactTimes">
            <valueString value="Not after 7pm" />
        </extension>
    </extension>
    <active value="true" />
    <patient>
        <reference value="Patient/Patient-NHS-9459304130-Jane-Smith" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9100000009" />
        </identifier>
    </patient>
    <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="Smith" />
        <given value="Jane" />
        <prefix value="Mrs" />
        <suffix value="MBE" />
        <period>
            <start value="2020-01-01" />
            <end value="2021-12-31" />
        </period>
    </name>
    <telecom>
        <system value="phone" />
        <value value="01632960587" />
        <use value="home" />
        <period>
            <start value="2020-01-01" />
            <end value="2021-12-31" />
        </period>
    </telecom>
    <address>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
            <extension url="type">
                <valueCodeableConcept>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
                        <code value="PAF" />
                    </coding>
                </valueCodeableConcept>
            </extension>
            <extension url="value">
                <valueString value="12345678" />
            </extension>
        </extension>
        <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
            <extension url="type">
                <valueCodeableConcept>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
                        <code value="UPRN" />
                    </coding>
                </valueCodeableConcept>
            </extension>
            <extension url="value">
                <valueString value="123456789012" />
            </extension>
        </extension>
        <use value="home" />
        <line value="1 Trevelyan Square" />
        <line value="Boar Lane" />
        <line value="City Centre" />
        <line value="Leeds" />
        <line value="West Yorkshire" />
        <postalCode value="LS1 6AE" />
        <period>
            <start value="2020-01-01" />
            <end value="2021-12-31" />
        </period>
    </address>
    <period>
        <start value="2020-01-01" />
        <end value="2021-12-31" />
    </period>
    <communication>
        <language>
            <coding>
                <system value="urn:ietf:bcp:47" />
                <code value="fr" />
                <display value="French" />
            </coding>
        </language>
    </communication>
</RelatedPerson>

JSON View

{
    "resourceType": "RelatedPerson",
    "id": "PDS-RelatedPerson-507B7621-Example",
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator",
            "valueBoolean": true
        },
        {
            "extension":  [
                {
                    "url": "PreferredWrittenCommunicationFormat",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat",
                                "code": "12",
                                "display": "Braille"
                            }
                        ]
                    }
                },
                {
                    "url": "PreferredContactMethod",
                    "valueCodeableConcept": {
                        "coding":  [
                            {
                                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod",
                                "code": "1",
                                "display": "Letter"
                            }
                        ]
                    }
                },
                {
                    "url": "PreferredContactTimes",
                    "valueString": "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",
                            "valueCodeableConcept": {
                                "coding":  [
                                    {
                                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                                        "code": "PAF"
                                    }
                                ]
                            }
                        },
                        {
                            "url": "value",
                            "valueString": "12345678"
                        }
                    ],
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
                },
                {
                    "extension":  [
                        {
                            "url": "type",
                            "valueCodeableConcept": {
                                "coding":  [
                                    {
                                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                                        "code": "UPRN"
                                    }
                                ]
                            }
                        },
                        {
                            "url": "value",
                            "valueString": "123456789012"
                        }
                    ],
                    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
                }
            ],
            "use": "home",
            "line":  [
                "1 Trevelyan Square",
                "Boar Lane",
                "City Centre",
                "Leeds",
                "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"
                    }
                ]
            }
        }
    ]
}