NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available. 
{
    "resourceType": "Bundle",
    "id": "dd4c3e37-555d-47fc-9309-37539893e074",
    "type": "searchset",
    "total": 2,
    "entry":  [
        {
            "fullUrl": "Immunization/edea022a-2d81-11eb-adc1-0242ac120001",
            "resource": {
                "resourceType": "Immunization",
                "id": "edea022a-2d81-11eb-adc1-0242ac120001",
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
                        "valueCodeableConcept": {
                            "coding":  [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "1324681000000101",
                                    "display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
                                }
                            ]
                        }
                    }
                ],
                "identifier":  [
                    {
                        "use": "secondary",
                        "system": "https://supplierABC/identifiers/vacc",
                        "value": "1324761000000100"
                    }
                ],
                "status": "completed",
                "vaccineCode": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "39114911000001105",
                            "display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
                        }
                    ]
                },
                "patient": {
                    "type": "Patient",
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9912003888"
                    }
                },
                "occurrenceDateTime": "2020-12-23T13:00:08.476+00:00",
                "recorded": "2020-12-23",
                "primarySource": true,
                "manufacturer": {
                    "display": "AstraZeneca Ltd"
                },
                "lotNumber": "R04X",
                "expirationDate": "2021-04-29",
                "route": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "78421000",
                            "display": "Intramuscular route (qualifier value)"
                        }
                    ]
                },
                "doseQuantity": {
                    "value": 0.3,
                    "unit": "mL",
                    "system": "http://snomed.info/sct",
                    "code": "258773002"
                },
                "performer":  [
                    {
                        "actor": {
                            "type": "Organization",
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "RX809"
                            }
                        }
                    }
                ],
                "reasonCode":  [
                    {
                        "coding":  [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "443684005",
                                "display": "Disease outbreak (event)"
                            }
                        ]
                    }
                ],
                "protocolApplied":  [
                    {
                        "doseNumberPositiveInt": 1
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "Immunization/edea022a-2d81-11eb-adc1-0242ac120000",
            "resource": {
                "resourceType": "Immunization",
                "id": "edea022a-2d81-11eb-adc1-0242ac120000",
                "extension":  [
                    {
                        "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
                        "valueCodeableConcept": {
                            "coding":  [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "1324691000000104",
                                    "display": "Administration of second dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
                                }
                            ]
                        }
                    }
                ],
                "identifier":  [
                    {
                        "use": "secondary",
                        "system": "https://supplierABC/identifiers/vacc",
                        "value": "1324761000000102"
                    }
                ],
                "status": "completed",
                "vaccineCode": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "39114911000001105",
                            "display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
                        }
                    ]
                },
                "patient": {
                    "type": "Patient",
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9912003888"
                    }
                },
                "occurrenceDateTime": "2021-02-23T13:00:08.476+00:00",
                "recorded": "2021-02-23",
                "primarySource": false,
                "reportOrigin": {
                    "text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
                },
                "manufacturer": {
                    "display": "AstraZeneca Ltd"
                },
                "lotNumber": "A04Z",
                "expirationDate": "2021-06-29",
                "route": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "78421000",
                            "display": "Intramuscular route (qualifier value)"
                        }
                    ]
                },
                "doseQuantity": {
                    "value": 0.3,
                    "unit": "mL",
                    "system": "http://snomed.info/sct",
                    "code": "258773002"
                },
                "performer":  [
                    {
                        "actor": {
                            "type": "Organization",
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "RX809"
                            }
                        }
                    }
                ],
                "reasonCode":  [
                    {
                        "coding":  [
                            {
                                "system": "http://snomed.info/sct",
                                "code": "443684005",
                                "display": "Disease outbreak (event)"
                            }
                        ]
                    }
                ],
                "protocolApplied":  [
                    {
                        "doseNumberPositiveInt": 2
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
<Bundle xmlns="http://hl7.org/fhir">
    <id value="dd4c3e37-555d-47fc-9309-37539893e074" />
    <type value="searchset" />
    <total value="2" />
    <entry>
        <fullUrl value="Immunization/edea022a-2d81-11eb-adc1-0242ac120001" />
        <resource>
            <Immunization>
                <id value="edea022a-2d81-11eb-adc1-0242ac120001" />
                <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
                    <valueCodeableConcept>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <code value="1324681000000101" />
                            <display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <identifier>
                    <use value="secondary" />
                    <system value="https://supplierABC/identifiers/vacc" />
                    <value value="1324761000000100" />
                </identifier>
                <status value="completed" />
                <vaccineCode>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="39114911000001105" />
                        <display value="COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
                    </coding>
                </vaccineCode>
                <patient>
                    <type value="Patient" />
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9912003888" />
                    </identifier>
                </patient>
                <occurrenceDateTime value="2020-12-23T13:00:08.476+00:00" />
                <recorded value="2020-12-23" />
                <primarySource value="true" />
                <manufacturer>
                    <display value="AstraZeneca Ltd" />
                </manufacturer>
                <lotNumber value="R04X" />
                <expirationDate value="2021-04-29" />
                <route>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="78421000" />
                        <display value="Intramuscular route (qualifier value)" />
                    </coding>
                </route>
                <doseQuantity>
                    <value value="0.3" />
                    <unit value="mL" />
                    <system value="http://snomed.info/sct" />
                    <code value="258773002" />
                </doseQuantity>
                <performer>
                    <actor>
                        <type value="Organization" />
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="RX809" />
                        </identifier>
                    </actor>
                </performer>
                <reasonCode>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="443684005" />
                        <display value="Disease outbreak (event)" />
                    </coding>
                </reasonCode>
                <protocolApplied>
                    <doseNumberPositiveInt value="1" />
                </protocolApplied>
            </Immunization>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="Immunization/edea022a-2d81-11eb-adc1-0242ac120000" />
        <resource>
            <Immunization>
                <id value="edea022a-2d81-11eb-adc1-0242ac120000" />
                <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
                    <valueCodeableConcept>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <code value="1324691000000104" />
                            <display value="Administration of second dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <identifier>
                    <use value="secondary" />
                    <system value="https://supplierABC/identifiers/vacc" />
                    <value value="1324761000000102" />
                </identifier>
                <status value="completed" />
                <vaccineCode>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="39114911000001105" />
                        <display value="COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
                    </coding>
                </vaccineCode>
                <patient>
                    <type value="Patient" />
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/nhs-number" />
                        <value value="9912003888" />
                    </identifier>
                </patient>
                <occurrenceDateTime value="2021-02-23T13:00:08.476+00:00" />
                <recorded value="2021-02-23" />
                <primarySource value="false" />
                <reportOrigin>
                    <text value="RR8 - LEEDS TEACHING HOSPITALS NHS TRUST" />
                </reportOrigin>
                <manufacturer>
                    <display value="AstraZeneca Ltd" />
                </manufacturer>
                <lotNumber value="A04Z" />
                <expirationDate value="2021-06-29" />
                <route>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="78421000" />
                        <display value="Intramuscular route (qualifier value)" />
                    </coding>
                </route>
                <doseQuantity>
                    <value value="0.3" />
                    <unit value="mL" />
                    <system value="http://snomed.info/sct" />
                    <code value="258773002" />
                </doseQuantity>
                <performer>
                    <actor>
                        <type value="Organization" />
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="RX809" />
                        </identifier>
                    </actor>
                </performer>
                <reasonCode>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="443684005" />
                        <display value="Disease outbreak (event)" />
                    </coding>
                </reasonCode>
                <protocolApplied>
                    <doseNumberPositiveInt value="2" />
                </protocolApplied>
            </Immunization>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>
Bundle
back to top