2.16.840.1.113883.10.22.4.33/static-2017-06-15T000000

From HL7 IPS
Revision as of 08:51, 23 August 2018 by ADbot (talk | contribs) (Automated ADBot page content)
Jump to: navigation, search
Id2.16.840.1.113883.10.22.4.33Effective Date2017‑06‑15
Other versions this id:
    StatusKorange.png Under pre-publication reviewVersion LabelSTU1
    NameIPSSubordinateSubstanceAdministrationDisplay NameIPS Subordinate SubstanceAdministration
    DescriptionThis entry is used by a main substanceAdministration act to provide dosage information as the frequency of intakes or the amount of the medication given.
    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)
    Associated with
    Associated with 3 concepts
    IdNameData Set
    hl7ips-data​element-224Kyellow.png Frequency of intake Kyellow.png CEN/TC 251 prEN 17269
    hl7ips-data​element-223Kyellow.png Number of units per intake Kyellow.png CEN/TC 251 prEN 17269
    hl7ips-data​element-119Kyellow.png Dose Instruction Kyellow.png CEN/TC 251 prEN 17269
    RelationshipSpecialization: template 2.16.840.1.113883.10.21.4.6 (DYNAMIC)
    Example
    Example
    <hl7:substanceAdministration classCode="SBADM" moodCode="EVN">
      <hl7:templateId root="2.16.840.1.113883.10.22.4.33"/>  <hl7:statusCode code="active"/>  <!-- choice: 1..1
    element hl7:effectiveTime[@value or @nullFlavor]
    element hl7:effectiveTime[@xsi:type='PIVL_TS']
    element hl7:effectiveTime[@xsi:type='EIVL_TS']
    element hl7:effectiveTime[@xsi:type='SXPR_TS']
    -->
      <hl7:effectiveTime xsi:type="PIVL_TS" institutionSpecified="true">
        <hl7:period value="12" unit="h"/>  </hl7:effectiveTime>
      <hl7:doseQuantity xsi:type="IVL_PQ" value="2" unit="{puff}"/>  <hl7:consumable>
        <hl7:manufacturedProduct>
          <hl7:manufacturedMaterial nullFlavor="NA"/>    </hl7:manufacturedProduct>
      </hl7:consumable>
    </hl7:substanceAdministration>
    ItemDTCardConfDescriptionLabel
    hl7:substanceAdministration
    IPSS...BADM
     
    Target.png
    hl7ips-data​element-119Kyellow.png Dose Instruction Kyellow.png CEN/TC 251 prEN 17269
    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'.</substanceAdministration>
     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 … 1MIPSS...BADM
    Treeblank.pngTreetree.png@root
    uid1 … 1F2.16.840.1.113883.10.22.4.33
    Treetree.pnghl7:statusCode
    CS1 … 1MIPSS...BADM
     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"IPSS...BADM
    Treeblank.pngTreeblank.png where [@value or @nullFlavor]
     
    Target.png
    hl7ips-data​element-224Kyellow.png Frequency of intake Kyellow.png CEN/TC 251 prEN 17269
     Example
    Once (known date)
    <effectiveTime value="20170404"/>
     Example
    Unknown
    <effectiveTime nullFlavor="UNK"/>
    Treeblank.pngTreetree.pnghl7:effectiveTime
    PIVL_TS0 … 1CIPSS...BADM
    Treeblank.pngTreeblank.png where [@xsi:type='PIVL_TS']
     
    Target.png
    hl7ips-data​element-224Kyellow.png Frequency of intake Kyellow.png CEN/TC 251 prEN 17269
     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 … 1CIPSS...BADM
    Treeblank.pngTreeblank.png where [@xsi:type='EIVL_TS']
     
    Target.png
    hl7ips-data​element-224Kyellow.png Frequency of intake Kyellow.png CEN/TC 251 prEN 17269
     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 … 1CIPSS...BADM
    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 … 1RIPSS...BADM
    Treeblank.pngTreeblank.png where [@xsi:type='SXPR_TS']
     
    Target.png
    hl7ips-data​element-224Kyellow.png Frequency of intake Kyellow.png CEN/TC 251 prEN 17269
    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.
    IPSS...BADM
     
    Target.png
    hl7ips-data​element-223Kyellow.png Number of units per intake Kyellow.png CEN/TC 251 prEN 17269
    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
    <doseQuantity nullFlavor="OTH">
      <translation>
        <originalText>
          <reference value="#text-ref-1"/>    </originalText>
      </translation>
    </doseQuantity>
    Treetree.pnghl7:rateQuantity
    IVL_PQ0 … 1IPSS...BADM
    Treetree.pnghl7:consumable
    1 … 1RIPSS...BADM
    Treeblank.pngTreetree.pnghl7:manufacturedProduct
    1 … 1RIPSS...BADM
    Treeblank.pngTreeblank.pngTreetree.pnghl7:manufactured​Material
    1 … 1RIPSS...BADM
    Treeblank.pngTreeblank.pngTreeblank.pngTreetree.png@nullFlavor
    cs1 … 1FNA