National Proxy Service

WARNING

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

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

<link>

</link>

<entry>

<text>

<div xmlns="http://www.w3.org/1999/xhtml"><a name="RelatedPerson_RelatedPerson-NHS-9100000009"> </a>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009<a name="RelatedPerson-NHS-9100000009"> </a><a name="hcRelatedPerson-NHS-9100000009"> </a><a name="RelatedPerson-NHS-9100000009-en-US"> </a>identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009active: falsepatient: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)relationship: Natural Mothername: Jayne Smith (Official)birthDate: 1916-12-05</div>

</text>

</identifier>

</identifier>

</patient>

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

</RelatedPerson>

</resource>

</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>Generated Narrative: RelatedPerson RelatedPerson-NHS-9100000009<a name=\"RelatedPerson-NHS-9100000009\"> </a><a name=\"hcRelatedPerson-NHS-9100000009\"> </a><a name=\"RelatedPerson-NHS-9100000009-en-US\"> </a>identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/91000000009active: falsepatient: Jane Marie Anne Smith (Identifier: <code>https://fhir.nhs.uk/Id/nhs-number</code>/9000000017)relationship: Natural Mothername: Jayne Smith (Official)birthDate: 1916-12-05</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"

}

]

}