Back To Index  <<  Back To Templates

draft Template  IPS Internal Reference

Id 2.16.840.1.113883.10.22.4.31 Effective Date 2017‑05‑02
Status draft Draft Version Label
Name IPSEntryInternalReference Display Name IPS Internal Reference
Description This template is used to reference (point to) information contained in other entries within the same document.
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 3 templates, Uses 0 templates
Used by as Name Version
2.16.840.1.113883.10.22.4.17 Containment draft IPS Procedure Entry 2017‑03‑27
2.16.840.1.113883.10.22.3.4 link draft IPS History of Procedures Section 2017‑03‑27
2.16.840.1.113883.10.22.1.1 link draft International Patient Summary 2017‑04‑11
Relationship Adaptation: template 1.3.6.1.4.1.19376.1.5.3.1.4.4.1 (2013‑12‑20)
Example
Reference to an uncoded element
<act classCode="ACT" moodCode="cs">
  <templateId root="2.16.840.1.113883.10.22.4.31"/>  <id root="1.2.3.999" extension="__example only__"/>  <code nullFlavor="NA"/></act>
Item DT Card Conf Description Label
hl7:act
 R (IPSdotsnce)
@classCode
 cs 1 … 1 F ACT
@moodCode
 cs 1 … 1 R The @moodCode of the reference SHALL match the @moodCode of the referenced element
  Variable let Name refMoodCode  
  Value @moodCode  
  Variable let Name refID  
  Value concat(hl7:id[1]/@root,'#',hl7:id[1]/@extension)  
  Variable let Name refCode  
  Value concat(hl7:code[1]/@code,'#',hl7:code[1]/@codeSystem)  
  Variable let Name reffedObject  
  Value (ancestor::hl7:ClinicalDocument//*:id[concat(@root,'#',@extension)=$refID][not(preceding-sibling::hl7:templateId/@root='1.3.6.1.4.1.19376.1.5.3.1.4.4.1')]/parent::*)[1]  
  Schematron assert role red error  
  test not(exists($reffedObject)) or $reffedObject[@moodCode=$refMoodCode]  
  Message The @moodCode of the reference SHALL match the @moodCode of the referenced element  
  Schematron assert role red error  
  test exists($reffedObject)  
  Message The root and extension attributes SHALL identify an element defined elsewhere in the same document.  
  Schematron assert role red error  
  test not(exists($reffedObject)) or ($reffedObject[not(*:code/@code)] and hl7:code[@nullFlavor='NA']) or $reffedObject/*:code[concat(@code,'#',@codeSystem)=$refCode]  
  Message The code of the reference SHALL match the code of the referenced element  
hl7:templateId
 II 1 … 1 M (IPSdotsnce)
@root
 uid 1 … 1 F 2.16.840.1.113883.10.22.4.31
hl7:id
 II 1 … 1 R This element shall be present. The root and extension attributes shall identify an element defined elsewhere in the same document. (IPSdotsnce)
hl7:code
 CD 1 … 1 R This element shall be present. It shall be valued when the internal reference is to element that has a <code> element, and shall have the same attributes as the <code> element in the act it references. If the element it references does not have a <code> element, then the nullFlavor attribute should be set to "NA". (IPSdotsnce)
@nullFlavor
 cs 0 … 1 F NA