Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
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&_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" }