StructureDefinition Extension-UKCore-VaccinationProcedure

Canonical_URLDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure

This describes the immunization procedure code.

This extension extends the Immunization resource to support the exchange of an immunization procedure code.

Context of Use Immunization

Tree View

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept

Table View

Extension..1
Extension.url..
Extension.value[x]CodeableConcept1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-VaccinationProcedure" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" />
    <version value="2.2.0" />
    <name value="ExtensionUKCoreVaccinationProcedure" />
    <title value="Extension UK Core Vaccination Procedure" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This describes the immunization procedure code." />
    <purpose value="This extension extends the Immunization resource to support the exchange of an immunization procedure code." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Immunization" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="An extension to hold an immunization procedure code" />
            <definition value="An extension to hold an immunization procedure code." />
            <max value="1" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure" />
            <definition value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-VaccinationProcedure",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
    "version": "2.2.0",
    "name": "ExtensionUKCoreVaccinationProcedure",
    "title": "Extension UK Core Vaccination Procedure",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This describes the immunization procedure code.",
    "purpose": "This extension extends the Immunization resource to support the exchange of an immunization procedure code.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Immunization"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "An extension to hold an immunization procedure code",
                "definition": "An extension to hold an immunization procedure code.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure",
                "definition": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure"
                }
            }
        ]
    }
}

Examples

Vaccination Procedure- An example to illustrate the extension for a vaccination procedure.
Example UKCore-Immunization-Extension-VaccinationProcedure

Covid Vaccination Procedure
- An example to illustrate the extension for a vaccination procedure for COVID.
Example UKCore-Immunization-Extension-VaccinationProcedureCovid

Guidance


back to top