Template

Show index

Template IHE External Reference Entry 2013‑12‑20

Id1.3.6.1.4.1.19376.1.5.3.1.4.4
ref
IHE-PCC-
Effective Date2013‑12‑20
Statusactive ActiveVersion Label2014
NameIHEExternalReferenceEntryDisplay NameIHE External Reference Entry
Description

CDA Documents may reference information contained in other documents. While CDA Release 2.0 supports references in content via the <linkHtml> element, this is insufficient for many EMR systems as the link is assumed to be accessible via a URL, which is often not the case. In order to link an external reference, one needs the document identifier, and access to the clinical system wherein the document resides. For a variety of reasons, it is desirable to refer to the document by its identity, rather than by linking through a URL.

  1. The identity of a document does not change, but the URLs used to access it may vary depending upon location, implementation, or other factors.
  2. Referencing clinical documents by identity does not impose any implementation specific constraints on the mechanism used to resolve these references, allowing the content to be implementation neutral. For example, in the context of an XDS Affinity domain the clinical system used to access documents would be an XDS Registry and one or more XDS Repositories where documents are stored. In other contexts, access might be through a Clinical Data Repository (CDR), or Document Content Management System (DCMS). Each of these may have different mechanisms to resolve a document identifier to the document resource.
  3. The identity of a document is known before the document is published (e.g., in an XDS Repository, Clinical Data Repository, or Document Content Management System), but its URL is often not known. Using the document identity allows references to existing documents to be created before those documents have been published to a URL. This is important to document creators, as it does not impose workflow restrictions on how links are created during the authoring process.

Fortunately, CDA Release 2.0 also provides a mechanism to refer to external documents in an entry, as shown below.

ContextParent nodes of template element with id 1.3.6.1.4.1.19376.1.5.3.1.4.4
Label6.3.4.9
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 4 transactions and 16 templates, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.78.4.8Transactiondraft Patient summary2024‑01‑18
2.16.840.1.113883.3.1937.777.11.4.12Transactiondraft Return PS of country A2012‑05‑02
2.16.840.1.113883.3.1937.777.49.4.2Transactiondraft PS created2022‑05‑19 08:45:25
2.16.840.1.113883.3.1937.777.11.4.23Transactiondraft Return MRO2013‑11‑02
1.2.203.24341.11.10.1.1linkdraft CZ-EU Patient Summary2019‑11‑28 20:23:19
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkdraft epSOS-Patient Summary2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkretired epSOS-Patient Summary2018‑11‑14 10:53:50
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkretired eHDSI Patient Summary2020‑04‑14 13:03:47
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkretired eHDSI Patient Summary2020‑09‑02 10:19:44
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkretired eHDSI Patient Summary2022‑09‑12 13:44:19
1.3.6.1.4.1.12559.11.10.1.3.1.1.3linkactive eHDSI Patient Summary2024‑04‑19 10:03:32
1.3.6.1.4.1.12559.11.10.1.3.1.1.4linkretired epSOS-Health Care Encounter Report2018‑11‑14 09:02:41
1.3.6.1.4.1.12559.11.10.1.3.1.2.5Containmentdraft Section Coded Results2013‑12‑20
1.3.6.1.4.1.12559.11.10.1.3.1.2.5Containmentretired eHDSI Coded Results2020‑04‑16 12:13:16
1.3.6.1.4.1.19376.1.5.3.1.3.12Containmentactive IHE Coded List of Surgeries section (2014)2016‑09‑28 10:10:47
1.3.6.1.4.1.19376.1.5.3.1.3.28Containmentactive IHE Coded Results Section (2014)2015‑10‑05 17:52:06
1.3.6.1.4.1.19376.1.5.3.1.3.30Containmentactive IHE Coded Hospital Studies Summary Section (2016)2017‑03‑16 09:57:56
1.3.6.1.4.1.19376.1.7.3.1.1.15.3.2Containmentactive IHE Hearing Screening Coded Results (2016)2017‑03‑24 12:33:27
2.16.756.5.30.1.1.10.3.31Containmentpending Results Section - coded (2016)2016‑11‑11
2.16.840.1.113883.3.1937.777.78.10.5linkactive UNICOM Patient Summary (v0.1)2024‑01‑18 11:57:06
Example
Example
<act classCode="ACT" moodCode="EVN">
  <templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.4"/>  <id root="" extension=""/>  <code nullFlavor="NA"/>  <text>
    <reference value="#study-1"/>  </text>
  <!-- For CDA -->
  <reference typeCode="REFR|SPRT">
    <externalDocument classCode="DOC" moodCode="EVN">
      <id extension="" root=""/>      <text>
        <reference value="http://foo.."/>      </text>
    </externalDocument>
  </reference>
  <!-- For HL7 Version 3 Messages <sourceOf typeCode='REFR|SPRT'>
<act classCode='DOC' moodCode='EVN'>
<id extension='' root=''/>
<text><reference value='http://foo...'</text>
</act>
</sourceOf>-->
</act>
ItemDTCardConfDescriptionLabel
hl7:act
R6.3.4.9
@classCode
cs1 … 1FACT
@moodCode
cs1 … 1FEVN
hl7:templateId
II1 … 1R6.3.4.9
@root
uid1 … 1F1.3.6.1.4.1.19376.1.5.3.1.4.4
hl7:id
II1 … 1M6.3.4.9
hl7:code
CD1 … 1R6.3.4.9
@nullFlavor
cs1 … 1FNA
hl7:text
ED1 … 1R6.3.4.9
hl7:reference
1 … *R6.3.4.9
@typeCode
cs1 … 1R
 CONF
@typeCode shall be "SPRT"
or
@typeCode shall be "REFR"
hl7:externalDocument
1 … 1R6.3.4.9
@classCode
cs0 … 1FDOC
@moodCode
cs0 … 1FEVN
hl7:id
II1 … 1M6.3.4.9
hl7:text
ED0 … 16.3.4.9