Back To Index  <<  Back To Templates

ref Template  UV Subordinate Substance Administration

Id 2.16.840.1.113883.10.21.4.6 Effective Date valid from 2017‑04‑30
Status draft Draft Version Label
Name UVSubordinateadministration Display Name UV Subordinate Substance Administration
Description This is the Subordinate Substance Administration to convey information about dosages
Context Parent nodes of template element with id 2.16.840.1.113883.10.21.4.6
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.21.4.1 Containment draft UV Medication Order 2015‑10‑07
2.16.840.1.113883.10.21.4.7 Containment draft UV Medication Statement 2017‑05‑01
Relationship Specialization: template 2.16.840.1.113883.10.12.308 (2005‑09‑07)
Example
Example
<substanceAdministration classCode="SBADM" moodCode="EVN">
  <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>
Item DT Card Conf Description Label
hl7:substanceAdministration
1 … 1 R (UVS…ion)
@classCode
cs 1 … 1 F SBADM
@moodCode
cs 1 … 1 R If the subordinate substance administration refers to Medication Order then a <substanceAdministration> request/intend (@moodCode='RQO' or 'INT') is used; otherwise, to record medications which are stated to have taken, the @moodCode shall be set to 'EVN'.
  CONF
The value of @moodCode shall be drawn from value set 2.16.840.1.113883.11.20.9.18 MoodCodeEvnInt (DYNAMIC)
  Constraint The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration
hl7:templateId
II 1 … 1 M (UVS…ion)
@root
uid 1 … 1 F 2.16.840.1.113883.10.21.4.6
hl7:statusCode
CS 1 … 1 M (UVS…ion)
  Constraint The 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)
hl7:effectiveTime
1 … 1 R This required element describes the frequency of intakes. If not known it shall be valued with the nullflavor "UNK" (UVS…ion)
  Example
Once (known date)
<effectiveTime value="20170404"/>
  Example
Unknown
<effectiveTime nullFlavor="UNK"/>
  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>
  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>
hl7:doseQuantity
IVL_PQ 0 … 1 R The <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 expressed 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)
@unit
cs 0 … 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
<!-- TO BE CHECKED -->
<doseQuantity value="2" unit="{puff}">
  <translation>
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>
  </translation>
</doseQuantity>
  Example
Textual dosage
<!-- TO BE CHECKED -->
<doseQuantity>
  <translation>
    <originalText>
      <reference value="#text-ref-1"/>    </originalText>
  </translation>
</doseQuantity>
hl7:rateQuantity
IVL_PQ 0 … 1 (UVS…ion)
hl7:consumable
1 … 1 R (UVS…ion)
hl7:manufacturedProduct
1 … 1 R (UVS…ion)
hl7:manufacturedMaterial
1 … 1 R (UVS…ion)
@nullFlavor
cs 1 … 1 F NA