FHIR Genomics Implementation Guide

Notice

Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.

Bundle-Searchset-Example

Example of a searchset bundle returned in response to a search query on Specimen. This example has a single match and also returns a Patient resource as specified in the query's _incldue parameter.

Bundle

id : Bundle-Searchset-Example

meta

lastUpdated : 2024-05-31T15:27:00.009+00:00

type : searchset

total : 1

link

relation : self

url : https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/?_include=Specimen%3Asubject&identifier=RGT03135

entry

fullUrl : https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Specimen/44707473

resource

id : 44707473

meta

versionId : 1

lastUpdated : 2024-05-13T14:28:05.843+00:00

source : #CJ6XJLTGD315XL2Z

identifier

system : https://fhir.add.nhs.uk/Id/specimenId

value : RGT03135

status : unavailable

type

coding

system : http://snomed.info/sct

code : 445295009

display : Blood specimen with EDTA

subject

reference : Patient/44707475

identifier

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

value : 9449307946

request

reference : ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example

search

mode : match

entry

fullUrl : https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Patient/44707475

resource

id : 44707475

meta

versionId : 1

lastUpdated : 2024-05-13T14:28:05.843+00:00

source : #CJ6XJLTGD315XL2Z

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex

value

coding

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

code : M

display : Male

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory

value

coding

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

code : A

display : White - British

identifier

extension

url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus

value

coding

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

version : 2.2.0

code : 01

display : Number present and verified

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

value : 9449307946

identifier

system : urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24

value : RWT14789

assigner

identifier

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

value : RAX01

name

family : Sorrell

given : Lindsay

gender : male

birthDate : 2011-04-12

deceased : False

address

line : 31 THE AVENUE

line : BERWICK COURT

postalCode : KT4 7BS

generalPractitioner

identifier

system : https://fhir.hl7.org.uk/Id/gmp-number

value : G9999999

display : Dr. Aero Smith

generalPractitioner

identifier

system : https://fhir.hl7.org.uk/Id/ODS-code

value : AP123

display : anywhere place

link

other

reference : https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9449307946

type : seealso

search

mode : include

{
    "resourceType": "Bundle",
    "id": "Bundle-Searchset-Example",
    "meta": {
        "lastUpdated": "2024-05-31T15:27:00.009+00:00"
    },
    "type": "searchset",
    "total": 1,
    "link":  [
        {
            "relation": "self",
            "url": "https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/?_include=Specimen%3Asubject&identifier=RGT03135"
        }
    ],
    "entry":  [
        {
            "fullUrl": "https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Specimen/44707473",
            "resource": {
                "resourceType": "Specimen",
                "id": "44707473",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2024-05-13T14:28:05.843+00:00",
                    "source": "#CJ6XJLTGD315XL2Z"
                },
                "identifier":  [
                    {
                        "system": "https://fhir.add.nhs.uk/Id/specimenId",
                        "value": "RGT03135"
                    }
                ],
                "status": "unavailable",
                "type": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "445295009",
                            "display": "Blood specimen with EDTA"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/44707475",
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9449307946"
                    }
                },
                "request":  [
                    {
                        "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example"
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Patient/44707475",
            "resource": {
                "resourceType": "Patient",
                "id": "44707475",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2024-05-13T14:28:05.843+00:00",
                    "source": "#CJ6XJLTGD315XL2Z"
                },
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
                        "valueCodeableConcept": {
                            "coding":  [
                                {
                                    "system": "http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender",
                                    "code": "M",
                                    "display": "Male"
                                }
                            ]
                        }
                    },
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory",
                        "valueCodeableConcept": {
                            "coding":  [
                                {
                                    "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland",
                                    "code": "A",
                                    "display": "White - British"
                                }
                            ]
                        }
                    }
                ],
                "identifier":  [
                    {
                        "extension":  [
                            {
                                "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus",
                                "valueCodeableConcept": {
                                    "coding":  [
                                        {
                                            "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                                            "version": "2.2.0",
                                            "code": "01",
                                            "display": "Number present and verified"
                                        }
                                    ]
                                }
                            }
                        ],
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9449307946"
                    },
                    {
                        "system": "urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24",
                        "value": "RWT14789",
                        "assigner": {
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "RAX01"
                            }
                        }
                    }
                ],
                "name":  [
                    {
                        "family": "Sorrell",
                        "given":  [
                            "Lindsay"
                        ]
                    }
                ],
                "gender": "male",
                "birthDate": "2011-04-12",
                "deceasedBoolean": false,
                "address":  [
                    {
                        "line":  [
                            "31 THE AVENUE",
                            "BERWICK COURT"
                        ],
                        "postalCode": "KT4 7BS"
                    }
                ],
                "generalPractitioner":  [
                    {
                        "identifier": {
                            "system": "https://fhir.hl7.org.uk/Id/gmp-number",
                            "value": "G9999999"
                        },
                        "display": "Dr. Aero Smith"
                    },
                    {
                        "identifier": {
                            "system": "https://fhir.hl7.org.uk/Id/ODS-code",
                            "value": "AP123"
                        },
                        "display": "anywhere place"
                    }
                ],
                "link":  [
                    {
                        "other": {
                            "reference": "https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9449307946"
                        },
                        "type": "seealso"
                    }
                ]
            },
            "search": {
                "mode": "include"
            }
        }
    ]
}

<Bundle xmlns="http://hl7.org/fhir">
    <id value="Bundle-Searchset-Example" />
    <meta>
        <lastUpdated value="2024-05-31T15:27:00.009+00:00" />
    </meta>
    <type value="searchset" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/?_include=Specimen%3Asubject&amp;identifier=RGT03135" />
    </link>
    <entry>
        <fullUrl value="https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Specimen/44707473" />
        <resource>
            <Specimen>
                <id value="44707473" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2024-05-13T14:28:05.843+00:00" />
                    <source value="#CJ6XJLTGD315XL2Z" />
                </meta>
                <identifier>
                    <system value="https://fhir.add.nhs.uk/Id/specimenId" />
                    <value value="RGT03135" />
                </identifier>
                <status value="unavailable" />
                <type>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="445295009" />
                        <display value="Blood specimen with EDTA" />
                    </coding>
                </type>
                <subject>
                    <reference value="Patient/44707475" />
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9449307946" />
                    </identifier>
                </subject>
                <request>
                    <reference value="ServiceRequest/ServiceRequest-NonWGSTestOrderForm-Example" />
                </request>
            </Specimen>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="https://api.service.nhs.uk/genomic-order-management-service/FHIR/R4/Patient/44707475" />
        <resource>
            <Patient>
                <id value="44707475" />
                <meta>
                    <versionId value="1" />
                    <lastUpdated value="2024-05-13T14:28:05.843+00:00" />
                    <source value="#CJ6XJLTGD315XL2Z" />
                </meta>
                <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex">
                    <valueCodeableConcept>
                        <coding>
                            <system value="http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender" />
                            <code value="M" />
                            <display value="Male" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory">
                    <valueCodeableConcept>
                        <coding>
                            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland" />
                            <code value="A" />
                            <display value="White - British" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <identifier>
                    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus">
                        <valueCodeableConcept>
                            <coding>
                                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
                                <version value="2.2.0" />
                                <code value="01" />
                                <display value="Number present and verified" />
                            </coding>
                        </valueCodeableConcept>
                    </extension>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="9449307946" />
                </identifier>
                <identifier>
                    <system value="urn:oid:2.16.840.1.113883.2.1.3.2.4.18.24" />
                    <value value="RWT14789" />
                    <assigner>
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="RAX01" />
                        </identifier>
                    </assigner>
                </identifier>
                <name>
                    <family value="Sorrell" />
                    <given value="Lindsay" />
                </name>
                <gender value="male" />
                <birthDate value="2011-04-12" />
                <deceasedBoolean value="false" />
                <address>
                    <line value="31 THE AVENUE" />
                    <line value="BERWICK COURT" />
                    <postalCode value="KT4 7BS" />
                </address>
                <generalPractitioner>
                    <identifier>
                        <system value="https://fhir.hl7.org.uk/Id/gmp-number" />
                        <value value="G9999999" />
                    </identifier>
                    <display value="Dr. Aero Smith" />
                </generalPractitioner>
                <generalPractitioner>
                    <identifier>
                        <system value="https://fhir.hl7.org.uk/Id/ODS-code" />
                        <value value="AP123" />
                    </identifier>
                    <display value="anywhere place" />
                </generalPractitioner>
                <link>
                    <other>
                        <reference value="https://api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9449307946" />
                    </other>
                    <type value="seealso" />
                </link>
            </Patient>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
</Bundle>

Notice

Bundle-Searchset-Example

Propose a change to Bundle-SearchsetSearchset-Example