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.

vaccination-covid19-not-given

{
    "resourceType": "Immunization",
    "id": "251d4f32-e9ae-41f2-bb63-54e692195cc2",
    "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://fhir.leedsth.nhs.uk/Id/vaccination",
            "value": "1001324761000000"
        }
    ],
    "status": "not-done",
    "statusReason":  [
        {
            "coding":  [
                {
                    "system": "http://snomed.info/sct",
                    "code": "1324721000000108",
                    "display": "SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination dose declined"
                }
            ]
        }
    ],
    "vaccineCode": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                "code": "NA",
                "display": "not applicable"
            }
        ]
    },
    "patient": {
        "reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
        "type": "Patient",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
        }
    },
    "occurrenceDateTime": "2020-12-21T09:15:08.326+00:00",
    "recorded": "2020-12-21",
    "primarySource": false,
    "reportOrigin": {
        "text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
    },
    "performer":  [
        {
            "actor": {
                "type": "Organization",
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "C4B2A"
                },
                "display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
            }
        }
    ]
}
<Immunization xmlns="http://hl7.org/fhir">
    <id value="251d4f32-e9ae-41f2-bb63-54e692195cc2" />
    <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://fhir.leedsth.nhs.uk/Id/vaccination" />
        <value value="1001324761000000" />
    </identifier>
    <status value="not-done" />
    <statusReason>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="1324721000000108" />
            <display value="SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination dose declined" />
        </coding>
    </statusReason>
    <vaccineCode>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
            <code value="NA" />
            <display value="not applicable" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002" />
        <type value="Patient" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9912003888" />
        </identifier>
    </patient>
    <occurrenceDateTime value="2020-12-21T09:15:08.326+00:00" />
    <recorded value="2020-12-21" />
    <primarySource value="false" />
    <reportOrigin>
        <text value="RR8 - LEEDS TEACHING HOSPITALS NHS TRUST" />
    </reportOrigin>
    <performer>
        <actor>
            <type value="Organization" />
            <identifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="C4B2A" />
            </identifier>
            <display value="ELLAND ROAD STADIUM - COVID VACCINATION CENTRE" />
        </actor>
    </performer>
</Immunization>
Immunization
back to top