HL7 FHIR logo

UK Core Implementation Guide 1.0.0 - STU1

patient

A reference to the patient who either received or did not receive the immunisation. The resource being referenced should conform to Profile UKCore-Patient.

Table View

Immunization.id[0]UKCore-Immunization-Sn-PatientConformVaccination-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.patient[0].type[0]Patient
Immunization.patient[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
Immunization.patient[0].identifier[0].value[0]9912003888
Immunization.occurrenceDateTime[0]2021-07-20

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-PatientConformVaccination-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <!--   **************snippet start**************   -->
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        <type value="Patient" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9912003888" />
        </identifier>
    </patient>
    <!--   **************snippet end**************   -->
    <occurrenceDateTime value="2021-07-20" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-PatientConformVaccination-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example",
        "type": "Patient",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
        }
    },
    "occurrenceDateTime": "2021-07-20"
}

Provider Systems

Provider systems SHALL provide a reference and/or identifier that allows the consumer system to query another API if they need to access the complete UKCore-Patient resource.

Consumer Systems

Consumer systems SHALL consume this data.

back to top