Id1.3.182.11.10.3.1Effective Date2018‑02‑12 08:21:05
Statusdraft DraftVersion Label
NameImmunizationsentryDisplay NameeHDSI Immunizations Entry
ContextPathname /
ClassificationCDA Entry Level Template
Open/ClosedClosed (only defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 4 templates
Used by as NameVersion
1.3.182.11.10.2.1Containmentdraft eHDSI Immunizations Section2018‑02‑08 16:03:17
Uses as NameVersion
1.3.182.7.3.2.10.5Containmentdraft CDA AssignedEntity simple (1.0)DYNAMIC
1.3.182.11.1.13Containmentdraft CDA Organization (1.0)DYNAMIC
1.3.182.11.10.3.2Containmentdraft eHDSI Problem EntryDYNAMIC
1.3.182.11.10.3.3Containmentdraft eHDSI Comment EntryDYNAMIC
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
RAn 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.
Immudotsntry
@classCode
cs1 … 1FSBADM
@moodCode
cs1 … 1FEVN
@negationInd
bl1 … 1RIn the case the Immunization was not performed, negationInd shall be set to "true", otherwise, it shall be false.
Details/comments can be provided in the appropriate entryRelationship  with templateId  1.3.182.11.10.3.3 eHDSI Comment Entry. 
reasonNotGiven shall be present and contain a valid code if negationInd is set to "true"
1.3.182.11.10.3.3 eHDSI Comment Entry
hl7:templateId
II1 … 1MImmudotsntry
@root
uid1 … 1F1.3.182.11.10.3.1
hl7:id
II.EPSOS1 … 1MUnique identifier for the immunization event.Immudotsntry
hl7:code
CE1 … 1MImmudotsntry
@code
CONF1 … 1FIMMUNIZ
@codeSystem
1 … 1F1.3.5.1.4.1.19376.1.5.3.2
hl7:text
ED1 … 1MThe 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.
Immudotsntry
hl7:reference
TEL1 … 1MImmudotsntry
@value
st1 … 1RReference pointing to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1
hl7:statusCode
CS1 … 1MImmudotsntry
@code
CONF1 … 1Fcompleted
hl7:effectiveTime
TS.DATE1 … *RThe effectiveTime element shall be present and should contain a time value that indicates the date of the substance administration. If the exact date is not clear, fractions can be given like YYYYMM or YYYY only.

Causes validation error:
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. 
Immudotsntry
@nullFlavor
cs0 … 1FUNK
hl7:effectiveTime
TS.DATE0 … *This effectiveTime element shall be used to present end expiration date of the vaccine. This information together with the lotNumber and the id of the product should come from scanning the box of the vaccine.Immudotsntry
hl7:reasonNotGiven
CE0 … 1Coded Element to codify the reason why the vaccination has not been given. This is relevant only when negationInd = true. 
Details/comments can be provided in the appropriate entryRelationship  with templateId  1.3.182.11.10.3.3  eHDSI Comment Entry
Immudotsntry
hl7:routeCode
CE0 … 1RThe route via which the medication entered the body. This information is given with the Medication item/Vaccine product given. Immudotsntry
hl7:approachSiteCode
CE0 … 1Body site at which the immunization has been given
Immudotsntry
hl7:doseQuantity
IVL_PQ0 … 1RThe quantity of the dose information is given with the Medication item/Vaccine product. 
Immudotsntry
hl7:administrationUnitCode
CE0 … 1Immudotsntry
hl7:consumable
1 … 1RThe <consumable> element shall be present, and shall contain a <manufacturedElement> element, conforming to the Product Entry Content Module template.
Immudotsntry
@typeCode
cs1 … 1FCSM
hl7:manufacturedProduct
1 … 1RImmudotsntry
@classCode
cs0 … 1FMANU
hl7:id
II1 … 1RImmudotsntry
@root
oid1 … 1F1.3.182.4.17
hl7:manufacturedMaterial
1 … 1RImmudotsntry
@classCode
cs0 … 1FMMAT
@determinerCode
cs0 … 1FKIND
hl7:code
CE1 … 1RThe <code> element is used to support coding of the medication used for immunization. If coded, it must provide a code and codeSystem attribute using a controlled vocabulary for medications. The displayName for the code and codeSystemName should be provided as well for diagnostic and human readability purposes, but are not required. 
Immudotsntry
 CONF
The value of @code shall be drawn from value set 1.3.6.1.4.1.12559.11.10.1.3.1.42.28 epSOSVaccine (DYNAMIC)
or
The value of @code shall be drawn from value set 1.3.182.10.63.1 eSante_NullValueRepresentation (DYNAMIC)
hl7:originalText
ED0 … 1RIn a CDA document, the <originalText> shall contain a <reference> who’s URI value points to the generic name and strength of the medication (in narrative text section), or just the generic name alone if strength is not relevant.
Immudotsntry
hl7:name
EN1 … 1RShould contain the brand name of the medication / immunization.
Immudotsntry
hl7:lotNumberText
ST0 … 1Charge/Batchnumber of the VaccineImmudotsntry
hl7:expirationDate
TS0 … 1Expiration date of the VaccineImmudotsntry
hl7:manufacturerOrganization
0 … 1RContains 1.3.182.11.1.13 CDA Organization (DYNAMIC)Immudotsntry
hl7:performer
0 … 1RHealth professional who performed the activity of the immunization eventImmudotsntry
hl7:assignedEntity
1 … 1RContains 1.3.182.7.3.2.10.5 CDA AssignedEntity simple (DYNAMIC)Immudotsntry
hl7:entryRelationship
0 … *RAn 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.182.11.10.3.3 eHDSI Comment Entry (DYNAMIC)
Immudotsntry
hl7:entryRelationship
0 … *RThis 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 <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.182.11.10.3.2 eHDSI Problem Entry (DYNAMIC)
Immudotsntry
hl7:reference
0 … 1Immudotsntry
hl7:externalAct
1 … 1RThis externalAct is used to reference the Immunization protocol if exists. It is to explain to which series of Immunizations this Immunization belongs.

Immudotsntry
hl7:id
II1 … 1MImmudotsntry
hl7:code
CD1 … 1MImmudotsntry
@code
CONF1 … 1F59780-7
@codeSystem
1 … 1F2.16.840.1.113883.6.1
@displayName
1 … 1FImmunization series
hl7:entryRelationship
0 … 1Position of Immunization within the Immunization seriesImmudotsntry
hl7:observation
1 … 1RImmudotsntry
hl7:code
CD1 … 1MImmudotsntry
@code
CONF1 … 1F30973-2
@codeSystem
1 … 1F2.16.840.1.113883.6.1
hl7:statusCode
CD1 … 1RImmudotsntry
@code
CONF0 … 1Fcompleted
hl7:value
INT1 … 1RThe sequence number of this immunization within the immunization recordImmudotsntry