Back To Index  <<  Back To Templates

ref Template  UV Medication Information (detail)

Id 2.16.840.1.113883.10.21.4.11 Effective Date valid from 2017‑05‑10
Status draft Draft Version Label
Name UVMedicationInformationdetail Display Name UV Medication Information (detail)
Context Parent nodes of template element with id 2.16.840.1.113883.10.21.4.11
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.21.4.1 Containment draft UV Medication Order 2015‑10‑07
Relationship Specialization: template 2.16.840.1.113883.10.12.312 (2005‑09‑07)
Adaptation: template 1.3.6.1.4.1.19376.1.9.1.3.1 (DYNAMIC)
Item DT Card Conf Description Label
hl7:manufacturedMaterial
 (UVM…ail)
@classCode
 0 … 1 F MMAT
@determinerCode
 0 … 1 F KIND
hl7:templateId
 II 1 … 1 M (UVM…ail)
@root
 uid 1 … 1 F 2.16.840.1.113883.10.21.4.11
hl7:code
 CE 1 … 1 R The code element element SHALL be present and describes the code of the medication. The medication may be either
  • a brand/product or
  • described as a generic/scientific name or
  • a descriptor of a magistral preparation/compound medicine
The originalText shall contain a reference whose URI value points to the name and strength of the medication, or just the name alone if strength is not relevant. If the medicine is uncoded (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used. 		(UVM…ail)
hl7:originalText
 ED 0 … 1 (UVM…ail)
hl7:reference
 TEL 1 … 1 R (UVM…ail)
@nullFlavor
 cs 0 … 1 F NA
hl7:name
 EN 1 … 1 R The element SHALL contain the name of the medication (e.g.,“Adol 500mg Caplet”).The medication may be either
  • a brand/product or
  • described as a generic/scientific name or
  • a descriptor of a magistral preparation/compound medicine
If the medicine has no brand name (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used. 		(UVM…ail)
@nullFlavor
 cs 0 … 1 F NA
pharm:formCode
 CE 0 … * This code represents the pharmaceutical dose form (e.g., tablet, capsule, liquid) and SHOULD be present, if not implied by the product. It MAY be present if implied by the product. The value of this code affects the units used in the substance administration quantity element. (UVM…ail)
hl7:lotNumberText
 ST 0 … 1 The lotNumberText element MAY be present and is a string representation of a lot number of this specific instance of the product. The provided lot number SHALL refer to the primary packaged item described in the Packaging 605 element. (UVM…ail)
pharm:expirationTime
 TS 0 … * The pharm:expirationTime element MAY be present and SHALL contain a value attribute containing the date (e.g., specific date, specific date including time) of expiration of this specific 610 instance of the product. The value given in the pharm:expirationTime element SHALL refer to the primary packaged item described in the Medicine Packaging element. (UVM…ail)
@value
 1 … 1 R
pharm:asContent
 0 … * This structure describes the packaging of the medication and MAY be present. It represents the primary description of the packaging of the medicine (e.g., the medicine is packaged in ampoules of 50ml volume each) and may include additional packaging information of how many of the primary packaged items are within an outer package (e.g., 5 ampoules are packaged in a box).

The primary description of the package SHOULD be consistent with the given pharmaceutical dose form (pharm:formCode of the medication, see chapter “Medication Form Code”). Example: a consistent pharmaceutical dose form to the package form “Ampoules” would be e.g., “Solution for injection”.

In case the package describes a product, the pharm:code element provides the code for the product and SHOULD be present.

In case the package describes a product, and the package has a brand name, it SHOULD be described in the pharm:name element (e.g., Xylocaine 1% with Adrenaline Inj, 5 injections package).

The pharm:formCode element represents the form of the package (e.g., tablet container, bottle, ...) and SHOULD be present, if not implied by the product. It MAY be present if implied by the product. It SHALL be present if the asSuperContent element is present.

The pharm:capacityQuantity element SHALL be present and describes the capacity of the packaging.

If the capacityQuantity is given in countable units, the unit attribute SHALL NOT be present. If the capacityQuantity is given in non-countable units, the unit attribute SHALL be present and the value SHALL be out of the UCUM code system.

A pharm:asSuperContent element MAY be present to represent the quantity of the given primary packaged item (e.g., ampoule of 50ml) within an outer package (e.g., 5 ampoules in a box). It SHALL contain a pharm:containerPackagedMedicine element which SHALL contain a pharm:capacityQuantity element describing the quantity of the given primary packaged item present in the outer package. If the capacityQuantity is given in countable units, the unit attribute SHALL NOT be present. If the capacityQuantity is given in non-countable units, the unit attribute SHALL be present and the value SHALL be out of the UCUM code system. 		(UVM…ail)
@classCode
 1 … 1 F CONT
  Example
General example
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
    <!-- Medicinal product code (package-level) -->
    <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <!-- Brand name (package) -->
    <pharm:name> . . . </pharm:name>    <pharm:formCode code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <pharm:capacityQuantity value=" " unit=" "/>    <pharm:asSuperContent>
      <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
        <pharm:capacityQuantity value=" " unit=" "/>      </pharm:containerPackagedMedicine>    </pharm:asSuperContent>  </pharm:containerPackagedMedicine></pharm:asContent>
  Example
Medicinal product with pharmaceutical dose form ”Tablets”, available as a “Tablet container” with 30 tablets
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
    <!-- .. -->
    <pharm:formCode code=" " displayName="Tablet container" codeSystem=" " codeSystemName=" "/>    <!-- 30 tablets in the package -->
    <pharm:capacityQuantity value="30"/>  </pharm:containerPackagedMedicine></pharm:asContent>
  Example
Medicinal product with pharmaceutical dose form 'Solution for injection', available as “Ampoules” with 50ml volume, packaged as 5 ampoules per box
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
    <!-- .. -->
    <pharm:formCode code=" " displayName="Ampoules" codeSystem=" " codeSystemName=" "/>    <pharm:capacityQuantity value="50" unit="ml"/>    <!-- 50ml per ampoule -->
    <pharm:asSuperContent>
      <pharm:containerPackagedMedicine classCode="CONT" determinerCode="INSTANCE">
        <!-- 5 ampoules in a box -->
        <pharm:capacityQuantity value="5"/>      </pharm:containerPackagedMedicine>    </pharm:asSuperContent>  </pharm:containerPackagedMedicine></pharm:asContent>
pharm:containerPackagedMedicine
 1 … * R (UVM…ail)
@classCode
 1 … 1 F CONT
@determinerCode
 1 … 1 F INSTANCE
pharm:code
 CE 0 … * (UVM…ail)
pharm:name
 EN 0 … * (UVM…ail)
pharm:formCode
 CE 0 … 1 (UVM…ail)
  Schematron assert role red error  
  test not(pharm:capacityQuantity) or pharm:formCode  
  Message pharm:formCode SHALL be present if pharm:asSuperContent present  
pharm:capacityQuantity
 PQ 1 … 1 M (UVM…ail)
@value
 1 … 1 R
@unit
 cs 0 … 1  
pharm:asSuperContent
 0 … * (UVM…ail)
pharm:containerPackagedMedicine
 1 … * R (UVM…ail)
@classCode
 1 … 1 F CONT
@determinerCode
 1 … 1 F INSTANCE
pharm:capacityQuantity
 PQ 1 … 1 M (UVM…ail)
@value
 1 … 1 R
@unit
 cs 0 … 1  
pharm:asSpecializedKind
 0 … * R (UVM…ail)
@classCode
 1 … 1 F GRIC
  Example <pharm:asSpecializedKind classCode="GRIC">
  <pharm:generalizedMedicineClass classCode="MMAT">
    <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>  </pharm:generalizedMedicineClass></pharm:asSpecializedKind>
pharm:generalizedMedicineClass
 0 … * (UVM…ail)
@classCode
 1 … 1 F MMAT
pharm:code
 1 … 1 R (UVM…ail)
pharm:name
 0 … * (UVM…ail)
pharm:ingredient
 0 … * (UVM…ail)
@classCode
 1 … 1 F ACTI
  Example <pharm:ingredient classCode="ACTI">
  <pharm:quantity>
    <numerator xsi:type="PQ" value=" " unit=" "/>    <denominator xsi:type="PQ" value=" " unit=" "/>  </pharm:quantity>  <pharm:ingredient classCode="MMAT" determinerCode="KIND">
    <pharm:code code=" " displayName=" " codeSystem="2.16.840.1.113883.6.73" codeSystemName="ATC WHO"/>  </pharm:ingredient></pharm:ingredient>
pharm:quantity
 0 … 1 (UVM…ail)
  Example
10 mg of the ingredient per ml
<pharm:quantity>
  <numerator xsi:type="PQ" value="10" unit="mg"/>  <denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
  Example
2% of the ingredient
<pharm:quantity>
  <numerator xsi:type="PQ" value="2" unit="%"/>  <denominator xsi:type="PQ" value="1"/></pharm:quantity>
  Example
5mg of the ingredient
<pharm:quantity>
  <numerator xsi:type="PQ" value="5" unit="mg"/>  <denominator xsi:type="PQ" value="1"/></pharm:quantity>
pharm:numerator
 0 … 1 (UVM…ail)
pharm:denominator
 0 … 1 (UVM…ail)
pharm:ingredient
 0 … * (UVM…ail)
@classCode
 1 … 1 F MMAT
@determinerCode
 1 … 1 F KIND
pharm:code
 0 … 1 (UVM…ail)
pharm:name
 1 … 1 R (UVM…ail)