HL7 FHIR logo

UK Core Implementation Guide 1.0.0 - STU1 Pre-release

doseQuantity

The quantity of vaccine product that was administered.

By preference, use UCUM units of measure. Examples of when a UCUM unit of measure would be used are “gram” or “milliliter” or “percent”.

Where a UCUM unit of measure is not defined, use a SNOMED CT unit of measure. Examples of when a SNOMED CT unit of measure would typically be used are “tablet”, “capsule” or “ampule”.

Table View

Immunization.id[0]UKCore-Immunization-Sn-UnitsOfMeasure-Example
Immunization.meta[0].profile[0]https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization
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.occurrenceDateTime[0]2021-07-20
Immunization.doseQuantity[0].value[0]0.5
Immunization.doseQuantity[0].unit[0]milliliter
Immunization.doseQuantity[0].system[0]http://unitsofmeasure.org
Immunization.doseQuantity[0].code[0]ml

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-UnitsOfMeasure-Example" />
    <meta>
        <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization" />
    </meta>
    <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>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <doseQuantity>
        <value value="0.5" />
        <unit value="milliliter" />
        <system value="http://unitsofmeasure.org" />
        <code value="ml" />
    </doseQuantity>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-UnitsOfMeasure-Example",
    "meta": {
        "profile":  [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
        ]
    },
    "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"
    },
    "occurrenceDateTime": "2021-07-20",
    "doseQuantity": {
        "value": 0.5,
        "unit": "milliliter",
        "system": "http://unitsofmeasure.org",
        "code": "ml"
    }
}
back to top