Example - _include Search Result
Important: This page is under development by NHS England
Tree View
Bundle |
id : ODS-Bundle-includeSearchResults-Example |
type : searchset |
total : 2 |
link |
relation : self |
url : https://baseurl/fhir/OrganizationAffiliation?_include=OrganizationAffiliation%3Aparticipating-organization&participating-organization=Q72&primary-organization=FDC49 |
entry |
fullUrl : https://baseurl/fhir/OrganizationAffiliation/383689 |
resource |
id : 383689 |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
extension |
url : dateType |
value |
system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
code : Legal |
display : Legal |
extension |
url : period |
value |
start : 2015-05-11 |
end : 2020-03-31 |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
extension |
url : dateType |
value |
system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
code : Operational |
display : Operational |
extension |
url : period |
value |
start : 2015-05-11 |
end : 2020-03-31 |
identifier |
system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance |
value : 383689 |
active : False |
period |
start : 2015-05-11 |
end : 2020-03-31 |
organization |
reference : Organization/FDC49 |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : FDC49 |
participatingOrganization |
reference : Organization/Q72 |
identifier |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : Q72 |
code |
coding |
system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship |
code : RE5 |
display : IS LOCATED IN THE GEOGRAPHY OF |
search |
mode : match |
entry |
fullUrl : https://baseurl/fhir/Organization/Q72 |
resource |
id : Q72 |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole |
extension |
url : instanceID |
value : 202011 |
extension |
url : roleCode |
value |
coding |
system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole |
code : RO210 |
display : NHS ENGLAND (REGION, LOCAL OFFICE) |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
extension |
url : dateType |
value |
system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
code : Legal |
display : Legal |
extension |
url : period |
value |
start : 2015-04-01 |
end : 2020-03-31 |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
extension |
url : dateType |
value |
system : https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
code : Operational |
display : Operational |
extension |
url : period |
value |
start : 2015-01-16 |
extension |
url : active |
value : True |
extension |
url : https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime |
extension |
url : type |
value |
system : https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime |
code : LastChangeDate |
display : Last Change Date |
extension |
url : dateTime |
value : 2020-09-30 |
identifier |
use : official |
system : https://fhir.nhs.uk/Id/ods-organization-code |
value : Q72 |
assigner |
display : HSCIC |
active : True |
type |
coding |
system : https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType |
code : Full |
display : Full |
type |
coding |
system : https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass |
code : RC1 |
display : HSCOrg |
name : NHS ENGLAND NORTH EAST AND YORKSHIRE (YORKSHIRE AND HUMBER) |
address |
line : CITY OFFICE PARK |
line : 3 LEEDS CITY OFFICE PARK |
line : HOLBECK |
city : LEEDS |
district : WEST YORKSHIRE |
postalCode : LS11 5BD |
country : ENGLAND |
search |
mode : include |
Table View
Bundle.id[0] | ODS-Bundle-includeSearchResults-Example |
Bundle.type[0] | searchset |
Bundle.total[0] | 2 |
Bundle.link[0].relation[0] | self |
Bundle.link[0].url[0] | https://baseurl/fhir/OrganizationAffiliation?_include=OrganizationAffiliation%3Aparticipating-organization&participating-organization=Q72&primary-organization=FDC49 |
Bundle.entry[0].fullUrl[0] | https://baseurl/fhir/OrganizationAffiliation/383689 |
Bundle.entry[0].resource[0].id[0] | 383689 |
Bundle.entry[0].resource[0].extension[0].extension[0].url[0] | dateType |
Bundle.entry[0].resource[0].extension[0].extension[0].value[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
Bundle.entry[0].resource[0].extension[0].extension[0].value[0].code[0] | Legal |
Bundle.entry[0].resource[0].extension[0].extension[0].value[0].display[0] | Legal |
Bundle.entry[0].resource[0].extension[0].extension[1].url[0] | period |
Bundle.entry[0].resource[0].extension[0].extension[1].value[0].start[0] | 2015-05-11 |
Bundle.entry[0].resource[0].extension[0].extension[1].value[0].end[0] | 2020-03-31 |
Bundle.entry[0].resource[0].extension[0].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
Bundle.entry[0].resource[0].extension[1].extension[0].url[0] | dateType |
Bundle.entry[0].resource[0].extension[1].extension[0].value[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
Bundle.entry[0].resource[0].extension[1].extension[0].value[0].code[0] | Operational |
Bundle.entry[0].resource[0].extension[1].extension[0].value[0].display[0] | Operational |
Bundle.entry[0].resource[0].extension[1].extension[1].url[0] | period |
Bundle.entry[0].resource[0].extension[1].extension[1].value[0].start[0] | 2015-05-11 |
Bundle.entry[0].resource[0].extension[1].extension[1].value[0].end[0] | 2020-03-31 |
Bundle.entry[0].resource[0].extension[1].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
Bundle.entry[0].resource[0].identifier[0].system[0] | https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance |
Bundle.entry[0].resource[0].identifier[0].value[0] | 383689 |
Bundle.entry[0].resource[0].active[0] | False |
Bundle.entry[0].resource[0].period[0].start[0] | 2015-05-11 |
Bundle.entry[0].resource[0].period[0].end[0] | 2020-03-31 |
Bundle.entry[0].resource[0].organization[0].reference[0] | Organization/FDC49 |
Bundle.entry[0].resource[0].organization[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
Bundle.entry[0].resource[0].organization[0].identifier[0].value[0] | FDC49 |
Bundle.entry[0].resource[0].participatingOrganization[0].reference[0] | Organization/Q72 |
Bundle.entry[0].resource[0].participatingOrganization[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
Bundle.entry[0].resource[0].participatingOrganization[0].identifier[0].value[0] | Q72 |
Bundle.entry[0].resource[0].code[0].coding[0].system[0] | https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship |
Bundle.entry[0].resource[0].code[0].coding[0].code[0] | RE5 |
Bundle.entry[0].resource[0].code[0].coding[0].display[0] | IS LOCATED IN THE GEOGRAPHY OF |
Bundle.entry[0].search[0].mode[0] | match |
Bundle.entry[1].fullUrl[0] | https://baseurl/fhir/Organization/Q72 |
Bundle.entry[1].resource[0].id[0] | Q72 |
Bundle.entry[1].resource[0].extension[0].extension[0].url[0] | instanceID |
Bundle.entry[1].resource[0].extension[0].extension[0].value[0] | 202011 |
Bundle.entry[1].resource[0].extension[0].extension[1].url[0] | roleCode |
Bundle.entry[1].resource[0].extension[0].extension[1].value[0].coding[0].system[0] | https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole |
Bundle.entry[1].resource[0].extension[0].extension[1].value[0].coding[0].code[0] | RO210 |
Bundle.entry[1].resource[0].extension[0].extension[1].value[0].coding[0].display[0] | NHS ENGLAND (REGION, LOCAL OFFICE) |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[0].url[0] | dateType |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[0].value[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[0].value[0].code[0] | Legal |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[0].value[0].display[0] | Legal |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[1].url[0] | period |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[1].value[0].start[0] | 2015-04-01 |
Bundle.entry[1].resource[0].extension[0].extension[2].extension[1].value[0].end[0] | 2020-03-31 |
Bundle.entry[1].resource[0].extension[0].extension[2].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[0].url[0] | dateType |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[0].value[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[0].value[0].code[0] | Operational |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[0].value[0].display[0] | Operational |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[1].url[0] | period |
Bundle.entry[1].resource[0].extension[0].extension[3].extension[1].value[0].start[0] | 2015-01-16 |
Bundle.entry[1].resource[0].extension[0].extension[3].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod |
Bundle.entry[1].resource[0].extension[0].extension[4].url[0] | active |
Bundle.entry[1].resource[0].extension[0].extension[4].value[0] | True |
Bundle.entry[1].resource[0].extension[0].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole |
Bundle.entry[1].resource[0].extension[1].extension[0].url[0] | type |
Bundle.entry[1].resource[0].extension[1].extension[0].value[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime |
Bundle.entry[1].resource[0].extension[1].extension[0].value[0].code[0] | LastChangeDate |
Bundle.entry[1].resource[0].extension[1].extension[0].value[0].display[0] | Last Change Date |
Bundle.entry[1].resource[0].extension[1].extension[1].url[0] | dateTime |
Bundle.entry[1].resource[0].extension[1].extension[1].value[0] | 2020-09-30 |
Bundle.entry[1].resource[0].extension[1].url[0] | https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime |
Bundle.entry[1].resource[0].identifier[0].use[0] | official |
Bundle.entry[1].resource[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-organization-code |
Bundle.entry[1].resource[0].identifier[0].value[0] | Q72 |
Bundle.entry[1].resource[0].identifier[0].assigner[0].display[0] | HSCIC |
Bundle.entry[1].resource[0].active[0] | True |
Bundle.entry[1].resource[0].type[0].coding[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType |
Bundle.entry[1].resource[0].type[0].coding[0].code[0] | Full |
Bundle.entry[1].resource[0].type[0].coding[0].display[0] | Full |
Bundle.entry[1].resource[0].type[1].coding[0].system[0] | https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass |
Bundle.entry[1].resource[0].type[1].coding[0].code[0] | RC1 |
Bundle.entry[1].resource[0].type[1].coding[0].display[0] | HSCOrg |
Bundle.entry[1].resource[0].name[0] | NHS ENGLAND NORTH EAST AND YORKSHIRE (YORKSHIRE AND HUMBER) |
Bundle.entry[1].resource[0].address[0].line[0] | CITY OFFICE PARK |
Bundle.entry[1].resource[0].address[0].line[1] | 3 LEEDS CITY OFFICE PARK |
Bundle.entry[1].resource[0].address[0].line[2] | HOLBECK |
Bundle.entry[1].resource[0].address[0].city[0] | LEEDS |
Bundle.entry[1].resource[0].address[0].district[0] | WEST YORKSHIRE |
Bundle.entry[1].resource[0].address[0].postalCode[0] | LS11 5BD |
Bundle.entry[1].resource[0].address[0].country[0] | ENGLAND |
Bundle.entry[1].search[0].mode[0] | include |
XML View
<Bundle xmlns="http://hl7.org/fhir"> <id value="ODS-Bundle-includeSearchResults-Example" /> <type value="searchset" /> <total value="2" /> <link> <relation value="self" /> <url value="https://baseurl/fhir/OrganizationAffiliation?_include=OrganizationAffiliation%3Aparticipating-organization&participating-organization=Q72&primary-organization=FDC49" /> </link> <entry> <fullUrl value="https://baseurl/fhir/OrganizationAffiliation/383689" /> <resource> <OrganizationAffiliation> <id value="383689" /> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"> <extension url="dateType"> <valueCoding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="Legal" /> <display value="Legal" /> </valueCoding> </extension> <extension url="period"> <valuePeriod> <start value="2015-05-11" /> <end value="2020-03-31" /> </valuePeriod> </extension> </extension> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"> <extension url="dateType"> <valueCoding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="Operational" /> <display value="Operational" /> </valueCoding> </extension> <extension url="period"> <valuePeriod> <start value="2015-05-11" /> <end value="2020-03-31" /> </valuePeriod> </extension> </extension> <identifier> <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance" /> <value value="383689" /> </identifier> <active value="false" /> <period> <start value="2015-05-11" /> <end value="2020-03-31" /> </period> <organization> <reference value="Organization/FDC49" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="FDC49" /> </identifier> </organization> <participatingOrganization> <reference value="Organization/Q72" /> <identifier> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="Q72" /> </identifier> </participatingOrganization> <code> <coding> <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship" /> <code value="RE5" /> <display value="IS LOCATED IN THE GEOGRAPHY OF" /> </coding> </code> </OrganizationAffiliation> </resource> <search> <mode value="match" /> </search> </entry> <entry> <fullUrl value="https://baseurl/fhir/Organization/Q72" /> <resource> <Organization> <id value="Q72" /> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole"> <extension url="instanceID"> <valueInteger value="202011" /> </extension> <extension url="roleCode"> <valueCodeableConcept> <coding> <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole" /> <code value="RO210" /> <display value="NHS ENGLAND (REGION, LOCAL OFFICE)" /> </coding> </valueCodeableConcept> </extension> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"> <extension url="dateType"> <valueCoding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="Legal" /> <display value="Legal" /> </valueCoding> </extension> <extension url="period"> <valuePeriod> <start value="2015-04-01" /> <end value="2020-03-31" /> </valuePeriod> </extension> </extension> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod"> <extension url="dateType"> <valueCoding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="Operational" /> <display value="Operational" /> </valueCoding> </extension> <extension url="period"> <valuePeriod> <start value="2015-01-16" /> </valuePeriod> </extension> </extension> <extension url="active"> <valueBoolean value="true" /> </extension> </extension> <extension url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime"> <extension url="type"> <valueCoding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime" /> <code value="LastChangeDate" /> <display value="Last Change Date" /> </valueCoding> </extension> <extension url="dateTime"> <valueDateTime value="2020-09-30" /> </extension> </extension> <identifier> <use value="official" /> <system value="https://fhir.nhs.uk/Id/ods-organization-code" /> <value value="Q72" /> <assigner> <display value="HSCIC" /> </assigner> </identifier> <active value="true" /> <type> <coding> <system value="https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType" /> <code value="Full" /> <display value="Full" /> </coding> </type> <type> <coding> <system value="https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass" /> <code value="RC1" /> <display value="HSCOrg" /> </coding> </type> <name value="NHS ENGLAND NORTH EAST AND YORKSHIRE (YORKSHIRE AND HUMBER)" /> <address> <line value="CITY OFFICE PARK" /> <line value="3 LEEDS CITY OFFICE PARK" /> <line value="HOLBECK" /> <city value="LEEDS" /> <district value="WEST YORKSHIRE" /> <postalCode value="LS11 5BD" /> <country value="ENGLAND" /> </address> </Organization> </resource> <search> <mode value="include" /> </search> </entry> </Bundle>
JSON View
{ "resourceType": "Bundle", "id": "ODS-Bundle-includeSearchResults-Example", "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://baseurl/fhir/OrganizationAffiliation?_include=OrganizationAffiliation%3Aparticipating-organization&participating-organization=Q72&primary-organization=FDC49" } ], "entry": [ { "fullUrl": "https://baseurl/fhir/OrganizationAffiliation/383689", "resource": { "resourceType": "OrganizationAffiliation", "id": "383689", "extension": [ { "extension": [ { "url": "dateType", "valueCoding": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "Legal", "display": "Legal" } }, { "url": "period", "valuePeriod": { "start": "2015-05-11", "end": "2020-03-31" } } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" }, { "extension": [ { "url": "dateType", "valueCoding": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "Operational", "display": "Operational" } }, { "url": "period", "valuePeriod": { "start": "2015-05-11", "end": "2020-03-31" } } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" } ], "identifier": [ { "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/organization-relationship-instance", "value": "383689" } ], "active": false, "period": { "start": "2015-05-11", "end": "2020-03-31" }, "organization": { "reference": "Organization/FDC49", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "FDC49" } }, "participatingOrganization": { "reference": "Organization/Q72", "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Q72" } }, "code": [ { "coding": [ { "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRelationship", "code": "RE5", "display": "IS LOCATED IN THE GEOGRAPHY OF" } ] } ] }, "search": { "mode": "match" } }, { "fullUrl": "https://baseurl/fhir/Organization/Q72", "resource": { "resourceType": "Organization", "id": "Q72", "extension": [ { "extension": [ { "url": "instanceID", "valueInteger": 202011 }, { "url": "roleCode", "valueCodeableConcept": { "coding": [ { "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole", "code": "RO210", "display": "NHS ENGLAND (REGION, LOCAL OFFICE)" } ] } }, { "extension": [ { "url": "dateType", "valueCoding": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "Legal", "display": "Legal" } }, { "url": "period", "valuePeriod": { "start": "2015-04-01", "end": "2020-03-31" } } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" }, { "extension": [ { "url": "dateType", "valueCoding": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "Operational", "display": "Operational" } }, { "url": "period", "valuePeriod": { "start": "2015-01-16" } } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" }, { "url": "active", "valueBoolean": true } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" }, { "extension": [ { "url": "type", "valueCoding": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime", "code": "LastChangeDate", "display": "Last Change Date" } }, { "url": "dateTime", "valueDateTime": "2020-09-30" } ], "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime" } ], "identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Q72", "assigner": { "display": "HSCIC" } } ], "active": true, "type": [ { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType", "code": "Full", "display": "Full" } ] }, { "coding": [ { "system": "https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass", "code": "RC1", "display": "HSCOrg" } ] } ], "name": "NHS ENGLAND NORTH EAST AND YORKSHIRE (YORKSHIRE AND HUMBER)", "address": [ { "line": [ "CITY OFFICE PARK", "3 LEEDS CITY OFFICE PARK", "HOLBECK" ], "city": "LEEDS", "district": "WEST YORKSHIRE", "postalCode": "LS11 5BD", "country": "ENGLAND" } ] }, "search": { "mode": "include" } } ] }