Id1.3.6.1.4.1.12559.11.10.1.3.1.3.19Effective Date2024‑01‑26 13:34:38
Statusactive ActiveVersion Label
NameeHDSIImmunizationDisplay NameeHDSI Immunization
Description

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

ContextParent nodes of template element with id 1.3.6.1.4.1.12559.11.10.1.3.1.3.19
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Associated with
Associated with 8 concepts
IdNameData Set
ehdsi-dataelement-69draft Vaccine/prophylaxis description draft eHDSI Data Set
ehdsi-dataelement-60draft Country of vaccination draft eHDSI Data Set
ehdsi-dataelement-65draft Vaccination date draft eHDSI Data Set
ehdsi-dataelement-61draft Health Professional identification draft eHDSI Data Set
ehdsi-dataelement-64draft Number in a series of vaccinations/doses draft eHDSI Data Set
ehdsi-dataelement-62draft Administering centre draft eHDSI Data Set
ehdsi-dataelement-70draft Disease or agent targeted code draft eHDSI Data Set
ehdsi-dataelement-71draft Disease or agent targeted description draft eHDSI Data Set
Used by / Uses
Used by 0 transactions and 1 template, Uses 5 templates
Used by as NameVersion
1.3.6.1.4.1.12559.11.10.1.3.1.2.15Containmentactive eHDSI Immunizations2020‑09‑02 14:55:50
Uses as NameVersion
1.3.6.1.4.1.12559.11.10.1.3.1.3.11Containmentactive eHDSI CommentDYNAMIC
1.3.6.1.4.1.12559.11.10.1.3.1.3.18Containmentactive eHDSI Immunization ProductDYNAMIC
1.3.6.1.4.1.12559.11.10.1.3.1.3.28Containmentactive eHDSI Position Of VaccinationDYNAMIC
1.3.6.1.4.1.12559.11.10.1.3.1.3.44Containmentactive eHDSI Reaction ManifestationDYNAMIC
2.16.840.1.113883.3.1937.777.11.10.150Containmentactive CDA Performer (Body)DYNAMIC
Example
Example
<substanceAdministration typeCode="SBADM" moodCode="EVN" negationInd="true{{!}}false">
  <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.19"/>  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.12"/>  <templateId root="2.16.840.1.113883.10.20.1.24"/>  <id root="" extension=""/>  <code code="IMMUNIZ" codeSystem="1.3.5.1.4.1.19376.1.5.3.2" codeSystemName="IHEActCode"/>  <text>
    <reference value="#xxx"/>  </text>  <statusCode>
    <vocabulary code="completed"/>  </statusCode>  <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="">
          <originalText>
            <reference value="#yyy"/>          </originalText>        </code>      </manufacturedMaterial>    </manufacturedProduct>  </consumable>  <!-- An optional entry relationship that provides prescription activity -->
  <entryRelationship typeCode="REFR">
    <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.7.3"/>    <!-- ... -->
  </entryRelationship>  <!-- 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.10.20.1.46"/>      <code code="30973-2" displayName="Dose Number" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>      <statusCode code="completed"/>      <value type="INT" value=""/>    </observation>  </entryRelationship>  <entryRelationship inversionInd="false" typeCode="CAUS">
    <observation classCode="OBS" moodCode="EVN">
      <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.7"/>      <id root="" extension=""/>    </observation>  </entryRelationship>  <!-- Optional <entryRelationship> element containing comments -->
</substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
R

An immunization is a substance administration event.

eHDSdotstion
@classCode
cs1 … 1FSBADM
@moodCode
cs1 … 1FEVN
hl7:templateId
II1 … 1MeHDSI ImmunizationseHDSdotstion
@root
uid1 … 1F1.3.6.1.4.1.12559.11.10.1.3.1.3.19
hl7:templateId
II1 … 1MIHE Immunizations Entry (IHE PCC)eHDSdotstion
@root
uid1 … 1F1.3.6.1.4.1.19376.1.5.3.1.4.12
hl7:templateId
II1 … 1MMedication activity (CCD)eHDSdotstion
@root
uid1 … 1F2.16.840.1.113883.10.20.1.24
hl7:id
II.EPSOS1 … 1MeHDSdotstion
hl7:code
CD.EPSOS1 … 1M

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.

codeSystem

codeSystemName

Description

1.3.5.1.4.1.19376.1.5.3.2

IHEActCode

The IMMUNIZ term from the IHE ActCode vocabulary.

eHDSdotstion
@code
CONF1 … 1FIMMUNIZ
@codeSystem
1 … 1F1.3.5.1.4.1.19376.1.5.3.2
hl7:text
ED1 … 1R

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.

eHDSdotstion
 
target
ehdsi-dataelement-69draft Vaccine/prophylaxis description draft eHDSI Data Set
hl7:reference
TEL1 … 1MeHDSdotstion
@value
1 … 1RReference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
hl7:statusCode
CS1 … 1R

The statusCode shall be set to "completed" for all administered immunizations. If the immunization is not administered, the statusCode has to be set to "cancelled".

eHDSdotstion
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.4.642.3.295 ImmunizationStatusCodes (DYNAMIC)
hl7:effectiveTime
1 … 1R

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.

eHDSdotstion
 
target
ehdsi-dataelement-65draft Vaccination date draft eHDSI Data Set
hl7:routeCode
CE0 … 1R

See routeCode under the Medication Item Entry Content module.

eHDSdotstion
hl7:doseQuantity
IVL_PQ0 … 1R

See doseQuantity under the Medication Item Entry Content module.

eHDSdotstion
hl7:consumable
1 … 1R

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


Contains 1.3.6.1.4.1.12559.11.10.1.3.1.3.18 eHDSI Immunization Product (DYNAMIC)		eHDSdotstion
@typeCode
cs1 … 1FCSM
hl7:performer
0 … *RWhen present, this element represents the Health Professional and centre that provided the immunization.

Contains 2.16.840.1.113883.3.1937.777.11.10.150 CDA Performer (Body) (DYNAMIC)		eHDSdotstion
 
target
ehdsi-dataelement-60draft Country of vaccination draft eHDSI Data Set
ehdsi-dataelement-61draft Health Professional identification draft eHDSI Data Set
ehdsi-dataelement-62draft Administering centre draft eHDSI Data Set
hl7:participant
0 … *Disease or agent that the vaccination provides protection against.
eHDSdotstion
@typeCode
cs1 … 1FIND
hl7:participantRole
1 … 1ReHDSdotstion
@classCode
cs1 … 1FAGNT
hl7:code
CD.EPSOS1 … 1RCode for the illness or disease that the vaccination provides protection against.
eHDSdotstion
 
target
ehdsi-dataelement-70draft Disease or agent targeted code draft eHDSI Data Set
ehdsi-dataelement-71draft Disease or agent targeted description draft eHDSI Data Set
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.5 eHDSIIllnessandDisorder (DYNAMIC)
hl7:playingEntity
1 … 1ReHDSdotstion
@classCode
cs1 … 1FENT
hl7:entryRelationship
0 … 1R

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 1.3.6.1.4.1.12559.11.10.1.3.1.3.28 eHDSI Position Of Vaccination (DYNAMIC)		eHDSdotstion
 
target
ehdsi-dataelement-64draft Number in a series of vaccinations/doses draft eHDSI Data Set
 Example<entryRelationship typeCode="SUBJ">
  <observation classCode="OBS" moodCode="EVN">
    <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.28"/>    <code code="30973-2" displayName="Dose Number" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC"/>    <statusCode code="completed"/>    <value type="INT" value=" "/>  </observation></entryRelationship>
hl7:entryRelationship
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 1.3.6.1.4.1.12559.11.10.1.3.1.3.44 eHDSI Reaction Manifestation (DYNAMIC)		eHDSdotstion
 Example<entryRelationship inversionInd="false" typeCode="CAUS">
  <observation classCode="OBS" moodCode="EVN">
    <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.44"/>    <id root=" " extension=" "/>  </observation></entryRelationship>
hl7:entryRelationship
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 1.3.6.1.4.1.12559.11.10.1.3.1.3.11 eHDSI Comment (DYNAMIC)		eHDSdotstion