PDS Related Person Network

Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Examples

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

Important: This page is under development by NHS England

Tree View

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

relationship

coding

system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole

code : Guardian

display : Guardian of patient

name

use : usual

family : WILLAN

given : Virgil

given : Morris

prefix : Mr

period

start : 2024-05-15

address

use : home

line : 1 BEECH GARTH

line : BARROW-UPON-HUMBER

line : S HUMBERSIDE

postalCode : DN19 7DR

period

start : 2024-05-15

period

start : 2024-05-15

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"
    }
}

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

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

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

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

<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"
                    }
                ]
            }
        }
    ]
}

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

Important: This page is under development by NHS England

Tree View

RelatedPerson

id : PDS-RelatedPerson-D1EDA4B8-Example

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 9732017945

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 : MTH

display : mother

relationship

coding

system : https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole

code : Guardian

display : Guardian of patient

relationship

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

Table View

RelatedPerson.id[0]	PDS-RelatedPerson-D1EDA4B8-Example
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].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" />
    <identifier>
        <system value="https://fhir.nhs.uk/Id/nhs-number" />
        <value value="9732017945" />
    </identifier>
    <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="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",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9732017945"
        }
    ],
    "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": "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"
    }
}

Bundle Searchset Related Person identifier query

Important: This page is under development by NHS England

Tree View

Bundle

id : NationalProxy-Bundle-Search-RelatedPerson-identifier-Example

type : searchset

total : 1

link

relation : self

url : https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009

entry

fullUrl : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

resource

id : RelatedPerson-NHS-9100000009

text

status : generated

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 91000000009

active : False

patient

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 9000000017

display : Jane Marie Anne Smith

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleCode

code : NMTH

display : natural mother

text : Natural Mother

name

use : official

family : Smith

given : Jayne

birthDate : 1916-12-05

search

mode : match

Table View

Bundle.id[0]	NationalProxy-Bundle-Search-RelatedPerson-identifier-Example
Bundle.type[0]	searchset
Bundle.total[0]	1
Bundle.link[0].relation[0]	self
Bundle.link[0].url[0]	https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number\|91000000009
Bundle.entry[0].fullUrl[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].id[0]	RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].text[0].status[0]	generated
Bundle.entry[0].resource[0].text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_RelatedPerson-NHS-9100000009"> </a><p class="res-header-id"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name="RelatedPerson-NHS-9100000009"> </a><a name="hcRelatedPerson-NHS-9100000009"> </a><a name="RelatedPerson-NHS-9100000009-en-US"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>
Bundle.entry[0].resource[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].identifier[0].value[0]	91000000009
Bundle.entry[0].resource[0].active[0]	False
Bundle.entry[0].resource[0].patient[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].patient[0].identifier[0].value[0]	9000000017
Bundle.entry[0].resource[0].patient[0].display[0]	Jane Marie Anne Smith
Bundle.entry[0].resource[0].relationship[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
Bundle.entry[0].resource[0].relationship[0].coding[0].code[0]	NMTH
Bundle.entry[0].resource[0].relationship[0].coding[0].display[0]	natural mother
Bundle.entry[0].resource[0].relationship[0].text[0]	Natural Mother
Bundle.entry[0].resource[0].name[0].use[0]	official
Bundle.entry[0].resource[0].name[0].family[0]	Smith
Bundle.entry[0].resource[0].name[0].given[0]	Jayne
Bundle.entry[0].resource[0].birthDate[0]	1916-12-05
Bundle.entry[0].search[0].mode[0]	match

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="NationalProxy-Bundle-Search-RelatedPerson-identifier-Example" />
    <type value="searchset" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009" />
    </link>
    <entry>
        <fullUrl value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
        <resource>
            <RelatedPerson>
                <id value="RelatedPerson-NHS-9100000009" />
                <text>
                    <status value="generated" />
                    <div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_RelatedPerson-NHS-9100000009"> </a><p class="res-header-id"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name="RelatedPerson-NHS-9100000009"> </a><a name="hcRelatedPerson-NHS-9100000009"> </a><a name="RelatedPerson-NHS-9100000009-en-US"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>
                </text>
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="91000000009" />
                </identifier>
                <active value="false" />
                <patient>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9000000017" />
                    </identifier>
                    <display value="Jane Marie Anne Smith" />
                </patient>
                <relationship>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                        <code value="NMTH" />
                        <display value="natural mother" />
                    </coding>
                    <text value="Natural Mother" />
                </relationship>
                <name>
                    <use value="official" />
                    <family value="Smith" />
                    <given value="Jayne" />
                </name>
                <birthDate value="1916-12-05" />
            </RelatedPerson>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "id": "NationalProxy-Bundle-Search-RelatedPerson-identifier-Example",
    "type": "searchset",
    "total": 1,
    "link":  [
        {
            "relation": "self",
            "url": "https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009"
        }
    ],
    "entry":  [
        {
            "fullUrl": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009",
            "resource": {
                "resourceType": "RelatedPerson",
                "id": "RelatedPerson-NHS-9100000009",
                "text": {
                    "status": "generated",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"RelatedPerson_RelatedPerson-NHS-9100000009\"> </a><p class=\"res-header-id\"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name=\"RelatedPerson-NHS-9100000009\"> </a><a name=\"hcRelatedPerson-NHS-9100000009\"> </a><a name=\"RelatedPerson-NHS-9100000009-en-US\"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}\">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>"
                },
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "91000000009"
                    }
                ],
                "active": false,
                "patient": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9000000017"
                    },
                    "display": "Jane Marie Anne Smith"
                },
                "relationship":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "NMTH",
                                "display": "natural mother"
                            }
                        ],
                        "text": "Natural Mother"
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "family": "Smith",
                        "given":  [
                            "Jayne"
                        ]
                    }
                ],
                "birthDate": "1916-12-05"
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

Bundle Searchset Related Person patient:identifier query

Important: This page is under development by NHS England

Tree View

Bundle

id : NationalProxy-Bundle-Search-RelatedPerson-patient-Example

type : searchset

total : 1

link

relation : self

url : https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000017

entry

fullUrl : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

resource

id : RelatedPerson-NHS-9100000009

text

status : generated

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 91000000009

active : False

patient

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 9000000017

display : Jane Marie Anne Smith

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleCode

code : NMTH

display : natural mother

text : Natural Mother

name

use : official

family : Smith

given : Jayne

birthDate : 1916-12-05

search

mode : match

Table View

Bundle.id[0]	NationalProxy-Bundle-Search-RelatedPerson-patient-Example
Bundle.type[0]	searchset
Bundle.total[0]	1
Bundle.link[0].relation[0]	self
Bundle.link[0].url[0]	https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number\|9000000017
Bundle.entry[0].fullUrl[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].id[0]	RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].text[0].status[0]	generated
Bundle.entry[0].resource[0].text[0].div[0]	<div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_RelatedPerson-NHS-9100000009"> </a><p class="res-header-id"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name="RelatedPerson-NHS-9100000009"> </a><a name="hcRelatedPerson-NHS-9100000009"> </a><a name="RelatedPerson-NHS-9100000009-en-US"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>
Bundle.entry[0].resource[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].identifier[0].value[0]	91000000009
Bundle.entry[0].resource[0].active[0]	False
Bundle.entry[0].resource[0].patient[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].patient[0].identifier[0].value[0]	9000000017
Bundle.entry[0].resource[0].patient[0].display[0]	Jane Marie Anne Smith
Bundle.entry[0].resource[0].relationship[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
Bundle.entry[0].resource[0].relationship[0].coding[0].code[0]	NMTH
Bundle.entry[0].resource[0].relationship[0].coding[0].display[0]	natural mother
Bundle.entry[0].resource[0].relationship[0].text[0]	Natural Mother
Bundle.entry[0].resource[0].name[0].use[0]	official
Bundle.entry[0].resource[0].name[0].family[0]	Smith
Bundle.entry[0].resource[0].name[0].given[0]	Jayne
Bundle.entry[0].resource[0].birthDate[0]	1916-12-05
Bundle.entry[0].search[0].mode[0]	match

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="NationalProxy-Bundle-Search-RelatedPerson-patient-Example" />
    <type value="searchset" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000017" />
    </link>
    <entry>
        <fullUrl value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
        <resource>
            <RelatedPerson>
                <id value="RelatedPerson-NHS-9100000009" />
                <text>
                    <status value="generated" />
                    <div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_RelatedPerson-NHS-9100000009"> </a><p class="res-header-id"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name="RelatedPerson-NHS-9100000009"> </a><a name="hcRelatedPerson-NHS-9100000009"> </a><a name="RelatedPerson-NHS-9100000009-en-US"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>
                </text>
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="91000000009" />
                </identifier>
                <active value="false" />
                <patient>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9000000017" />
                    </identifier>
                    <display value="Jane Marie Anne Smith" />
                </patient>
                <relationship>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                        <code value="NMTH" />
                        <display value="natural mother" />
                    </coding>
                    <text value="Natural Mother" />
                </relationship>
                <name>
                    <use value="official" />
                    <family value="Smith" />
                    <given value="Jayne" />
                </name>
                <birthDate value="1916-12-05" />
            </RelatedPerson>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "id": "NationalProxy-Bundle-Search-RelatedPerson-patient-Example",
    "type": "searchset",
    "total": 1,
    "link":  [
        {
            "relation": "self",
            "url": "https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9000000017"
        }
    ],
    "entry":  [
        {
            "fullUrl": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009",
            "resource": {
                "resourceType": "RelatedPerson",
                "id": "RelatedPerson-NHS-9100000009",
                "text": {
                    "status": "generated",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"RelatedPerson_RelatedPerson-NHS-9100000009\"> </a><p class=\"res-header-id\"><b>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009</b></p><a name=\"RelatedPerson-NHS-9100000009\"> </a><a name=\"hcRelatedPerson-NHS-9100000009\"> </a><a name=\"RelatedPerson-NHS-9100000009-en-US\"> </a><p><b>identifier</b>: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009</p><p><b>active</b>: false</p><p><b>patient</b>: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)</p><p><b>relationship</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NMTH}\">Natural Mother</span></p><p><b>name</b>: Jayne Smith (Official)</p><p><b>birthDate</b>: 1916-12-05</p></div>"
                },
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "91000000009"
                    }
                ],
                "active": false,
                "patient": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9000000017"
                    },
                    "display": "Jane Marie Anne Smith"
                },
                "relationship":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "NMTH",
                                "display": "natural mother"
                            }
                        ],
                        "text": "Natural Mother"
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "family": "Smith",
                        "given":  [
                            "Jayne"
                        ]
                    }
                ],
                "birthDate": "1916-12-05"
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

Bundle Searchset Related Person and Provenance patient:identifier query

Important: This page is under development by NHS England

Tree View

Bundle

type : searchset

timestamp : 2025-03-05T15:09:22.268+00:00

meta

lastUpdated : 2025-03-05T15:09:22.268+00:00

versionId : 92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c

entry

fullUrl : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

search

mode : match

resource

id : RelatedPerson-NHS-9100000009

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 91000000009

active : True

patient

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 9000000017

display : Jane Marie Anne Smith

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleCode

code : NMTH

display : natural mother

name

use : official

family : Smith

given : Jayne

birthDate : 1916-12-05

meta

versionId : bb8e51f1-b7c3-462f-872a-8230e12f49cf

lastUpdated : 2025-02-10T11:48:55.011+00:00

entry

fullUrl : https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7

search

mode : include

resource

target

reference : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

recorded : 2024-10-25T16:39:24+01:00

agent

type

coding

system : http://terminology.hl7.org/CodeSystem/provenance-participant-type

code : assembler

who

identifier

system : https://fhir.nhs.uk/Id/ods-organization-code

value : W7V6T

display : Related Person Network

entity

role : source

what

display : Civil Birth Registration

agent

type

coding

system : http://terminology.hl7.org/CodeSystem/provenance-participant-type

code : legal

who

identifier

system : https://fhir.nhs.uk/Id/ods-organization-code

value : XDC

display : Office for National Statistics (ONS)

id : 49baa779-6273-47bb-8ed3-b01754790fe7

meta

versionId : 097b5f6e-d60c-46b0-ba28-80e73c5c961f

lastUpdated : 2025-02-26T15:25:31.026+00:00

total : 1

link

relation : self

url : https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=9000000017&_total=accurate&_count=10&_skip=0&_revinclude=Provenance:target

id : NationalProxy-Bundle-Search-RelatedPersonProv-patient-Example

Table View

Bundle.id[0]	NationalProxy-Bundle-Search-RelatedPersonProv-patient-Example
Bundle.meta[0].versionId[0]	92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c
Bundle.meta[0].lastUpdated[0]	2025-03-05T15:09:22.268+00:00
Bundle.type[0]	searchset
Bundle.timestamp[0]	2025-03-05T15:09:22.268+00:00
Bundle.total[0]	1
Bundle.link[0].relation[0]	self
Bundle.link[0].url[0]	https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=9000000017&_total=accurate&_count=10&_skip=0&_revinclude=Provenance:target
Bundle.entry[0].fullUrl[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].id[0]	RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].meta[0].versionId[0]	bb8e51f1-b7c3-462f-872a-8230e12f49cf
Bundle.entry[0].resource[0].meta[0].lastUpdated[0]	2025-02-10T11:48:55.011+00:00
Bundle.entry[0].resource[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].identifier[0].value[0]	91000000009
Bundle.entry[0].resource[0].active[0]	True
Bundle.entry[0].resource[0].patient[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].patient[0].identifier[0].value[0]	9000000017
Bundle.entry[0].resource[0].patient[0].display[0]	Jane Marie Anne Smith
Bundle.entry[0].resource[0].relationship[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
Bundle.entry[0].resource[0].relationship[0].coding[0].code[0]	NMTH
Bundle.entry[0].resource[0].relationship[0].coding[0].display[0]	natural mother
Bundle.entry[0].resource[0].name[0].use[0]	official
Bundle.entry[0].resource[0].name[0].family[0]	Smith
Bundle.entry[0].resource[0].name[0].given[0]	Jayne
Bundle.entry[0].resource[0].birthDate[0]	1916-12-05
Bundle.entry[0].search[0].mode[0]	match
Bundle.entry[1].fullUrl[0]	https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7
Bundle.entry[1].resource[0].id[0]	49baa779-6273-47bb-8ed3-b01754790fe7
Bundle.entry[1].resource[0].meta[0].versionId[0]	097b5f6e-d60c-46b0-ba28-80e73c5c961f
Bundle.entry[1].resource[0].meta[0].lastUpdated[0]	2025-02-26T15:25:31.026+00:00
Bundle.entry[1].resource[0].target[0].reference[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[1].resource[0].recorded[0]	2024-10-25T16:39:24+01:00
Bundle.entry[1].resource[0].agent[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/provenance-participant-type
Bundle.entry[1].resource[0].agent[0].type[0].coding[0].code[0]	assembler
Bundle.entry[1].resource[0].agent[0].who[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Bundle.entry[1].resource[0].agent[0].who[0].identifier[0].value[0]	W7V6T
Bundle.entry[1].resource[0].agent[0].who[0].display[0]	Related Person Network
Bundle.entry[1].resource[0].entity[0].role[0]	source
Bundle.entry[1].resource[0].entity[0].what[0].display[0]	Civil Birth Registration
Bundle.entry[1].resource[0].entity[0].agent[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/provenance-participant-type
Bundle.entry[1].resource[0].entity[0].agent[0].type[0].coding[0].code[0]	legal
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].identifier[0].value[0]	XDC
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].display[0]	Office for National Statistics (ONS)
Bundle.entry[1].search[0].mode[0]	include

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="NationalProxy-Bundle-Search-RelatedPersonProv-patient-Example" />
    <meta>
        <versionId value="92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c" />
        <lastUpdated value="2025-03-05T15:09:22.268+00:00" />
    </meta>
    <type value="searchset" />
    <timestamp value="2025-03-05T15:09:22.268+00:00" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=9000000017&amp;_total=accurate&amp;_count=10&amp;_skip=0&amp;_revinclude=Provenance:target" />
    </link>
    <entry>
        <fullUrl value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
        <resource>
            <RelatedPerson>
                <id value="RelatedPerson-NHS-9100000009" />
                <meta>
                    <versionId value="bb8e51f1-b7c3-462f-872a-8230e12f49cf" />
                    <lastUpdated value="2025-02-10T11:48:55.011+00:00" />
                </meta>
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="91000000009" />
                </identifier>
                <active value="true" />
                <patient>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9000000017" />
                    </identifier>
                    <display value="Jane Marie Anne Smith" />
                </patient>
                <relationship>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                        <code value="NMTH" />
                        <display value="natural mother" />
                    </coding>
                </relationship>
                <name>
                    <use value="official" />
                    <family value="Smith" />
                    <given value="Jayne" />
                </name>
                <birthDate value="1916-12-05" />
            </RelatedPerson>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7" />
        <resource>
            <Provenance>
                <id value="49baa779-6273-47bb-8ed3-b01754790fe7" />
                <meta>
                    <versionId value="097b5f6e-d60c-46b0-ba28-80e73c5c961f" />
                    <lastUpdated value="2025-02-26T15:25:31.026+00:00" />
                </meta>
                <target>
                    <reference value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
                </target>
                <recorded value="2024-10-25T16:39:24+01:00" />
                <agent>
                    <type>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" />
                            <code value="assembler" />
                        </coding>
                    </type>
                    <who>
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="W7V6T" />
                        </identifier>
                        <display value="Related Person Network" />
                    </who>
                </agent>
                <entity>
                    <role value="source" />
                    <what>
                        <display value="Civil Birth Registration" />
                    </what>
                    <agent>
                        <type>
                            <coding>
                                <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" />
                                <code value="legal" />
                            </coding>
                        </type>
                        <who>
                            <identifier>
                                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                                <value value="XDC" />
                            </identifier>
                            <display value="Office for National Statistics (ONS)" />
                        </who>
                    </agent>
                </entity>
            </Provenance>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "03/05/2025 15:09:22",
    "meta": {
        "lastUpdated": "03/05/2025 15:09:22",
        "versionId": "92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c"
    },
    "entry":  [
        {
            "fullUrl": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "RelatedPerson",
                "id": "RelatedPerson-NHS-9100000009",
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "91000000009"
                    }
                ],
                "active": true,
                "patient": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9000000017"
                    },
                    "display": "Jane Marie Anne Smith"
                },
                "relationship":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "NMTH",
                                "display": "natural mother"
                            }
                        ]
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "family": "Smith",
                        "given":  [
                            "Jayne"
                        ]
                    }
                ],
                "birthDate": "1916-12-05",
                "meta": {
                    "versionId": "bb8e51f1-b7c3-462f-872a-8230e12f49cf",
                    "lastUpdated": "02/10/2025 11:48:55"
                }
            }
        },
        {
            "fullUrl": "https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7",
            "search": {
                "mode": "include"
            },
            "resource": {
                "resourceType": "Provenance",
                "target":  [
                    {
                        "reference": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009"
                    }
                ],
                "recorded": "10/25/2024 15:39:24",
                "agent":  [
                    {
                        "type": {
                            "coding":  [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                    "code": "assembler"
                                }
                            ]
                        },
                        "who": {
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "W7V6T"
                            },
                            "display": "Related Person Network"
                        }
                    }
                ],
                "entity":  [
                    {
                        "role": "source",
                        "what": {
                            "display": "Civil Birth Registration"
                        },
                        "agent":  [
                            {
                                "type": {
                                    "coding":  [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                            "code": "legal"
                                        }
                                    ]
                                },
                                "who": {
                                    "identifier": {
                                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                        "value": "XDC"
                                    },
                                    "display": "Office for National Statistics (ONS)"
                                }
                            }
                        ]
                    }
                ],
                "id": "49baa779-6273-47bb-8ed3-b01754790fe7",
                "meta": {
                    "versionId": "097b5f6e-d60c-46b0-ba28-80e73c5c961f",
                    "lastUpdated": "02/26/2025 15:25:31"
                }
            }
        }
    ],
    "total": 1,
    "link":  [
        {
            "relation": "self",
            "url": "https://example.nhs.uk/FHIR/R4/RelatedPerson?patient:identifier=9000000017&_total=accurate&_count=10&_skip=0&_revinclude=Provenance:target"
        }
    ],
    "id": "NationalProxy-Bundle-Search-RelatedPersonProv-patient-Example"
}

Bundle Searchset Related Person and Provenance identifier query

Important: This page is under development by NHS England

Tree View

Bundle

type : searchset

timestamp : 2025-03-05T15:09:22.268+00:00

meta

lastUpdated : 2025-03-05T15:09:22.268+00:00

versionId : 92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c

entry

fullUrl : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

search

mode : match

resource

id : RelatedPerson-NHS-9100000009

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 91000000009

active : True

patient

identifier

system : https://fhir.nhs.uk/Id/nhs-number

value : 9000000017

display : Jane Marie Anne Smith

relationship

coding

system : http://terminology.hl7.org/CodeSystem/v3-RoleCode

code : NMTH

display : natural mother

name

use : official

family : Smith

given : Jayne

birthDate : 1916-12-05

meta

versionId : bb8e51f1-b7c3-462f-872a-8230e12f49cf

lastUpdated : 2025-02-10T11:48:55.011+00:00

entry

fullUrl : https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7

search

mode : include

resource

target

reference : http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009

recorded : 2024-10-25T16:39:24+01:00

agent

type

coding

system : http://terminology.hl7.org/CodeSystem/provenance-participant-type

code : assembler

who

identifier

system : https://fhir.nhs.uk/Id/ods-organization-code

value : W7V6T

display : Related Person Network

entity

role : source

what

display : Civil Birth Registration

agent

type

coding

system : http://terminology.hl7.org/CodeSystem/provenance-participant-type

code : legal

who

identifier

system : https://fhir.nhs.uk/Id/ods-organization-code

value : XDC

display : Office for National Statistics (ONS)

id : 49baa779-6273-47bb-8ed3-b01754790fe7

meta

versionId : 097b5f6e-d60c-46b0-ba28-80e73c5c961f

lastUpdated : 2025-02-26T15:25:31.026+00:00

total : 1

link

relation : self

url : https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009&_revinclude=Provenance:target

id : NationalProxy-Bundle-Search-RelatedPersonProv-identifier-Example

Table View

Bundle.id[0]	NationalProxy-Bundle-Search-RelatedPersonProv-identifier-Example
Bundle.meta[0].versionId[0]	92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c
Bundle.meta[0].lastUpdated[0]	2025-03-05T15:09:22.268+00:00
Bundle.type[0]	searchset
Bundle.timestamp[0]	2025-03-05T15:09:22.268+00:00
Bundle.total[0]	1
Bundle.link[0].relation[0]	self
Bundle.link[0].url[0]	https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number\|91000000009&_revinclude=Provenance:target
Bundle.entry[0].fullUrl[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].id[0]	RelatedPerson-NHS-9100000009
Bundle.entry[0].resource[0].meta[0].versionId[0]	bb8e51f1-b7c3-462f-872a-8230e12f49cf
Bundle.entry[0].resource[0].meta[0].lastUpdated[0]	2025-02-10T11:48:55.011+00:00
Bundle.entry[0].resource[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].identifier[0].value[0]	91000000009
Bundle.entry[0].resource[0].active[0]	True
Bundle.entry[0].resource[0].patient[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[0].resource[0].patient[0].identifier[0].value[0]	9000000017
Bundle.entry[0].resource[0].patient[0].display[0]	Jane Marie Anne Smith
Bundle.entry[0].resource[0].relationship[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-RoleCode
Bundle.entry[0].resource[0].relationship[0].coding[0].code[0]	NMTH
Bundle.entry[0].resource[0].relationship[0].coding[0].display[0]	natural mother
Bundle.entry[0].resource[0].name[0].use[0]	official
Bundle.entry[0].resource[0].name[0].family[0]	Smith
Bundle.entry[0].resource[0].name[0].given[0]	Jayne
Bundle.entry[0].resource[0].birthDate[0]	1916-12-05
Bundle.entry[0].search[0].mode[0]	match
Bundle.entry[1].fullUrl[0]	https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7
Bundle.entry[1].resource[0].id[0]	49baa779-6273-47bb-8ed3-b01754790fe7
Bundle.entry[1].resource[0].meta[0].versionId[0]	097b5f6e-d60c-46b0-ba28-80e73c5c961f
Bundle.entry[1].resource[0].meta[0].lastUpdated[0]	2025-02-26T15:25:31.026+00:00
Bundle.entry[1].resource[0].target[0].reference[0]	http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009
Bundle.entry[1].resource[0].recorded[0]	2024-10-25T16:39:24+01:00
Bundle.entry[1].resource[0].agent[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/provenance-participant-type
Bundle.entry[1].resource[0].agent[0].type[0].coding[0].code[0]	assembler
Bundle.entry[1].resource[0].agent[0].who[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Bundle.entry[1].resource[0].agent[0].who[0].identifier[0].value[0]	W7V6T
Bundle.entry[1].resource[0].agent[0].who[0].display[0]	Related Person Network
Bundle.entry[1].resource[0].entity[0].role[0]	source
Bundle.entry[1].resource[0].entity[0].what[0].display[0]	Civil Birth Registration
Bundle.entry[1].resource[0].entity[0].agent[0].type[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/provenance-participant-type
Bundle.entry[1].resource[0].entity[0].agent[0].type[0].coding[0].code[0]	legal
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].identifier[0].value[0]	XDC
Bundle.entry[1].resource[0].entity[0].agent[0].who[0].display[0]	Office for National Statistics (ONS)
Bundle.entry[1].search[0].mode[0]	include

XML View

<Bundle xmlns="http://hl7.org/fhir">
    <id value="NationalProxy-Bundle-Search-RelatedPersonProv-identifier-Example" />
    <meta>
        <versionId value="92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c" />
        <lastUpdated value="2025-03-05T15:09:22.268+00:00" />
    </meta>
    <type value="searchset" />
    <timestamp value="2025-03-05T15:09:22.268+00:00" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009&amp;_revinclude=Provenance:target" />
    </link>
    <entry>
        <fullUrl value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
        <resource>
            <RelatedPerson>
                <id value="RelatedPerson-NHS-9100000009" />
                <meta>
                    <versionId value="bb8e51f1-b7c3-462f-872a-8230e12f49cf" />
                    <lastUpdated value="2025-02-10T11:48:55.011+00:00" />
                </meta>
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="91000000009" />
                </identifier>
                <active value="true" />
                <patient>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9000000017" />
                    </identifier>
                    <display value="Jane Marie Anne Smith" />
                </patient>
                <relationship>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                        <code value="NMTH" />
                        <display value="natural mother" />
                    </coding>
                </relationship>
                <name>
                    <use value="official" />
                    <family value="Smith" />
                    <given value="Jayne" />
                </name>
                <birthDate value="1916-12-05" />
            </RelatedPerson>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7" />
        <resource>
            <Provenance>
                <id value="49baa779-6273-47bb-8ed3-b01754790fe7" />
                <meta>
                    <versionId value="097b5f6e-d60c-46b0-ba28-80e73c5c961f" />
                    <lastUpdated value="2025-02-26T15:25:31.026+00:00" />
                </meta>
                <target>
                    <reference value="http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009" />
                </target>
                <recorded value="2024-10-25T16:39:24+01:00" />
                <agent>
                    <type>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" />
                            <code value="assembler" />
                        </coding>
                    </type>
                    <who>
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="W7V6T" />
                        </identifier>
                        <display value="Related Person Network" />
                    </who>
                </agent>
                <entity>
                    <role value="source" />
                    <what>
                        <display value="Civil Birth Registration" />
                    </what>
                    <agent>
                        <type>
                            <coding>
                                <system value="http://terminology.hl7.org/CodeSystem/provenance-participant-type" />
                                <code value="legal" />
                            </coding>
                        </type>
                        <who>
                            <identifier>
                                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                                <value value="XDC" />
                            </identifier>
                            <display value="Office for National Statistics (ONS)" />
                        </who>
                    </agent>
                </entity>
            </Provenance>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
</Bundle>

JSON View

{
    "resourceType": "Bundle",
    "type": "searchset",
    "timestamp": "03/05/2025 15:09:22",
    "meta": {
        "lastUpdated": "03/05/2025 15:09:22",
        "versionId": "92785ce8-d6c3-4d6a-bcb8-40527c0d9f6c"
    },
    "entry":  [
        {
            "fullUrl": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009",
            "search": {
                "mode": "match"
            },
            "resource": {
                "resourceType": "RelatedPerson",
                "id": "RelatedPerson-NHS-9100000009",
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "91000000009"
                    }
                ],
                "active": true,
                "patient": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9000000017"
                    },
                    "display": "Jane Marie Anne Smith"
                },
                "relationship":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                                "code": "NMTH",
                                "display": "natural mother"
                            }
                        ]
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "family": "Smith",
                        "given":  [
                            "Jayne"
                        ]
                    }
                ],
                "birthDate": "1916-12-05",
                "meta": {
                    "versionId": "bb8e51f1-b7c3-462f-872a-8230e12f49cf",
                    "lastUpdated": "02/10/2025 11:48:55"
                }
            }
        },
        {
            "fullUrl": "https://server.fire.ly/Provenance/49baa779-6273-47bb-8ed3-b01754790fe7",
            "search": {
                "mode": "include"
            },
            "resource": {
                "resourceType": "Provenance",
                "target":  [
                    {
                        "reference": "http://example.org/fhir/RelatedPerson/RelatedPerson-NHS-9100000009"
                    }
                ],
                "recorded": "10/25/2024 15:39:24",
                "agent":  [
                    {
                        "type": {
                            "coding":  [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                    "code": "assembler"
                                }
                            ]
                        },
                        "who": {
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "W7V6T"
                            },
                            "display": "Related Person Network"
                        }
                    }
                ],
                "entity":  [
                    {
                        "role": "source",
                        "what": {
                            "display": "Civil Birth Registration"
                        },
                        "agent":  [
                            {
                                "type": {
                                    "coding":  [
                                        {
                                            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                                            "code": "legal"
                                        }
                                    ]
                                },
                                "who": {
                                    "identifier": {
                                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                        "value": "XDC"
                                    },
                                    "display": "Office for National Statistics (ONS)"
                                }
                            }
                        ]
                    }
                ],
                "id": "49baa779-6273-47bb-8ed3-b01754790fe7",
                "meta": {
                    "versionId": "097b5f6e-d60c-46b0-ba28-80e73c5c961f",
                    "lastUpdated": "02/26/2025 15:25:31"
                }
            }
        }
    ],
    "total": 1,
    "link":  [
        {
            "relation": "self",
            "url": "https://example.nhs.uk/FHIR/R4/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number|91000000009&_revinclude=Provenance:target"
        }
    ],
    "id": "NationalProxy-Bundle-Search-RelatedPersonProv-identifier-Example"
}