HL7 FHIR logo

UK Core Implementation Guide STU3 Sequence - Sprint 6 Review

protocolApplied

The protocol (set of recommendations) being followed by the provider who administered the dose.

protocolApplied.targetDisease

It is recommended for international/EU interoperability that Immunization.protocolApplied.targetDisease is populated. The SNOMED CT concept should be from EU COVID-19 Diseases or Vaccine Target Diseases (GPS) - IPS

Disease UK SNOMED self
COVID-19 840539006
Others See "Vaccine Target Diseases (GPS) - IPS"

protocolApplied.doseNumberPositiveInt

Nominal position in a series of vaccines, N.B. This field will not always be reliable, therefore for Covid vaccinations, the vaccination procedure code or situation code should be used as that includes the dose number.

Example of Immunization.protocolApplied usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-ProtocolApplied-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.occurrenceDateTime[0]2021-07-20
Immunization.protocolApplied[0].targetDisease[0].coding[0].system[0]http://snomed.info/sct
Immunization.protocolApplied[0].targetDisease[0].coding[0].code[0]840539006
Immunization.protocolApplied[0].targetDisease[0].coding[0].display[0]COVID-19
Immunization.protocolApplied[0].doseNumberPositiveInt[0]1

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-ProtocolApplied-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>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <protocolApplied>
        <targetDisease>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="840539006" />
                <display value="COVID-19" />
            </coding>
        </targetDisease>
        <doseNumberPositiveInt value="1" />
    </protocolApplied>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-ProtocolApplied-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"
    },
    "occurrenceDateTime": "2021-07-20",
    "protocolApplied":  [
        {
            "targetDisease":  [
                {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "840539006",
                            "display": "COVID-19"
                        }
                    ]
                }
            ],
            "doseNumberPositiveInt": 1
        }
    ]
}
back to top