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

</identifier>

</patient>

<system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
<code value="FTH" />
<display value="father" />

</coding>

</relationship>

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

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

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

}

Propose a change to

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

</extension>

<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" />
<code value="12" />
<display value="Braille" />

</coding>

</valueCodeableConcept>

</extension>

<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" />
<code value="1" />
<display value="Letter" />

</coding>

</valueCodeableConcept>

</extension>

</extension>

</identifier>

</patient>

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

<system value="phone" />
<value value="01632960587" />
<use value="home" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>

</telecom>

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

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

}

]

}

]

}

Propose a change to

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

meta

profile : https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS

extension

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status

value : True

extension

url : dateType

value

system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType

code : system-effective

display : System Effective

extension

url : period

value

start : 2025-06-25T16:01:19+00:00

url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod

identifier

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

value : 9732017945

active : True

patient

reference : Patient/Patient-NHS-9732017996-Canon-Smith

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.meta[0].profile[0]	https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS
RelatedPerson.extension[0].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status
RelatedPerson.extension[0].value[0]	True
RelatedPerson.extension[1].extension[0].url[0]	dateType
RelatedPerson.extension[1].extension[0].value[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
RelatedPerson.extension[1].extension[0].value[0].code[0]	system-effective
RelatedPerson.extension[1].extension[0].value[0].display[0]	System Effective
RelatedPerson.extension[1].extension[1].url[0]	period
RelatedPerson.extension[1].extension[1].value[0].start[0]	2025-06-25T16:01:19+00:00
RelatedPerson.extension[1].url[0]	https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
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].reference[0]	Patient/Patient-NHS-9732017996-Canon-Smith
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

<meta>

</meta>

</extension>

<system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" />
<code value="system-effective" />
<display value="System Effective" />

</valueCoding>

</extension>

</valuePeriod>

</extension>

</identifier>

</identifier>

</patient>

<system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
<code value="MTH" />
<display value="mother" />

</coding>

</relationship>

<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" />
<code value="Guardian" />
<display value="Guardian of patient" />

</coding>

</relationship>

<system value="http://terminology.hl7.org/CodeSystem/v2-0131" />
<code value="N" />
<display value="Next-of-Kin" />

</coding>

</relationship>

<name>

</period>

</name>

</period>

</RelatedPerson>

JSON View

{

"resourceType": "RelatedPerson",

"id": "PDS-RelatedPerson-D1EDA4B8-Example",

"meta": {

"profile": [

"https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS"

]

"extension": [

{

"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Next-of-Kin-Status",

"valueBoolean": true

{

"extension": [

{

"url": "dateType",

"valueCoding": {

"system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType",
"code": "system-effective",
"display": "System Effective"

}

{

"url": "period",

"valuePeriod": {

"start": "2025-06-25T16:01:19+00:00"

}

"url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"

}

"identifier": [

{

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

"value": "9732017945"

}

"active": true,

"patient": {

"reference": "Patient/Patient-NHS-9732017996-Canon-Smith",

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

}

Propose a change to PDS-RelatedPerson-D1EDA4B8-Example

An example to illustrate the identificaation of source system through which the relationship between a Patient and their proxy originated from.

PDS-Provenance-RelatedPersonUpdate-Example

Important: This page is under development by NHS England

Tree View

Provenance

id : PDS-Provenance-RelatedPersonUpdate-Example

target

reference : RelatedPerson/PDS-RelatedPerson-D1EDA4B8-Example

recorded : 2025-06-30T12:00:00Z

activity

coding

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

code : UPDATE

display : update

agent

who

identifier

system : https://fhir.nhs.uk/Id/accredited-system-id

value : 200000000115

onBehalfOf

identifier

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

value : RR8

Table View

Provenance.id[0]	PDS-Provenance-RelatedPersonUpdate-Example
Provenance.target[0].reference[0]	RelatedPerson/PDS-RelatedPerson-D1EDA4B8-Example
Provenance.recorded[0]	2025-06-30T12:00:00+00:00
Provenance.activity[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/v3-DataOperation
Provenance.activity[0].coding[0].code[0]	UPDATE
Provenance.activity[0].coding[0].display[0]	update
Provenance.agent[0].who[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/accredited-system-id
Provenance.agent[0].who[0].identifier[0].value[0]	200000000115
Provenance.agent[0].onBehalfOf[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/ods-organization-code
Provenance.agent[0].onBehalfOf[0].identifier[0].value[0]	RR8

XML View

</target>

<system value="http://terminology.hl7.org/CodeSystem/v3-DataOperation" />
<code value="UPDATE" />
<display value="update" />

</coding>

</activity>

<agent>

<who>

</identifier>

</who>

</identifier>

</onBehalfOf>

</agent>

</Provenance>

JSON View

{

"resourceType": "Provenance",

"id": "PDS-Provenance-RelatedPersonUpdate-Example",

"target": [

{

"reference": "RelatedPerson/PDS-RelatedPerson-D1EDA4B8-Example"

}

"recorded": "2025-06-30T12:00:00Z",

"activity": {

"coding": [

{

"system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
"code": "UPDATE",
"display": "update"

}

]

"agent": [

{

"who": {

"identifier": {

"system": "https://fhir.nhs.uk/Id/accredited-system-id",

"value": "200000000115"

}

"onBehalfOf": {

"identifier": {

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

"value": "RR8"

}

]

}

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

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

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

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

Consent.id[0]	PDS-Consent-CallbackConsent-Example
Consent.meta[0].profile[0]	https://fhir.hl7.org.uk/StructureDefinition/UKCore-Consent
Consent.status[0]	active
Consent.scope[0].coding[0].system[0]	http://terminology.hl7.org/CodeSystem/consentscope
Consent.scope[0].coding[0].code[0]	patient-privacy
Consent.category[0].coding[0].system[0]	https://fhir.nhs.uk/England/CodeSystem/England-CallbackConsent
Consent.category[0].coding[0].code[0]	callback-consent
Consent.category[0].coding[0].display[0]	Consent to Callback
Consent.patient[0].reference[0]	Patient/Patient-NHS-9732017996-Canon-Smith
Consent.patient[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Consent.patient[0].identifier[0].value[0]	9732017996
Consent.performer[0].reference[0]	RelatedPerson/PDS-RelatedPerson-D1EDA4B8-Example
Consent.performer[0].identifier[0].system[0]	https://fhir.nhs.uk/Id/nhs-number
Consent.performer[0].identifier[0].value[0]	9732017945
Consent.policy[0].authority[0]	https://www.exampleauthority.nhs.uk
Consent.policy[0].uri[0]	https://www.exampleauthority.nhs.uk/policies/nhse-policy-example-v1.0
Consent.provision[0].type[0]	permit

Examples

RelatedPerson-45B0DF3F-Example

Tree View

Table View

XML View

JSON View

RelatedPerson-507B7621-Example

Tree View

Table View

XML View

JSON View

RelatedPerson-D1EDA4B8-Example

Tree View

Table View

XML View

JSON View

Bundle Searchset Related Person identifier query

Tree View

Table View

XML View

JSON View

Bundle Searchset Related Person patient:identifier query

Tree View

Table View

XML View

JSON View

Bundle Searchset Related Person and Provenance patient:identifier query

Tree View

Table View

XML View

JSON View

Bundle Searchset Related Person and Provenance identifier query

Tree View

Table View

XML View

JSON View

PDS-Consent-CallConsent-Example

Tree View

Table View

XML View

JSON View

PDS-Provenance-RelatedPersonUpdate-Example

Tree View

Table View

XML View

JSON View