Clinical Document Architecture
2.0.1-sd-202510-matchbox-patch - release

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

Logical Model:

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument Version: 2.0.1-sd-202510-matchbox-patch
Active as of 2025-10-29 Computable Name: ClinicalDocument

This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId 0..1 II
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId 0..1 II
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClinicalDocument 1..1 ANY XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... @classCode 0..1 cs Binding: CDAActClass (example)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st Fixed Value: POCD_HD000040
... templateId 0..* II
... id 1..1 II
​... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 1..1 CE Binding: FHIRDocumentTypeCodes (example)
... title 0..1 ST
... sdtcStatusCode 0..1 CS XML Namespace: urn:hl7-org:sdtc
XML: statusCode (urn:hl7-org:sdtc)
Binding: ActStatus (required)
... terminologyDate 0..1 TS XML Namespace: urn:hl7-at:v3
XML: terminologyDate (urn:hl7-at:v3)
... formatCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: formatCode (urn:hl7-at:v3)
... practiceSettingCode 0..1 CD XML Namespace: urn:hl7-at:v3
XML: practiceSettingCode (urn:hl7-at:v3)
... effectiveTime 1..1 TS
... confidentialityCode 1..1 CE
... languageCode 0..1 CS Binding: AllLanguages (required)
... setId 0..1 II
... versionNumber 0..1 INT
... copyTime 0..1 TS
... recordTarget 1..* RecordTarget
... author 1..* Author
... dataEnterer 0..1 DataEnterer
... informant 0..* Informant
... custodian 1..1 Custodian
... informationRecipient 0..* InformationRecipient
... legalAuthenticator 0..* LegalAuthenticator
... authenticator 0..* Authenticator
... participant 0..* Participant1
... inFulfillmentOf 0..* InFulfillmentOf
... documentationOf 0..* DocumentationOf
... relatedDocument 0..* RelatedDocument
... authorization 0..* Authorization
... componentOf 0..1 ComponentOf
... component 1..1 Component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClinicalDocument.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.classCode Base example CDAActClass 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.moodCode Base required CDAActMood 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
ClinicalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
ClinicalDocument.sdtcStatusCode Base required ActStatus 📦2.0.0 THO v5.3
ClinicalDocument.languageCode Base required All Languages 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ClinicalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

​Other representations of profile: CSV, Excel