Back To Index  <<  Back To Templates

ref Template  Immunizations

Id Effective Date valid from 2013‑12‑20
Status draft Draft Version Label
Name EntryImmunizations Display Name Immunizations

An immunizations entry is used to record the patient's immunization history.

Context Parent nodes of template element with id
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Associated with
Associated with 2 concepts
Id Name Data Set
epsos-dataelement-169 Vaccination date epSOS Data Set
epsos-dataelement-171 Vaccine description epSOS Data Set
Used by / Uses
Used by 0 transactions and 4 templates, Uses 4 templates
Used by as Name Version Containment draft Section Immunizations 2013‑12‑20 link draft epSOS-Patient Summary 2013‑12‑20 link draft epSOS-Health Care Encounter Report 2013‑12‑20 link draft epSOS-Medication Related Overview 2013‑12‑20
Uses as Name Version Containment draft Immunization Product DYNAMIC
2.16.840.1.113883. Containment draft Position Of Vaccination DYNAMIC Containment draft Problem DYNAMIC Containment draft Comment DYNAMIC
<substanceAdministration typeCode="SBADM" moodCode="EVN" negationInd="true{{!}}false">
  <templateId root="2.16.840.1.113883."/>  <templateId root=""/>  <id root="" extension=""/>  <code code="IMMUNIZ" codeSystem="" codeSystemName="IHEActCode"/>  <text>
    <reference value="#xxx"/>  </text>
  <statusCode code="completed"/>  <effectiveTime value=""/>  <!-- The reasonCode would normally provide a reason why the immunization was
not performed. It isn't supported by CDA R2, and so comments will have to suffice.
<reasonCode code='' codeSystem='' codeSystemName='ActNoImmunizationReasonIndicator'/>
  <routeCode code="" codeSystem="" codeSystemName="RouteOfAdministration"/>  <doseQuantity value="" units=""/>  <consumable typeCode="CSM">
    <manufacturedProduct classCode="MANU">
      <manufacturedMaterial classCode="MMAT" determinerCode="KIND">
        <code code="" codeSystem="" codeSystemName="">
            <reference value="#yyy"/>          </originalText>
  <!-- An optional entry relationship that provides prescription activity -->
  <entryRelationship typeCode="REFR">
    <templateId root=""/>    <!-- ... -->
  <!-- An optional entry relationship that identifies the immunization series number -->
  <entryRelationship typeCode="SUBJ">
    <observation classCode="OBS" moodCode="EVN">
      <templateId root="2.16.840.1.113883."/>      <code code="30973-2" displayName="Dose Number" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>      <statusCode code="completed"/>      <value xsi:type="INT" value=""/>    </observation>
  <entryRelationship inversionInd="false" typeCode="CAUS">
    <observation classCode="OBS" moodCode="EVN">
      <templateId root="2.16.840.1.113883."/>      <templateId root=""/>      <templateId root="2.16.840.1.113883."/>      <id root="" extension=""/>    </observation>
  <!-- Optional <entryRelationship> element containing comments -->
notice There is an open issue with this item:
Item DT Card Conf Description Label

An immunization is a substance administration event. An immunization entry may be a record of why a specific immunization was not performed. In this case, negationInd shall be set to "true", otherwise, it shall be false.

cs 1 … 1 F SBADM
cs 1 … 1 F EVN
bl 1 … 1 R
II 1 … 1 M (Entdotsons)
uid 1 … 1 F
II 1 … 1 M (Entdotsons)
uid 1 … 1 F 2.16.840.1.113883.
II.EPSOS 1 … 1 M (Entdotsons)
CD.EPSOS 1 … 1 M

This required element records that the act was an immunization. The substance administration act must have a <code> element with code and codeSystem attributes present. If no coding system is used by the source, then simply record the code exactly as shown above. This <code> element shall not be used to record the type of vaccine used from a vocabulary of drug names.





The IMMUNIZ term from the IHE ActCode vocabulary.

1 … 1 F (IHEActCode)
ED 1 … 1 R

The URI given in the value attribute of the <reference> element points to an element in the narrative content that contains the complete text describing the immunization activity.

target epsos-dataelement-171 Vaccine description epSOS Data Set
TEL 1 … 1 M (Entdotsons)
1 … 1 R Reference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
CS 1 … 1 R

The statusCode shall be set to "completed" for all immunizations.

CONF 0 … 1 F completed
1 … 1 R

The effectiveTime element shall be present and should contain a time value that indicates the date of the substance administration. If the date is unknown, this shall be recorded using the nullFlavor attribute, with the reason that the information is unknown being specified. Otherwise, the date shall be recorded, and should have precision of at least the day.

target epsos-dataelement-169 Vaccination date epSOS Data Set
CE 0 … 1 R

See routeCode under the Medication Item Entry Content module.

IVL_PQ 0 … 1 R

See doseQuantity under the Medication Item Entry Content module.

1 … 1 R

The <consumable> element shall be present, and shall contain a <manufacturedElement> element, conforming to the Product Entry Content Module template.

Contains Immunization Product (DYNAMIC)
treeblank where [@typeCode='CSM'] [hl7:manufacturedProduct [hl7:templateId [@root=''] and hl7:templateId [@root='2.16.840.1.113883.']]]
cs 1 … 1 F CSM
0 … 1 R

This optional entry relationship may be present to indicate that position of this immunization in a series of immunizations. The <code> element shall be present and must be recorded with the code and codeSystem attributes shown above. This element indicates that the observation describes the dose number for the immunization. The <statusCode> element shall be present, and must be recorded exactly as shown above. This element indicates that the observation has been completed. The <value> element shall be present, and shall indicate the immunization series number in the value attribute.

Contains 2.16.840.1.113883. Position Of Vaccination (DYNAMIC)
treeblank where [hl7:observation [hl7:templateId [@root='2.16.840.1.113883.']]]
  Example <entryRelationship typeCode="SUBJ">
  <observation classCode="OBS" moodCode="EVN">
    <templateId root="2.16.840.1.113883."/>    <code code="30973-2" displayName="Dose Number" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>    <statusCode code="completed"/>    <value xsi:type="INT" value=" "/>  </observation>
0 … * R

This repeatable element should be used to identify adverse reactions caused by the immunization. The <observation> element provides a pointer to the adverse reaction caused by the immunization. The template IDs describe that it points to a conforming Problem Entry Content Module that also conform to the CCD Reaction template.

The <id> element is required, and gives the identifier of the adverse reaction. The adverse reaction pointed to by this element shall be described in more detail using the Allergies entry, elsewhere in the document where the Allergies and Intolerances section is found.

Contains Problem (DYNAMIC)
treeblank where [hl7:observation [hl7:templateId [@root=''] and hl7:templateId [@root='2.16.840.1.113883.']]]
  Example <entryRelationship inversionInd="false" typeCode="CAUS">
  <observation classCode="OBS" moodCode="EVN">
    <templateId root="2.16.840.1.113883."/>    <templateId root=""/>    <templateId root="2.16.840.1.113883."/>    <id root=" " extension=" "/>  </observation>
0 … * R

An immunization entry can have negationInd set to true to indicate that an immunization did not occur. In this case, it shall have at least one comment that provides an explanation for why the immunization did not take place. Other comments may also be present.

Contains Comment (DYNAMIC)
treeblank where [hl7:act [hl7:templateId [@root='2.16.840.1.113883.'] and hl7:templateId [@root='']]]