Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

IG Home Page

MATCHBOX CDA definition

This Implementation Guide is a representation of the Clinical Document Architecture (CDA) R2.0 specification using FHIR Logical Models expressed as FHIR StructureDefinition instances.

20240619: This CDA Model is derived from HL7 2.0.0-sd

For use with matchbox the following adaptions have been made:

IHE LAB and Pharm additions

LabCriterion
LabPrecondition
Material
ObservationRange
Person
PharmContent
PharmIngredient
PharmMedicineClass
PharmPackagedMedicine
PharmSpecializedKind
PharmSubstance
PharmSuperContent
ServiceEvent

Versionless dependency to terminology

• see Pull Request

Australian addition

CS Support in Observation.value

Austria additions

hl7at extensions: ClinicalDocument.terminologyDate, ClinicalDocument.formatCode, ClinicalDocument.practiceSettingCode

max card. changed from 1 to * for ClinicalDocument.legalAuthenticator and max card. changed from 1 to * CustodianOrganization.telecom

CDA definition

This guide does not replace the CDA specification. It includes the Overview, Implementation Notes, and Narrative Block information from the specification to provide context and guidance. To understand CDA, readers should consult the actual CDA specification. If there are any differences found between the specification and this guide, the specification takes precedence and is assumed to be correct.

CDA Extensions

This guide also incorporates the approved SDTC extensions. Elements from the extensions will be found with ‘sdtc’ before their name. They also are defined to be in the urn:hl7-org:sdtc namespace and that is visible in the structure pages. Custodian Organization has an example of an extension element (sdtcTelecom). Note that while extensions are prefixed with ‘sdtc’, their actual XML name does not include this. Their XML name is displayed in the structure pages as XML. For example, the CustodianOrganization’s sdtcTelecom would appear in an instance as either <telecom xmlns="urn:hl7-org:sdtc" value="...." /> or in a document with a defined prefix for sdtc:

<ClinicalDocument xmlns="urn:hl7-org:v3" xmlns:sdtc="urn:hl7-org:v3/voc">
	<custodian>
		<assignedCustodian>
			<representedCustodianOrganization>
				<sdtc:telecom value="..." />
	...

CDA Example

An example of a CDA document has been provided along with a transformed version of the example using the informative CDA stylesheet.

CDA Validation

With the representation of the CDA structures using FHIR StructureDefinitions, there is now an option on how to validate CDA documents. The CDA schemas are still valid and can be found here. Additionally, by pointing the FHIR validator at this guide, CDA instances can be validated using FHIR validators.

FHIRPath Supplements

The FHIRPath language defines a set of contexts that get passed into expressions and also allows the definition of additional contexts and functions. CDA provides the following supplemental guidance for evaluating FHIRPath:

• The %resource variable when it appears in expressions on CDA profiles will be evaluated as the root ClinicalDocument.

• A new function: hasTemplateIdOf([ProfileUrl]) evaluates to true or false based on whether the XML contains a <templateId /> element corresponding to the identifier of a particular profile.

For example, if a profile like http://hl7.org/cda/us/custom/StructureDefinition/ExampleSection contains an identifier property like urn:hl7ii:2.16.840.1.113883.10.20.22.99.999:2024-05-01, then the following XPath:

%resource.component.structuredBody.component.where(section.hasTemplateIdOf('http://hl7.org/cda/us/custom/StructureDefinition/ExampleSection'))

will return true if the document contains a section with the templateId of Example Section.

It is equivalent to the following, but allows an IG author to easily update the templateId extensions without finding-and-replacing constraint expressions:

%resource.component.structuredBody.component.where(section.templateId.where(root = '2.16.840.1.113883.10.20.22.99.999' and extension = '2024-05-01'))

Authors

The current specification lists the following people as editors/authors:

• Robert H. Dolin, MD
• Liora Alschuler
• Sandy Boyer, BSP
• Calvin Beebe
• Fred M. Behlen, PhD
• Paul V. Biron
• Amnon Shabo (Shvo), PhD

This guide has the following authors:

• Jean Duteau
• Rosemary Hofstede
• Benjamin Flessner
• Susan Rand

The CDA community also benefits from the following people who have contributed to the guide:

• Austin Kreisler
• John D’Amore
• Lisa Nelson
• Brett Marquard
• Gay Dolin
• Matt Szczepankiewicz

Other Information

This publication includes IP covered under the following statements.

• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: ClinicalDocument, ExternalDocument, ParentDocument and Section

IG	Package	FHIR	Comment
Clinical Document Architecture	hl7.cda.uv.core#2.0.0-sd-202406-matchbox-patch	R5
FHIR Extensions Pack	hl7.fhir.uv.extensions.r5#5.1.0	R5	Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
HL7 Terminology (THO)	hl7.terminology#5.3.0	R4
FHIR Extensions Pack	hl7.fhir.uv.extensions.r4#1.0.0	R4

There are no Global profiles defined