Back To Index  <<  Back To Templates

draft Template  UV Subordinate Substance Administration

Id 2.16.840.1.113883.10.21.4.6
ref
pharmcda-
 		Effective Date 2023‑01‑30 09:36:00
Status draft Draft Version Label 2023
Name UVSubordinateadministration Display Name UV Subordinate Substance Administration
Description Universal 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 5 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.22.4.15 Containment draft IPS Immunization (STU2) 2024‑08‑04 21:20:24
2.16.840.1.113883.10.22.3.5 link pending IPS Immunizations Section (STU1) 2017‑04‑05
2.16.840.1.113883.10.22.1.1 link draft International Patient Summary (2021) 2020‑07‑14 16:08:21
2.16.840.1.113883.10.22.4.4 Containment draft IPS Medication Statement (STU2) 2024‑08‑04 10:41:54
2.16.840.1.113883.10.22.3.1 link pending IPS Medication Summary Section (STU1) 2016‑11‑11
Relationship Version: template 2.16.840.1.113883.10.21.4.6 UV Subordinate Substance Administration (2017‑04‑30)
ref
pharmcda-

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>
Item DT Card Conf Description Label
hl7:substanceAdministration
 		1 … 1 R (UVSdotsion)
@classCode
 		cs 1 … 1 F SBADM
@moodCode
 		cs 1 … 1 R If 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)
  Constraint The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration
hl7:templateId
 		II 1 … 1 M (UVSdotsion)
@root
 		uid 1 … 1 F 2.16.840.1.113883.10.21.4.6
hl7:statusCode
 		CS 1 … 1 M (UVSdotsion)
  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)
Choice 1 … 1 Elements 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']
hl7:effectiveTime
 		TS 0 … 1 C This required element describes the frequency of intakes. If not known it shall be valued with the nullflavor "UNK" (UVSdotsion)
where [@value or @nullFlavor]
  Example
Once (known date)
<effectiveTime value="20170404"/>
  Example
Unknown
<effectiveTime nullFlavor="UNK"/>
hl7:effectiveTime
 		PIVL_TS 0 … 1 C Periodic Time Interval (UVSdotsion)
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>
hl7:effectiveTime
 		EIVL_TS 0 … 1 C Event Related Time Interval (UVSdotsion)
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>
hl7:event
 		EIVL.event 0 … 1 C (UVSdotsion)
@code
 		cs 0 … 1  
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10706 TimingEvent (DYNAMIC)
hl7:effectiveTime
 		SXPR_TS 0 … 1 R Combined Time Interval (UVSdotsion)
where [@xsi:type='SXPR_TS']
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 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. 		(UVSdotsion)
@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
<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>
hl7:rateQuantity
 		IVL_PQ 0 … 1 (UVSdotsion)
hl7:maxDoseQuantity
 		RTO_PQ_PQ 0 … 1 (UVSdotsion)
hl7:administrationUnitCode
 		CE 0 … 1 (UVSdotsion)
  CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.14570 AdministrableDrugForm (DYNAMIC)
hl7:consumable
 		1 … 1 R (UVSdotsion)
hl7:manufacturedProduct
 		1 … 1 R (UVSdotsion)
hl7:manufacturedMaterial
 		1 … 1 R (UVSdotsion)
@nullFlavor
 		cs 1 … 1 F NA