Back To Index  <<  Back To Templates

retired Template  eHDSI Immunization Product

Id 1.3.6.1.4.1.12559.11.10.1.3.1.3.18 Effective Date 2020‑09‑03 13:33:05
Other versions this id:
Status retired Retired Version Label
Name eHDSIImmunizationProduct Display Name eHDSI Immunization Product
Description

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 eHDSIVaccine value set (OID 1.3.6.1.4.1.12559.11.10.1.3.1.42.28). The code system can be SNOMED CT (codeSystem OID 2.16.840.1.113883.6.96) or WHO ATC (codeSystem OID 2.16.840.1.113883.6.73).

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 0 templates, Uses 1 template
Uses as Name Version
2.16.840.1.113883.3.1937.777.11.10.145 Include active eHDSI Immunization Material DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.20.1.53 (DYNAMIC)
ref
?

Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.7.2 eHDSI Immunization Product (DYNAMIC)
Example
Example
<manufacturedProduct>
  <templateId root="1.3.6.1.4.1.12559.11.10.1.3.1.3.18"/>  <templateId root="2.16.840.1.113883.10.20.1.53"/>  <manufacturedMaterial>
    <code code="" displayName="" codeSystem="" codeSystemName="">
      <originalText>
        <reference value=""/>      </originalText>
    </code>
    <name/>  </manufacturedMaterial>
</manufacturedProduct>
Item DT Card Conf Description Label
hl7:manufacturedProduct
0 … 1 R (eHDdotsuct)
@classCode
cs 0 … 1 F MANU
hl7:templateId
II.EPSOS 1 … 1 R eHDSI Immunization Product (eHDdotsuct)
@root
uid 1 … 1 F 1.3.6.1.4.1.12559.11.10.1.3.1.3.18
hl7:templateId
II.EPSOS 0 … 1 R IHE Product Entry (IHE PCC) (eHDdotsuct)
@root
uid 1 … 1 F 1.3.6.1.4.1.19376.1.5.3.1.4.7.2
hl7:templateId
II.EPSOS 1 … 1 R Product (CCD) (eHDdotsuct)
@root
uid 1 … 1 F 2.16.840.1.113883.10.20.1.53
Included 1 … 1 from 2.16.840.1.113883.3.1937.777.11.10.145 eHDSI Immunization Material (DYNAMIC)
hl7:manufacturedMaterial
1 … 1 R (eHDdotsuct)
@classCode
cs 0 … 1 F MMAT
@determinerCode
cs 0 … 1 F KIND
hl7:code
CE 1 … 1 R (eHDdotsuct)
 
target
ehdsi-dataelement-68 draft Vaccination code 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.28 eHDSIVaccine (DYNAMIC)
hl7:originalText
ED 1 … 1 R (eHDdotsuct)
hl7:name
EN 1 … 1 R (eHDdotsuct)
hl7:lotNumberText
ST 0 … 1

A distinctive combination of numbers and/or letters which specifically identifies a batch. 

(eHDdotsuct)
 
target
ehdsi-dataelement-63 draft Batch/lot number draft eHDSI Data Set
hl7:manufacturerOrganization
0 … 1 Companies or other legal entities, including non profit-making organisations, who are granted the marketing authorization of an immunization product and are responsible for it throughout its lifetime. (eHDdotsuct)
@classCode
cs 0 … 1 F ORG
@determinerCode
cs 0 … 1 F INSTANCE
  Example <manufacturerOrganization classCode="ORG" determinerCode="INSTANCE">
  <id root="2.99" extension="XYZ"/>  <name>Pfizer</name></manufacturerOrganization>
  Schematron assert role red error  
  test @nullFlavor or hl7:id or hl7:name  
  Message If the MarketingAuthorizationHolder or manufacturer Organization element is specified and doesn't have a nullFlavor value, an id or name element has to present.  
hl7:id
II.EPSOS 0 … * R (eHDdotsuct)
  Example <id root="2.99" extension="XYZ"/>
hl7:name
ON 0 … 1 R (eHDdotsuct)
  Example <name>Pfizer</name>