Difference between revisions of "2.16.840.1.113883.10.22.2.7/static-2017-04-12T000000"

From HL7 IPS
Jump to: navigation, search
(Automated ADBot page content)
(Automated ADBot page content)
Line 1: Line 1:
<table xmlns="http://www.w3.org/1999/xhtml" class="artdecor" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Id</th><td style="text-align: left;">2.16.840.1.113883.10.22.2.7</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2017‑04‑12</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Status</th><td style="text-align: left;">[[File:Kyellow.png|14px]] Draft</td><th style="width: 20em; text-align: left;">Version Label</th><td style="text-align: left;"></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Name</th><td style="text-align: left;">IPSCDArelatedDocument</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">IPS CDA relatedDocument</td></tr><td style="text-align: left;" colspan="4"><table class="treetable" id="templateDescTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Description</td></tr><tr><td><div><p>An IPS may have three types of parent document: <br /></p><ul><li>A superseded version that the present instance of the document wholly replaces (typeCode = RPLC). <br /></li><li>A source document from which the present document is transformed (typeCode = XFRM). An IPS may be created by transformation from an already existing local Patient Summary or an IPS document. An example of this case is the creation of a derived instance in which translations are appended in order to facilitate the cross-border usage of this document; or the case in which a local patient summary is transformed to originate a new IPS instance.<br /></li><li>An original version that the present document integrates (typeCode = APND). In some cross-border services legal agreements (see e.g. the European Digital Service Infrastructure for eHealth), for liability reasons, it is required that together with the Patient Summary also a printable representation of the original national data / document this IPS comes from is also transmitted or made available for consultation. The relationship between the IPS and this content may be tracked using this relationship. </li></ul><div>Note 1: even for countries not dealing with real documents in their National Infrastructures (e.g. data collected from local databases), this mechanism could be useful to identify the collection of data used for generating the epSOS CDAs, facilitating the information backtracking. In that case the ID might be that of the epSOS friendly document or of any other kind of intermediate document used for generating the NCP document input.
+
<table xmlns="http://www.w3.org/1999/xhtml" class="artdecor" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Id</th><td style="text-align: left;">2.16.840.1.113883.10.22.2.7</td><th style="width: 20em; text-align: left;">Effective Date</th><td style="text-align: left;"> valid from 2017‑04‑12</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Status</th><td style="text-align: left;">[[File:Kyellow.png|14px]] Draft</td><th style="width: 20em; text-align: left;">Version Label</th><td style="text-align: left;"></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Name</th><td style="text-align: left;">IPSCDArelatedDocument</td><th style="width: 20em; text-align: left;">Display Name</th><td style="text-align: left;">IPS CDA relatedDocument</td></tr><td style="text-align: left;" colspan="4"><table class="treetable" id="templateDescTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Description</td></tr><tr><td><div><p>An IPS may have three types of parent document: <br /></p><ul><li>A superseded version that the present instance of the document wholly replaces (typeCode = RPLC). <br /></li><li>A source document from which the present document is transformed (typeCode = XFRM). An IPS may be created by transformation from an already existing local Patient Summary or an IPS document. An example of this case is the creation of a derived instance in which translations are appended in order to facilitate the cross-border usage of this document; or the case in which a local patient summary is transformed to originate a new IPS instance.<br /></li><li>An original version that the present document integrates (typeCode = APND). Some cross-border legal agreements (e.g.  the European Digital Service Infrastructure for eHealth) require the patient summary to be accompanied by  a printable representation of the original national data / document this IPS comes from. The relationship between the IPS and this content may be tracked using this relationship. </li></ul><div>Note 1: even for countries not dealing with real documents in their National Infrastructures (e.g. data collected from local databases), this mechanism could be useful to identify the collection of data used for generating the epSOS CDAs, facilitating the information backtracking. In that case the ID might be that of the epSOS friendly document or of any other kind of intermediate document used for generating the NCP document input. </div><div>Note 2: even if none of the allowable relationships defined by the CDA standard (XFRM, RPLC, APND) fits perfectly with the described case; the APND relationship seems to be the one that fits the better. In fact “An addendum is a separate document that references the parent document, and may extend or alter the observations in the prior document. The parent document remains a current component of the patient record, and the addendum and its parent are both read by report recipients.” </div></div></td></tr></table></td><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Classification</th><td style="text-align: left;" colspan="3">CDA Header Level Template</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Open/Closed</th><td style="text-align: left;" colspan="3">Open (other than defined elements are allowed)</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Used by / Uses</th><td style="text-align: left;" colspan="3"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Used by 0 transactions and 1 template, Uses 0 templates</td></tr><tr><td><div><table class="artdecor" width="100%" border="0" cellspacing="1" cellpadding="3" style="background: transparent;"><tr><th style="width: 20%; text-align: left;">Used by</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.1.1</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] International Patient Summary</td><td style="text-align: left;">2017‑04‑11</td></tr></table></div></td></tr></table></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Relationship</th><td style="text-align: left;" colspan="3">Adaptation: template 2.16.840.1.113883.10.12.111 <i> </i> (2005‑09‑07)</td></tr><tr class="explabel " style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Example of national document identified by its ID</span></td></tr><tr><td><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">XFRM</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is obtained as trasformation of the "aa-bb-cc" document --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa-bb-cc</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span></tt></td></tr></table></td></tr><tr class="explabel " style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Reference to the local PS and to supporting documentation</span></td></tr><tr><td><tt><span style="display: block;"><span style="color:green">&lt;!-- the example starts here --&gt;<br /></span></span><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">XFRM</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is obtained as trasformation of the "aa-bb-cc" Local Patient Summary  --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa-bb-cc</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">APND</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is integrated by the information provided by the "aa1-bb1-cc1" document --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa1-bb1-cc1</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span><span style="display: block;"><span style="color:green">&lt;!-- the example ends here --&gt;<br /></span></span></tt></td></tr></table></td></tr><tr style="vertical-align: top;"><td colspan="4" class="tabtab"><table class="treetable" id="transactionTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr><th style="width: 30%; text-align: left;">Item</th><th style="width: 2em; text-align: left;">DT</th><th style="width: 2em; text-align: left;">Card</th><th style="width: 2em; text-align: left;">Conf</th><th style="text-align: left;">Description</th><th style="width: 2em; text-align: left;">Label</th></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td><tt><strong>hl7:relatedDocument<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@typeCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>R</td><td style="vertical-align: top;" colspan="2"></td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td class="conf">CONF</td><td colspan="4"><table class="artdecor" width="100%" border="0" cellspacing="2" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><td>The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.11610 <i>x_ActRelationshipDocument </i>(DYNAMIC)</td></tr></table></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:parentDocument<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@classCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">DOCCLIN</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@moodCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">EVN</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:id<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>1 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:code<br /></strong></tt></td></tr></table></td><td><strong>CD.IPS</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@codeSystem<br /></strong></tt></td></tr></table></td><td rowspan="1" class="conf">CONF</td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">2.16.840.1.113883.6.1 (Logical Observation Identifier Names and Codes)</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:text<br /></strong></tt></td></tr></table></td><td><strong>ED</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:setId<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="ad-diffblock-horizontal " cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:versionNumber<br /></strong></tt></td></tr></table></td><td><strong>INT</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS...ent)</span></td></tr></table></td></tr></table>
                </div><div>Note 2: even if no one of the allowable relationships defined by the CDA standard (XFRM, RPLC, APND) fits perfectly with the described case; the APND relationship seems to be that that fits the better. In fact “An addendum is a separate document that references the parent document, and may extend or alter the observations in the prior document. The parent document remains a current component of the patient record, and the addendum and its parent are both read by report recipients.”
 
                </div></div></td></tr></table></td><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Classification</th><td style="text-align: left;" colspan="3">CDA Header Level Template</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Open/Closed</th><td style="text-align: left;" colspan="3">Open (other than defined elements are allowed)</td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Used by / Uses</th><td style="text-align: left;" colspan="3"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;">Used by 0 transactions and 1 template, Uses 0 templates</td></tr><tr><td><div><table class="artdecor" width="100%" border="0" cellspacing="1" cellpadding="3" style="background: transparent;"><tr><th style="width: 20%; text-align: left;">Used by</th><th style="width: 1%; text-align: left;"> as </th><th style="width: 60%; text-align: left;">Name</th><th style="width: 19%; text-align: left;">Version</th></tr><tr><td style="text-align: left;">2.16.840.1.113883.10.22.1.1</td><td style="text-align: left;">Include</td><td style="text-align: left;">[[File:Kyellow.png|14px]] International Patient Summary</td><td style="text-align: left;">2017‑04‑11</td></tr></table></div></td></tr></table></td></tr><tr style="vertical-align: top;"><th style="width: 20em; text-align: left;">Relationship</th><td style="text-align: left;" colspan="3">Adaptation: template 2.16.840.1.113883.10.12.111 (<i>2005‑09‑07</i>)</td></tr><tr class="explabel" style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Example of national document identified by its ID</span></td></tr><tr><td><tt><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">XFRM</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is obtained as trasformation of the "aa-bb-cc" document --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa-bb-cc</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span></tt></td></tr></table></td></tr><tr class="explabel" style="vertical-align: top;"><td style="width: 20em; text-align: left;">Example</td><td colspan="3" class="explabelblue"><table class="treetable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr class="desclabel"><td style="height: 1.5em;" class="togglertreetable"><span class="expcaption">Reference to the local PS and to supporting documentation</span></td></tr><tr><td><tt><span style="display: block;"><span style="color:green">&lt;!-- the example starts here --&gt;<br /></span></span><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">XFRM</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is obtained as trasformation of the "aa-bb-cc" Local Patient Summary  --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa-bb-cc</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span><span style="display: block;" class="explrendered"><span class="ppsign">&lt;</span><span class="ppelement">relatedDocument</span> <span class="ppattribute">typeCode</span><span class="ppsign">="</span><span class="ppcontent">APND</span><span class="ppsign">"</span><span class="ppsign">&gt;</span><br /><span style="display: block;">  <span style="color:green">&lt;!-- the IPS is integrated by the information provided by the "aa1-bb1-cc1" document --&gt;<br /></span></span><span style="display: block;" class="explrendered">  <span class="ppsign">&lt;</span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span><br /><span style="display: block;" class="explrendered">    <span class="ppsign">&lt;</span><span class="ppelement">id</span> <span class="ppattribute">root</span><span class="ppsign">="</span><span class="ppcontent">aa1-bb1-cc1</span><span class="ppsign">"</span><span class="ppsign">/</span><span class="ppsign">&gt;</span></span>  <span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">parentDocument</span><span class="ppsign">&gt;</span></span><span class="ppsign">&lt;/</span><span class="ppnamespace"></span><span class="ppelement">relatedDocument</span><span class="ppsign">&gt;</span></span><span style="display: block;"><span style="color:green">&lt;!-- the example ends here --&gt;<br /></span></span></tt></td></tr></table></td></tr><tr style="vertical-align: top;"><td colspan="4" class="tabtab"><table class="treetable" id="transactionTable" width="100%" border="0" cellspacing="3" cellpadding="2" style="background: transparent;"><tr><th style="width: 30%; text-align: left;">Item</th><th style="width: 2em; text-align: left;">DT</th><th style="width: 2em; text-align: left;">Card</th><th style="width: 2em; text-align: left;">Conf</th><th style="text-align: left;">Description</th><th style="width: 2em; text-align: left;">Label</th></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td><tt><strong>hl7:relatedDocument<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>0 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@typeCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>1 … 1</strong></span></td><td>R</td><td style="vertical-align: top;" colspan="2"></td></tr><tr style="vertical-align: top;"><td style="background-color: white;" colspan="1"> </td><td class="conf">CONF</td><td colspan="4"><table class="artdecor" width="100%" border="0" cellspacing="2" cellpadding="2" style="background: transparent;"><tr style="vertical-align: top;"><td>The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.11610 <i>x_ActRelationshipDocument </i>(DYNAMIC)</td></tr></table></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:parentDocument<br /></strong></tt></td></tr></table></td><td><strong></strong></td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@classCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">DOCCLIN</td></tr><tr><td style="vertical-align: top;" class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@moodCode<br /></strong></tt></td></tr></table></td><td>cs</td><td><span><strong>0 … 1</strong></span></td><td>F</td><td style="vertical-align: top;" colspan="2">EVN</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:id<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>1 … *</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:code<br /></strong></tt></td></tr></table></td><td><strong>CD.IPS</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr style="vertical-align: top;"><td><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>@codeSystem<br /></strong></tt></td></tr></table></td><td rowspan="1" class="conf">CONF</td><td><span style="color: black;"><strong>1 … 1</strong></span></td><td><strong>F</strong></td><td colspan="2">2.16.840.1.113883.6.1 (Logical Observation Identifier Names and Codes)</td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:text<br /></strong></tt></td></tr></table></td><td><strong>ED</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:setId<br /></strong></tt></td></tr></table></td><td><strong>II</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr><tr style="vertical-align: top; background-color: #FFEAEA;"><td class="columnName"><table class="artdecor" cellpadding="1" style="background: transparent;"><tr><td style="vertical-align: top;">[[File:Treeblank.png|16px]]</td><td style="vertical-align: top;">[[File:Treetree.png|16px]]</td><td><tt><strong>hl7:versionNumber<br /></strong></tt></td></tr></table></td><td><strong>INT</strong></td><td><span style="color: black;"><strong>0 … 1</strong></span></td><td><span style="color: color: black;"><strong>R</strong></span></td><td></td><td style="background-color: #FFEEEE;"><span title="">(IPS…ent)</span></td></tr></table></td></tr></table>
 

Revision as of 10:52, 15 December 2017

Id2.16.840.1.113883.10.22.2.7Effective Date valid from 2017‑04‑12
StatusKyellow.png DraftVersion Label
NameIPSCDArelatedDocumentDisplay NameIPS CDA relatedDocument
Description

An IPS may have three types of parent document:

  • A superseded version that the present instance of the document wholly replaces (typeCode = RPLC). 
  • A source document from which the present document is transformed (typeCode = XFRM). An IPS may be created by transformation from an already existing local Patient Summary or an IPS document. An example of this case is the creation of a derived instance in which translations are appended in order to facilitate the cross-border usage of this document; or the case in which a local patient summary is transformed to originate a new IPS instance.
  • An original version that the present document integrates (typeCode = APND). Some cross-border legal agreements (e.g.  the European Digital Service Infrastructure for eHealth) require the patient summary to be accompanied by  a printable representation of the original national data / document this IPS comes from. The relationship between the IPS and this content may be tracked using this relationship. 
Note 1: even for countries not dealing with real documents in their National Infrastructures (e.g. data collected from local databases), this mechanism could be useful to identify the collection of data used for generating the epSOS CDAs, facilitating the information backtracking. In that case the ID might be that of the epSOS friendly document or of any other kind of intermediate document used for generating the NCP document input.
Note 2: even if none of the allowable relationships defined by the CDA standard (XFRM, RPLC, APND) fits perfectly with the described case; the APND relationship seems to be the one that fits the better. In fact “An addendum is a separate document that references the parent document, and may extend or alter the observations in the prior document. The parent document remains a current component of the patient record, and the addendum and its parent are both read by report recipients.”
ClassificationCDA Header Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.22.1.1IncludeKyellow.png International Patient Summary2017‑04‑11
RelationshipAdaptation: template 2.16.840.1.113883.10.12.111 (2005‑09‑07)
Example
Example of national document identified by its ID
<relatedDocument typeCode="XFRM">
  <!-- the IPS is obtained as trasformation of the "aa-bb-cc" document -->
  <parentDocument>
    <id root="aa-bb-cc"/>  </parentDocument>
</relatedDocument>
Example
Reference to the local PS and to supporting documentation
<!-- the example starts here -->
<relatedDocument typeCode="XFRM">
  <!-- the IPS is obtained as trasformation of the "aa-bb-cc" Local Patient Summary -->
  <parentDocument>
    <id root="aa-bb-cc"/>  </parentDocument>
</relatedDocument>
<relatedDocument typeCode="APND">
  <!-- the IPS is integrated by the information provided by the "aa1-bb1-cc1" document -->
  <parentDocument>
    <id root="aa1-bb1-cc1"/>  </parentDocument>
</relatedDocument>
<!-- the example ends here -->
ItemDTCardConfDescriptionLabel
hl7:relatedDocument
0 … *R(IPS...ent)
Treetree.png@typeCode
cs1 … 1R
 CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.11610 x_ActRelationshipDocument (DYNAMIC)
Treetree.pnghl7:parentDocument
1 … 1R(IPS...ent)
Treeblank.pngTreetree.png@classCode
cs0 … 1FDOCCLIN
Treeblank.pngTreetree.png@moodCode
cs0 … 1FEVN
Treeblank.pngTreetree.pnghl7:id
II1 … *R(IPS...ent)
Treeblank.pngTreetree.pnghl7:code
CD.IPS0 … 1R(IPS...ent)
Treeblank.pngTreeblank.pngTreetree.png@codeSystem
CONF0 … 1F2.16.840.1.113883.6.1 (Logical Observation Identifier Names and Codes)
Treeblank.pngTreetree.pnghl7:text
ED0 … 1R(IPS...ent)
Treeblank.pngTreetree.pnghl7:setId
II0 … 1R(IPS...ent)
Treeblank.pngTreetree.pnghl7:versionNumber
INT0 … 1R(IPS...ent)