Back To Index << Back To Templates

# Template Document Replacement - relatedDocument

Id | 2.16.756.5.30.1.1.10.2.13 ref hl7chcda- | Effective Date | 2019‑01‑01 21:22:58
Status | Active | Version Label | 2020
Name | cdach_header_DocumentReplacement | Display Name | Document Replacement - relatedDocument
Description | Relationship to another CDA-CH V2 based document that is replaced by the current one. All CDA-CH V2 derivatives, i.e. Swiss exchange formats MUST reference this template.
Context | Parent nodes of template element with id 2.16.756.5.30.1.1.10.2.13
Label | CDA‑CH V2
Classification | CDA Header Level Template
Open/Closed | Open (other than defined elements are allowed)
Used by / Uses |
Used by 6 transactions and 15 templates, Uses 0 templates
Used by | as | Name | Version
--- | --- | --- | ---
cdachemed-transaction-4 | Transaction | Medication Prescription document | 2018‑04‑04 15:33:29
cdachemed-transaction-9 | Transaction | Medication Treatment Plan document | 2019‑12‑12 14:11:31
cdachemed-transaction-5 | Transaction | Medication Dispense document | 2018‑04‑04 15:35:51
cdachemed-transaction-6 | Transaction | Pharmaceutical Advice document | 2018‑04‑04 15:36:35
cdachemed-transaction-7 | Transaction | Medication List document | 2018‑04‑04 15:37:19
cdachemed-transaction-8 | Transaction | Medication Card document (2022) | 2018‑04‑04 15:42:50
2.16.756.5.30.1.1.10.9.36 | Include | CDA-CH v2.0 Header Template Compilation (2017) | 2018‑04‑18
2.16.756.5.30.1.1.10.1.9 |  | CDA-CH v2.1 - structuredBody (2020) | 2019‑10‑17 15:22:41
2.16.756.5.30.1.1.10.9.41 | Include | Header Template Compilation Medication Dispense document (2019) | 2018‑01‑08 15:56:47
2.16.756.5.30.1.1.10.1.5 |  | Medication Dispense document (2020) | 2016‑05‑21
2.16.756.5.30.1.1.10.9.42 | Include | Header Template Compilation Medication Card document (2022) | 2019‑10‑17 13:58:45
2.16.756.5.30.1.1.10.1.3 |  | Medication Card document (2022) | 2016‑05‑13
2.16.756.5.30.1.1.10.9.42 | Include | Header Template Compilation Medication Card document (2017) | 2018‑01‑08 16:20:12
2.16.756.5.30.1.1.10.9.43 | Include | Header Template Compilation Pharmaceutical Advice document (2019) | 2018‑01‑08 16:23:16
2.16.756.5.30.1.1.10.1.6 |  | Pharmaceutical Advice document (2020) | 2016‑05‑21
2.16.756.5.30.1.1.10.9.44 | Include | Header Template Compilation MedicationTreatmentPlan (2019) | 2018‑01‑08 16:26:11
2.16.756.5.30.1.1.10.1.7 |  | Medication Treatment Plan document (2020) | 2017‑04‑12 13:57:31
2.16.756.5.30.1.1.10.9.45 | Include | Header Template Compilation Medication Prescription document (2021) | 2018‑01‑08 16:28:39
2.16.756.5.30.1.1.10.1.4 |  | Medication Prescription document (2020) | 2016‑05‑21
2.16.756.5.30.1.1.10.9.46 | Include | Header Template Compilation Medication List document (2019) | 2018‑01‑22 15:29:29
2.16.756.5.30.1.1.10.1.13 |  | Medication List document (2020) | 2018‑01‑22 15:17:26
Relationship | Specialization: template 2.16.840.1.113883.10.12.111 CDA relatedDocument (2005‑09‑07) ref ad1bbr-
Example |
Example
<relatedDocument typeCode="RPLC"> <templateId root="2.16.756.5.30.1.1.10.2.13"/> <parentDocument> <id root="30E19F60-3DB9-48B8-9BFD-FF04C342D0B1"/> <setId root="452A118A-06AB-47D2-A29B-709F7F2EC6FE"/> <versionNumber value="5"/> </parentDocument></relatedDocument>
Item | DT | Card | Conf | Description | Label
--- | --- | --- | --- | --- | ---
hl7:relatedDocument |  | 0 … * |  | Relationship to another CDA-CH V2 based document that is replaced by the current one. Notes: For correction of wrong information, a new document that replaces the earlier document MUST be created. The new document corrects previously incorrect information. This also applies to the case where information in the CDA header has been corrected (e.g., if the original document has been issued to the wrong patient). While processing the new document at the recipient, all values from the previous document MUST be interpreted as deprecated (deleted/marked as deleted/deprecated) and all values in the new document MUST be marked as valid: Values that were only contained in the previous document have to be treated as deleted. Values that are present in both documents are overwritten with the contents of the new document. Values that are only contained in the new document are to be added. | CDA‑CH V2
@typeCode | cs | 1 … 1 | F | RPLC
| Indicates that it is a relationship to another document that needs to be replaced.
hl7:templateId | II | 1 … 1 | M |  | CDA‑CH V2
@root | uid | 1 … 1 | F | 2.16.756.5.30.1.1.10.2.13
hl7:parentDocument |  | 1 … 1 | R | Relationship to the document that needs to be replaced. | CDA‑CH V2
hl7:id | II | 1 … 1 | M | The id of the document to be replaced MUST be declared. | CDA‑CH V2
@root | uid | 1 … 1 | R | The id (GUID) of the document to be replaced.
@extension | st | 0 | NP | NP/not present
hl7:setId | II | 1 … 1 | M | The setId of the document to be replaced MUST be declared. | CDA‑CH V2
@extension | st | 0 | NP | NP/not present
@root | uid | 1 … 1 | R | The setId (GUID) of the document to be replaced and MUST be identical with the content of the setId of the current document.
| Schematron assert | role | error |
| test | (@root=/hl7:ClinicalDocument/hl7:setId/@root) and not(@extension) and not(/hl7:ClinicalDocument/hl7:setId/@extension) |
| Message | ClinicalDocument/setId: MUST be identical to the one of the replaced document |
hl7:versionNumber | INT | 1 … 1 | M | The version number of the document to be replaced. | CDA‑CH V2
| Schematron assert | role | error |
| test | /hl7:ClinicalDocument/hl7:versionNumber/@value > @value |
| Message | ClinicalDocument/versionNumber: MUST be higher than the one of the replaced document |