Difference between revisions of "2.16.840.1.113883.10.22.4.33/static-2017-06-15T000000"

From HL7 IPS
Jump to: navigation, search
(Automated ADBot page content)
(No difference)

Revision as of 20:32, 6 July 2017

Id2.16.840.1.113883.10.22.4.33Effective Date valid from 2017‑06‑15
StatusKyellow.png DraftVersion Label
NameIPSSubordinateSubstanceAdministrationDisplay NameIPS Subordinate SubstanceAdministration
DescriptionTemplate CDA SubstanceAdministration (prototype, directly derived from POCD_RM000040 MIF)
ContextParent nodes of template element with id 2.16.840.1.113883.10.22.4.33
LabelIPSSubordSBADM
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.22.4.4ContainmentKyellow.png IPS Medication Entry2016‑11‑11
2.16.840.1.113883.10.22.3.1Link.pngKyellow.png IPS Medication Summary Section2016‑11‑11
2.16.840.1.113883.10.22.1.1Link.pngKyellow.png International Patient Summary2017‑04‑11
RelationshipSpecialization: template 2.16.840.1.113883.10.12.308 (2005‑09‑07)
ItemDTCardConfDescriptionLabel
hl7:substanceAdministration
IPSSubor…
Treetree.png@classCode
cs1 … 1FSBADM
Treetree.png@moodCode
cs1 … 1RIf the statement refers to a prescribed medication then a <substanceAdministration> intent (moodCode='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)
 ConstraintThe moodCode of this subordinate <substanceAdministration> SHALL be the same of the parent <substanceAdministration> .
Treetree.pnghl7:templateId
II1 … 1MIPSSubor…
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.22.4.33
Treetree.pnghl7:statusCode
CS1 … 1MIPSSubor…
 ConstraintThe statusCode of this subordinate <substanceAdministration> SHALL be the same of that of the parent <substanceAdministration>.
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.11.22.12 ActStatusActiveCompletedAbortedSuspended (2017‑03‑30)
 Example<statusCode code="active"/>
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"
IPSSubor…
Treeblank.pngTreeblank.png where [@value or @nullFlavor]
 Example
Once (known date)
<effectiveTime value="20170404"/>
 Example
Unknown
<effectiveTime nullFlavor="UNK"/>
Treeblank.pngTreetree.pnghl7:effectiveTime
PIVL_TS0 … 1CIPSSubor…
Treeblank.pngTreeblank.png 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 … 1CIPSSubor…
Treeblank.pngTreeblank.png 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 … 1CIPSSubor…
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_TS1 … 1RIPSSubor…
Treeblank.pngTreeblank.png 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.

IPSSubor…
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>
    <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>
Treetree.pnghl7:rateQuantity
IVL_PQ0 … 1IPSSubor…
Treetree.pnghl7:consumable
1 … 1RIPSSubor…
Treeblank.pngTreetree.pnghl7:manufacturedProduct
1 … 1RIPSSubor…
Treeblank.pngTreeblank.pngTreetree.pnghl7:manufactured​Material
1 … 1RIPSSubor…
Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
cs1 … 1FNA