Jump to: navigation, search

2.16.840.1.113883.10.21.4.11/static-2017-05-10T000000

Id
2.16.840.1.113883.10.21.4.11
Effective Date2017‑05‑10
StatusKyellow.png DraftVersion Label
NameUVMedicationInformationdetailDisplay NameUV Medication Information (detail)
DescriptionUniversal Medication Information (detail)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.11
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 1 template
Uses as NameVersion
2.16.840.1.113883.10.12.151ContainmentKgreen.png CDA OrganizationDYNAMIC
Relationship
Specialization: template 2.16.840.1.113883.10.12.312 CDA ManufacturedProduct (2005‑09‑07)
ref
ad1bbr-
Adaptation: template 1.3.6.1.4.1.19376.1.9.1.3.1 IHE MedicineEntryContentModule (DYNAMIC)
ref
ch-pharm-
ItemDTCardConfDescriptionLabel
hl7:manufacturedProduct
(UVM...ail)
Treetree.png@classCode
cs1 … 1FMANU
Treetree.pnghl7:templateId
II1 … 1M(UVM...ail)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.11
Treetree.pnghl7:manufactured​Material
(UVM...ail)
Treeblank.pngTreetree.png@classCode
0 … 1FMMAT
Treeblank.pngTreetree.png@determiner​Code
0 … 1FKIND
Treeblank.pngTreetree.pnghl7:code
CE1 … 1RThe code 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
If the medicine has no code / is uncoded (e.g., magistral preparations, compound medicine, ...) nullFlavor="NA" SHALL be used.
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
Treeblank.pngTreeblank.pngTreetree.pnghl7:originalText
ED1 … 1RThe originalText shall contain a reference whose URI value points to the name and strength of the medication in the corresponding section.text, or just the name alone if strength is not relevant.(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pnghl7:reference
TEL1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pnghl7:translation
CE0 … *Product code(s) from any organizational or juristdictional system(UVM...ail)
 CONF
shall be drawn from concept domain "Product Code"
Treeblank.pngTreetree.pnghl7:name
EN0 … 1RThe element SHOULD 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
(UVM...ail)
Treeblank.pngTreetree.pngpharm:formCode
CE0 … 1This 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 may affect the units used in the substance administration quantity element.(UVM...ail)
Treeblank.pngTreetree.pnghl7:lotNumberText
ST0 … 1The 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 element.(UVM...ail)
Treeblank.pngTreetree.pngpharm:expirationTime
TS0 … 1The 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 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)
Treeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreetree.pngpharm: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 product (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:capacity​Quantity 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:container​Packaged​Medicine element which SHALL contain a pharm:capacity​Quantity 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)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
 Example
Packaged Medicinal Product with formCode
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedProduct classCode="CONT" determinerCode="INSTANCE">
    <!-- Packaged Medicinal Product -->
    <pharm:code codeSystem="1.999.999" code="PC_ID" displayName="Packaged Product Name"/>    <pharm:name>100 MIRACLE PILLS(TM)</pharm:name>    <pharm:formCode codeSystem="0.4.0.127.0.16.1.1.2.1" code="30009000" displayName="Box" CodeSystemName="EDQM"/>  </pharm:containerPackagedProduct>
</pharm:asContent>
 Example
General example
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedProduct 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:asContent>
      <pharm:containerPackagedProduct classCode="CONT" determinerCode="INSTANCE">
        <pharm:capacityQuantity value=" " unit=" "/>      </pharm:containerPackagedProduct>
    </pharm:asContent>
  </pharm:containerPackagedProduct>
</pharm:asContent>
 Example
Medicinal product with pharmaceutical dose form ”Tablets”, available as a “Tablet container” with 30 tablets
<pharm:asContent classCode="CONT">
  <pharm:containerPackagedProduct classCode="CONT" determinerCode="INSTANCE">
    <!-- .. -->
    <pharm:formCode code=" " displayName="Tablet container" codeSystem=" " codeSystemName=" "/>    <!-- 30 tablets in the package -->
    <pharm:capacityQuantity value="30"/>  </pharm:containerPackagedProduct>
</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:containerPackagedProduct classCode="CONT" determinerCode="INSTANCE">
    <!-- .. -->
    <pharm:formCode code=" " displayName="Ampoules" codeSystem=" " codeSystemName=" "/>    <pharm:capacityQuantity value="50" unit="ml"/>    <!-- 50ml per ampoule -->
    <pharm:asContent>
      <pharm:containerPackagedProduct classCode="CONT" determinerCode="INSTANCE">
        <!-- 5 ampoules in a box -->
        <pharm:capacityQuantity value="5"/>      </pharm:containerPackagedProduct>
    </pharm:asContent>
  </pharm:containerPackagedProduct>
</pharm:asContent>
 Example
Packaged Medicinal Product with multiple layers packaging
<pharm:asContent>
  <pharm:containerPackagedProduct>
    <!-- Inner Package -->
    <pharm:code codeSystem="..." code="..." displayName="..."/>    <pharm:asContent>
      <pharm:containerPackagedProduct>
        <!-- Intermediate Package -->
        <pharm:asContent>
          <pharm:containerPackagedProduct>
            <!-- Outer Package / Packaged Medicinal Product -->
          </pharm:containerPackagedProduct>
        </pharm:asContent>
      </pharm:containerPackagedProduct>
    </pharm:asContent>
  </pharm:containerPackagedProduct>
</pharm:asContent>
Treeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ1 … 1M(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *In case of multiple layers of packaging (5 vials 10 ml; box with 2 blisters of 20 tablets) this element can be used for describing the intermediate Packaged Medicinal Product Item or the Packaged Medicinal Product.

For example in the case 
  \--Box 
  \-----2 blisters 
  \--------20 tablets 
it describes the "2 blisters" 

In the case of 
  \--Box 
  \-----5 vials
it represents the Packaged Medicinal Product. 
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1RIt represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is the most inner  <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ1 … 1M(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *RIn case of multiple layers of packaging (5 vials 10 ml; box with 2 blisters of 20 tablets) this element can be used for describing the intermediate Packaged Medicinal Product Item or the Packaged Medicinal Product.

For example in the case 
  \--Box 
  \-----2 blisters 
  \--------20 tablets 
it describes the "2 blisters" 

In the case of 
  \--Box 
  \-----5 vials
it represents the Packaged Medicinal Product. 
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *RIt represents the intermediate Package Item or the Packaged Medicinal Product(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *RIn case of multiple layers of packaging (box with 2 blisters of 20 tablets) this element is used for describing the most outer Packaged Medicinal Product Item or the Packaged Medicinal Product.

For example in the case 
  \--Box 
  \-----2 blisters 
  \--------20 tablets 
it describes the Packaged Medicinal Product. 
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … *RWhen present, it represents the Packaged Medicinal Product(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FINSTANCE
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … *RWhen present, it can be used to represent the brand name.(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreetree.pngpharm:quantity
PQ0 … *(UVM...ail)
Treeblank.pngTreetree.pngpharm:asSpecializedKind
0 … *R(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FGRIC
 Example<pharm:asSpecializedKind classCode="GRIC">
  <pharm:generalizedMedicineClass classCode="MMAT">
    <pharm:code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>  </pharm:generalizedMedicineClass>
</pharm:asSpecializedKind>
Treeblank.pngTreeblank.pngTreetree.pngpharm:generalizedMedicineClass
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM...ail)
Treeblank.pngTreetree.pngpharm:ingredient
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FACTI
 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>
Treeblank.pngTreeblank.pngTreetree.pngpharm: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>
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:numerator
0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:denominator
0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:ingredientSubstance
0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
1 … 1R(UVM...ail)
Treetree.pnghl7:manufacturerOrganization
0 … 1RContains 2.16.840.1.113883.10.12.151 CDA Organization (DYNAMIC)(UVM...ail)