Back To Index  <<  Back To Templates

ref Template  Immunization Product

Id Effective Date valid from 2013‑12‑20
Status draft Draft Version Label
Name EntryImmunizationProduct Display Name Immunization Product

The product entry describes an immunization used in a <substanceAdministration> act. It adopts the constraints of the ASTM/HL7 Continuity of Care Document.

In a CDA document, the name and strength of the immunization administered are specified in the elements under the <manufacturedMaterial> element. The templateId elements are required and identify this as a product entry.

The <code> element of the <manufacturedMaterial> describes the vaccine. The values for the code attribute come from the epSOSVaccine value set (OID The code system is SNOMED CT (codeSystem OID 2.16.840.1.113883.6.96).The <originalText> shall contain a <reference> whose URI value points to the generic name and strength of the medication, or just the generic name alone if strength is not relevant.Note: When the text is supplied from the narrative, the implication is that if you supply the components of a combination vaccine in an entry, you must also display these in the narrative text, otherwise you would not be able to break the combination vaccine down into its component parts. This is entirely consistent with the CDA Release 2.0 requirements that the narrative supply the necessary and relevant human readable information content.

The <name> element should contain the name of the vaccine (or active ingredient in the case of subordinate <substanceAdministration> elements used to record components of a vaccine). Note that the brand name should be represented as a translation of the code element.

Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 5 templates, Uses 1 template
Used by as Name Version Containment draft Immunizations 2013‑12‑20 link 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
2.16.840.1.113883.3.1937.777.11.10.145 Include draft Immunization Material DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.12.312 (2005‑09‑07)
  <templateId root=""/>  <templateId root="2.16.840.1.113883."/>  <manufacturedMaterial>
    <code code="" displayName="" codeSystem="" codeSystemName="">
        <reference value=""/>      </originalText>
    <name/>  </manufacturedMaterial>
notice There is an open issue with this item:
Item DT Card Conf Description Label
0 … 1 R (Entdotsuct)
cs 0 … 1 F MANU
II.EPSOS 1 … 1 R (Entdotsuct)
uid 1 … 1 F
II.EPSOS 1 … 1 R (Entdotsuct)
uid 1 … 1 F 2.16.840.1.113883.
Included 1 … 1 from 2.16.840.1.113883.3.1937.777.11.10.145 Immunization Material (DYNAMIC)
1 … 1 R (Entdotsuct)
cs 0 … 1 F MMAT
cs 0 … 1 F KIND
CE 1 … 1 R (Entdotsuct)
target epsos-dataelement-170 Vaccine code epSOS Data Set
The value of @code shall be drawn from value set epSOSVaccine (DYNAMIC)
ED 1 … 1 R (Entdotsuct)
EN 1 … 1 R (Entdotsuct)
target epsos-dataelement-168 Vaccine brand name epSOS Data Set