Back To Index  <<  Back To Templates

ref Template  External document

Id 2.16.756.5.30.1.1.10.4.29
ref
hl7chcda-
 		Effective Date 2018‑04‑18
Status pending Under pre-publication review Version Label 2017
Name cdach_entry_ExternalDocument Display Name External document
Description
External documents can be included in a CDA document, either by means of references or by means of XML embedding.
This template defines a reference to an external document, only.
Embedded documents can be created with the template Observation Media (or derived templates).
Context Parent nodes of template element with id 2.16.756.5.30.1.1.10.4.29
Label CDA‑CH V2
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 10 templates, Uses 0 templates
Used by as Name Version
2.16.756.5.30.1.1.10.4.17 Containment pending Laboratory Isolate Organizer (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.4 link pending Laboratory Report Data Processing Entry (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.3.3 link pending Laboratory Speciality Section - coded (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.1.10 link pending General Laboratory Report (2018) 2018‑04‑19
2.16.756.5.30.1.1.10.3.5 link pending Laboratory Report Item Section - coded (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.19 Containment pending Laboratory Battery Organizer (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.3 Containment pending Laboratory Observation (2017) 2017‑06‑21
notice Circular reference found with 2.16.756.5.30.1.1.10.4.3, please check
2.16.756.5.30.1.1.10.4.11 link pending Specimen Collection (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.85 link pending Laboratory Isolate Organizer - Pathogen Detection (2018) 2018‑04‑19
2.16.756.5.30.1.1.10.4.87 link pending Laboratory Battery Organizer - Antibiogram (2018) 2018‑04‑19
Relationship Specialization: template 2.16.840.1.113883.10.12.328 (2005‑09‑07)
Adaptation: template 2.16.840.1.113883.10.20.1.36 (DYNAMIC)
Example
Example
<externalDocument classCode="DOC" moodCode="EVN">
  <templateId root="2.16.756.5.30.1.1.10.4.29"/>  <id root="2.999" extension="your id"/>  <text>
    <reference value="http://foo.bar"/>  </text></externalDocument>
Item DT Card Conf Description Label
hl7:externalDocument
 Reference to an external document. CDA‑CH V2
@classCode
 cs 1 … 1 F DOC
@moodCode
 cs 1 … 1 F EVN
hl7:templateId
 II 1 … 1 CDA‑CH V2
@root
 uid 1 … 1 F 2.16.756.5.30.1.1.10.4.29
hl7:id
 II 1 … * M MUST contain the id of the external document. CDA‑CH V2
@root
 uid 1 … 1 R MUST contain the OID of the system that issued the ID. OIDs of code systems, which are published in the public OID registry for the Swiss health care system (oid.refdata.ch) are REQUIRED. Others are NOT ALLOWED.
@extension
 st 0 … 1   Contains the ID itself. The ID MUST be unique within the system that issued the ID.
hl7:code
 NP CDA‑CH V2
hl7:text
 ED 0 … 1 The external document MUST be declared as a link.
The link MUST be declared as an URL, which points to the referenced document.
The same link MUST be used in the human readable part (narrative text) using the <linkHTML> element. 		CDA‑CH V2
hl7:reference
 CDA‑CH V2
  Schematron assert role red error  
  test not(@value) or @value=ancestor::hl7:section/hl7:text//hl7:linkHtml/@href  
  Message The URL of a referenced document MAY be present, and SHALL be represented in Observation / reference / ExternalDocument / text / reference. A <linkHTML> element containing the same URL SHOULD be present in the associated CDA Narrative Block.