Difference between revisions of "PHARM Templates Implementationguide"

From HL7 IPS
Jump to: navigation, search
(→‎Templates)
 
(225 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<div class="online-document-information">
 +
<div class="col-md-12">
 +
<div class="panel panel-warning-white-border">
 +
<div class="panel-heading"> <span class="panel-title"><i class="fa fa-cogs"></i> Continuous Build </span> </div>
 +
<div class="panel-body"> <p class="bs">
 +
This is the '''Continuous Build''' of the HL7 CDA® R2 Implementation Guide '''Pharmacy Templates''' (will be incorrect/inconsistent at times).<p/>
 +
See the [https://www.hl7.org/implement/standards/product_brief.cfm?product_id=514 Directory of the published standard].
 +
</div></div></div></div></div>
 
{{Infobox_Document
 
{{Infobox_Document
−
|Title    = HL7 CDA® R2 Implementation Guide: Pharmacy Templates, Release 1
+
|Title    = <center>HL7 CDA® R2 Implementation Guide:<br/>Pharmacy Templates<br/><div style="font-size:60%">Edition 1 (Universal Realm)<br/>Standard for Trial use<br/>1.2.0<br/>April 2023</div></center>
 
|Short    = Pharmacy Templates
 
|Short    = Pharmacy Templates
−
|Namespace = cdapharm  
+
|Namespace = cdapharm
−
|Type      = Implementation Guide
+
|Type      =  
−
|Version  = 0.90
+
|Version  = 1.2.0
−
|Submitted = HL7 International
+
|Sponsored = Pharmacy Workgroup
−
|Date      = July 22, 2017
+
|Date      = April 1, 2023
 
|Status    = Draft
 
|Status    = Draft
−
|Period    = Draft
+
|Period    = STUPUB
 
|OID      = n.n.
 
|OID      = n.n.
 
|Realm    = Universal
 
|Realm    = Universal
 
|Custodian = HL7
 
|Custodian = HL7
−
|Copyrighttext = © 2016-2017 Health Level Seven International ® ALL RIGHTS RESERVED.<br/>The reproduction of this material in any form is strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are register
+
|Copyrighttext = Copyright © 2023 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. Pat & TM Off.<br/>Use of this material is governed by HL7's IP Compliance Policy.
−
}}
+
|Topright = CDAR2_IG_PHARM_TEMPLATES_E1_STU2_2023APR
−
 
+
}}
 +
 
{{:HL7_Important_Note}}
 
{{:HL7_Important_Note}}
  
Line 22: Line 31:
 
__TOC__
 
__TOC__
 
=Introduction=
 
=Introduction=
−
This Implementation Guide provides templates for ''Medication Order'' and ''Medication Statement'' that can be used by HL7 standards developers and external projects to develop models for pharmacy related content. The implementation guide is intended to provide consistency of pharmacy related models across all uses regardless of the method of transport by:
+
This Implementation Guide provides CDA R2 templates for ''Medication Order'' and ''Medication Statement'', '' Medication Dispense'' and ''Medication Administration'' that can be used by HL7 standards developers and external projects to develop models for pharmacy related content. The implementation guide is intended to provide consistency of pharmacy related models across all uses regardless of the method of transport by '''creating a library of Universal (UV) Pharmacy Templates that can be used by other Work Groups to derive constrained versions'''.
−
*creating a library of Universal pharmacy templates that can be used by other Work Groups to derive constrained versions.
+
−
 
 
 
==Purpose==
 
==Purpose==
  
 
===Background===
 
===Background===
−
Historically multiple HL7 Work Groups have developed specifications for pharmacy related content and as a result, there is inconsistency in the models that exist in HL7 V2, V3, CDA and FHIR. The Pharmacy Work Group often receives questions as to how to model pharmacy related content but in some cases, the use case cannot be met with the existing models.
+
Historically multiple HL7 Work Groups have developed specifications for pharmacy related content and as a result, there is inconsistency in how medication related content is represented in HL7 V2, V3, CDA and FHIR.
 +
The Pharmacy Work Group often receives questions as to how to model pharmacy related content but in some cases, the use case cannot be met with the existing models.
  
−
This Implementation Guide provides a library of pharmacy templates that can be used by HL7 Work Groups or external projects to derive constrained versions of models for pharmacy related content.
+
This Implementation Guide provides a CDA R2 library of pharmacy templates that can be used by HL7 Work Groups or external projects to derive constrained versions of models for pharmacy related content.
  
 
==Scope==
 
==Scope==
−
The scope of the Implementation Guide is limited to ''Medication Order'' and ''Medication Statement''. The content was developed by aligning and harmonizing the existing specifications for Consolidated CDA (C-CDA Release 2.1).
+
This Pharmacy Templates Implementation Guide defines common pharmacy artifacts (order, dispense, administration and statement) in CDA R2 format. The scope of the Implementation Guide is limited to ''Medication Order'' and ''Medication Statement'', '' Medication Dispense'' and ''Medication Administration''. The content was developed by aligning and harmonizing the existing specifications for Consolidated CDA (C-CDA Release 2.1<ref name="ccda21">http://www.hl7.org/implement/standards/product_brief.cfm?product_id=379</ref>).
−
 
+
<!--
−
Future releases of the Implementation Guide will include ''Medication Dispense'' and ''Medication Administration''.
+
<div style="background-color: #d9edf7; color: #31708f; padding: 10px;">
−
 
+
<b>Ballot Scope</b>
 +
<br/>
 +
The scope of this ballot is limited to the new content for Medication Dispense and Medication Administration Templates. Feedback not related to these templates will be found "not related" and should be made via the STU change request process.
 +
</div>
 +
-->
 
==Ballot Status of the Document==
 
==Ballot Status of the Document==
−
The Implementation Guide is being balloted as Informative with the intention to go to Standard for Trial Use (STU) and then to Normative.
+
The Implementation Guide was balloted as Standard for Trial Use (STU) and then goes to Normative.
  
 
==Audience==
 
==Audience==
Line 56: Line 69:
 
*HL7 Version 3 Pharmacy Models
 
*HL7 Version 3 Pharmacy Models
 
*HL7 FHIR® Pharmacy Resources
 
*HL7 FHIR® Pharmacy Resources
 +
*International Patient Summary (IPS), where all pharmacy related templates are specialisations of the corresponding templates defined in this guide
  
 
=Principles and background=
 
=Principles and background=
−
{{AlertBox|Nothing in here yet. Do we want to report about
+
The Pharmacy Work Group has a set of rich set of existing models that were used as the basis for the implementation guide including HL7 V3 models and FHIR resources. 
−
*the new method to represent normal, split and tapered dose information in CDA Substance Administrations?
+
 
−
*do we want to tell people that we reduced the richness of the original Pharmacy V3 templates drastically to ease implementation?
+
This implementation guide was created by the Pharmacy Work Group using the following approach:
−
*do we want to mention FHIR profile work that influenced heavily the development of the CDA templates?
+
*Review of Consolidated CDA (C-CDA<ref name="ccda21"></ref>) to identify templates that include pharmacy related content
−
*And/or more general other design principles?}}
+
*Compare C-CDA templates to existing Pharmacy HL7 V3 models and Pharmacy FHIR resources to identify differences and gaps
 +
*Create universal templates to that can be constrained for use for new templates.
 +
 
 +
For the Medication Model reflected in template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail), the Common Message Element Type CMET R_Medication Universal” (COCT_MT230100UV02), Release 2 (as published in HL7 V3 2017, V2.0.2 Dec 2010, derived from Common Product Model) was used to construct the CDA extension elements (see also "Extensions" used in this guide in the appendix).
 +
 
 +
The template rules are formalized using the computable format defined by the HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1<ref name="teits">HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1 http://www.hl7.org/implement/standards/product_brief.cfm?product_id=377</ref> in order to facilitate also the automatic generation of consistent testing and validation capabilities.
  
 
= Technical Background =
 
= Technical Background =
Line 70: Line 89:
 
This specification specifies CDA '''Entry Level Templates''' only. They can be re-used in any appropriate context, such as an Entry of a ''medication'' section.  
 
This specification specifies CDA '''Entry Level Templates''' only. They can be re-used in any appropriate context, such as an Entry of a ''medication'' section.  
  
−
Two "root" Entry Templates are provided as entry points for the two described use cases:
+
Two "root" Entry Templates are provided as entry points for the four described use cases:
 
*UV Medication Order (2.16.840.1.113883.10.21.4.1)
 
*UV Medication Order (2.16.840.1.113883.10.21.4.1)
 
*UV Medication Statement (2.16.840.1.113883.10.21.4.7)
 
*UV Medication Statement (2.16.840.1.113883.10.21.4.7)
 +
*UV Medication Administration (2.16.840.1.113883.10.21.4.13)
 +
*UV Medication Dispense (2.16.840.1.113883.10.21.4.15)
 
These templates use other Entry Level Templates that are all listed in a subsequent section of this document.
 
These templates use other Entry Level Templates that are all listed in a subsequent section of this document.
  
−
This specification uses the following OIDs for the artefacts that are registered at the HL7 OID registry.  
+
This specification uses the following OIDs for the artifacts that are registered at the HL7 OID registry.  
 
*The root OID for templates is 2.16.840.1.113883.10.21
 
*The root OID for templates is 2.16.840.1.113883.10.21
 
**Entry Level templates are summarized under 2.16.840.1.113883.10.21'''.4''', e.g. 2.16.840.1.113883.10.21.4.5 ''UV Substitution Permission''
 
**Entry Level templates are summarized under 2.16.840.1.113883.10.21'''.4''', e.g. 2.16.840.1.113883.10.21.4.5 ''UV Substitution Permission''
 
**“other” assistance templates are summarized under 2.16.840.1.113883.10.21'''.9''', e.g. 2.16.840.1.113883.10.22.9.1 ''UV Use Period''
 
**“other” assistance templates are summarized under 2.16.840.1.113883.10.21'''.9''', e.g. 2.16.840.1.113883.10.22.9.1 ''UV Use Period''
 
* The root OID for Value Sets is 2.16.840.1.113883.11
 
* The root OID for Value Sets is 2.16.840.1.113883.11
−
The sub branches for templates follow the recommendations of HL7 International and ISO 13582<ref>ISO/TS 13582:2013 Health informatics -- Sharing of OID registry information</ref>
+
The sub branches for templates follow the recommendations of HL7 International and ISO 13582<ref>ISO/TS 13582:2013 Health informatics -- Sharing of OID registry information</ref>.
 +
 
 +
==Namespace Identifier==
 +
The CDA extensions for Pharmacy defined by the Pharmacy Workgroup are handled under the XML namespace identifier <pre>urn:hl7-org:pharm</pre> and typically use the namespace prefix <pre>pharm:</pre>
  
 
{{:DocumentUse}}
 
{{:DocumentUse}}
 +
 +
==Reading Publication Artifacts==
 +
A reading guide is available that explains the formalisms used to express the publication artifacts, i.e. template meta data and template design. For convenience the guide is included in the appendix.
  
 
=Functional requirements and high-level use cases=
 
=Functional requirements and high-level use cases=
Line 91: Line 118:
 
*Recording the use of a medication (in the past, current or future)
 
*Recording the use of a medication (in the past, current or future)
 
The following definitions are relevant to this Implementation Guide:
 
The following definitions are relevant to this Implementation Guide:
−
*“Prescribing” is an activity that can be performed by a variety of healthcare professionals and involves a variety of orderable items (see glossary entry). For the purposes of the following Implementation Guide, prescribing is defined as the act of prescribing a medication in either an ambulatory or an institutional setting. This could include initiating a new medication order or making all kinds of modifications to existing orders.
+
*''Prescribing'' is an activity that can be performed by a variety of healthcare professionals and involves a variety of orderable items (see glossary entry). For the purposes of the following Implementation Guide, prescribing is defined as the act of authorizing the usage of a medication in various settings for example, inpatient, community, and long term care. This could include initiating a new medication order or making all kinds of modifications to existing orders.
−
*“Dispensing” is an activity undertaken to fulfill the logistical requirements of a prescription. It supplies the materials needed to perform the prescribed actions by those who will perform them. Examples of dispensing include eyeglasses, contact lenses and medications. For the purposes of the following ballot material, dispensing is defined as supplying a medication in fulfillment of a prescription or medication order. While dispensing in these circumstances would usually be performed by a pharmacist, other health care providers such as nurses or physicians might also dispense medications.  
+
*''Dispensing'' is the provision of a medication or other material to a caregiver in fulfillment of a prescription or medication order. It supplies the materials needed to perform the prescribed actions by those who will perform them. Examples of dispensing include eyeglasses, contact lenses and medications. Dispensing is defined as supplying a medication in fulfilment of a prescription or medication order. While dispensing is usually performed by a pharmacist, other health care providers such as nurses or physicians may also dispense.
−
*“Administration” is an activity undertaken to give medication to the patient. In the community, this process is usually not recorded, since the majority occurs in the patient's home; only administrations undertaken by a healthcare professional, such as vaccination, tend to be formally documented. Administration of medication in the institutional setting is usually recorded on a dose-by-dose basis, and may be messaged on that basis, or a summary of all the administrations occurring during an inpatient stay may be described.
+
*''Administration'' is an activity undertaken to give medication to the patient. In the community, this process is usually not recorded, since the majority occurs in the patient's home; only administrations undertaken by a healthcare professional, such as vaccination, tend to be formally documented. Administration of medication in the institutional setting is usually recorded on a dose-by-dose basis, and may be messaged on that basis, or a summary of all the administrations occurring during an inpatient stay may be described.
 +
*''Medication Statement'' is an activity that can be performed by a variety of healthcare professionals, or the patient, or non-healthcare professionals.  Examples of recording medication statements include taking a patient's medication history, recording reported use of medications where the source of the patient information is from a third party and not the patient e.g. a family member when the patient is unable to communicate their medication history.   
  
 
<div class="landscape">
 
<div class="landscape">
 +
 
=Templates=
 
=Templates=
−
==Root Entry Level Templates==
+
 
−
As mentioned before, this specification defines two "root" Entry Level Templates, one for each of the covered use cases.
+
==Use Case Entry Level Templates==
 +
As mentioned before, this specification defines two "root" Entry Level Templates, one for each of the covered use cases. All entry templates are used in the context of a CDA section.
  
 
===UV Medication Order===
 
===UV Medication Order===
 
The following graph gives an overview of the high-level template components of this template, followed by the actual definition.
 
The following graph gives an overview of the high-level template components of this template, followed by the actual definition.
 +
 +
''Note: If you need to include multiple ordered medications as part of a single order, you can include multiple CDA entries under one CDA section. CDA Section definitions are not part of this guide.''
  
 
{{:2.16.840.1.113883.10.21.4.1/hgraph}}
 
{{:2.16.840.1.113883.10.21.4.1/hgraph}}
−
<p/>
+
 
 +
The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition
 +
<br>
 
{{:2.16.840.1.113883.10.21.4.1/dynamic}}
 
{{:2.16.840.1.113883.10.21.4.1/dynamic}}
  
Line 111: Line 145:
  
 
{{:2.16.840.1.113883.10.21.4.7/hgraph}}
 
{{:2.16.840.1.113883.10.21.4.7/hgraph}}
−
<p/>
+
The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition
 +
<br>
 
{{:2.16.840.1.113883.10.21.4.7/dynamic}}
 
{{:2.16.840.1.113883.10.21.4.7/dynamic}}
 +
 +
===UV Medication Administration===
 +
The following graph gives an overview of the high-level template components of this template, followed by the actual definition.
 +
 +
{{:2.16.840.1.113883.10.21.4.13/hgraph}}
 +
The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition
 +
<br>
 +
{{:2.16.840.1.113883.10.21.4.13/dynamic}}
 +
 +
===UV Medication Dispense===
 +
The following graph gives an overview of the high-level template components of this template, followed by the actual definition.
 +
 +
{{:2.16.840.1.113883.10.21.4.15/hgraph}}
 +
The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition
 +
<br>
 +
{{:2.16.840.1.113883.10.21.4.15/dynamic}}
  
 
==Entry Level Templates==
 
==Entry Level Templates==
 +
These entry level templates are used Section "Use Case Entry Level Templates".
 +
===UV ClinicalStatement Encounter===
 +
{{:2.16.840.1.113883.10.21.4.4/dynamic}}
 +
===UV ClinicalStatement Observation===
 +
{{:2.16.840.1.113883.10.21.4.3/dynamic}}
 +
===UV Comment Activity===
 +
{{:2.16.840.1.113883.10.21.4.12/dynamic}}
 +
===UV Content===
 +
{{:2.16.840.1.113883.10.21.4.17/dynamic}}
 +
 +
===UV Dispense Request===
 +
{{:2.16.840.1.113883.10.21.4.2/dynamic}}
 +
===UV Dispense Event Reference===
 +
{{:2.16.840.1.113883.10.21.4.9/dynamic}}
 +
===UV Generalized Medicine Class===
 +
{{:2.16.840.1.113883.10.21.4.19/dynamic}}
 +
 +
===UV Ingredient===
 +
{{:2.16.840.1.113883.10.21.4.18/dynamic}}
 +
 +
===UV Medication Information (detail)===
 +
{{:2.16.840.1.113883.10.21.4.11/dynamic}}
 +
 +
===UV Medication Information (simple)===
 +
{{:2.16.840.1.113883.10.21.4.10/dynamic}}
 +
 +
===UV Medication Order Reference===
 +
{{:2.16.840.1.113883.10.21.4.8/dynamic}}
 +
===UV Subordinate Substance Administration===
 +
{{:2.16.840.1.113883.10.21.4.6/dynamic}}
 +
===UV Substitution Event Adminstration===
 +
{{:2.16.840.1.113883.10.21.4.14/dynamic}}
 +
===UV Substitution Permission===
 
{{:2.16.840.1.113883.10.21.4.5/dynamic}}
 
{{:2.16.840.1.113883.10.21.4.5/dynamic}}
 +
===UV Use Period===
 +
{{:2.16.840.1.113883.10.21.9.1/dynamic}}
 +
<!--
 +
==Templates drawn from C-CDA (not subject of this guide)==
 +
===Indication (V2)===
 +
{{:2.16.840.1.113883.10.20.22.4.19/dynamic}}
 +
-->
 
</div>
 
</div>
  
 
=Appendix (Informative) =
 
=Appendix (Informative) =
 
==Acronyms and abbreviations ==
 
==Acronyms and abbreviations ==
−
<div class="column clearfix">
+
*'''C-CDA''': Consolidated CDA
−
<div class="col-md-12">
+
*'''CDA''': Clinical Document Architecture
−
<table class="table table-bordered wikitable">
+
*'''DSTU''': Draft Standard for Trial Use
−
<tr><td>'''C-CDA'''</td><td>Consolidated CDA</td></tr>
+
*'''EDQM''': European Directorate for the Quality of Medicines &amp; Healthcare
−
<tr><td>'''CDA'''</td><td>Clinical Document Architecture</td></tr>
+
*'''EHR''': Electronic Healthcare Record
−
<tr><td>'''DSTU'''</td><td>Draft Standard for Trial Use</td></tr>
+
*'''HL7''': Health Level Seven
−
<tr><td>'''EDQM'''</td><td>European Directorate for the Quality of Medicines &amp; Healthcare</td></tr>
+
*'''HP''': Healthcare Professional
−
<tr><td>'''EHR'''</td><td>Electronic Healthcare Record</td></tr>
+
*'''IDMP''': IDentification of Medicinal Products (ISO Standard)
−
<tr><td>'''HL7'''</td><td>Health Level Seven</td></tr>
+
*'''IHE''': Integrating the Healthcare Enterprise
−
<tr><td>'''HP'''</td><td>Healthcare Professional</td></tr>
+
*'''ISO''': International Organization for Standardization
−
<tr><td>'''IDMP'''</td><td>IDentification of Medicinal Products (ISO Standard)</td></tr>
+
*'''JIC''': Joint Initiative Council on SDO Global Health Informatics Standardization
−
<tr><td>'''IHE'''</td><td>Integrating the Healthcare Enterprise</td></tr>
+
*'''LOINC''': Logical Observation Identifiers Names & Codes
−
<tr><td>'''ISO'''</td><td>International Organization for Standardization</td></tr>
+
*'''MPID''': Medicinal Product Identifier  
−
<tr><td>'''JIC'''</td><td>Joint Initiative Council on SDO Global Health Informatics Standardization</td></tr>
+
*'''PCID ''': Medicinal Product Package Identifier
−
<tr><td>'''LOINC'''</td><td>Logical Observation Identifiers Names & Codes</td></tr>
+
*'''PhPID(s)''': Pharmaceutical Product Identifier(s)
−
<tr><td>'''MPID'''</td><td>Medicinal Product Identifier </td></tr>
+
*'''SDO''': Standard Developing Organization
−
<tr><td>'''PCID '''</td><td>Medicinal Product Package Identifier</td></tr>
+
*'''STU''': Standard for Trial Use
−
<tr><td>'''PhPID(s)'''</td><td>Pharmaceutical Product Identifier(s)</td></tr>
+
*'''UCUM''': Unified Code for Units of Measure
−
<tr><td>'''SDO'''</td><td>Standard Developing Organization</td></tr>
 
−
<tr><td>'''STU'''</td><td>Standard for Trial Use</td></tr>
 
−
<tr><td>'''UCUM'''</td><td>Unified Code for Units of Measure</td></tr>
 
−
</table>
 
−
</div>
 
−
</div>
 
  
 
==Glossary ==
 
==Glossary ==
Line 151: Line 236:
  
 
==Integrated examples==
 
==Integrated examples==
−
The ''Medication on CDA'' specification releases are published at [http://pharmcda.art-decor.org Project Publication Page]. The actual release has a link to the XML materials as which the W3C schemas are part of; it also includes example CDA document instances. A set of use cases have been defined and represented in ''Medication on CDA'' format.
+
The ''Medication on CDA'' specification releases are published at the Pharmacy Templates Material Publication Page on HL7 GitHub<ref name="pharmgithub">Pharmacy Templates Material Publication Page on HL7 GitHub https://github.com/HL7/CDA-pharma</ref>. This GitHub offers XML materials (also compacted as a ZIP to download) like the W3C schemas and example CDA document instances. A set of use cases have been defined and represented in ''Medication on CDA'' format.
−
 
 
−
It is likely that the publication site will move to hl7.org permanently, we will inform about that process.
 
  
 
==Validation artifacts ==
 
==Validation artifacts ==
 
You can test your implementation (instances) against the ''Medication on CDA'' specification. To download materials to your computer for local testing and validation consider...
 
You can test your implementation (instances) against the ''Medication on CDA'' specification. To download materials to your computer for local testing and validation consider...
−
* ...the W3C schemas (actually valid for any CDA specification) located at the [http://pharmcda.art-decor.org Project Publication Page]. The actual release has a link to the XML materials as which the W3C schemas are part of; it also includes example CDA document instances.
+
 
−
* ..the ISO schematron, automatically generated by the tool. These are files to do validation locally by associating IPS CDA instances with the main schematron using an XML editor or to use the derived XSLT conversions and apply the according XSLT derivation to your local IPS CDA instance.
+
* ...the W3C schemas (actually valid for any CDA specification) located at the PHARM Materials Page on HL7 GitHub<ref name="pharmgithub"></ref>.  
 +
 
 +
* ..the ISO schematron, automatically generated by ART-DECOR based on the definitions, located at the Pharmacy Templates Material Publication Page on ART-DECOR<ref name="adpubpage">Pharmacy Templates Material Publication Page on ART-DECOR https://hl7intl.art-decor.pub/index.php?prefix=pharmcda-</ref>. These are files to do validation locally by associating PHARM CDA instances with the main schematron using an XML editor or to use the derived XSLT conversions and apply the according XSLT derivation to your local PHARM CDA instance.
  
 
For further information you can follow the documentation.
 
For further information you can follow the documentation.
  
 
==Operational information ==
 
==Operational information ==
−
* The original specification is hosted on the logical ART-DECOR main server art-decor.org under the ''Governance Group'' '''HL7 International''', the project is reachable at the [http://art-decor.org/art-decor/decor-project--pharmcda- Live Project Landing Page].
+
* The original specification is hosted on the logical ART-DECOR main server art-decor.org under the ''Governance Group'' '''HL7 International''', the project is reachable at the Project Live Landing Page<ref> Pharmacy Templates Project Live Landing Page https://art-decor.org/ad/#/pharmcda-/project/overview</ref>.
−
* Any ''Medication on CDA'' specification release in HTML format resides at [http://pharmcda.art-decor.org Project Publication Page]. It is likely that the publication site will move to hl7.org permanently, we will inform about that process.
 
  
 
==Licenses==
 
==Licenses==
Line 170: Line 254:
 
*'''SNOMED CT''': SNOMED International (formerly know as International Healthcare Terminology Standards Development Organization IHTSDO)<ref>Get SNOMED CT http://www.ihtsdo.org/snomed-ct/get-snomed-ct</ref> or info@ihtsdo.org
 
*'''SNOMED CT''': SNOMED International (formerly know as International Healthcare Terminology Standards Development Organization IHTSDO)<ref>Get SNOMED CT http://www.ihtsdo.org/snomed-ct/get-snomed-ct</ref> or info@ihtsdo.org
 
*'''Logical Observation Identifiers Names & Codes''' (LOINC): The Regenstrief Institute, Inc.
 
*'''Logical Observation Identifiers Names & Codes''' (LOINC): The Regenstrief Institute, Inc.
−
*'''Unified Code for Units of Measure (UCUM) : Regenstrief Institute, Inc. and the UCUM Organization  
+
*'''Unified Code for Units of Measure (UCUM) : Regenstrief Institute, Inc. and the UCUM Organization
−
*'''EDQM Standard Terms ''' : European Directorate for the Quality of Medicines & Healthcare (EDQM) <ref>EDQM Standard Terms https://standardterms.edqm.eu</ref>
 
  
 
=List of all artifacts used in this guide=
 
=List of all artifacts used in this guide=
Line 186: Line 269:
 
* [[2.16.840.1.113883.10.21.4.10]] UV Medication Information (simple)
 
* [[2.16.840.1.113883.10.21.4.10]] UV Medication Information (simple)
 
* [[2.16.840.1.113883.10.21.4.11]] UV Medication Information (detail)
 
* [[2.16.840.1.113883.10.21.4.11]] UV Medication Information (detail)
 +
* [[2.16.840.1.113883.10.21.4.12]] UV Comment Activity
 +
* [[2.16.840.1.113883.10.21.4.13]] UV Medication Administration
 +
* [[2.16.840.1.113883.10.21.4.14]] UV Substitution Event Adminstration
 +
* [[2.16.840.1.113883.10.21.4.15]] UV Medication Dispense
 +
* [[2.16.840.1.113883.10.21.4.17]] UV Content
 +
* [[2.16.840.1.113883.10.21.4.18]] UV Ingredient
 +
* [[2.16.840.1.113883.10.21.4.19]] UV Generalized Medicine Class
 +
<!--* [[2.16.840.1.113883.10.21.4.16]] UV Substitution Event Supply-->
 
* [[2.16.840.1.113883.10.21.9.1]] UV Use Period
 
* [[2.16.840.1.113883.10.21.9.1]] UV Use Period
−
 
+
<!--
 
===References (re-used) from current C-CDA===
 
===References (re-used) from current C-CDA===
−
* [[2.16.840.1.113883.10.20.22.4.64]] Comment Activity
 
 
* [[2.16.840.1.113883.10.20.22.4.19]] Indication (V2)
 
* [[2.16.840.1.113883.10.20.22.4.19]] Indication (V2)
 +
-->
  
−
===Unconstrained Templates from the original CDA specification===
+
==Unconstrained Templates from the original CDA specification==
 
* [[2.16.840.1.113883.10.12.151]] CDA Organization
 
* [[2.16.840.1.113883.10.12.151]] CDA Organization
 
* [[2.16.840.1.113883.10.12.152]] CDA Person
 
* [[2.16.840.1.113883.10.12.152]] CDA Person
Line 216: Line 307:
  
 
==Value Sets ==
 
==Value Sets ==
−
*[[2.16.840.1.113883.11.21.2]] xxxxx
+
===Medication Time Units (UCUM)===
−
*[[2.16.840.1.113883.11.22.3]] xxxxy
+
{{:2.16.840.1.113883.11.21.1/dynamic}}
 +
===ActStatusCodeActiveCompletedAbortedSuspended===
 +
{{:2.16.840.1.113883.11.21.2/dynamic}}
 +
=== Mood Code Evn Int Rqo===
 +
{{:2.16.840.1.113883.11.21.4/dynamic}}
 +
=== Unknown or absent medication===
 +
{{:2.16.840.1.113883.11.21.5/dynamic}}
 +
 
 +
==Referenced HL7 Version 3 Value Sets==
 +
*2.16.840.1.113883.1.11.13955 ActEncounterCode
 +
*2.16.840.1.113883.1.11.16208 ActPharmacySupplyType
 +
*2.16.840.1.113883.1.11.16866 ActPriority
 +
*2.16.840.1.113883.1.11.15933 ActStatus
 +
*2.16.840.1.113883.1.11.19708 ActSubstanceAdministrationCode
 +
*2.16.840.1.113883.1.11.16621 ActSubstanceAdminSubstitutionCode
 +
*2.16.840.1.113883.1.11.14570 AdministrableDrugForm
 +
*2.16.840.1.113883.1.11.11526 HumanLanguage
 +
*2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt
 +
*2.16.840.1.113883.1.11.78 Observation Interpretation
 +
*2.16.840.1.113883.1.11.14079 ObservationMethod
 +
*2.16.840.1.113883.1.11.14581 RouteOfAdministration
 +
*2.16.840.1.113883.1.11.19719 SubstanceAdminSubstitutionNotAllowedReason
 +
*2.16.840.1.113883.1.11.19377 SubstanceAdminSubstitutionReason
 +
*2.16.840.1.113883.1.11.10706 TimingEvent
 +
*2.16.840.1.113883.1.11.19447 x_ActRelationshipEntryRelationship
 +
*2.16.840.1.113883.1.11.19890 x_ActStatusActiveComplete
  
−
==System OIDs / IDs ==
 
−
==Code systems==
 
 
==Datatypes ==
 
==Datatypes ==
 +
Datatypes for element definitions used
 +
*ANY – ANY
 +
*BL – Boolean
 +
*CD – Concept Descriptor
 +
*CE – Coded with Equivalents
 +
*CS – Coded Simple Value
 +
*ED – Encapsulated Data
 +
*EN – Entity Name
 +
*II – Instance Identifier
 +
*INT – Integer
 +
*INT.NONNEG – Interval of Integer, non-negative
 +
*IVL_INT – Interval of Integer
 +
*IVL_PQ – Interval of Physical Quantity
 +
*IVL_TS – Interval of Time Stamp
 +
*IVXB_TS – Interval Boundary of Time Stamp
 +
*PIVL_TS – Periodic Interval of Timezone
 +
*PQ – Physical Quantity
 +
*RTO_PQ_PQ – Ratio Physical Quantity / Physical Quantity
 +
*ST – Character String
 +
*TEL – Telecommunication Address
 +
*TS – Time Stamp
 +
 +
Datatypes for attributes used
 +
*bl – boolean code
 +
*cs – code
 +
*uid – identifier
 +
 +
==Extensions==
 +
=== Detailed medications information ===
 +
This specification uses CDA extensions in order to provide details about medications, as further described in the section on the design conventions for Medicinal Product Identification and as used in template 2.16.840.1.113883.10.21.4.11 ''UV Medication Information (detail)''. The extension uses the namespace <pre>urn:hl7-org:pharm</pre>
 +
 +
This is the list of elements defined for that template.
 +
 +
*pharm:formCode (Administrable Pharmaceutical Dose Form)
 +
*pharm:asContent (Packaging of the medication)
 +
**pharm:quantity
 +
**pharm:containerPackagedMedicine (Most inner Package Item or the Packaged Medicinal Product)
 +
***pharm:code
 +
***pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
 +
***pharm:formCode (type of the most inner package item or of the or the Packaged Medicinal Product)
 +
***pharm:capacityQuantity (the functional capacity of the container)
 +
***pharm:asContent (Containing package)
 +
****pharm:quantity
 +
****pharm:containerPackagedMedicine (Intermediate Package Item or the Packaged Medicinal Product)
 +
*****pharm:code
 +
*****pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
 +
*****pharm:formCode (type of the intermediate package item or of the or the Packaged Medicinal Product)
 +
*****pharm:capacityQuantity (the functional capacity of the container)
 +
*****pharm:asContent (Containing package)
 +
******pharm:quantity
 +
******pharm:containerPackagedMedicine (Packaged Medicinal Product)
 +
*******pharm:code
 +
*******pharm:name (Name of the Packaged Medicinal Product)
 +
*******pharm:formCode (type of the Packaged Medicinal Product)
 +
*******pharm:capacityQuantity (the functional capacity of the container)
 +
*pharm:asSpecializedKind (used to represent any classification of the product (ATC code, future PhPIDs,..) )
 +
**pharm:generalizedMaterialKind
 +
***pharm:code
 +
***pharm:name
 +
*pharm:ingredient (list of active substances used for this product)
 +
**pharm:quantity (strength)
 +
**pharm:ingredientSubstance (active substance)
 +
***pharm:code
 +
***pharm:name
 +
 +
{{:Reading_Guide_for_Publication_Artefacts}}
  
 
=References=
 
=References=
 
==Literature==
 
==Literature==
−
* Keith W. Boone: The CDA TM Book. Springer 2011, ISBN 978-0-85729-336-7
+
* Boone KW: The CDA Book. Springer 2011, ISBN 978-0-85729-336-7
  
 
==Links==
 
==Links==
 
<references/>
 
<references/>
 +
 
==Figures==
 
==Figures==
 
<references group="Figure"/>
 
<references group="Figure"/>
 +
 +
[[Category:IG]]

Latest revision as of 10:43, 8 April 2023

Continuous Build

This is the Continuous Build of the HL7 CDA® R2 Implementation Guide Pharmacy Templates (will be incorrect/inconsistent at times).

See the Directory of the published standard.

Document Information

This document contains: Pharmacy Templates (1.2.0). The text materials belong to category cdapharm.

CDAR2_IG_PHARM_TEMPLATES_E1_STU2_2023APR
Hl7intnew.png
HL7 CDA® R2 Implementation Guide:
Pharmacy Templates
Edition 1 (Universal Realm)
Standard for Trial use
1.2.0
April 2023
Pharmacy Templates
Publication of this standard for trial use (STU) has been approved by Health Level Seven International (HL7). This STU is not an accredited American National Standard. The comment period for use of this STU shall end 24 months from the date of publication. Suggestions for revision should be submitted at http://www.hl7.org/stucomments/index.cfm. Following this 24 month evaluation period, this STU, revised as necessary, will be submitted to a normative ballot in preparation for approval by ANSI as an American National Standard. Implementations of this STU shall be viable throughout the normative ballot process and for up to six months after publication of the relevant normative standard.


Copyright © 2023 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. Pat & TM Off.
Use of this material is governed by HL7's IP Compliance Policy.

HL7 CDA® R2 Implementation Guide: Pharmacy Templates, Edition 1
1.2.0 April 2023 – © 2016-2023 Health Level Seven International. All rights reserved.



Important Notes

HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license, please visit http://www.HL7.org/implement/standards/index.cfm.

If you are the individual that obtained the license for this HL7 Standard, specification or other freely licensed work (in each and every instance "Specified Material"), the following describes the permitted uses of the Material.

A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part without paying license fees to HL7.

INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional items of Special Material in whole or part, into products and services, or to enjoy additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL MEMBERS of HL7.

B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are authorized, without additional charge, on a perpetual (except as provided for in the full license terms governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal purposes only) and share this Material with your employees and consultants for study purposes, and (b) utilize the Material for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual property rights of third parties (which may include members of HL7). No other license, sublicense, or other rights of any kind are granted under this Agreement.

C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are authorized, without additional charge, to read and use the Specified Material for evaluating whether to implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part. NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7. Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.

Ownership. Licensee agrees and acknowledges that HL7 owns all right, title, and interest, in and to the Materials. Licensee shall take no action contrary to, or inconsistent with, the foregoing.

Licensee agrees and acknowledges that HL7 may not own all right, title, and interest, in and to the Materials and that the Materials may contain and/or reference intellectual property owned by third parties (“Third Party IP”). Acceptance of these License Terms does not grant Licensee any rights with respect to Third Party IP. Licensee alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize Third Party IP in connection with the Materials or otherwise. Any actions, claims or suits brought by a third party resulting from a breach of any Third Party IP right by the Licensee remains the Licensee’s liability.

Following is a non-exhaustive list of third-party terminologies that may require a separate license:

TerminologyOwner/Contact
Current Procedures Terminology (CPT) code setAmerican Medical Association https://www.ama-assn.org/practice-management/cpt-licensing
SNOMED CT©SNOMED CT® International http://www.snomed.org/snomed-ct/get-snomed-ct or info@ihtsdo.org
Logical Observation Identifiers Names & Codes (LOINC©)Regenstrief Institute, Inc.
International Classification of Diseases (ICD) codesWorld Health Organization (WHO)
NUCC Health Care Provider Taxonomy code setAmerican Medical Association. Please see www.nucc.org. AMA licensing contact: 312-464-5022 (AMA IP services)

Obtaining a CPT Sublicense from HL7

Contact hq@hl7.org about how to obtain a sublicense from HL7 for non-production use of CPT for (i) the development and publication of value sets, profiles, and other artifacts as part of the HL7 Implementation Guides, (ii) as part of defined VSAC value sets, and (iii) to support HL7's terminology services within the Territory.

Flow Down Clauses for CPT Sublicense from HL7

CPT content is copyrighted by the American Medical Association and CPT is a registered trademark of the AMA.

HL7, as a party to a license agreement with the AMA, is authorized to grant user a limited, non-exclusive, non-transferable, non-sublicensable license for user to use CPT content for (i) the development and publication of value sets, profiles, and other artifacts as part of the HL7 Implementation Guides, (ii) as part of defined VSAC value sets, and (iii) to support HL7's terminology services within the Territory, each of which shall be considered a non-production use. The sublicense granted hereunder shall automatically terminate upon termination of the agreement between HL7 and AMA, unless prior written consent of AMA is obtained.

The provision of updated CPT content is dependent on a continuing contractual relationship between HL7 and the AMA.

User acknowledge a separate license agreement shall be required, and shall govern any proposed use, including any distribution of CPT content for any other purposes not expressly permitted under this Agreement, and the terms of such agreement will govern such use (e.g., a separate license agreement shall govern production use and commercial purposes). AMA reserves the right to accept or reject licenses based on AMA's evaluation of the proposed use of the CPT content.

User acknowledge that User's development and commercialization of CPT-informed works developed with reference to Licensed Products may only be implemented in the Territory.

User is prohibited from making CPT content publicly available, creating derivative works (including translating), transferring, selling, leasing, licensing, or otherwise making available to any unauthorized party the CPT content, or a copy or portion of CPT content to any unauthorized party, including a subsidiary, affiliate, or other legal entity, however designated, for any purpose whatsoever except as expressly permitted under a separate agreement.

User expressly acknowledges and agrees to the extent permitted by applicable law, use of CPT content is at User's sole risk and CPT content is provided "as is" without warranty of any kind. The AMA does not directly or indirectly practice medicine or dispense medical services. Fee schedules, relative value units, conversion factors and/or related components are not assigned by the AMA, are not part of CPT, and the AMA is not recommending their use. CPT content herein does not replace the AMA's Current Procedural Terminology book or other appropriate coding authority. The coding information contained in CPT content should be used only as a guide.

U.S. Government End Users. CPT is commercial technical data, which was developed exclusively at private expense by the American Medical Association (AMA), 330 North Wabash Avenue, Chicago, Illinois 60611. This agreement does not grant the Federal Government a direct license to use CPT based on FAR 52.227- 14 (Data Rights - General) and DFARS 252.227-7015 (Technical Data - Commercial Items).

User expressly consents to the release of its name to the AMA.

Co-Chair, Primary Editor Melva Peters
Jenaker Consulting
melva@jenakerconsulting.com
Co-Chair, Primary Editor John Hatem
jnhatem@hotmail.com
Co-Chair Scott Robertson PharmD
scott.m.robertson@kp.org
Co-Chair Jean Duteau
jean@duteaudesign.com
Contributor Dr Kai U. Heitmann
Heitmann Consulting and Services, ART-DECOR Open Tools GmbH, HL7 Germany
info@kheitmann.de
Contributor Giorgio Cangioli, PhD
Consultant, HL7 Italy
giorgio.cangioli@gmail.com
Contributor Tom de Jong
VZVZ, HL7 The Netherlands
tom@nova-pro.nl
Contributor Dr Christof Geßner
Gematik GmbH, HL7 Germany
christof.gessner@gematik.de

Contents

Introduction

This Implementation Guide provides CDA R2 templates for Medication Order and Medication Statement, Medication Dispense and Medication Administration that can be used by HL7 standards developers and external projects to develop models for pharmacy related content. The implementation guide is intended to provide consistency of pharmacy related models across all uses regardless of the method of transport by creating a library of Universal (UV) Pharmacy Templates that can be used by other Work Groups to derive constrained versions.

Purpose

Background

Historically multiple HL7 Work Groups have developed specifications for pharmacy related content and as a result, there is inconsistency in how medication related content is represented in HL7 V2, V3, CDA and FHIR. The Pharmacy Work Group often receives questions as to how to model pharmacy related content but in some cases, the use case cannot be met with the existing models.

This Implementation Guide provides a CDA R2 library of pharmacy templates that can be used by HL7 Work Groups or external projects to derive constrained versions of models for pharmacy related content.

Scope

This Pharmacy Templates Implementation Guide defines common pharmacy artifacts (order, dispense, administration and statement) in CDA R2 format. The scope of the Implementation Guide is limited to Medication Order and Medication Statement, Medication Dispense and Medication Administration. The content was developed by aligning and harmonizing the existing specifications for Consolidated CDA (C-CDA Release 2.1[1]).

Ballot Status of the Document

The Implementation Guide was balloted as Standard for Trial Use (STU) and then goes to Normative.

Audience

  • Clinical and Public Health laboratories
  • Immunization Registries
  • Pharmaceutical Vendors
  • EHR/PHR vendors
  • Clinical Decision Support Systems
  • HIS Vendors
  • Emergency Services Providers
  • Healthcare Institutions
  • Pharmacists
  • Physicians and other Clinicians

Relationships with other projects and guides

  • Consolidated CDA (C-CDA)
  • HL7 Version 3 Pharmacy Models
  • HL7 FHIR® Pharmacy Resources
  • International Patient Summary (IPS), where all pharmacy related templates are specialisations of the corresponding templates defined in this guide

Principles and background

The Pharmacy Work Group has a set of rich set of existing models that were used as the basis for the implementation guide including HL7 V3 models and FHIR resources. 

This implementation guide was created by the Pharmacy Work Group using the following approach:

  • Review of Consolidated CDA (C-CDA[1]) to identify templates that include pharmacy related content
  • Compare C-CDA templates to existing Pharmacy HL7 V3 models and Pharmacy FHIR resources to identify differences and gaps
  • Create universal templates to that can be constrained for use for new templates.

For the Medication Model reflected in template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail), the Common Message Element Type CMET R_Medication Universal” (COCT_MT230100UV02), Release 2 (as published in HL7 V3 2017, V2.0.2 Dec 2010, derived from Common Product Model) was used to construct the CDA extension elements (see also "Extensions" used in this guide in the appendix).

The template rules are formalized using the computable format defined by the HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1[2] in order to facilitate also the automatic generation of consistent testing and validation capabilities.

Technical Background

What is a CDA

CDA R2 is "… a document markup standard that specifies the structure and semantics of clinical documents for the purpose of exchange” [CDA R2, Section 1.1]. Clinical documents, according to CDA, have the following characteristics:

  • Persistence
  • Stewardship
  • Potential for authentication
  • Context
  • Wholeness
  • Human readability

CDA defines a header for classification and management and a document body that carries the clinical record. While the header metadata are prescriptive and designed for consistency across all instances, the body is highly generic, leaving the designation of semantic requirements to implementation.

Templated CDA

CDA R2 can be constrained by mechanisms defined in the “Refinement and Localization” section of the HL7 Version 3 Interoperability Standards. The mechanism most commonly used to constrain CDA is referred to as “templated CDA”. This specification created a set of artifacts containing modular CDA templates (and associated value sets) for the purpose of the International Patient Summary, and the templates can be reused across any number of CDA document types.

There are different kinds of templates that might be created. Among them, the most common ones are:

  • CDA Document Level Templates constrain fields in the Clinical Document Architecture (CDA) header, and define containment relationships to CDA sections.
    For example, a History-and-Physical document-level template might require that the patient’s name be present, and that the document contain a Physical Exam section.
  • CDA Header Level Templates constrain fields for parts of the CDA header, like the patient (record target), the author, participations or the service event.
  • CDA Section Level Templates constrain fields in the CDA section, and define containment relationships to CDA entries.
    For example, a Physical-exam section-level template might require that the section/code be fixed to a particular LOINC code, and that the section contain a Systolic Blood Pressure observation.
  • CDA Entry Level Templates constrain the CDA clinical statement model in accordance with real world observations and acts.
    For example, a Systolic-blood-pressure entry-level template defines how the CDA Observation class is constrained (how to populate observation/code, how to populate observation/value, etc.) to represent the notion of a systolic blood pressure.

Open and Closed Templates

Open templates permit anything to be done in the underlying standard that is not explicitly prohibited. This allows templates to be built up over time that extend and go beyond the original use cases for which they were originally designed.

Closed templates only permit what has been defined in the template, and do not permit anything beyond that. There are good reasons to use closed templates, sometimes having to do with local policy. For example, in communicating information from a healthcare provider to an insurance company, some information may need to be omitted to ensure patient privacy laws are followed. Most templates developed for CDA are of the open sort.

Template versioning

Template versioning is needed to enable template designs to evolve over time.

Template versioning enables template designers to control and shape the conformance statements that make up a template’s design over time tailoring the design to fit the template’s intended purpose.

Each template version is associated with a particular template. The template – as a whole – has a mandatory globally unique, non-semantic, identifier. The identifier serves as the identifier of the original intent of the template and as the identifier of the set of versions that represent the template over time.

Template versions have a mandatory timestamp (date and optional time), called the “effective date”. The date can be seen as the point in time when the template version “came into being”, i.e. was recognized as existent by the governance group. Use of the template prior to this date would be considered an invalid use of the template.

For further information on Templates, Template Versions and related topics refer to the HL7 Templates Standard[2].

Identifiers for Templates and Value Sets

This specification specifies CDA Entry Level Templates only. They can be re-used in any appropriate context, such as an Entry of a medication section.

Two "root" Entry Templates are provided as entry points for the four described use cases:

  • UV Medication Order (2.16.840.1.113883.10.21.4.1)
  • UV Medication Statement (2.16.840.1.113883.10.21.4.7)
  • UV Medication Administration (2.16.840.1.113883.10.21.4.13)
  • UV Medication Dispense (2.16.840.1.113883.10.21.4.15)

These templates use other Entry Level Templates that are all listed in a subsequent section of this document.

This specification uses the following OIDs for the artifacts that are registered at the HL7 OID registry.

  • The root OID for templates is 2.16.840.1.113883.10.21
    • Entry Level templates are summarized under 2.16.840.1.113883.10.21.4, e.g. 2.16.840.1.113883.10.21.4.5 UV Substitution Permission
    • “other” assistance templates are summarized under 2.16.840.1.113883.10.21.9, e.g. 2.16.840.1.113883.10.22.9.1 UV Use Period
  • The root OID for Value Sets is 2.16.840.1.113883.11

The sub branches for templates follow the recommendations of HL7 International and ISO 13582[3].

Namespace Identifier

The CDA extensions for Pharmacy defined by the Pharmacy Workgroup are handled under the XML namespace identifier 

urn:hl7-org:pharm

and typically use the namespace prefix 

pharm:

How to read this document

All artifacts (templates, value sets etc.) listed with the status Kyellow.png Draft or Korange.png Pending are subject to ballot comments.

Artifacts with other status information, especially Kgreen.png Final or Active are not (directly) part of the ballot and some artifacts actually even come from external sources. Reference artifacts are indicated by the symbol

ref

. These reference artifacts are also not subject to the ballot, as they might be balloted elsewhere already.

The PDF version contains a ruler on the left side of the pages. A ruler has the page number on top of it and allows locating a line at the page by simply specifying the number at the scale tick. This is more precise and allows also commenting on graphics and pictures.

For example if you have a comment on page 29 because of a typo (see figure), you simply specify the error with its location p0029-04.

Of course you can also refer by classical chapter and section numbers. The use of the ruler has the ballot team's preference, though.

IPS ballotruler.jpg

IPS ballotruler.jpg

[Figure 1] To locate a typo on page 29 as a ballot comment, simply specify the location p0029-04.

Reading Publication Artifacts

A reading guide is available that explains the formalisms used to express the publication artifacts, i.e. template meta data and template design. For convenience the guide is included in the appendix.

Functional requirements and high-level use cases

The following use cases are relevant to the pharmacy domain for both community and institutional settings:

  • Prescribing a medication (aka Prescription or Order or Request)
  • Dispensing a medication
  • Recording the administration of a medication
  • Recording the use of a medication (in the past, current or future)

The following definitions are relevant to this Implementation Guide:

  • Prescribing is an activity that can be performed by a variety of healthcare professionals and involves a variety of orderable items (see glossary entry). For the purposes of the following Implementation Guide, prescribing is defined as the act of authorizing the usage of a medication in various settings for example, inpatient, community, and long term care. This could include initiating a new medication order or making all kinds of modifications to existing orders.
  • Dispensing is the provision of a medication or other material to a caregiver in fulfillment of a prescription or medication order. It supplies the materials needed to perform the prescribed actions by those who will perform them. Examples of dispensing include eyeglasses, contact lenses and medications. Dispensing is defined as supplying a medication in fulfilment of a prescription or medication order. While dispensing is usually performed by a pharmacist, other health care providers such as nurses or physicians may also dispense.
  • Administration is an activity undertaken to give medication to the patient. In the community, this process is usually not recorded, since the majority occurs in the patient's home; only administrations undertaken by a healthcare professional, such as vaccination, tend to be formally documented. Administration of medication in the institutional setting is usually recorded on a dose-by-dose basis, and may be messaged on that basis, or a summary of all the administrations occurring during an inpatient stay may be described.
  • Medication Statement is an activity that can be performed by a variety of healthcare professionals, or the patient, or non-healthcare professionals. Examples of recording medication statements include taking a patient's medication history, recording reported use of medications where the source of the patient information is from a third party and not the patient e.g. a family member when the patient is unable to communicate their medication history.

Templates

Use Case Entry Level Templates

As mentioned before, this specification defines two "root" Entry Level Templates, one for each of the covered use cases. All entry templates are used in the context of a CDA section.

UV Medication Order

The following graph gives an overview of the high-level template components of this template, followed by the actual definition.

Note: If you need to include multiple ordered medications as part of a single order, you can include multiple CDA entries under one CDA section. CDA Section definitions are not part of this guide.

  1. Entry
     UV Medication Order (2.16.840.1.113883.10.21.4.1)
    1. Entry
       UV Use Period (2.16.840.1.113883.10.21.9.1)
    2. Entry
       CDA Subject (Body) (2.16.840.1.113883.10.12.320)
    3. Entry
       UV Medication Information (simple) (2.16.840.1.113883.10.21.4.10)
      1. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    4. Entry
       UV Medication Information (detail) (2.16.840.1.113883.10.21.4.11)
      1. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      2. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      3. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      4. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      5. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      6. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      7. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      8. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      9. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      10. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      11. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      12. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      13. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    5. Entry
       CDA Author (Body) (2.16.840.1.113883.10.12.318)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
      2. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      3. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    6. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    7. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    8. Entry
       UV Subordinate Substance Administration (2.16.840.1.113883.10.21.4.6)
    9. Entry
       UV Dispense Request (2.16.840.1.113883.10.21.4.2)
      1. Entry
         CDA Subject (Body) (2.16.840.1.113883.10.12.320)
      2. Entry
         CDA ManufacturedProduct (2.16.840.1.113883.10.12.312)
        1. Entry
           CDA LabeledDrug (2.16.840.1.113883.10.12.310)
        2. Entry
           CDA Material (2.16.840.1.113883.10.12.311)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
      3. Entry
         CDA Performer (Body) (2.16.840.1.113883.10.12.323)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
      4. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      5. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      6. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      7. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    10. Entry
       UV ClinicalStatement Observation (2.16.840.1.113883.10.21.4.3)
      1. Entry
         CDA Subject (Body) (2.16.840.1.113883.10.12.320)
      2. Entry
         CDA Specimen (2.16.840.1.113883.10.12.322)
      3. Entry
         CDA Performer (Body) (2.16.840.1.113883.10.12.323)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
      4. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
      5. Entry
         CDA Informant (Body) (2.16.840.1.113883.10.12.319)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
        2. Entry
           CDA RelatedEntity (2.16.840.1.113883.10.12.316)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
      6. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      7. Entry
         CDA Reference (2.16.840.1.113883.10.12.324)
        1. Entry
           CDA ExternalAct (2.16.840.1.113883.10.12.325)
        2. Entry
           CDA ExternalObservation (2.16.840.1.113883.10.12.326)
        3. Entry
           CDA ExternalProcedure (2.16.840.1.113883.10.12.327)
        4. Entry
           CDA ExternalDocument (2.16.840.1.113883.10.12.328)
      8. Entry
         CDA Precondition (2.16.840.1.113883.10.12.329)
    11. Entry
       IPS Internal Reference (2.16.840.1.113883.10.22.4.31)
    12. Entry
       UV ClinicalStatement Observation (2.16.840.1.113883.10.21.4.3)
      1. Entry
         CDA Subject (Body) (2.16.840.1.113883.10.12.320)
      2. Entry
         CDA Specimen (2.16.840.1.113883.10.12.322)
      3. Entry
         CDA Performer (Body) (2.16.840.1.113883.10.12.323)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
      4. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
      5. Entry
         CDA Informant (Body) (2.16.840.1.113883.10.12.319)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
        2. Entry
           CDA RelatedEntity (2.16.840.1.113883.10.12.316)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
      6. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      7. Entry
         CDA Reference (2.16.840.1.113883.10.12.324)
        1. Entry
           CDA ExternalAct (2.16.840.1.113883.10.12.325)
        2. Entry
           CDA ExternalObservation (2.16.840.1.113883.10.12.326)
        3. Entry
           CDA ExternalProcedure (2.16.840.1.113883.10.12.327)
        4. Entry
           CDA ExternalDocument (2.16.840.1.113883.10.12.328)
      8. Entry
         CDA Precondition (2.16.840.1.113883.10.12.329)
    13. Entry
       UV Substitution Permission (2.16.840.1.113883.10.21.4.5)
    14. Entry
       UV ClinicalStatement Encounter (2.16.840.1.113883.10.21.4.4)
    15. Entry
       UV Comment Activity (2.16.840.1.113883.10.21.4.12)
      1. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
    16. Entry
       CDA Precondition (2.16.840.1.113883.10.12.329)


The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition

Id2.16.840.1.113883.10.21.4.1Effective Date2023‑01‑31 11:29:28
Other versions this id:
  • Kblank.png UVSubstanceadministrationrequest as of 2023‑01‑31 10:52:39
  • Kblank.png UVSubstanceadministrationrequest as of 2023‑01‑30 08:30:30
  • Kblank.png UVSubstanceadministrationrequest as of 2021‑08‑04 17:03:38
  • Kblank.png UVSubstanceadministrationrequest as of 2015‑10‑07
StatusKyellow.png DraftVersion Label2023
NameUVSubstanceadministrationrequestDisplay NameUV Medication Order
DescriptionUniversal Medication Order (Substance Administration Request)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.1
LabelMedicationOrder
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 14 templates
Uses as NameVersion
2.16.840.1.113883.10.21.9.1IncludeKyellow.png UV Use Period (2023)DYNAMIC
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.21.4.10ContainmentKorange.png UV Medication Information (simple) (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.11ContainmentKyellow.png UV Medication Information (detail) (2023)DYNAMIC
2.16.840.1.113883.10.12.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
2.16.840.1.113883.10.21.4.6ContainmentKyellow.png UV Subordinate Substance Administration (2023)DYNAMIC
2.16.840.1.113883.10.21.4.2ContainmentKorange.png UV Dispense Request (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.3ContainmentKorange.png UV ClinicalStatement Observation (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.22.4.31ContainmentKorange.png IPS Internal Reference (STU1)DYNAMIC
2.16.840.1.113883.10.21.4.5ContainmentKorange.png UV Substitution Permission (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.4ContainmentKorange.png UV ClinicalStatement Encounter (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.12ContainmentKorange.png UV Comment Activity (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.12.329ContainmentKgreen.png CDA PreconditionDYNAMIC
RelationshipVersion: template 2.16.840.1.113883.10.21.4.1 UV Medication Order (2015‑10‑07)
Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="RQO">
  <templateId root="2.16.840.1.113883.10.21.4.1"/>  <id root="1.2.3.99.99.99" extension="58768437489739"/>  <code code="..." codeSystem="..."/>  <text>...</text>  <statusCode code="active"/>  <effectiveTime value="..."/>  <repeatNumber value="..."/>  <routeCode code="IPINHL" codeSystem="2.16.840.1.113883.5.112" displayName="Inhalation, respiratory Inhalation, intrapulmonary Inhalation, oral"/>  <approachSiteCode code="..." codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="PUFF" codeSystem="2.16.840.1.113883.5.85" displayName="Puff"/>  <consumable typeCode="CSM">
    <!-- Consumable -->
  </consumable>  <participant typeCode="DEV">
    <!-- Device -->
  </participant>  <participant typeCode="LOC">
    <!-- Location -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- Subordinate Substance Administrations -->
  </entryRelationship>  <entryRelationship typeCode="COMP">
    <!-- Annotations -->
  </entryRelationship>  <precondition>
    <!-- Precondition -->
  </precondition></substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
Medi...rder
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1FRQO
Treetree.pnghl7:templateId
II1 … 1MMedi...rder
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.1
Treetree.pnghl7:id
II1 … *RMedi...rder
Treetree.pnghl7:code
CD (extensible)0 … 1RMedi...rder
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.1.11.19708 ActSubstanceAdministrationCode (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1Medi...rder
Treetree.pnghl7:statusCode
CS (required)1 … 1MMedi...rder
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.21.2 ActStatusActiveCompletedAbortedSuspended (DYNAMIC)
Included from 2.16.840.1.113883.10.21.9.1 UV Use Period (DYNAMIC)
Choice1 … 1
The effectiveTime element encodes the use period of the medication, it is always expressed as an interval of time.
It may be expressed using the low and high OR with the width element.
The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high][not(hl7:width)]
  • hl7:effectiveTime[hl7:width][not(hl7:low|hl7:high)]
  • hl7:effectiveTime[hl7:low | hl7:width][not(hl7:high)]
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 1: specified interval


The low and high values of the first effectiveTime element represent the start and stop times for the medication. The low value represents the start time, and the high value represents the stop time. If either the low or the high value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.

In case of unbounded period (continuous therapy) the high element will be valued with the nullFlavor attribute to NA.


The high value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the low value. The rationale is that a provider, seeing a prescription that has not been refilled would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.		Medi...rder
where [hl7:low or
[not(hl7:width)]
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
continous therapy
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RMedi...rder
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1RMedi...rder
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 2: 'floating' period:
The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy)		Medi...rder
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
NPMedi...rder
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
NPMedi...rder
Treeblank.pngTreeblank.pngTreetree.pnghl7:center
NPMedi...rder
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...rder
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 3: anchored period:
The width element is used to specify a period of (actual or intended) administration anchored to a specific date (e.g. a two weeks therapy starting today)		Medi...rder
where [hl7:low or
[not(hl7:high)]
 Example
2 week period starting on 2013-03-21
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS0 … 1CMedi...rder
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...rder
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treetree.pnghl7:repeatNumber
IVL_INT0 … 1Medi...rder
Treetree.pnghl7:routeCode
CE (example)0 … 1Medi...rder
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.14581 RouteOfAdministration (DYNAMIC)
Treetree.pnghl7:approachSiteCode
CD (example)0 … *Medi...rder
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.19724 HumanSubstanceAdministrationSite (DYNAMIC)
Treetree.pnghl7:doseQuantity
IVL_PQNPMedi...rder
Treetree.pnghl7:rateQuantity
IVL_PQNPMedi...rder
Treetree.pnghl7:maxDoseQuantity
RTO_PQ_PQ0 … 1Medi...rder
Treetree.pnghl7:administrationUnitCode
CENPMedi...rder
Treetree.pnghl7:subject
0 … 1CThe patient, subject to requested dispenses or subject to substances being administered to.
Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)		Medi...rder
 ConstraintCondition: This can be omitted if the patient context that is provided in the CDA header is identical to the subject
Choice1 … 1Elements to choose from:
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (simple)
Contains 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)		Medi...rder
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (detail)
Contains 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)		Medi...rder
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Treetree.pnghl7:author
0 … *Prescriber: A party that originates the order and therefore has responsibility for the information given in the order.
Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)		Medi...rder
Treetree.pnghl7:participant
0 … 1Record Target: indicates the person who's medical record holds the documentation of this medication statement. This element is only populated when the document is placed in a medical record of someone other than the patient (subject).
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...rder
where [@typeCode='RCT']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRCT
Treetree.pnghl7:participant
0 … 1Verifier: The person or organization that has primary responsibility for the order. The responsible party is not necessarily present in an action, but is accountable for the action through the power to delegate.
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...rder
where [@typeCode='VRF']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FVRF
Treetree.pnghl7:entryRelationship
0 … *CSubordinate Substance Administration Request as a component of the overall order.
At least one subordinated Substance Administration should be present to convey information about dosages (dose, frequency of intakes,..) unless dosage is unknown.
Subordinated Substance Administration elements can be also used either to handle split dosing, or to support combination medications.
Contains 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (DYNAMIC)		Medi...rder
where [hl7:substanceAdministration]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 ConstraintAt least one subordinate element SHALL be present.
 Example<entryRelationship typeCode="COMP">
  <!-- component: Subordinate Substance Administration Request. -->
  <substanceAdministration classCode="SBADM" moodCode="RQO">
    <templateId root="2.16.840.1.113883.10.21.4.6"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treeblank.pngTreetree.pnghl7:sequenceNumber
INT0 … 1Sequence number of the Subordinate Substance Administration.Medi...rder
Treetree.pnghl7:entryRelationship
0 … 1RDispense Request as a component of the overall order. This element is used in the medication order when the dispense request information contains additional information to support a fully specified medication prescription. For example, to include the validity period of the dispense or the organization to dispense the medication.
Contains 2.16.840.1.113883.10.21.4.2 UV Dispense Request (DYNAMIC)		Medi...rder
where [hl7:supply]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 Example<entryRelationship typeCode="COMP">
  <!-- component: The Dispense Request is a component of the overall order. -->
  <supply classCode="SPLY" moodCode="RQO">
    <templateId root="2.16.840.1.113883.10.21.4.2"/>    <!-- .. -->
  </supply></entryRelationship>
Choice0 … *Elements to choose from:
  • hl7:entryRelationship containing template 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)
  • hl7:entryRelationship containing template 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)		Medi...rder
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<hl7:entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <!-- template 2.16.840.1.113883.10.21.4.3 'UV ClinicalStatement Observation' (2016-05-01T00:00:00) -->
</hl7:entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...rder
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)		Medi...rder
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <act>
    <!-- Clinical Statement Minimal -->
  </act></entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...rder
Treetree.pnghl7:entryRelationship
0 … *RPertinent Information: Specifies any pertinent information (observation) relevant to the order.
Contains 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)		Medi...rder
Treeblank.pngTreetree.png@typeCode
cs1 … 1FPERT
 Example<entryRelationship typeCode="PERT">
  <observation>
    <!-- Clinical Statement Observation -->
  </observation></entryRelationship>
Treetree.pnghl7:entryRelationship
0 … 1RPermission: The order can be the subject of the permissions related to substitution.
Contains 2.16.840.1.113883.10.21.4.5 UV Substitution Permission (DYNAMIC)		Medi...rder
where [hl7:act]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
Treetree.pnghl7:entryRelationship
0 … 1REncounter: Used to link an order to a specific encounter.
Contains 2.16.840.1.113883.10.21.4.4 UV ClinicalStatement Encounter (DYNAMIC)		Medi...rder
where [hl7:encounter]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 Example<encounter classCode="ENC" moodCode="EVN">
  <id/>  <code code="..."/></encounter>
Treetree.pnghl7:entryRelationship
0 … *Annotations: The Medication Order can be the subject of annotations.
Contains 2.16.840.1.113883.10.21.4.12 UV Comment Activity (DYNAMIC)		Medi...rder
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
Treetree.pnghl7:precondition
0 … *Precondition: A requirement to be true before the SubstanceAdministration is performed.
Contains 2.16.840.1.113883.10.12.329 CDA Precondition (DYNAMIC)		Medi...rder


UV Medication Statement

The following graph gives an overview of the high-level template components of this template, followed by the actual definition.

  1. Entry
     UV Medication Statement (2.16.840.1.113883.10.21.4.7)
    1. Entry
       UV Use Period (2.16.840.1.113883.10.21.9.1)
    2. Entry
       CDA Subject (Body) (2.16.840.1.113883.10.12.320)
    3. Entry
       UV Medication Information (simple) (2.16.840.1.113883.10.21.4.10)
      1. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    4. Entry
       UV Medication Information (detail) (2.16.840.1.113883.10.21.4.11)
      1. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      2. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      3. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      4. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      5. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      6. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      7. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      8. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      9. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      10. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      11. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      12. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      13. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    5. Entry
       CDA Author (Body) (2.16.840.1.113883.10.12.318)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
      2. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      3. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    6. *
       CDA AssignedEntity (2.16.840.1.113883.10.12.153)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
      2. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    7. Entry
       CDA RelatedEntity (2.16.840.1.113883.10.12.316)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
    8. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    9. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    10. Entry
       UV Subordinate Substance Administration (2.16.840.1.113883.10.21.4.6)
    11. Entry
       UV Medication Order Reference (2.16.840.1.113883.10.21.4.8)
      1. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
    12. Entry
       UV Dispense Event Reference (2.16.840.1.113883.10.21.4.9)
    13. Entry
       UV ClinicalStatement Observation (2.16.840.1.113883.10.21.4.3)
      1. Entry
         CDA Subject (Body) (2.16.840.1.113883.10.12.320)
      2. Entry
         CDA Specimen (2.16.840.1.113883.10.12.322)
      3. Entry
         CDA Performer (Body) (2.16.840.1.113883.10.12.323)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
      4. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
      5. Entry
         CDA Informant (Body) (2.16.840.1.113883.10.12.319)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
        2. Entry
           CDA RelatedEntity (2.16.840.1.113883.10.12.316)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
      6. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      7. Entry
         CDA Reference (2.16.840.1.113883.10.12.324)
        1. Entry
           CDA ExternalAct (2.16.840.1.113883.10.12.325)
        2. Entry
           CDA ExternalObservation (2.16.840.1.113883.10.12.326)
        3. Entry
           CDA ExternalProcedure (2.16.840.1.113883.10.12.327)
        4. Entry
           CDA ExternalDocument (2.16.840.1.113883.10.12.328)
      8. Entry
         CDA Precondition (2.16.840.1.113883.10.12.329)
    14. Entry
       IPS Internal Reference (2.16.840.1.113883.10.22.4.31)

The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition

Id2.16.840.1.113883.10.21.4.7Effective Date2023‑01‑30 08:32:34
Other versions this id:
  • Kblank.png UVMedicationstatement as of 2021‑08‑04 14:09:15
  • Kblank.png UVMedicationstatement as of 2017‑05‑01
StatusKyellow.png DraftVersion Label2023
NameUVMedicationstatementDisplay NameUV Medication Statement
Description
Universal Medication Statement: Recording a "medication statement" is an activity that can be performed by a variety of healthcare professionals, or the patient, or non-healthcare professionals. Examples of recording medication statements include taking a patient's medication history, recording reported use of medications where the source of the patient information is from a third party and not the patient e.g. a family member when the patient is unable to communicate their medication history.
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.7
LabelMedicationStatement
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 13 templates
Uses as NameVersion
2.16.840.1.113883.10.21.9.1IncludeKyellow.png UV Use Period (2023)DYNAMIC
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.21.4.10ContainmentKorange.png UV Medication Information (simple) (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.11ContainmentKyellow.png UV Medication Information (detail) (2023)DYNAMIC
2.16.840.1.113883.10.12.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
2.16.840.1.113883.10.12.153ContainmentKgreen.png CDA AssignedEntityDYNAMIC
2.16.840.1.113883.10.12.316ContainmentKgreen.png CDA RelatedEntityDYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
2.16.840.1.113883.10.21.4.6ContainmentKyellow.png UV Subordinate Substance Administration (2023)DYNAMIC
2.16.840.1.113883.10.21.4.8ContainmentKorange.png UV Medication Order Reference (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.9ContainmentKorange.png UV Dispense Event Reference (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.3ContainmentKorange.png UV ClinicalStatement Observation (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.22.4.31ContainmentKorange.png IPS Internal Reference (STU1)DYNAMIC
RelationshipVersion: template 2.16.840.1.113883.10.21.4.7 UV Medication Statement (2021‑08‑04 14:09:15)
Version: template 2.16.840.1.113883.10.21.4.7 UV Medication Statement (2017‑05‑01)
Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.7"/>  <id root="1.2.3.99.99.99" extension="988437489739"/>  <code code="..." codeSystem="..."/>  <text>...</text>  <statusCode code="active"/>  <effectiveTime value="..."/>  <repeatNumber value="..."/>  <routeCode code="SOAK" codeSystem="2.16.840.1.113883.5.112" displayName="Immersion (soak)"/>  <approachSiteCode code="..." codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="PUFF" displayName="Puff" codeSystem="2.16.840.1.113883.5.85"/>  <consumable typeCode="CSM">
    <!-- Consumable -->
  </consumable>  <participant typeCode="DEV">
    <!-- Device -->
  </participant>  <participant typeCode="LOC">
    <!-- Location -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- Subordinate Substance Administrations -->
  </entryRelationship>  <entryRelationship typeCode="COMP">
    <!-- Annotations -->
  </entryRelationship>  <precondition>
    <!-- Precondition -->
  </precondition></substanceAdministration>
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.7"/>  <id root="1.2.3.999" extension="--example only--"/>  <code code="DRUG" displayName="Drug therapy" codeSystem="2.16.840.1.113883.5.4"/>  <text/>  <statusCode code="active"/>  <!-- include template 'UV Use Period' (dynamic) .. O -->
  <repeatNumber/>  <routeCode code="SOAK" displayName="Immersion (soak)" codeSystem="2.16.840.1.113883.5.112"/>  <approachSiteCode code="--code--" codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="APPFUL" displayName="Applicatorful" codeSystem="2.16.840.1.113883.5.85"/>  <subject>
    <!-- template 'CDA Subject (Body)' (dynamic) -->
  </subject>  <consumable typeCode="CSM">
    <!-- template 2.16.840.1.113883.10.12.312 'CDA ManufacturedProduct' (dynamic) -->
  </consumable>  <!-- choice: 1..1
element hl7:author
element hl7:participant[@typeCode='AUT']
-->
  <!-- choice: 0..1
element hl7:informant[exists(hl7:assignedEntity)]
element hl7:participant[@typeCode='INF']
element hl7:informant[exists(hl7:relatedEntity)]
-->
  <participant typeCode="RCT">
    <!-- template 2.16.840.1.113883.10.12.321 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="VRF">
    <!-- template 2.16.840.1.113883.10.12.321 'CDA Participant (Body)' (dynamic) -->
  </participant>  <entryRelationship typeCode="COMP">
    <sequenceNumber value="1"/>    <!-- template 2.16.840.1.113883.10.21.4.6 'Subordinate Substance Administration' (dynamic) -->
  </entryRelationship>  <entryRelationship typeCode="REFR">
    <!-- template 2.16.840.1.113883.10.21.4.8 'UV Medication Order Reference' (dynamic) -->
  </entryRelationship>  <entryRelationship typeCode="REFR">
    <!-- template 2.16.840.1.113883.10.21.4.9 'UV Dispense Event Reference' (dynamic) -->
  </entryRelationship></substanceAdministration>
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.7"/>  <id root="1.2.3.99.99.99" extension="988437489739"/>  <code code="..." codeSystem="..."/>  <text>...</text>  <statusCode code="active"/>  <effectiveTime value="..."/>  <repeatNumber value="..."/>  <routeCode code="SOAK" codeSystem="2.16.840.1.113883.5.112" displayName="Immersion (soak)"/>  <approachSiteCode code="..." codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="PUFF" displayName="Puff" codeSystem="2.16.840.1.113883.5.85"/>  <consumable typeCode="CSM">
    <!-- Consumable -->
  </consumable>  <participant typeCode="DEV">
    <!-- Device -->
  </participant>  <participant typeCode="LOC">
    <!-- Location -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- Subordinate Substance Administrations -->
  </entryRelationship>  <entryRelationship typeCode="COMP">
    <!-- Annotations -->
  </entryRelationship>  <precondition>
    <!-- Precondition -->
  </precondition></substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
Medi...ment
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1REVN will be used to record a medication statement where the patient is currently taking or has taken the medication in the past.
INT will be used to record a medication statement where the patient plans to take the medication or be administered the medication in the future.
 CONF
@moodCode shall be "EVN"
or
@moodCode shall be "INT"
Treetree.pnghl7:templateId
II1 … 1MMedi...ment
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.7
Treetree.pnghl7:id
II0 … *RMedi...ment
Treetree.pnghl7:code
CD (preferred)0 … 1RThe code element is valorized with the ACT code DRUG; FD or IMMUNIZ unless it is used for asserting the known absence of medication treatments or no information about them.Medi...ment
 CONF
The value of @code comes preferably from value set 2.16.840.1.113883.1.11.19708 ActSubstanceAdministrationCode (DYNAMIC)
or
The value of @code comes preferably from value set 2.16.840.1.113883.11.21.5 Unknown or absent medication (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1Medi...ment
Treetree.pnghl7:statusCode
CS (required)1 … 1MMedi...ment
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
Included from 2.16.840.1.113883.10.21.9.1 UV Use Period (DYNAMIC)
Choice1 … 1
The effectiveTime element encodes the use period of the medication, it is always expressed as an interval of time.
It may be expressed using the low and high OR with the width element.
The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high][not(hl7:width)]
  • hl7:effectiveTime[hl7:width][not(hl7:low|hl7:high)]
  • hl7:effectiveTime[hl7:low | hl7:width][not(hl7:high)]
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 1: specified interval


The low and high values of the first effectiveTime element represent the start and stop times for the medication. The low value represents the start time, and the high value represents the stop time. If either the low or the high value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.

In case of unbounded period (continuous therapy) the high element will be valued with the nullFlavor attribute to NA.


The high value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the low value. The rationale is that a provider, seeing a prescription that has not been refilled would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.		Medi...ment
where [hl7:low or
[not(hl7:width)]
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
continous therapy
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1RMedi...ment
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 2: 'floating' period:
The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy)		Medi...ment
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
NPMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
NPMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:center
NPMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...ment
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 3: anchored period:
The width element is used to specify a period of (actual or intended) administration anchored to a specific date (e.g. a two weeks therapy starting today)		Medi...ment
where [hl7:low or
[not(hl7:high)]
 Example
2 week period starting on 2013-03-21
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS0 … 1CMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...ment
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treetree.pnghl7:repeatNumber
IVL_INT0 … 1Medi...ment
Treetree.pnghl7:routeCode
CE (example)0 … 1Medi...ment
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.14581 RouteOfAdministration (DYNAMIC)
Treetree.pnghl7:approachSiteCode
CD (example)0 … *Medi...ment
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.19724 HumanSubstanceAdministrationSite (DYNAMIC)
Treetree.pnghl7:doseQuantity
IVL_PQNPMedi...ment
Treetree.pnghl7:rateQuantity
IVL_PQNPMedi...ment
Treetree.pnghl7:maxDoseQuantity
RTO_PQ_PQ0 … 1Medi...ment
Treetree.pnghl7:administrationUnitCode
CENPMedi...ment
Treetree.pnghl7:subject
0 … 1CPatient: The patient that takes the medicine.
Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)		Medi...ment
 ConstraintCondition: This can be omitted if the patient context that is provided in the CDA header is identical to the subject
ChoiceElements to choose from:
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (simple)
Contains 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)		Medi...ment
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (detail)
Contains 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)		Medi...ment
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Choice
Required author of the medication statement: healthcare professional or patient
Elements to choose from:
  • hl7:author containing template 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)
  • hl7:participant[@typeCode='AUT']
Treeblank.pngTreetree.pnghl7:author
Use this if the author of the medication statement is a healthcare professional
Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)		Medi...ment
 Example
Author of the medication statement is a healthcare professional
<author>
  <time value="20170221"/>  <assignedAuthor>
    <id root="1.2.3.99.99.99" extension="75487435893498"/>    <assignedPerson>
      <name>
        <given qualifier="IN">Ampu</given>        <prefix qualifier="VV">L.</prefix>        <family>Lee</family>      </name>    </assignedPerson>  </assignedAuthor></author>
Treeblank.pngTreetree.pnghl7:participant
Use this if the author of the medication statement is the patientMedi...ment
where [@typeCode='AUT']
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FAUT
 Example
Author of the medication statement is the patient
<participant typeCode="AUT">
  <time value="20170121091548"/>  <participantRole classCode="PAT"/></participant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:time
TS1 … 1RMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:participantRole
1 … 1MMedi...ment
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPAT
Choice
Optional informants of the medication statement: healthcare professional or patient contact party (related party)
Elements to choose from:
  • hl7:informant[exists(hl7:assignedEntity)]
  • hl7:participant[@typeCode='INF']
  • hl7:informant[exists(hl7:relatedEntity)]
Treeblank.pngTreetree.pnghl7:informant
Use this if the informant of the medication statement is a healthcare professionalMedi...ment
where [exists(hl7:assignedEntity)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs0 … 1FINF
Treeblank.pngTreeblank.pngTreetree.png@context​Control​Code
cs0 … 1FOP
 Example
Informant of the medication statement is a healthcare professional
<informant>
  <assignedEntity>
    <id root="1.2.3.99.99.99" extension="75487435893498"/>    <assignedPerson>
      <name>
        <given qualifier="IN">Ampu</given>        <prefix qualifier="VV">L.</prefix>        <family>Lee</family>      </name>    </assignedPerson>  </assignedEntity></informant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:assignedEntity
1 … 1Contains 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC)Medi...ment
Treeblank.pngTreetree.pnghl7:participant
Use this if the informant of the medication statement is the patientMedi...ment
where [@typeCode='INF']
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FINF
 Example
Informant of the medication statement is the patient
<participant typeCode="INF">
  <time value="20170121091548"/>  <participantRole classCode="PAT"/></participant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:time
TS1 … 1RMedi...ment
Treeblank.pngTreeblank.pngTreetree.pnghl7:participantRole
1 … 1MMedi...ment
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPAT
Treeblank.pngTreetree.pnghl7:informant
Use this if the informant of the medication statement is a contact party (related party)Medi...ment
where [exists(hl7:relatedEntity)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs0 … 1FINF
Treeblank.pngTreeblank.pngTreetree.png@context​Control​Code
cs0 … 1FOP
 Example
Informant of the medication statement is a contact party (related party)
<informant>
  <relatedEntity classCode="AGNT">
    <relatedPerson classCode="PSN" determinerCode="INSTANCE">
      <name>
        <!-- .. -->
      </name>    </relatedPerson>  </relatedEntity></informant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:relatedEntity
1 … 1Contains 2.16.840.1.113883.10.12.316 CDA RelatedEntity (DYNAMIC)Medi...ment
Treetree.pnghl7:participant
0 … 1Record Target: indicates the person who's medical record holds the documentation of this medication statement. This element is only populated when the document is placed in a medical record of someone other than the patient (subject).
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...ment
where [@typeCode='RCT']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRCT
Treetree.pnghl7:participant
0 … 1Verifier: The person or organization that has primary responsibility for the medication statement. The responsible party is not necessarily present in an action, but is accountable for the action through the power to delegate.
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...ment
where [@typeCode='VRF']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FVRF
Treetree.pnghl7:entryRelationship
0 … *CSubordinate Substance Administration Statament as a component of the overall medication statement.
At least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,..) unless medications are unknown or known absent.
Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.
Contains 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (DYNAMIC)		Medi...ment
where [exists(hl7:substanceAdministration)]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 ConstraintAt least one subordinate <substanceAdministration> element SHALL be present unless medications are unknown or known absent.</substanceAdministration>
 Example<entryRelationship typeCode="COMP">
  <!-- component: Subordinate Substance Administration Statement. -->
  <substanceAdministration classCode="SBADM" moodCode="EVN">
    <templateId root="2.16.840.1.113883.10.21.4.6"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treeblank.pngTreetree.pnghl7:sequenceNumber
INT0 … 1Sequence number of the Subordinate Substance Administration.Medi...ment
Treetree.pnghl7:entryRelationship
0 … *RMedication Order Reference.
Contains 2.16.840.1.113883.10.21.4.8 UV Medication Order Reference (DYNAMIC)		Medi...ment
where [@typeCode='REFR' and exists(hl7:substanceAdministration)]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
 Example<entryRelationship typeCode="REFR">
  <substanceAdministration classCode="SBADM" moodCode="RQO">
    <templateId root="2.16.840.1.113883.10.21.4.8"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treetree.pnghl7:entryRelationship
0 … *RDispense Event Reference.
Contains 2.16.840.1.113883.10.21.4.9 UV Dispense Event Reference (DYNAMIC)		Medi...ment
where [@typeCode='REFR' and exists(hl7:supply)]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
 Example<entryRelationship typeCode="REFR">
  <supply classCode="SPLY" moodCode="EVN">
    <templateId root="2.16.840.1.113883.10.21.4.9"/>    <!-- .. -->
  </supply></entryRelationship>
ChoiceElements to choose from:
  • hl7:entryRelationship[@typeCode='RSON' and exists(hl7:observation)] containing template 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)
  • hl7:entryRelationship[@typeCode='RSON' and exists(hl7:act)] containing template 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)		Medi...ment
where [@typeCode='RSON' and exists(hl7:observation)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<cda:entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <!-- template 2.16.840.1.113883.10.21.4.3 'UV ClinicalStatement Observation' (2016-05-01T00:00:00) -->
</cda:entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...ment
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)		Medi...ment
where [@typeCode='RSON' and exists(hl7:act)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <act>
    <!-- Clinical Statement Minimal -->
  </act></entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...ment


UV Medication Administration

The following graph gives an overview of the high-level template components of this template, followed by the actual definition.

  1. Entry
     UV Medication Administration (2.16.840.1.113883.10.21.4.13)
    1. Entry
       UV Use Period (2.16.840.1.113883.10.21.9.1)
    2. Entry
       CDA Subject (Body) (2.16.840.1.113883.10.12.320)
    3. Entry
       UV Medication Information (simple) (2.16.840.1.113883.10.21.4.10)
      1. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    4. Entry
       UV Medication Information (detail) (2.16.840.1.113883.10.21.4.11)
      1. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      2. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      3. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      4. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      5. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      6. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      7. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      8. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      9. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      10. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      11. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      12. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      13. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    5. Entry
       CDA Author (Body) (2.16.840.1.113883.10.12.318)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
      2. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      3. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    6. *
       CDA AssignedEntity (2.16.840.1.113883.10.12.153)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
      2. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    7. Entry
       CDA RelatedEntity (2.16.840.1.113883.10.12.316)
      1. *
         CDA Person (2.16.840.1.113883.10.12.152)
    8. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    9. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    10. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    11. Entry
       UV Subordinate Substance Administration (2.16.840.1.113883.10.21.4.6)
    12. Entry
       UV Substitution Event Adminstration (2.16.840.1.113883.10.21.4.14)
    13. Entry
       UV Medication Order Reference (2.16.840.1.113883.10.21.4.8)
      1. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
    14. Entry
       UV Dispense Event Reference (2.16.840.1.113883.10.21.4.9)
    15. Entry
       UV ClinicalStatement Observation (2.16.840.1.113883.10.21.4.3)
      1. Entry
         CDA Subject (Body) (2.16.840.1.113883.10.12.320)
      2. Entry
         CDA Specimen (2.16.840.1.113883.10.12.322)
      3. Entry
         CDA Performer (Body) (2.16.840.1.113883.10.12.323)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
      4. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
      5. Entry
         CDA Informant (Body) (2.16.840.1.113883.10.12.319)
        1. *
           CDA AssignedEntity (2.16.840.1.113883.10.12.153)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
          2. *
             CDA Organization (2.16.840.1.113883.10.12.151)
        2. Entry
           CDA RelatedEntity (2.16.840.1.113883.10.12.316)
          1. *
             CDA Person (2.16.840.1.113883.10.12.152)
      6. Entry
         CDA Participant (Body) (2.16.840.1.113883.10.12.321)
        1. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        2. Entry
           CDA PlayingEntity (2.16.840.1.113883.10.12.313)
      7. Entry
         CDA Reference (2.16.840.1.113883.10.12.324)
        1. Entry
           CDA ExternalAct (2.16.840.1.113883.10.12.325)
        2. Entry
           CDA ExternalObservation (2.16.840.1.113883.10.12.326)
        3. Entry
           CDA ExternalProcedure (2.16.840.1.113883.10.12.327)
        4. Entry
           CDA ExternalDocument (2.16.840.1.113883.10.12.328)
      8. Entry
         CDA Precondition (2.16.840.1.113883.10.12.329)
    16. Entry
       IPS Internal Reference (2.16.840.1.113883.10.22.4.31)

The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition

Id2.16.840.1.113883.10.21.4.13Effective Date2023‑01‑30 08:31:37
Other versions this id:
  • Kblank.png UVMedicationadministration as of 2019‑02‑17
StatusKyellow.png DraftVersion Label2023
NameUVMedicationadministrationDisplay NameUV Medication Administration
Description
Universal Medication Administration: This includes information about an actual administration of a medication. Medication administrations include information about medication use where the medications have been prescribed or not prescribed. Medication administrations may include "negative" statements such as "the patient was not given medication ABC". Due to implementation experience, dosage information is always put into the subordinate substance administration entries.
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.13
LabelMedicationAdministration
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 14 templates
Uses as NameVersion
2.16.840.1.113883.10.21.9.1IncludeKyellow.png UV Use Period (2023)DYNAMIC
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.21.4.10ContainmentKorange.png UV Medication Information (simple) (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.11ContainmentKyellow.png UV Medication Information (detail) (2023)DYNAMIC
2.16.840.1.113883.10.12.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
2.16.840.1.113883.10.12.153ContainmentKgreen.png CDA AssignedEntityDYNAMIC
2.16.840.1.113883.10.12.316ContainmentKgreen.png CDA RelatedEntityDYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
2.16.840.1.113883.10.21.4.6ContainmentKyellow.png UV Subordinate Substance Administration (2023)DYNAMIC
2.16.840.1.113883.10.21.4.14ContainmentKyellow.png UV Substitution Event Adminstration (2023)DYNAMIC
2.16.840.1.113883.10.21.4.8ContainmentKorange.png UV Medication Order Reference (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.9ContainmentKorange.png UV Dispense Event Reference (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.3ContainmentKorange.png UV ClinicalStatement Observation (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.22.4.31ContainmentKorange.png IPS Internal Reference (STU1)DYNAMIC
RelationshipVersion: template 2.16.840.1.113883.10.21.4.13 UV Medication Administration (2019‑02‑17)
Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.13"/>  <id root="1.2.3.99.99.99" extension="988437489739"/>  <code code="DRUG" codeSystem="2.16.840.1.113883.5.4"/>  <text>...</text>  <statusCode code="active"/>  <effectiveTime value="..."/>  <repeatNumber value="..."/>  <routeCode code="SOAK" codeSystem="2.16.840.1.113883.5.112" displayName="Immersion (soak)"/>  <approachSiteCode code="..." codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="PUFF" displayName="Puff" codeSystem="2.16.840.1.113883.5.85"/>  <consumable typeCode="CSM">
    <!-- Consumable -->
  </consumable>  <participant typeCode="DEV">
    <!-- Device -->
  </participant>  <participant typeCode="LOC">
    <!-- Location -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- Subordinate Substance Administrations -->
  </entryRelationship>  <entryRelationship typeCode="COMP">
    <!-- Annotations -->
  </entryRelationship>  <precondition>
    <!-- Precondition -->
  </precondition></substanceAdministration>
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.13"/>  <id root="1.2.3.999" extension="--example only--"/>  <code code="DRUG" codeSystem="2.16.840.1.113883.5.4"/>  <text>...</text>  <statusCode code="active"/>  <!-- include template 'UV Use Period' (dynamic) .. O -->
  <routeCode code="SOAK" displayName="Immersion (soak)" codeSystem="2.16.840.1.113883.5.112"/>  <approachSiteCode code="--code--" codeSystem="2.16.840.1.113883.5.1052"/>  <administrationUnitCode code="APPFUL" displayName="Applicatorful" codeSystem="2.16.840.1.113883.5.85"/>  <subject>
    <!-- template 'CDA Subject (Body)' (dynamic) -->
  </subject>  <consumable typeCode="CSM">
    <!-- template 2.16.840.1.113883.10.12.312 'CDA ManufacturedProduct' (dynamic) -->
  </consumable>  <!-- choice: 1..1
element hl7:author
element hl7:participant[@typeCode='AUT']
-->
  <participant typeCode="RCT">
    <!-- template 2.16.840.1.113883.10.12.321 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="VRF">
    <!-- template 2.16.840.1.113883.10.12.321 'CDA Participant (Body)' (dynamic) -->
  </participant>  <entryRelationship typeCode="COMP">
    <sequenceNumber value="1"/>    <!-- template 2.16.840.1.113883.10.21.4.6 'Subordinate Substance Administration' (dynamic) -->
  </entryRelationship>  <entryRelationship typeCode="REFR">
    <!-- template 2.16.840.1.113883.10.21.4.8 'UV Medication Order Reference' (dynamic) -->
  </entryRelationship>  <entryRelationship typeCode="REFR">
    <!-- template 2.16.840.1.113883.10.21.4.9 'UV Dispense Event Reference' (dynamic) -->
  </entryRelationship></substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
Medi...tion
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1MMedi...tion
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.13
Treetree.pnghl7:id
II0 … *RMedi...tion
 ConstraintIf the use case requires updates on the order, the ID shall be made mandatory.
Treetree.pnghl7:code
CD (extensible)0 … 1The code element is valorized with the ACT code from the indicated value set unless it is used for asserting the known absence of medication treatments or no information about them.Medi...tion
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.1.11.19708 ActSubstanceAdministrationCode (DYNAMIC)
or
The value of @code should be drawn from value set 2.16.840.1.113883.11.21.5 Unknown or absent medication (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1Medi...tion
Treetree.pnghl7:statusCode
CS (required)1 … 1MMedi...tion
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
Included from 2.16.840.1.113883.10.21.9.1 UV Use Period (DYNAMIC)
Choice1 … 1
The effectiveTime element encodes the use period of the medication, it is always expressed as an interval of time.
It may be expressed using the low and high OR with the width element.
The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high][not(hl7:width)]
  • hl7:effectiveTime[hl7:width][not(hl7:low|hl7:high)]
  • hl7:effectiveTime[hl7:low | hl7:width][not(hl7:high)]
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 1: specified interval


The low and high values of the first effectiveTime element represent the start and stop times for the medication. The low value represents the start time, and the high value represents the stop time. If either the low or the high value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.

In case of unbounded period (continuous therapy) the high element will be valued with the nullFlavor attribute to NA.


The high value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the low value. The rationale is that a provider, seeing a prescription that has not been refilled would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.		Medi...tion
where [hl7:low or
[not(hl7:width)]
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
continous therapy
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1RMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1RMedi...tion
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 2: 'floating' period:
The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy)		Medi...tion
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
NPMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:high
NPMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:center
NPMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...tion
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 3: anchored period:
The width element is used to specify a period of (actual or intended) administration anchored to a specific date (e.g. a two weeks therapy starting today)		Medi...tion
where [hl7:low or
[not(hl7:high)]
 Example
2 week period starting on 2013-03-21
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:low
IVXB_TS0 … 1CMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:width
PQ1 … 1RMedi...tion
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treetree.pnghl7:repeatNumber
IVL_INT0 … 1Medi...tion
Treetree.pnghl7:routeCode
CE (example)0 … 1Medi...tion
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.14581 RouteOfAdministration (DYNAMIC)
Treetree.pnghl7:approachSiteCode
CD (example)0 … *Medi...tion
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.19724 HumanSubstanceAdministrationSite (DYNAMIC)
Treetree.pnghl7:doseQuantity
IVL_PQNPMedi...tion
Treetree.pnghl7:rateQuantity
IVL_PQNPMedi...tion
Treetree.pnghl7:maxDoseQuantity
RTO_PQ_PQ0 … 1Medi...tion
Treetree.pnghl7:administrationUnitCode
CENPMedi...tion
Treetree.pnghl7:subject
0 … 1CPatient: The patient that takes the medicine.
Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)		Medi...tion
 ConstraintCondition: This can be omitted if the patient context that is provided in the CDA header is identical to the subject
Choice1 … 1Elements to choose from:
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)
  • hl7:consumable containing template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (simple)
Contains 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)		Medi...tion
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Treeblank.pngTreetree.pnghl7:consumable
0 … 1RConsumable: The medication that is administered (detail)
Contains 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)		Medi...tion
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FCSM
Choice1 … 1
Required author of the medication administration: healthcare professional or patient
Elements to choose from:
  • hl7:author containing template 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)
  • hl7:participant[@typeCode='AUT']
Treeblank.pngTreetree.pnghl7:author
Use this if the author of the medication statement is a healthcare professional
Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)		Medi...tion
 Example
Author of the medication statement is a healthcare professional
<author>
  <time value="20170221"/>  <assignedAuthor>
    <id root="1.2.3.99.99.99" extension="75487435893498"/>    <assignedPerson>
      <name>
        <given qualifier="IN">Ampu</given>        <prefix qualifier="VV">L.</prefix>        <family>Lee</family>      </name>    </assignedPerson>  </assignedAuthor></author>
Treeblank.pngTreetree.pnghl7:participant
Use this if the author of the medication administration is the patientMedi...tion
where [@typeCode='AUT']
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FAUT
 Example
Author of the medication statement is the patient
<participant typeCode="AUT">
  <time value="20170121091548"/>  <participantRole classCode="PAT"/></participant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:time
TS1 … 1RMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:participantRole
1 … 1MMedi...tion
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPAT
Choice0 … 1
Optional informants of the medication administration: healthcare professional or patient contact party (related party)
Elements to choose from:
  • hl7:informant[exists(hl7:assignedEntity)]
  • hl7:participant[@typeCode='INF']
  • hl7:informant[exists(hl7:relatedEntity)]
Treeblank.pngTreetree.pnghl7:informant
Use this if the informant of the medication statement is a healthcare professionalMedi...tion
where [exists(hl7:assignedEntity)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs0 … 1FINF
Treeblank.pngTreeblank.pngTreetree.png@context​Control​Code
cs0 … 1FOP
 Example
Informant of the medication statement is a healthcare professional
<informant>
  <assignedEntity>
    <id root="1.2.3.99.99.99" extension="75487435893498"/>    <assignedPerson>
      <name>
        <given qualifier="IN">Ampu</given>        <prefix qualifier="VV">L.</prefix>        <family>Lee</family>      </name>    </assignedPerson>  </assignedEntity></informant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:assignedEntity
1 … 1Contains 2.16.840.1.113883.10.12.153 CDA AssignedEntity (DYNAMIC)Medi...tion
Treeblank.pngTreetree.pnghl7:participant
Use this if the informant of the medication statement is the patientMedi...tion
where [@typeCode='INF']
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FINF
 Example
Informant of the medication statement is the patient
<participant typeCode="INF">
  <time value="20170121091548"/>  <participantRole classCode="PAT"/></participant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:time
TS1 … 1RMedi...tion
Treeblank.pngTreeblank.pngTreetree.pnghl7:participantRole
1 … 1MMedi...tion
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPAT
Treeblank.pngTreetree.pnghl7:informant
Use this if the informant of the medication statement is a contact party (related party)Medi...tion
where [exists(hl7:relatedEntity)]
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs0 … 1FINF
Treeblank.pngTreeblank.pngTreetree.png@context​Control​Code
cs0 … 1FOP
 Example
Informant of the medication statement is a contact party (related party)
<informant>
  <relatedEntity classCode="AGNT">
    <relatedPerson classCode="PSN" determinerCode="INSTANCE">
      <name>
        <!-- .. -->
      </name>    </relatedPerson>  </relatedEntity></informant>
Treeblank.pngTreeblank.pngTreetree.pnghl7:relatedEntity
1 … 1Contains 2.16.840.1.113883.10.12.316 CDA RelatedEntity (DYNAMIC)Medi...tion
Treetree.pnghl7:participant
0 … 1Record Target: indicates the person who's medical record holds the documentation of this medication statement. This element is only populated when the document is placed in a medical record of someone other than the patient (subject).
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...tion
where [@typeCode='RCT']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRCT
Treetree.pnghl7:participant
0 … 1Verifier: The person or organization that has primary responsibility for the medication statement. The responsible party is not necessarily present in an action, but is accountable for the action through the power to delegate.
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...tion
where [@typeCode='VRF']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FVRF
Treetree.pnghl7:participant
0 … 1Location
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		Medi...tion
where [@typeCode='LOC']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FLOC
Treetree.pnghl7:entryRelationship
0 … *CSubordinate Substance Administration Statament as a component of the overall medication statement.
At least one subordinated <substanceAdministration> has to be present to convey information about dosages (dose, frequency of intakes,..) unless medications are unknown or known absent.
Subordinated <substanceAdministration> elements can be also used either to handle split dosing, or to support combination medications.
Contains 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (DYNAMIC)		Medi...tion
where [hl7:substanceAdministration]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 ConstraintAt least one subordinate <substanceAdministration> element SHALL be present unless medications are unknown or known absent.</substanceAdministration>
 Example<entryRelationship typeCode="COMP">
  <!-- component: Subordinate Substance Administration Statement. -->
  <substanceAdministration classCode="SBADM" moodCode="EVN">
    <templateId root="2.16.840.1.113883.10.21.4.6"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treeblank.pngTreetree.pnghl7:sequenceNumber
INT0 … 1Sequence number of the Subordinate Substance Administration.Medi...tion
Treetree.pnghl7:entryRelationship
0 … 1RInformation about any substitutions in medication that have been made.
Contains 2.16.840.1.113883.10.21.4.14 UV Substitution Event Adminstration (DYNAMIC)		Medi...tion
where [@typeCode='COMP']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP
 Example<entryRelationship typeCode="COMP">
  <act classCode="ACT" moodCode="EVN">
    <!-- .. -->
  </act></entryRelationship>
Treetree.pnghl7:entryRelationship
0 … *RMedication Order Reference.
Contains 2.16.840.1.113883.10.21.4.8 UV Medication Order Reference (DYNAMIC)		Medi...tion
where [@typeCode='REFR'] [hl7:substanceAdministration]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
 Example<entryRelationship typeCode="REFR">
  <substanceAdministration classCode="SBADM" moodCode="EVN">
    <templateId root="2.16.840.1.113883.10.21.4.8"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treetree.pnghl7:entryRelationship
0 … *RDispense Event Reference.
Contains 2.16.840.1.113883.10.21.4.9 UV Dispense Event Reference (DYNAMIC)		Medi...tion
where [@typeCode='REFR'] [ [hl7:supply]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
 Example<entryRelationship typeCode="REFR">
  <supply classCode="SPLY" moodCode="EVN">
    <templateId root="2.16.840.1.113883.10.21.4.9"/>    <!-- .. -->
  </supply></entryRelationship>
Choice0 … *Elements to choose from:
  • hl7:entryRelationship containing template 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)
  • hl7:entryRelationship containing template 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.21.4.3 UV ClinicalStatement Observation (DYNAMIC)		Medi...tion
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<cda:entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <!-- template 2.16.840.1.113883.10.21.4.3 'UV ClinicalStatement Observation' (2016-05-01T00:00:00) -->
</cda:entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...tion
Treeblank.pngTreetree.pnghl7:entryRelationship
0 … *RReason: Specifies the reason (indication) for authoring the order.
Contains 2.16.840.1.113883.10.22.4.31 IPS Internal Reference (DYNAMIC)		Medi...tion
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <priorityNumber value="1"/>  <act>
    <!-- Clinical Statement Minimal -->
  </act></entryRelationship>
Treeblank.pngTreeblank.pngTreetree.pngpharm:priorityNumber
INT.​NONNEG0 … 1RIndicates the priority of this reason for the order in relation to its sibling reasons.Medi...tion


UV Medication Dispense

The following graph gives an overview of the high-level template components of this template, followed by the actual definition.

  1. Entry
     UV Medication Dispense (2.16.840.1.113883.10.21.4.15)
    1. Entry
       CDA Subject (Body) (2.16.840.1.113883.10.12.320)
    2. Entry
       UV Medication Information (simple) (2.16.840.1.113883.10.21.4.10)
      1. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    3. Entry
       UV Medication Information (detail) (2.16.840.1.113883.10.21.4.11)
      1. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      2. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      3. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      4. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      5. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      6. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      7. Entry
         UV Content (2.16.840.1.113883.10.21.4.17)
      8. Entry
         UV Generalized Medicine Class (2.16.840.1.113883.10.21.4.19)
      9. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      10. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      11. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      12. Entry
         UV Ingredient (2.16.840.1.113883.10.21.4.18)
      13. *
         CDA Organization (2.16.840.1.113883.10.12.151)
    4. Entry
       CDA Performer (Body) (2.16.840.1.113883.10.12.323)
      1. *
         CDA AssignedEntity (2.16.840.1.113883.10.12.153)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. *
           CDA Organization (2.16.840.1.113883.10.12.151)
    5. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    6. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    7. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    8. Entry
       CDA Participant (Body) (2.16.840.1.113883.10.12.321)
      1. Entry
         CDA Device (2.16.840.1.113883.10.12.315)
      2. Entry
         CDA PlayingEntity (2.16.840.1.113883.10.12.313)
    9. Entry
       UV Medication Order Reference (2.16.840.1.113883.10.21.4.8)
      1. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)
    10. Entry
       UV Comment Activity (2.16.840.1.113883.10.21.4.12)
      1. Entry
         CDA Author (Body) (2.16.840.1.113883.10.12.318)
        1. *
           CDA Person (2.16.840.1.113883.10.12.152)
        2. Entry
           CDA Device (2.16.840.1.113883.10.12.315)
        3. *
           CDA Organization (2.16.840.1.113883.10.12.151)

The boxes reflect the CDA Template Types. Symbols: * denotes templates with more than one classification, @ indicates a recursion in the definition

Id2.16.840.1.113883.10.21.4.15Effective Date2023‑01‑30 08:33:47
Other versions this id:
  • Kblank.png UVMedicationDispense as of 2023‑01‑30 08:28:25
  • Kblank.png UVMedicationDispense as of 2021‑08‑04 16:35:09
  • Kblank.png UVMedicationDispense as of 2019‑02‑17
StatusKyellow.png DraftVersion Label2023
NameUVMedicationDispenseDisplay NameUV Medication Dispense
Description
Universal Medication Dispense (Supply Event)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.15
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 7 templates
Uses as NameVersion
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.21.4.10ContainmentKorange.png UV Medication Information (simple) (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.11ContainmentKyellow.png UV Medication Information (detail) (2023)DYNAMIC
2.16.840.1.113883.10.12.323ContainmentKgreen.png CDA Performer (Body)DYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
2.16.840.1.113883.10.21.4.8ContainmentKorange.png UV Medication Order Reference (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.12ContainmentKorange.png UV Comment Activity (R1-STU2-ballot)DYNAMIC
RelationshipVersion: template 2.16.840.1.113883.10.21.4.15 UV Medication Dispense (2021‑08‑04 16:35:09)
Specialization: template 2.16.840.1.113883.10.12.309 CDA Supply (2005‑09‑07)
ref
ad1bbr-
Example
Example
<supply classCode="SPLY" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.15"/>  <id root="..." extension="--example only--"/>  <code/>  <text/>  <statusCode code="active"/>  <effectiveTime value="20170601"/>  <independentInd value="false"/>  <quantity value="1"/>  <expectedUseTime>
    <low value="20170601"/>    <low value="20170615"/>  </expectedUseTime>  <subject>
    <!-- template 'CDA Subject (Body)' (dynamic) -->
  </subject>  <product typeCode="PRD">
    <!-- template 'CDA ManufacturedProduct' (dynamic) -->
  </product>  <performer>
    <!-- template 'CDA Performer (Body)' (dynamic) -->
  </performer>  <participant typeCode="ORG">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="DST">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="RCV">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="LOC">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- template 'DispenseRequest' (dynamic) -->
  </entryRelationship></supply>
ItemDTCardConfDescriptionLabel
hl7:supply
(UVM...nse)
Treetree.png@classCode
cs1 … 1FSPLY
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1M(UVM...nse)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.15
Treetree.pnghl7:id
II0 … *(UVM...nse)
Treetree.pnghl7:code
CD (extensible)0 … 1(UVM...nse)
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.1.11.16208 ActPharmacySupplyType (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1(UVM...nse)
Treetree.pnghl7:statusCode
CS0 … 1(UVM...nse)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
Treetree.pnghl7:effectiveTime
TS0 … 1Date/Time of Dispense(UVM...nse)
Treetree.pnghl7:independentInd
BL0 … 1(UVM...nse)
Treetree.pnghl7:quantity
PQ0 … 1(UVM...nse)
Treetree.pnghl7:expectedUseTime
IVL_TS0 … 1(UVM...nse)
Treetree.pnghl7:subject
0 … 1Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)(UVM...nse)
Choice0 … 1Elements to choose from:
  • hl7:product containing template 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)
  • hl7:product containing template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)
Treeblank.pngTreetree.pnghl7:product
0 … 1RConsumable: The medication that is administered (simple)
Contains 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (DYNAMIC)		(UVM...nse)
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FPRD
Treeblank.pngTreetree.pnghl7:product
0 … 1RConsumable: The medication that is administered (detail)
Contains 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (DYNAMIC)		(UVM...nse)
Treeblank.pngTreeblank.pngTreetree.png@typeCode
cs1 … 1FPRD
Treetree.pnghl7:performer
0 … *Dispenser
Contains 2.16.840.1.113883.10.12.323 CDA Performer (Body) (DYNAMIC)		(UVM...nse)
Treetree.pnghl7:participant
0 … 1Origin
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVM...nse)
Treeblank.pngTreetree.png@typeCode
cs1 … 1FORG
Treetree.pnghl7:participant
0 … 1Destination
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVM...nse)
where [@typeCode='DST']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FDST
Treetree.pnghl7:participant
0 … *Receiver
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVM...nse)
where [@typeCode='RCV']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRCV
Treetree.pnghl7:participant
0 … 1Location
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVM...nse)
where [@typeCode='LOC']
Treeblank.pngTreetree.png@typeCode
cs1 … 1FLOC
Treetree.pnghl7:entryRelationship
0 … *RReference to the fulfilled Medication Order
Contains 2.16.840.1.113883.10.21.4.8 UV Medication Order Reference (DYNAMIC)		(UVM...nse)
where [@typeCode='REFR'] [hl7:substanceAdministration]
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFR
 Example<entryRelationship typeCode="REFR">
  <substanceAdministration classCode="SBADM" moodCode="RQO">
    <templateId root="2.16.840.1.113883.10.21.4.8"/>    <!-- .. -->
  </substanceAdministration></entryRelationship>
Treetree.pnghl7:entryRelationship
0 … *Annotations: The Medication Dispense can be the subject of annotations.
Contains 2.16.840.1.113883.10.21.4.12 UV Comment Activity (DYNAMIC)		(UVM...nse)
Treeblank.pngTreetree.png@typeCode
cs1 … 1FCOMP


Entry Level Templates

These entry level templates are used Section "Use Case Entry Level Templates".

UV ClinicalStatement Encounter

Id2.16.840.1.113883.10.21.4.4Effective Date2017‑01‑02
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVClinicalStatementMinimalEncounterDisplay NameUV ClinicalStatement Encounter
DescriptionUniversal Clinical Statement Minimal Encounter
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.4
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.302 CDA Encounter (2005‑09‑07)
ref
ad1bbr-

Adaptation: template 2.16.840.1.113883.10.20.22.4.49 Encounter Activity (V3) (DYNAMIC)
ref
ccda-
ItemDTCardConfDescriptionLabel
hl7:encounter
(UVC...ter)
Treetree.png@classCode
cs1 … 1FENC
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1R(UVC...ter)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.4
Treetree.pnghl7:id
II0 … *(UVC...ter)

UV ClinicalStatement Observation

Id2.16.840.1.113883.10.21.4.3Effective Date2016‑05‑01
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVClinicalStatementMinimalObservationDisplay NameUV ClinicalStatement Observation
DescriptionUniversal Clinical Statement Minimal Observation
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.3
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 8 templates
Uses as NameVersion
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.12.322ContainmentKgreen.png CDA SpecimenDYNAMIC
2.16.840.1.113883.10.12.323ContainmentKgreen.png CDA Performer (Body)DYNAMIC
2.16.840.1.113883.10.12.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
2.16.840.1.113883.10.12.319ContainmentKgreen.png CDA Informant (Body)DYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
2.16.840.1.113883.10.12.324ContainmentKgreen.png CDA ReferenceDYNAMIC
2.16.840.1.113883.10.12.329ContainmentKgreen.png CDA PreconditionDYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.303 CDA Observation (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
hl7:observation
(UVC...ion)
Treetree.png@classCode
cs1 … 1FOBS
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.png@negationInd
bl0 … 1 
Treetree.pnghl7:templateId
II1 … 1R(UVC...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.3
Treetree.pnghl7:id
II0 … *(UVC...ion)
Treetree.pnghl7:code
CD1 … 1RThis code (e.g. drawn from LOINC) specifies the type of observation, e.g. a lab value (creatinine) or a measurement of the body weight or a body surface.(UVC...ion)
 CONF
shall be drawn from concept domain "ObservationCode"
Treetree.pnghl7:derivationExpr
ST0 … 1(UVC...ion)
Treetree.pnghl7:text
ED0 … 1(UVC...ion)
Treetree.pnghl7:statusCode
CS0 … 1(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1(UVC...ion)
Treetree.pnghl7:priorityCode
CE0 … 1(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16866 ActPriority (DYNAMIC)
Treetree.pnghl7:repeatNumber
IVL_INT0 … 1(UVC...ion)
Treetree.pnghl7:language​Code
CS0 … 1(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.11526 HumanLanguage (DYNAMIC)
Treetree.pnghl7:value
ANY0 … *(UVC...ion)
Treetree.pnghl7:interpretationCode
CE0 … *(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.78 ObservationInterpretation (DYNAMIC)
Treetree.pnghl7:methodCode
CE0 … *(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14079 ObservationMethod (DYNAMIC)
Treetree.pnghl7:target​Site​Code
CD0 … *(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19724 HumanSubstanceAdministrationSite (DYNAMIC)
Treetree.pnghl7:subject
0 … 1Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)(UVC...ion)
Treetree.pnghl7:specimen
0 … *Contains 2.16.840.1.113883.10.12.322 CDA Specimen (DYNAMIC)(UVC...ion)
Treetree.pnghl7:performer
0 … *Contains 2.16.840.1.113883.10.12.323 CDA Performer (Body) (DYNAMIC)(UVC...ion)
Treetree.pnghl7:author
0 … *Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)(UVC...ion)
Treetree.pnghl7:informant
0 … *Contains 2.16.840.1.113883.10.12.319 CDA Informant (Body) (DYNAMIC)(UVC...ion)
Treetree.pnghl7:participant
0 … *Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)(UVC...ion)
Treetree.pnghl7:reference
0 … *Contains 2.16.840.1.113883.10.12.324 CDA Reference (DYNAMIC)(UVC...ion)
Treetree.pnghl7:precondition
0 … *Contains 2.16.840.1.113883.10.12.329 CDA Precondition (DYNAMIC)(UVC...ion)
Treetree.pnghl7:referenceRange
0 … *(UVC...ion)
Treeblank.pngTreetree.png@typeCode
cs1 … 1FREFV
Treeblank.pngTreetree.pnghl7:observationRange
1 … 1R(UVC...ion)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs0 … 1FOBS
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs0 … 1FEVN.CRT
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CD0 … 1(UVC...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@codeSystem
CONF0 … 1F2.16.840.1.113883.5.4 (Act Code)
Treeblank.pngTreeblank.pngTreetree.pnghl7:text
ED0 … 1(UVC...ion)
Treeblank.pngTreeblank.pngTreetree.pnghl7:value
ANY0 … 1(UVC...ion)
Treeblank.pngTreeblank.pngTreetree.pnghl7:interpretationCode
CE0 … 1(UVC...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.78 ObservationInterpretation (DYNAMIC)

UV Comment Activity

Id2.16.840.1.113883.10.21.4.12Effective Date2018‑03‑21
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVCommentactivityDisplay NameUV Comment Activity
Description
Comments that the provider makes about the activity, e.g. order or dispense. Comments are free text data that cannot otherwise be recorded using data elements already defined by this specification. They are not to be used to record information that can be recorded elsewhere. For example, a free text description of the severity of an allergic reaction would not be recorded in a comment.
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.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.301 CDA Act (2005‑09‑07)
ref
ad1bbr-
ItemDTCardConfDescriptionLabel
hl7:act
(UVC...ity)
Treetree.png@classCode
1 … 1FACT
Treetree.png@moodCode
1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1M(UVC...ity)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.12
Treetree.pnghl7:code
CD1 … 1M(UVC...ity)
Treeblank.pngTreetree.png@code
CONF1 … 1F48767-8
Treeblank.pngTreetree.png@codeSystem
1 … 1F2.16.840.1.113883.6.1 (LOINC)
Treetree.pnghl7:text
1 … 1M(UVC...ity)
Treeblank.pngTreetree.pnghl7:reference
TEL1 … 1R(UVC...ity)
Treeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs0 … 1FNA
Treetree.pnghl7:author
0 … 1Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)(UVC...ity)

UV Content

Id2.16.840.1.113883.10.21.4.17Effective Date2022‑03‑18 08:28:51
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVasContentDisplay NameUV Content
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
ItemDTCardConfDescriptionLabel
pharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVa...ent)
pharm:containerPackagedProduct
1 … 1R(UVa...ent)
Treetree.png@classCode
cs1 … 1FCONT
Treetree.png@determiner​Code
cs1 … 1FKIND
Treetree.pngpharm:code
CE0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVa...ent)
Treetree.pngpharm:name
EN0 … *
It represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVa...ent)
Treetree.pngpharm:formCode
CE0 … 1This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.
(UVa...ent)
Treetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVa...ent)
Treeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreetree.png@unit
cs0 … 1 
Treetree.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. 		(UVa...ent)
Treeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVa...ent)
Treeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RIt represents the intermediate Package Item or the Packaged Medicinal Product
(UVa...ent)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVa...ent)
Treeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1RIt represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.		(UVa...ent)
Treeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RThis element encodes the type of the intermediate package item or of the or the Packaged Medicinal Product.
(UVa...ent)
Treeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *R
In 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. 
(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1R(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RWhen present, it represents the Packaged Medicinal Product(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1When present, it can be used to convey the Packaged Medicinal Product ID.
(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1R(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1R(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVa...ent)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 


UV Dispense Request

Id2.16.840.1.113883.10.21.4.2Effective Date2016‑05‑01
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVDispenseRequestDisplay NameUV Dispense Request
DescriptionUniversal Dispense Request (Supply Request)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.2
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Uses
Uses 4 templates
Uses as NameVersion
2.16.840.1.113883.10.12.320ContainmentKgreen.png CDA Subject (Body)DYNAMIC
2.16.840.1.113883.10.12.312ContainmentKgreen.png CDA ManufacturedProductDYNAMIC
2.16.840.1.113883.10.12.323ContainmentKgreen.png CDA Performer (Body)DYNAMIC
2.16.840.1.113883.10.12.321ContainmentKgreen.png CDA Participant (Body)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.309 CDA Supply (2005‑09‑07)
ref
ad1bbr-
Example
Example
<supply classCode="SPLY" moodCode="RQO">
  <templateId root="2.16.840.1.113883.10.21.4.2"/>  <id root="..." extension="--example only--"/>  <code/>  <text/>  <statusCode code="active"/>  <effectiveTime xsi:type="IVL_TS">
    <low value="20170601"/>    <high value="20170801"/>  </effectiveTime>  <repeatNumber/>  <independentInd value="false"/>  <quantity value="1"/>  <expectedUseTime>
    <low value="20160511153724"/>  </expectedUseTime>  <subject>
    <!-- template 'CDA Subject (Body)' (dynamic) -->
  </subject>  <product typeCode="PRD">
    <!-- template 'CDA ManufacturedProduct' (dynamic) -->
  </product>  <performer>
    <!-- template 'CDA Performer (Body)' (dynamic) -->
  </performer>  <participant typeCode="ORG">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="DST">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="RCV">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <participant typeCode="LOC">
    <!-- template 'CDA Participant (Body)' (dynamic) -->
  </participant>  <entryRelationship typeCode="COMP">
    <!-- template 'DispenseRequest' (dynamic) -->
  </entryRelationship></supply>
ItemDTCardConfDescriptionLabel
hl7:supply
(UVD...est)
Treetree.png@classCode
cs1 … 1FSPLY
Treetree.png@moodCode
cs1 … 1FRQO
Treetree.pnghl7:templateId
II1 … 1M(UVD...est)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.2
Treetree.pnghl7:id
II0 … *(UVD...est)
Treetree.pnghl7:code
CD (extensible)0 … 1(UVD...est)
 CONF
The value of @code should be drawn from value set 2.16.840.1.113883.1.11.16208 ActPharmacySupplyType (DYNAMIC)
Treetree.pnghl7:text
ED0 … 1(UVD...est)
Treetree.pnghl7:statusCode
CS0 … 1(UVD...est)
Treeblank.pngTreetree.png@code
CONF0 … 1Factive
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1Validity period of the Dispense Request(UVD...est)
Treetree.pnghl7:repeatNumber
IVL_INT0 … 1(UVD...est)
Treetree.pnghl7:independentInd
BL0 … 1(UVD...est)
Treetree.pnghl7:quantity
PQ0 … 1(UVD...est)
Treetree.pnghl7:expectedUseTime
IVL_TS0 … 1(UVD...est)
Treetree.pnghl7:subject
0 … 1Contains 2.16.840.1.113883.10.12.320 CDA Subject (Body) (DYNAMIC)(UVD...est)
Treetree.pnghl7:product
0 … 1RContains 2.16.840.1.113883.10.12.312 CDA ManufacturedProduct (DYNAMIC)(UVD...est)
Treeblank.pngTreetree.png@typeCode
cs0 … 1FPRD
Treetree.pnghl7:performer
0 … *Contains 2.16.840.1.113883.10.12.323 CDA Performer (Body) (DYNAMIC)(UVD...est)
Treetree.pnghl7:participant
0 … 1Origin
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVD...est)
Treeblank.pngTreetree.png@typeCode
1 … 1FORG
Treetree.pnghl7:participant
0 … 1Destination
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVD...est)
where [@typeCode='DST']
Treeblank.pngTreetree.png@typeCode
1 … 1FDST
Treetree.pnghl7:participant
0 … *Receiver
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVD...est)
where [@typeCode='RCV']
Treeblank.pngTreetree.png@typeCode
1 … 1FRCV
Treetree.pnghl7:participant
0 … 1Location
Contains 2.16.840.1.113883.10.12.321 CDA Participant (Body) (DYNAMIC)		(UVD...est)
where [@typeCode='LOC']
Treeblank.pngTreetree.png@typeCode
1 … 1FLOC

UV Dispense Event Reference

Id2.16.840.1.113883.10.21.4.9Effective Date2017‑03‑30
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVDispenseEventReferenceDisplay NameUV Dispense Event Reference
DescriptionThis is a reference to a Dispense Event
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.9
LabelDispenseEventReference
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.309 CDA Supply (2005‑09‑07)
ref
ad1bbr-
Example
Example
<supply classCode="SPLY" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.9"/>  <id root="1.2.3.99.99.99" extension="978437489739"/></supply>
ItemDTCardConfDescriptionLabel
hl7:supply
Disp...ence
Treetree.png@classCode
cs1 … 1FSPLY
Treetree.png@moodCode
cs1 … 1FEVN
Treetree.pnghl7:templateId
II1 … 1MDisp...ence
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.9
Treetree.pnghl7:id
II1 … 1RDisp...ence

UV Generalized Medicine Class

Id2.16.840.1.113883.10.21.4.19Effective Date2023‑01‑29 21:57:12
Other versions this id:
  • Kblank.png UVgeneralizedMedicineClass as of 2022‑03‑18 08:39:53
StatusKyellow.png DraftVersion Label2023
NameUVgeneralizedMedicineClassDisplay NameUV Generalized Medicine Class
DescriptionUV generalized Medicine Class with determiner code KIND
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipVersion: template 2.16.840.1.113883.10.21.4.19 UV Generalized Medicine Class (2022‑03‑18 08:39:53)
ItemDTCardConfDescriptionLabel
pharm:generalizedMedicineKind
0 … *(UVg...ass)
Treetree.png@classCode
cs1 … 1FMMAT
Treetree.png@determiner​Code
cs1 … 1FKIND
Treetree.pngpharm:code
1 … 1R(UVg...ass)
Treetree.pngpharm:name
0 … *(UVg...ass)


UV Ingredient

Id2.16.840.1.113883.10.21.4.18Effective Date2022‑03‑18 08:34:40
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVIngredientDisplay NameUV Ingredient
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
ItemDTCardConfDescriptionLabel
pharm:quantity
RTO_PQ_PQ0 … 1(UVI...ent)
 Example
10 mg of the ingredient per ml
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="10" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
 Example
2% of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="2" unit="%"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
 Example
5mg of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="5" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
Treetree.pngcda:numerator
PQ0 … 1(UVI...ent)
Treetree.pngcda:denominator
PQ0 … 1(UVI...ent)
pharm:ingredientSubstance
0 … 1
The substance used for this product plying the role indicated in the ingredient classCode.
The <code> element contains the coded representation of the ingredient and the <name> element may be used for the plain text representation.
(UVI...ent)
Treetree.png@classCode
cs1 … 1FMMAT
Treetree.png@determiner​Code
cs1 … 1FKIND
Treetree.pngpharm:code
CD0 … 1C(UVI...ent)
Treetree.pngpharm:name
EN0 … 1C(UVI...ent)
 Schematron assertrole error 
 testpharm:code or pharm:name 
 MessageEither the name or the code of the substance (or both) shall be provided 


UV Medication Information (detail)

Id2.16.840.1.113883.10.21.4.11Effective Date2023‑02‑03 13:03:38
Other versions this id:
  • Kblank.png UVMedicationInformationdetail as of 2021‑08‑04 12:39:04
  • Kblank.png UVMedicationInformationdetail as of 2017‑05‑10
StatusKyellow.png DraftVersion Label2023
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 4 templates
Uses as NameVersion
2.16.840.1.113883.10.21.4.17IncludeKorange.png UV Content (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.21.4.19IncludeKyellow.png UV Generalized Medicine Class (2023)DYNAMIC
2.16.840.1.113883.10.21.4.18IncludeKorange.png UV Ingredient (R1-STU2-ballot)DYNAMIC
2.16.840.1.113883.10.12.151ContainmentKgreen.png CDA OrganizationDYNAMIC
RelationshipVersion: template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail) (2017‑05‑10)
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
cs0 … 1FMMAT
Treeblank.pngTreetree.png@determiner​Code
cs0 … 1FKIND
Treeblank.pngTreetree.pnghl7:code
CE0 … 1RThe code 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
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pnghl7:originalText
ED0 … 1RThe originalText shoud 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:desc
ED0 … 1(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. 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). 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.
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/contaner (e.g., tablet container, bottle, ...).


The <pharm:capacity​Quantity> element describes the capacity of the packaging, while the <pharm:quantity> the actual quantity of inner packaged items in the outer packaging container.


The product might have a single (30 pills bottle) or multiple (5 vials 10 ml; box with 2 blisters of 20 tablets) layers of packaging. In the latter case, the most inner (nested) item represents the most outer package item.
For example the case 
  \--Box 
  \-----2 blisters 
  \--------20 tablets 
is described as "20 tablets" contained by "a blister"; "2 blisters" contained by one box.
The most inner package represents the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
 Example
Packaged Medicinal Product with formCode
<asContent classCode="CONT">
  <containerPackagedProduct classCode="CONT" determinerCode="KIND">
    <!-- Packaged Medicinal Product -->
    <code codeSystem="1.999.999" code="PC_ID" displayName="Packaged Product Name"/>    <name>100 MIRACLE PILLS(TM)</name>    <formCode codeSystem="0.4.0.127.0.16.1.1.2.1" code="30009000" displayName="Box" CodeSystemName="EDQM"/>  </containerPackagedProduct></asContent>
 Example
General example
<asContent classCode="CONT">
  <quantity value=" " unit=" "/>  <containerPackagedProduct classCode="CONT" determinerCode="KIND">
    <!-- Medicinal product code (package-level) -->
    <code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <!-- Brand name (package) -->
    <name> . . . </name>    <formCode code=" " displayName=" " codeSystem=" " codeSystemName=" "/>    <capacityQuantity value=" " unit=" "/>    <asContent>
      <containerPackagedProduct classCode="CONT" determinerCode="KIND">
        <capacityQuantity value=" " unit=" "/>      </containerPackagedProduct>    </asContent>  </containerPackagedProduct></asContent>
 Example
Medicinal product with pharmaceutical dose form ”Tablets”, available as a “Tablet container” with 30 tablets
<asContent classCode="CONT">
  <!-- 30 tablets in the package -->
  <quantity value="30" unit="{tablet}"/>  <containerPackagedProduct classCode="CONT" determinerCode="KIND">
    <!-- .. -->
    <formCode code=" " displayName="Tablet container" codeSystem=" " codeSystemName=" "/>  </containerPackagedProduct></asContent>
 Example
Medicinal product with pharmaceutical dose form 'Solution for injection', available as “Ampoules” with 50ml volume, packaged as 5 ampoules per box
<asContent classCode="CONT">
  <quantity value="50" unit="ml"/>  <!-- 50ml per ampoule -->
  <containerPackagedProduct classCode="CONT" determinerCode="KIND">
    <!-- .. -->
    <formCode code=" " displayName="Ampoules" codeSystem=" " codeSystemName=" "/>    <asContent>
      <!-- 5 ampoules in a box -->
      <quantity value="5"/>      <containerPackagedProduct classCode="CONT" determinerCode="KIND">
        <!-- .. -->
      </containerPackagedProduct>    </asContent>  </containerPackagedProduct></asContent>
 Example
Packaged Medicinal Product with multiple layers packaging
<asContent classCode="CONT">
  <containerPackagedProduct>
    <!-- Inner Package -->
    <code codeSystem="..." code="..." displayName="..."/>    <asContent>
      <containerPackagedProduct>
        <!-- Intermediate Package -->
        <asContent>
          <containerPackagedProduct>
            <!-- Outer Package / Packaged Medicinal Product -->
          </containerPackagedProduct>        </asContent>      </containerPackagedProduct>    </asContent>  </containerPackagedProduct></asContent>
Included from 2.16.840.1.113883.10.21.4.17 UV Content (DYNAMIC)
Treeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *
It represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(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 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RIt represents the intermediate Package Item or the Packaged Medicinal Product
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(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 also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.		(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RThis element encodes the type of the intermediate package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(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 … *R
In 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.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RWhen present, it represents 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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1When present, it can be used to convey the Packaged Medicinal Product ID.
(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 … 1Captures the number of product units the package would contain if fully loaded.
(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.pngTreetree.pngpharm:asSpecializedKind
0 … *R
The Medicinal Product can be classified according to various classification systems, which may be jurisdictional or international as for example  the WHO ATC drug code, or the IDMP Pharmaceutical Product Identifier(s) (PhPID Set) when it will be available for use.
The generalizedMaterialKind/code element is used to covey these codes.
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FGRIC
 Example<asSpecializedKind classCode="GRIC">
  <generalizedMedicineClass classCode="MMAT">
    <code code=" " displayName=" " codeSystem=" " codeSystemName=" "/>  </generalizedMedicineClass></asSpecializedKind>
Included from 2.16.840.1.113883.10.21.4.19 UV Generalized Medicine Class (DYNAMIC)
Treeblank.pngTreeblank.pngTreetree.pngpharm:generalizedMedicineKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM...ail)
Treeblank.pngTreetree.pngpharm:part
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPART
Treeblank.pngTreeblank.pngTreetree.pngpharm:id
II0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:partProduct
1 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:desc
ED0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Included from 2.16.840.1.113883.10.21.4.17 UV Content (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *
It represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(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 … *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.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RIt 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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.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 also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.		(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RThis element encodes the type of the intermediate package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(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 … *R
In 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 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RWhen 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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1When present, it can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1R(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 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asSpecializedKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FGRIC
Included from 2.16.840.1.113883.10.21.4.19 UV Generalized Medicine Class (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:generalizedMedicineKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:part
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPART
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:id
II0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:partProduct
1 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:desc
ED0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Included from 2.16.840.1.113883.10.21.4.17 UV Content (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1R(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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *
It represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(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 … *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.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RIt represents the intermediate Package Item or 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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.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 also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.		(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RThis element encodes the type of the intermediate package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *R
In 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.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RWhen present, it represents the Packaged Medicinal Product(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1When present, it can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asSpecializedKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FGRIC
Included from 2.16.840.1.113883.10.21.4.19 UV Generalized Medicine Class (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:generalizedMedicineKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:part
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPART
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:id
II0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:partProduct
1 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:desc
ED0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Included from 2.16.840.1.113883.10.21.4.17 UV Content (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1R(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 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CE0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … *
It represents the Name of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE0 … 1This element encodes the type of the most inner package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.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.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1RThe quantity which specified how many inner packaged content entities are in an outer packaging container entity.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RIt represents the intermediate Package Item or the Packaged Medicinal Product
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1
It represents the code of the Package Item or of the Packaged Medicinal Product.
If this is also the most outer <pharm:containerPackagedProduct> than this element can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.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 also the most outer <pharm:containerPackagedProduct> than this element can be used for the brand name.		(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1RThis element encodes the type of the intermediate package item or of the or the Packaged Medicinal Product.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asContent
0 … *R
In 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.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
PQ0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:containerPackagedProduct
1 … 1RWhen present, it represents the Packaged Medicinal Product(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FCONT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1When present, it can be used to convey the Packaged Medicinal Product ID.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
ST0 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:formCode
CE1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:capacity​Quantity
PQ0 … 1Captures the number of product units the package would contain if fully loaded.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@value
1 … 1R
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@unit
cs0 … 1 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:asSpecializedKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FGRIC
Included from 2.16.840.1.113883.10.21.4.19 UV Generalized Medicine Class (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:generalizedMedicineKind
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
1 … 1R(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:part
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FPART
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredient
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1R
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.10430 RoleClassIngredientEntity (DYNAMIC)
Included from 2.16.840.1.113883.10.21.4.18 UV Ingredient (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
RTO_PQ_PQ0 … 1(UVM...ail)
 Example
10 mg of the ingredient per ml
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="10" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
 Example
2% of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="2" unit="%"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
 Example
5mg of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="5" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:numerator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:denominator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredientSubstance
0 … 1
The substance used for this product plying the role indicated in the ingredient classCode.
The <code> element contains the coded representation of the ingredient and the <name> element may be used for the plain text representation.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1C(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1C(UVM...ail)
 Schematron assertrole error 
 testpharm:code or pharm:name 
 MessageEither the name or the code of the substance (or both) shall be provided 
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredient
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1R
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.10430 RoleClassIngredientEntity (DYNAMIC)
Included from 2.16.840.1.113883.10.21.4.18 UV Ingredient (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
RTO_PQ_PQ0 … 1(UVM...ail)
 Example
10 mg of the ingredient per ml
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="10" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
 Example
2% of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="2" unit="%"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
 Example
5mg of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="5" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:numerator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:denominator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredientSubstance
0 … 1
The substance used for this product plying the role indicated in the ingredient classCode.
The <code> element contains the coded representation of the ingredient and the <name> element may be used for the plain text representation.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1C(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1C(UVM...ail)
 Schematron assertrole error 
 testpharm:code or pharm:name 
 MessageEither the name or the code of the substance (or both) shall be provided 
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredient
0 … *(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1R
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.10430 RoleClassIngredientEntity (DYNAMIC)
Included from 2.16.840.1.113883.10.21.4.18 UV Ingredient (DYNAMIC)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:quantity
RTO_PQ_PQ0 … 1(UVM...ail)
 Example
10 mg of the ingredient per ml
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="10" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
 Example
2% of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="2" unit="%"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
 Example
5mg of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="5" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:numerator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:denominator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:ingredientSubstance
0 … 1
The substance used for this product plying the role indicated in the ingredient classCode.
The <code> element contains the coded representation of the ingredient and the <name> element may be used for the plain text representation.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1C(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1C(UVM...ail)
 Schematron assertrole error 
 testpharm:code or pharm:name 
 MessageEither the name or the code of the substance (or both) shall be provided 
Treeblank.pngTreetree.pngpharm:ingredient
0 … *
This module provides the list of the ingredients (substances with a role) used for this product; one or more ingredients may be present.
The classCode of "ACTI" indicates that this is an active ingredient.
(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1R
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.10430 RoleClassIngredientEntity (DYNAMIC)
 Example<pharm:ingredient classCode="ACTI">
  <pharm:quantity>
    <cda:numerator type="PQ" value=" " unit=" "/>    <cda:denominator type="PQ" value=" " unit=" "/>  </pharm:quantity>  <ingredientSubstance classCode="MMAT" determinerCode="KIND">
    <code code=" " displayName=" " codeSystem="2.16.840.1.113883.6.73" codeSystemName="ATC WHO"/>  </ingredientSubstance></pharm:ingredient>
Included from 2.16.840.1.113883.10.21.4.18 UV Ingredient (DYNAMIC)
Treeblank.pngTreeblank.pngTreetree.pngpharm:quantity
RTO_PQ_PQ0 … 1(UVM...ail)
 Example
10 mg of the ingredient per ml
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="10" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1" unit="ml"/></pharm:quantity>
 Example
2% of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="2" unit="%"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
 Example
5mg of the ingredient
<pharm:quantity>
  <cda:numerator xsi:type="PQ" value="5" unit="mg"/>  <cda:denominator xsi:type="PQ" value="1"/></pharm:quantity>
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:numerator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngcda:denominator
PQ0 … 1(UVM...ail)
Treeblank.pngTreeblank.pngTreetree.pngpharm:ingredientSubstance
0 … 1
The substance used for this product plying the role indicated in the ingredient classCode.
The <code> element contains the coded representation of the ingredient and the <name> element may be used for the plain text representation.
(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FMMAT
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@determiner​Code
cs1 … 1FKIND
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:code
CD0 … 1C(UVM...ail)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.pngpharm:name
EN0 … 1C(UVM...ail)
 Schematron assertrole error 
 testpharm:code or pharm:name 
 MessageEither the name or the code of the substance (or both) shall be provided 
Treetree.pnghl7:manufacturerOrganization
0 … 1RContains 2.16.840.1.113883.10.12.151 CDA Organization (DYNAMIC)(UVM...ail)


UV Medication Information (simple)

Id2.16.840.1.113883.10.21.4.10Effective Date2021‑09‑29 19:15:16
Other versions this id:
  • Kblank.png UVMedicationInformationsimple as of 2021‑09‑29 19:15:02
  • Kblank.png UVMedicationInformationsimple as of 2017‑05‑10
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVMedicationInformationsimpleDisplay NameUV Medication Information (simple)
DescriptionUniversal Medication Information (simple)
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.10
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
RelationshipVersion: template 2.16.840.1.113883.10.21.4.10 UV Medication Information (simple) (2017‑05‑10)
Specialization: template 2.16.840.1.113883.10.12.312 CDA ManufacturedProduct (2005‑09‑07)
ref
ad1bbr-

Adaptation: template 2.16.840.1.113883.10.20.22.4.54 Immunization Medication Information (V2) (2014‑06‑09)
ref
ccda-
Example
US RxNorm Code
<hl7:manufacturedProduct classCode="MANU">
  <hl7:templateId root="2.16.840.1.113883.10.21.4.10"/>  <hl7:manufacturedMaterial classCode="MMAT" determinerCode="KIND">
    <hl7:code code="243670" codeSystem="2.16.840.1.113883.6.88" displayName="Aspirin 81 MG Oral Tablet"/>  </hl7:manufacturedMaterial></hl7:manufacturedProduct>
Example
Dutch G-Standaard Artikel Code
<hl7:manufacturedProduct classCode="MANU">
  <hl7:templateId root="2.16.840.1.113883.10.21.4.10"/>  <hl7:manufacturedMaterial classCode="MMAT" determinerCode="KIND">
    <hl7:code code="14145839" codeSystem="2.16.840.1.113883.2.4.4.8" codeSystemName="G-Standaard Artikel" displayName="FUROSEMIDE CF 40MG TABLET"/>  </hl7:manufacturedMaterial></hl7:manufacturedProduct>
Example
German Pharmaceutical Product Code
<hl7:manufacturedProduct classCode="MANU">
  <hl7:templateId root="2.16.840.1.113883.10.21.4.10"/>  <hl7:manufacturedMaterial classCode="MMAT" determinerCode="KIND">
    <hl7:code code="4213974" codeSystem="1.2.276.0.76.4.6" displayName="RAMIPRIL STADA 5 mg"/>    <hl7:lotNumberText>675-86574</hl7:lotNumberText>  </hl7:manufacturedMaterial>  <hl7:manufacturerOrganization>
    <hl7:name>STADA GmbH</hl7:name>  </hl7:manufacturerOrganization></hl7:manufacturedProduct>
ItemDTCardConfDescriptionLabel
hl7:manufacturedProduct
(UVM...ple)
Treetree.png@classCode
cs1 … 1FMANU
Treetree.pnghl7:templateId
II1 … 1M(UVM...ple)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.10
Treetree.pnghl7:manufactured​Material
1 … 1M(UVM...ple)
Treeblank.pngTreetree.png@classCode
cs0 … 1FMMAT
Treeblank.pngTreetree.png@determiner​Code
cs0 … 1FKIND
Treeblank.pngTreetree.pnghl7:code
CD1 … 1R
The code element 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...ple)
Treeblank.pngTreeblank.pngTreetree.pnghl7:translation
CE0 … *(UVM...ple)
 CONF
shall be drawn from concept domain "Product Code"
Treeblank.pngTreetree.pnghl7:lotNumberText
0 … 1(UVM...ple)
Treetree.pnghl7:manufacturerOrganization
0 … 1RContains 2.16.840.1.113883.10.12.151 CDA Organization (DYNAMIC)(UVM...ple)


UV Medication Order Reference

Id2.16.840.1.113883.10.21.4.8Effective Date2017‑03‑30
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVMedicationOrderReferenceDisplay NameUV Medication Order Reference
DescriptionUniversal Medication Medication Order Reference
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.8
LabelMedicationOrderReference
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.318ContainmentKgreen.png CDA Author (Body)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="RQO">
  <templateId root="2.16.840.1.113883.10.21.4.8"/>  <id root="1.2.3.99.99.99" extension="988437489739"/></substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
Medi...ence
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1FRQO
Treetree.pnghl7:templateId
II1 … 1MMedi...ence
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.8
Treetree.pnghl7:id
II1 … 1RMedi...ence
Treetree.pnghl7:author
0 … *Prescriber: A party that originates the order and therefore has responsibility for the information given in the order.
Contains 2.16.840.1.113883.10.12.318 CDA Author (Body) (DYNAMIC)		Medi...ence

UV Subordinate Substance Administration

Id2.16.840.1.113883.10.21.4.6Effective Date2023‑01‑30 09:36:00
Other versions this id:
  • Kblank.png UVSubordinateadministration as of 2017‑04‑30
StatusKyellow.png DraftVersion Label2023
NameUVSubordinateadministrationDisplay NameUV Subordinate Substance Administration
DescriptionUniversal Subordinate Substance Administration to convey information about dosages
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.6
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipVersion: template 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (2017‑04‑30)
Specialization: template 2.16.840.1.113883.10.12.308 CDA SubstanceAdministration (2005‑09‑07)
ref
ad1bbr-
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.6"/>  <statusCode code="active"/>  <effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
    <period value="12" unit="h"/>  </effectiveTime>  <doseQuantity xsi:type="IVL_PQ" value="2" unit="{puff}"/>  <consumable>
    <manufacturedProduct>
      <manufacturedMaterial nullFlavor="NA"/>    </manufacturedProduct>  </consumable></substanceAdministration>
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
1 … 1R(UVS...ion)
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1RIf the subordinate substance administration refers to Medication Order then a substance administration request (moodCode is 'RQO') is used.
If it refers to a Medication Statement, the moodCode shall be set to event/intent (moodCode is 'EVN' or 'INT').
 CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.21.4 Mood Code Evn Int Rqo (DYNAMIC)
 ConstraintThe moodCode of this subordinate substance administration SHALL be the same of the parent substance administration
Treetree.pnghl7:templateId
II1 … 1M(UVS...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.6
Treetree.pnghl7:statusCode
CS1 … 1M(UVS...ion)
 ConstraintThe statusCode of this subordinate substance administration SHALL be the same of that of the parent substance administration.
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.21.2 ActStatusActiveCompletedAbortedSuspended (DYNAMIC)
Choice1 … 1Elements to choose from:
  • hl7:effectiveTime[@value or @nullFlavor]
  • hl7:effectiveTime[@xsi:type='PIVL_TS']
  • hl7:effectiveTime[@xsi:type='EIVL_TS']
  • hl7:effectiveTime[@xsi:type='SXPR_TS']
Treeblank.pngTreetree.pnghl7:effectiveTime
TS0 … 1CThis required element describes the frequency of intakes. If not known it shall be valued with the nullflavor "UNK"(UVS...ion)
where [@value or @nullFlavor]
 Example
Once (known date)
<effectiveTime value="20170404"/>
 Example
Unknown
<effectiveTime nullFlavor="UNK"/>
Treeblank.pngTreetree.pnghl7:effectiveTime
PIVL_TS0 … 1CPeriodic Time Interval(UVS...ion)
where [@xsi:type='PIVL_TS']
 Example
Every 4 hours
<effectiveTime xsi:type="PIVL_TS" institutionSpecified="false">
  <period value="4" unit="h"/></effectiveTime>
 Example
Twice a day
<effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
  <period value="12" unit="h"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:effectiveTime
EIVL_TS0 … 1CEvent Related Time Interval(UVS...ion)
where [@xsi:type='EIVL_TS']
 Example
After meal
<effectiveTime xsi:type="EIVL_TS">
  <event code="PC" codeSystem="2.16.840.1.113883.5.139"/></effectiveTime>
 Example
One hour before breakfast
<effectiveTime xsi:type="EIVL_TS">
  <event code="ACM" codeSystem="2.16.840.1.113883.5.139"/>  <offset>
    <low value="1" unit="h"/>  </offset></effectiveTime>
Treeblank.pngTreeblank.pngTreetree.pnghl7:event
EIVL.event0 … 1C(UVS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@code
cs0 … 1 
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10706 TimingEvent (DYNAMIC)
Treeblank.pngTreetree.pnghl7:effectiveTime
SXPR_TS0 … 1RCombined Time Interval(UVS...ion)
where [@xsi:type='SXPR_TS']
Treetree.pnghl7:doseQuantity
IVL_PQ0 … 1RThe doseQuantity describes the amount of the medication given (the dosage).

If a dose range is given (e.g., 1-2 tablets, or 325-750mg), then the <low> and <high> bounds are specified in their respective elements; otherwise only one physical quantity is specified (e.g. 2 drops)

The dose can be in some known and measurable unit, such as grams, milligrams,or described in "administration" units (unit of presentation, such as capsules).

If the dose is in countable items (tablets, caplets, "eaches"), then the unit could be omitted or valorized using the UCUM annotations for describing the type of countable items (e.g. .{tablet}, {puff},..).

The unit attribute – when expresses unit of measures- shall be derived from the UCUM code system.
The used elements should contain a <translation> element that provides a reference to the originalText found in the narrative body of the document. 		(UVS...ion)
Treeblank.pngTreetree.png@unit
cs0 … 1 
 Example
Not pre-coordinated consumable
<doseQuantity value="25" unit="mg"/>
 Example
Pre-coordinated consumable - Dose Range
<doseQuantity>
  <low value="1" unit="{tablet}"/>  <high value="2" unit="{tablet}"/></doseQuantity>
 Example
Pre-coordinated consumable
<doseQuantity value="2" unit="{puff}"/>
 Example
Pre-coordinated consumable with text reference
<doseQuantity value="2" unit="{puff}">
  <translation nullFlavor="NI">
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>  </translation></doseQuantity>
 Example
Textual dosage
<doseQuantity nullFlavor="NI">
  <translation nullFlavor="NI">
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>  </translation></doseQuantity>
Treetree.pnghl7:rateQuantity
IVL_PQ0 … 1(UVS...ion)
Treetree.pnghl7:maxDoseQuantity
RTO_PQ_PQ0 … 1(UVS...ion)
Treetree.pnghl7:administrationUnitCode
CE0 … 1(UVS...ion)
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14570 AdministrableDrugForm (DYNAMIC)
Treetree.pnghl7:consumable
1 … 1R(UVS...ion)
Treeblank.pngTreetree.pnghl7:manufacturedProduct
1 … 1R(UVS...ion)
Treeblank.pngTreeblank.pngTreetree.pnghl7:manufactured​Material
1 … 1R(UVS...ion)
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs1 … 1FNA

UV Substitution Event Adminstration

Id2.16.840.1.113883.10.21.4.14Effective Date2023‑01‑30 08:42:54
Other versions this id:
  • Kblank.png UVSubstitutionEventAdministration as of 2019‑02‑17
StatusKyellow.png DraftVersion Label2023
NameUVSubstitutionEventAdministrationDisplay NameUV Substitution Event Adminstration
DescriptionInformation about a substitution made for this adminstration.
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.14
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipVersion: template 2.16.840.1.113883.10.21.4.14 UV Substitution Event Adminstration (2019‑02‑17)
Specialization: template 2.16.840.1.113883.10.12.301 CDA Act (2005‑09‑07)
ref
ad1bbr-
Example
Example
<act classCode="ACT" moodCode="EVN">
  <templateId root="2.16.840.1.113883.10.21.4.14"/>  <code code="TE" codeSystem="2.16.840.1.113883.5.1070" displayName="therapeutic alternative"/>  <entryRelationship typeCode="RSON">
    <act classCode="ACT" moodCode="EVN">
      <!-- Reason for substitution -->
    </act>  </entryRelationship></act>
ItemDTCardConfDescriptionLabel
hl7:act
1 … 1M(UVS...ion)
Treetree.png@classCode
cs1 … 1FACT
Treetree.png@moodCode
cs1 … 1FDEF
Treetree.pnghl7:templateId
II1 … 1M(UVS...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.14
Treetree.pnghl7:code
CE (example)1 … 1
The type of substitution made.
(UVS...ion)
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.16621 ActSubstanceAdminSubstitutionCode (DYNAMIC)
Treetree.pnghl7:entryRelationship
0 … 1C
Indicates the reason for substitution.
(UVS...ion)
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <code code="FP" codeSystem="2.16.840.1.113883.5.8" displayName="formulary policy">
    <originalText>Formulary policy</originalText>  </code></entryRelationship>
Treeblank.pngTreetree.pnghl7:act
1 … 1(UVS...ion)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FACT
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs1 … 1FEVN
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CD (example)1 … 1(UVS...ion)
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.19377 SubstanceAdminSubstitutionReason (DYNAMIC)

UV Substitution Permission

Id2.16.840.1.113883.10.21.4.5Effective Date2017‑01‑02
StatusKorange.png Under pre-publication reviewVersion LabelR1-STU2-ballot
NameUVSubstitutionPermissionDisplay NameUV Substitution Permission
DescriptionInformation about a substitution permission for this adminstration.
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.4.5
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.301 CDA Act (2005‑09‑07)
ref
ad1bbr-
Example
Example
<act classCode="ACT" moodCode="DEF">
  <templateId root="2.16.840.1.113883.10.21.4.5"/>  <code code="TE" codeSystem="2.16.840.1.113883.5.1070" displayName="therapeutic alternative"/>  <entryRelationship typeCode="RSON">
    <act classCode="ACT" moodCode="EVN">
      <!-- Reason no substitution -->
    </act>  </entryRelationship></act>
ItemDTCardConfDescriptionLabel
hl7:act
1 … 1M(UVS...ion)
Treetree.png@classCode
cs1 … 1FACT
Treetree.png@moodCode
cs1 … 1FDEF
Treetree.pnghl7:templateId
II1 … 1M(UVS...ion)
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.4.5
Treetree.pnghl7:code
CE (example)1 … 1The type of substitution that this permission relates to.(UVS...ion)
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.16621 ActSubstanceAdminSubstitutionCode (DYNAMIC)
Treetree.pnghl7:entryRelationship
0 … 1CUsed when substitution is not allowed and may indicate the reason for why substitution is not allowed.(UVS...ion)
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <code code="PAT" codeSystem="2.16.840.1.113883.5.8" displayName="Patient request">
    <originalText>Patient objects</originalText>  </code></entryRelationship>
Treeblank.pngTreetree.pnghl7:act
1 … 1(UVS...ion)
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FACT
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs1 … 1FEVN
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CD (example)1 … 1(UVS...ion)
 CONF
Examples of the value of @code are in the value set 2.16.840.1.113883.1.11.19719 SubstanceAdminSubstitutionNotAllowedReason (DYNAMIC)

UV Use Period

Id2.16.840.1.113883.10.21.9.1Effective Date2023‑01‑30 09:55:27
Other versions this id:
  • Kblank.png Useperiod as of 2017‑05‑02
  • Kblank.png Useperiod as of 2017‑01‑02
StatusKyellow.png DraftVersion Label2023
NameUseperiodDisplay NameUV Use Period
Description
This element encodes the start and stop time of the medication regimen. This is an interval of time (xsi:type='IVL_TS'), and must be specified as shown. This is an additional constraint placed upon CDA Release 2.0 by this profile, and simplifies the exchange of start/stop and frequency information between EMR systems.
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
ItemDTCardConfDescriptionLabel
Choice1 … 1
The effectiveTime element encodes the use period of the medication, it is always expressed as an interval of time.
It may be expressed using the low and high OR with the width element.
The first is used to indicate a specified interval (e.g. from march 15th, 2017); the latter for indicating a 'floating' period (e.g. 2 weeks).
Elements to choose from:
  • hl7:effectiveTime[hl7:low | hl7:high][not(hl7:width)]
  • hl7:effectiveTime[hl7:width][not(hl7:low|hl7:high)]
  • hl7:effectiveTime[hl7:low | hl7:width][not(hl7:high)]
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 1: specified interval


The low and high values of the first effectiveTime element represent the start and stop times for the medication. The low value represents the start time, and the high value represents the stop time. If either the low or the high value is unknown, this shall be recorded by setting the nullFlavor attribute to UNK.

In case of unbounded period (continuous therapy) the high element will be valued with the nullFlavor attribute to NA.


The high value records the end of the medication regime according to the information provided in the prescription or order. For example, if the prescription is for enough medication to last 30 days, then the high value should contain a date that is 30 days later then the low value. The rationale is that a provider, seeing a prescription that has not been refilled would normally assume that the medication is no longer being taken, even if the intent of the treatment plan is to continue the medication indefinitely.		(Use...iod)
where [hl7:low or
[not(hl7:width)]
Treeblank.pngTreetree.png@nullFlavor
cs0 … 1 
 Example
Known Interval
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high value="20140321"/></effectiveTime>
 Example
Information not available about the period
<effectiveTime type="IVL_TS" nullFlavor="NI"/>
 Example
Unknown end date
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="UNK"/></effectiveTime>
 Example
continous therapy
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <high nullFlavor="NA"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
IVXB_TS1 … 1R(Use...iod)
Treeblank.pngTreetree.pnghl7:high
IVXB_TS0 … 1R(Use...iod)
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 2: 'floating' period:
The width element is used to specify a period of (actual or intended) administration that is not anchored to any specific date (e.g. a two weeks therapy)		(Use...iod)
where [hl7:width] [not(hl7:lowor
hl7:high)]
 Example
2 week period
<effectiveTime type="IVL_TS">
  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
NP(Use...iod)
Treeblank.pngTreetree.pnghl7:high
NP(Use...iod)
Treeblank.pngTreetree.pnghl7:center
NP(Use...iod)
Treeblank.pngTreetree.pnghl7:width
PQ1 … 1R(Use...iod)
Treeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)
Treetree.pnghl7:effectiveTime
IVL_TS0 … 1CCase 3: anchored period:
The width element is used to specify a period of (actual or intended) administration anchored to a specific date (e.g. a two weeks therapy starting today)		(Use...iod)
where [hl7:low or
[not(hl7:high)]
 Example
2 week period starting on 2013-03-21
<effectiveTime type="IVL_TS">
  <low value="20130321"/>  <width value="2" unit="w"/></effectiveTime>
Treeblank.pngTreetree.pnghl7:low
IVXB_TS0 … 1C(Use...iod)
Treeblank.pngTreetree.pnghl7:width
PQ1 … 1R(Use...iod)
Treeblank.pngTreeblank.pngTreetree.png@unit
cs1 … 1R
 CONF
The value of @unit shall be drawn from value set 2.16.840.1.113883.11.21.1 Medication Time Units (UCUM) (DYNAMIC)

Appendix (Informative)

Acronyms and abbreviations

  • C-CDA: Consolidated CDA
  • CDA: Clinical Document Architecture
  • DSTU: Draft Standard for Trial Use
  • EDQM: European Directorate for the Quality of Medicines & Healthcare
  • EHR: Electronic Healthcare Record
  • HL7: Health Level Seven
  • HP: Healthcare Professional
  • IDMP: IDentification of Medicinal Products (ISO Standard)
  • IHE: Integrating the Healthcare Enterprise
  • ISO: International Organization for Standardization
  • JIC: Joint Initiative Council on SDO Global Health Informatics Standardization
  • LOINC: Logical Observation Identifiers Names & Codes
  • MPID: Medicinal Product Identifier
  • PCID : Medicinal Product Package Identifier
  • PhPID(s): Pharmaceutical Product Identifier(s)
  • SDO: Standard Developing Organization
  • STU: Standard for Trial Use
  • UCUM: Unified Code for Units of Measure

Glossary

  • Prescribing is an activity that can be performed by a variety of healthcare professionals and involves a variety of orderable items (see glossary entry). For the purposes of the following Implementation Guide, prescribing is defined as the act of prescribing a medication in either an ambulatory or an institutional setting. This could include initiating a new medication order or making all kinds of modifications to existing orders.
  • Dispensing is an activity undertaken to fulfill the logistical requirements of a prescription. It supplies the materials needed to perform the prescribed actions by those who will perform them. Examples of dispensing include eyeglasses, contact lenses and medications. For the purposes of the following ballot material, dispensing is defined as supplying a medication in fulfillment of a prescription or medication order. While dispensing in these circumstances would usually be performed by a pharmacist, other health care providers such as nurses or physicians might also dispense medications.
  • Administration is an activity undertaken to give medication to the patient. In the community, this process is usually not recorded, since the majority occurs in the patient's home; only administrations undertaken by a healthcare professional, such as vaccination, tend to be formally documented. Administration of medication in the institutional setting is usually recorded on a dose-by-dose basis, and may be messaged on that basis, or a summary of all the administrations occurring during an inpatient stay may be described.

Integrated examples

The Medication on CDA specification releases are published at the Pharmacy Templates Material Publication Page on HL7 GitHub[4]. This GitHub offers XML materials (also compacted as a ZIP to download) like the W3C schemas and example CDA document instances. A set of use cases have been defined and represented in Medication on CDA format.

Validation artifacts

You can test your implementation (instances) against the Medication on CDA specification. To download materials to your computer for local testing and validation consider...

  • ...the W3C schemas (actually valid for any CDA specification) located at the PHARM Materials Page on HL7 GitHub[4].
  • ..the ISO schematron, automatically generated by ART-DECOR based on the definitions, located at the Pharmacy Templates Material Publication Page on ART-DECOR[5]. These are files to do validation locally by associating PHARM CDA instances with the main schematron using an XML editor or to use the derived XSLT conversions and apply the according XSLT derivation to your local PHARM CDA instance.

For further information you can follow the documentation.

Operational information

  • The original specification is hosted on the logical ART-DECOR main server art-decor.org under the Governance Group HL7 International, the project is reachable at the Project Live Landing Page[6].

Licenses

Following is a non-exhaustive list of third-party terminologies that may require a separate license:

  • SNOMED CT: SNOMED International (formerly know as International Healthcare Terminology Standards Development Organization IHTSDO)[7] or info@ihtsdo.org
  • Logical Observation Identifiers Names & Codes (LOINC): The Regenstrief Institute, Inc.
  • Unified Code for Units of Measure (UCUM) : Regenstrief Institute, Inc. and the UCUM Organization

List of all artifacts used in this guide

CDA Templates

Unconstrained Templates from the original CDA specification

Value Sets

Medication Time Units (UCUM)

This terminology is a snapshot as of . Terminologies may evolve over time. If you need recent (dynamic) versions of this terminology, please retrieve it from the source.
Id2.16.840.1.113883.11.21.1Effective Date2023‑02‑01 11:12:08
StatusKgreen.png FinalVersion Label3.0
NameMedicationTimeUnitsDisplay NameMedication Time Units (UCUM)
DescriptionMedication Time Units, expressed in UCUM
Usage: 4
IdNameType
Template
2.16.840.1.113883.10.21.9.1UV Use Period DYNAMIC
2.16.840.1.113883.10.21.9.1UV Use Period (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.9.1UV Use Period (2023) DYNAMIC
2.16.840.1.113883.10.21.9.1UV Use Period (2023) DYNAMIC
Source Code System
2.16.840.1.113883.6.8 - Unified Code for Units of Measure - FHIR: http://unitsofmeasure.org - HL7 V2: UCUM
Level/ TypeCodeDisplay NameCode System
0‑L
a
Year
Unified Code for Units of Measure
0‑L
d
Day
Unified Code for Units of Measure
0‑L
h
Hour
Unified Code for Units of Measure
0‑L
min
Minute
Unified Code for Units of Measure
0‑L
mo
Month
Unified Code for Units of Measure
0‑L
s
Second
Unified Code for Units of Measure
0‑L
wk
Week
Unified Code for Units of Measure
Legenda: Type L=leaf, S=specializable, A=abstract, D=deprecated. NullFlavor OTH (other) suggests text in originalText. HL7 V3: NullFlavors to appear in @nullFlavor attribute instead of @code.

ActStatusCodeActiveCompletedAbortedSuspended

This terminology is a snapshot as of . Terminologies may evolve over time. If you need recent (dynamic) versions of this terminology, please retrieve it from the source.
Id2.16.840.1.113883.11.21.2Effective Date2017‑03‑06
StatusKyellow.png DraftVersion Label
NameActStatusCodeActiveCompletedAbortedSuspendedDisplay NameActStatusActiveCompletedAbortedSuspended
Usage: 6
IdNameType
Template
2.16.840.1.113883.10.21.4.1UV Medication Order (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.4.6UV Subordinate Substance Administration (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.4.1UV Medication Order (2023) DYNAMIC
2.16.840.1.113883.10.21.4.1UV Medication Order (STU1) DYNAMIC
2.16.840.1.113883.10.21.4.1UV Medication Order (2023) DYNAMIC
2.16.840.1.113883.10.21.4.6UV Subordinate Substance Administration (2023) DYNAMIC
Source Code System
2.16.840.1.113883.5.14 - ActStatus - FHIR: http://terminology.hl7.org/CodeSystem/v3-ActStatus
Level/ TypeCodeDisplay NameCode System
0‑L
completed
Completed
ActStatus
0‑L
aborted
Aborted
ActStatus
0‑L
active
Active
ActStatus
0‑L
suspended
Suspended
ActStatus
Legenda: Type L=leaf, S=specializable, A=abstract, D=deprecated. NullFlavor OTH (other) suggests text in originalText. HL7 V3: NullFlavors to appear in @nullFlavor attribute instead of @code.

Mood Code Evn Int Rqo

This terminology is a snapshot as of . Terminologies may evolve over time. If you need recent (dynamic) versions of this terminology, please retrieve it from the source.
Id2.16.840.1.113883.11.21.4Effective Date2018‑03‑21
StatusKyellow.png DraftVersion Label
NameMoodCodeEvnIntRqoDisplay NameMood Code Evn Int Rqo
Usage: 2
IdNameType
Template
2.16.840.1.113883.10.21.4.6UV Subordinate Substance Administration (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.4.6UV Subordinate Substance Administration (2023) DYNAMIC
Source Code System
2.16.840.1.113883.5.1001 - Act Mood - FHIR: http://terminology.hl7.org/CodeSystem/v3-ActMood
Level/ TypeCodeDisplay NameCode System
0‑L
EVN
Event
Act Mood
0‑L
INT
Intent
Act Mood
0‑L
RQO
Request
Act Mood
Legenda: Type L=leaf, S=specializable, A=abstract, D=deprecated. NullFlavor OTH (other) suggests text in originalText. HL7 V3: NullFlavors to appear in @nullFlavor attribute instead of @code.

Unknown or absent medication

This terminology is a snapshot as of . Terminologies may evolve over time. If you need recent (dynamic) versions of this terminology, please retrieve it from the source.
Id2.16.840.1.113883.11.21.5Effective Date2018‑03‑21
StatusKyellow.png DraftVersion Label
NameUnknownorabsentmedicationDisplay NameUnknown or absent medication
CopyrightThis artefact includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these artefacts must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/getsnomed-ct or info@snomed.org.
Usage: 5
IdNameType
Template
2.16.840.1.113883.10.21.4.7UV Medication Statement (STU1) DYNAMIC
2.16.840.1.113883.10.21.4.7UV Medication Statement (2023) DYNAMIC
2.16.840.1.113883.10.21.4.13UV Medication Administration (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.4.7UV Medication Statement (R1-STU2-ballot) DYNAMIC
2.16.840.1.113883.10.21.4.13UV Medication Administration (2023) DYNAMIC
Source Code System
2.16.840.1.113883.6.96 - SNOMED Clinical Terms - FHIR: http://snomed.info/sct - HL7 V2: SCT
Level/ TypeCodeDisplay NameCode System
0‑L
182904002
Drug treatment unknown (finding)
SNOMED Clinical Terms
0‑L
182849000
No drug therapy prescribed (situation)
SNOMED Clinical Terms
Legenda: Type L=leaf, S=specializable, A=abstract, D=deprecated. NullFlavor OTH (other) suggests text in originalText. HL7 V3: NullFlavors to appear in @nullFlavor attribute instead of @code.


Referenced HL7 Version 3 Value Sets

  • 2.16.840.1.113883.1.11.13955 ActEncounterCode
  • 2.16.840.1.113883.1.11.16208 ActPharmacySupplyType
  • 2.16.840.1.113883.1.11.16866 ActPriority
  • 2.16.840.1.113883.1.11.15933 ActStatus
  • 2.16.840.1.113883.1.11.19708 ActSubstanceAdministrationCode
  • 2.16.840.1.113883.1.11.16621 ActSubstanceAdminSubstitutionCode
  • 2.16.840.1.113883.1.11.14570 AdministrableDrugForm
  • 2.16.840.1.113883.1.11.11526 HumanLanguage
  • 2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt
  • 2.16.840.1.113883.1.11.78 Observation Interpretation
  • 2.16.840.1.113883.1.11.14079 ObservationMethod
  • 2.16.840.1.113883.1.11.14581 RouteOfAdministration
  • 2.16.840.1.113883.1.11.19719 SubstanceAdminSubstitutionNotAllowedReason
  • 2.16.840.1.113883.1.11.19377 SubstanceAdminSubstitutionReason
  • 2.16.840.1.113883.1.11.10706 TimingEvent
  • 2.16.840.1.113883.1.11.19447 x_ActRelationshipEntryRelationship
  • 2.16.840.1.113883.1.11.19890 x_ActStatusActiveComplete

Datatypes

Datatypes for element definitions used

  • ANY – ANY
  • BL – Boolean
  • CD – Concept Descriptor
  • CE – Coded with Equivalents
  • CS – Coded Simple Value
  • ED – Encapsulated Data
  • EN – Entity Name
  • II – Instance Identifier
  • INT – Integer
  • INT.NONNEG – Interval of Integer, non-negative
  • IVL_INT – Interval of Integer
  • IVL_PQ – Interval of Physical Quantity
  • IVL_TS – Interval of Time Stamp
  • IVXB_TS – Interval Boundary of Time Stamp
  • PIVL_TS – Periodic Interval of Timezone
  • PQ – Physical Quantity
  • RTO_PQ_PQ – Ratio Physical Quantity / Physical Quantity
  • ST – Character String
  • TEL – Telecommunication Address
  • TS – Time Stamp

Datatypes for attributes used

  • bl – boolean code
  • cs – code
  • uid – identifier

Extensions

Detailed medications information

This specification uses CDA extensions in order to provide details about medications, as further described in the section on the design conventions for Medicinal Product Identification and as used in template 2.16.840.1.113883.10.21.4.11 UV Medication Information (detail). The extension uses the namespace 

urn:hl7-org:pharm

This is the list of elements defined for that template.

  • pharm:formCode (Administrable Pharmaceutical Dose Form)
  • pharm:asContent (Packaging of the medication)
    • pharm:quantity
    • pharm:containerPackagedMedicine (Most inner Package Item or the Packaged Medicinal Product)
      • pharm:code
      • pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
      • pharm:formCode (type of the most inner package item or of the or the Packaged Medicinal Product)
      • pharm:capacityQuantity (the functional capacity of the container)
      • pharm:asContent (Containing package)
        • pharm:quantity
        • pharm:containerPackagedMedicine (Intermediate Package Item or the Packaged Medicinal Product)
          • pharm:code
          • pharm:name (Name of the Package Item or of the Packaged Medicinal Product)
          • pharm:formCode (type of the intermediate package item or of the or the Packaged Medicinal Product)
          • pharm:capacityQuantity (the functional capacity of the container)
          • pharm:asContent (Containing package)
            • pharm:quantity
            • pharm:containerPackagedMedicine (Packaged Medicinal Product)
              • pharm:code
              • pharm:name (Name of the Packaged Medicinal Product)
              • pharm:formCode (type of the Packaged Medicinal Product)
              • pharm:capacityQuantity (the functional capacity of the container)
  • pharm:asSpecializedKind (used to represent any classification of the product (ATC code, future PhPIDs,..) )
    • pharm:generalizedMaterialKind
      • pharm:code
      • pharm:name
  • pharm:ingredient (list of active substances used for this product)
    • pharm:quantity (strength)
    • pharm:ingredientSubstance (active substance)
      • pharm:code
      • pharm:name

How to read the table view for templates

The template definitions are shown in a table view. It is comprised of Template Meta data and the Template Design. For further information please refer to the HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1[2].

Templates may also be included in the hierarchical graph view (often used for CDA), see below.

Template Meta data

TemplatePublication1.png

TemplatePublication1.png

The upper right part of the template table contains the template meta data. Template id, status and the template name are shown (1). Furthermore the Version (effective date), a possible version label and the display name are shown (2).

The description area (plain or an accordion) contains the template descriptions/purpose (3), followed by classifications and whether the template is defined as open or closed (4).

The usage part (5) may list templates that uses this template or what templates this templates uses. A relationship list (6) may show all relationships to other templates or models.

Examples may show the correct use of the template by an XML fragment (7).

TemplatePublication5a.png

TemplatePublication5a.png

The relationship list shows all relationships to other templates or models for this template. It is divided in the "Used by" part listing templates that make use of this template, and a "Uses" listing all templates that are used by this templates, either as inclusion or containment. Indirect relationships like the parent Document Level Template for a Section Level Template are marked with a chain symbol.

The PDF version is rendered in the same way, but maybe with different fonts etc. to fit customized publication requirements.

TemplatePublication2.png

TemplatePublication2.png

Table view of Template Design

TemplatePublication3.png

TemplatePublication3.png

The headings of the table view of a template design are:

Item (1) contains the XML document tree view of all elements and attributes specified in the template design. Elements are denoted by a preceding triangle and attributes by a preceding "@".

DT (2) data types, contains the data type of the item, for more information on valid data types for element and attributes (see [2]).

Card / Conf (3) cardinality (Card) and conformance (Conf) of the item. Cardinality is the usual notion of min and max occurrences of the element. For attributes 0..1 denotes optionality, 1..1 say that the attribute is required and NP denotes prohibited attributes. Conformance may display values as shown in the following table.

Values of the conformance column
Conf Short Description
O optional Data is truly optional
R required If data is present and not masked (e.g. for privacy reasons), it must be provided, otherwise it may be omitted or explicitly null flavored.
Sender and receiver must support this element.
M mandatory The data must be populated with a valid value from the associated value domain, otherwise the instance is not valid and may not be communicated.
Sender and receiver must support this element.
C conditional There are conditions when data has to be provided (e.g. co-constraints like "information about pregnancy IF the patient is "female".
Sender and receiver must support this element.
F fixed The data has a fixed value.
NP not permitted Data shall not be present

Description (4) contains a textual description of the item, may also contain constraints and values for fixed attributes.

Label (5) is a human readable label that is displayed upon errors, warnings or notes during validation.

Details of the table view

TemplatePublication4.png

TemplatePublication4.png

The actual template design shows the XML structure in a hierarchical list of elements (items) that are typically prefixed by the namespace "hl7:" or "cda:" (1).

Elements are denoted with a triangle, attributes with an @ sign (2).

Data types are specified according to the list of supported data types (3). They may be simple data types (lowercase), regular data types (uppercase) or flavors thereof. In case of coded elements, the coding strength (Required/CNE, Extensible/CWE, Preferred or Example) can be highlighted near the datatype (e.g. “CD.IPS (Extensible/CWE)”) ; the absence of indications about the strength (e.g. “CE.IPS”) shall be interpreted as “Required/CNE”.

Values of the coding strength column
Strength Displayed as Description
Required Required/CNE Coded with no exceptions; this element SHALL be from the specified value set
Extensible Extensible/CWE Coded with Exceptions; this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.
Preferred Preferred Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.
Example Example Instances are not expected or even encouraged to draw from the specified value set. The value set merely provides examples of the types of concepts intended to be included.

The cardinality and conformance column is explained above (4).

Fixed values for e.g. attributes are also shown in the "description" column (5), preceded by a "F" in the Conf column.

Conformance statements are shown together with a CONF box, e.g. a @code and a @codeSystem with fixed and required values (6).

An optional label is displayed at the rightmost column (7).

Inclusion or containments of other templates, e.g. an entry within a section, are shown accordingly (8) along with their template id, display name and flexibility/stability indication, i.e. "DYNAMIC" (the most recent version) or a STATIC binding together with a version date.

TemplatePublication5b.png

TemplatePublication5b.png

Choices of elements are shown as a choice list with the elements in questions summarised in a bullet point list.

TemplatePublication6b.png

TemplatePublication6b.png

A typical Conformance Statement is the binding of a coded element to a value set. This is expressed in the way shown. The value set is represented with the id, display name and the flexibility/stability of the binding.

TemplatePublication6c.png

TemplatePublication6c.png

In case a constraint is expressed in words, a box "Constraint" accompanies the textual expression of the constraint.

TemplatePublication6a.png

TemplatePublication6a.png

In cases where constraints are expressed by formalised rules in ISO Schematron, the rule along with the role (error, warning), the test and the assertion message is shown.

How to read the Templates hierarchical graph view

TemplatePublication8a.png

TemplatePublication8a.png

Templates are often included in the hierarchical graph view (often used for CDA). It gives an overview of e.g. section and entries and their nesting/relationships.

TemplatePublication8b.png

TemplatePublication8b.png

In case a template has more that one type (CDA Person for header, section and entry templates), it is denoted with a *, if a recursive definition is detected, this is shown with the symbol @.

How to read the where criteria

Templates sometimes include criteria for identifying distinct elements from a list (e.g. in a choice).

The criteria used to identify the items are shown in square brackets using the assertion where [ criteria ]

Criteria can be:

  1. an xpath expression as in the example : where [hl7:low or hl7:high]
  2. or an integer indexing the items of the list: e.g. where [1]; where [2]

References

Literature

  • Boone KW: The CDA Book. Springer 2011, ISBN 978-0-85729-336-7

Links

  1. ↑ 1.0 1.1 http://www.hl7.org/implement/standards/product_brief.cfm?product_id=379
  2. ↑ 2.0 2.1 2.2 2.3 HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1 http://www.hl7.org/implement/standards/product_brief.cfm?product_id=377
  3. ↑ ISO/TS 13582:2013 Health informatics -- Sharing of OID registry information
  4. ↑ 4.0 4.1 Pharmacy Templates Material Publication Page on HL7 GitHub https://github.com/HL7/CDA-pharma
  5. ↑ Pharmacy Templates Material Publication Page on ART-DECOR https://hl7intl.art-decor.pub/index.php?prefix=pharmcda-
  6. ↑ Pharmacy Templates Project Live Landing Page https://art-decor.org/ad/#/pharmcda-/project/overview
  7. ↑ Get SNOMED CT http://www.ihtsdo.org/snomed-ct/get-snomed-ct

Figures

  1. ↑ Locating ballot comments
Retrieved from "http://wiki.international-patient-summary.net/index.php?title=PHARM_Templates_Implementationguide&oldid=9670"