Clinical Document Architecture
2.0.2-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.2-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: ClinicalDocument - Detailed Descriptions

Active as of 2025-12-11

Definitions for the ClinicalDocument logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. ClinicalDocument
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ClinicalDocument.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. ClinicalDocument.classCode
Control0..1
BindingFor example codes, see CDAActClass
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDOCCLIN
6. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
8. ClinicalDocument.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
12. ClinicalDocument.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
14. ClinicalDocument.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
16. ClinicalDocument.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
18. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
20. ClinicalDocument.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Fixed ValuePOCD_HD000040
22. ClinicalDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
24. ClinicalDocument.id
Definition

Represents the unique instance identifier of a clinical document.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. ClinicalDocument.sdtcCategory
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory.
28. ClinicalDocument.code
Definition

The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).

ShortKind of document
Control1..1
BindingFor example codes, see FHIRDocumentTypeCodes
(example to http://hl7.org/fhir/ValueSet/doc-typecodes)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. ClinicalDocument.title
Comments

It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a 'consultation' or 'progress note'). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
32. ClinicalDocument.sdtcStatusCode
Definition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
34. ClinicalDocument.effectiveTime
Definition

Signifies the document creation time, when the document first came into being.

ShortDocument creation time
Comments

Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
36. ClinicalDocument.confidentialityCode
ShortControls the disclosure of information in this document
Comments

Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. ClinicalDocument.languageCode
Definition

Specifies the human language of character data (whether they be in contents or attribute values).

ShortHuman language of character data
Comments

Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
40. ClinicalDocument.setId
ShortAn identifier that is common across all document revisions
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
42. ClinicalDocument.versionNumber
ShortAn integer value used to version successive replacement documents
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
44. ClinicalDocument.copyTime
Definition

Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

ShortDeprecated - use is discouraged
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Requirements

Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.

46. ClinicalDocument.recordTarget
ShortMedical record that this document belongs to
Comments

A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Requirements

The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.

48. ClinicalDocument.author
ShortHumans and/or machines that authored the document
Comments

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Medical Student Progress Note'. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Physician Progress Note' and the value of Author.functionCode is 'rounding physician'), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
50. ClinicalDocument.dataEnterer
ShortParticipant who has transformed a dictated note into text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
Alternate NamesTranscriptionist
52. ClinicalDocument.informant
Definition

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

ShortPerson that provides relevant information
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
54. ClinicalDocument.custodian
Definition

Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.

ShortOrganization that is in charge of maintaining the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
Requirements

The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.

56. ClinicalDocument.informationRecipient
ShortA recipient who should receive a copy of the document
Comments

The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
58. ClinicalDocument.legalAuthenticator
ShortParticipant who has legally authenticated the document
Comments

The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Requirements

While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

60. ClinicalDocument.authenticator
Definition

Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.

ShortParticipant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document
Comments

A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
62. ClinicalDocument.participant
Definition

Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.

ShortOther participants not explicitly mentioned by other classes
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
64. ClinicalDocument.inFulfillmentOf
ShortOrders that are fulfilled by this document
Comments

For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with 'Diagnostic Imaging Report'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
66. ClinicalDocument.documentationOf
ShortThe main Act being documented
Comments

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'History and Physical Report' and the procedure being documented is a 'History and Physical' act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply 'Procedure Report' and the procedure was a 'colonoscopy'. If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
68. ClinicalDocument.relatedDocument
ShortSource of a document revision, addenda, or transformation
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
Requirements

A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.

70. ClinicalDocument.authorization
ShortConsents associated with this document
Comments

The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal 'completed') and should be on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
72. ClinicalDocument.componentOf
Definition

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.

ShortSetting of the clinical encounter during which the documented act(s) or ServiceEvent occurred.
Comments

In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Diabetes Clinic Progress Note'. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Clinic Progress Note' and the value of HealthCareFacility.code is 'cardiology clinic'), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
74. ClinicalDocument.component
ShortBody of the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component

Guidance on how to interpret the contents of this table can be foundhere

0. ClinicalDocument
Control1..1
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ClinicalDocument.classCode
Control0..1
BindingFor example codes, see CDAActClass
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDOCCLIN
4. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. ClinicalDocument.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
8. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.1.3
12. ClinicalDocument.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePOCD_HD000040
14. ClinicalDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. ClinicalDocument.id
Definition

Represents the unique instance identifier of a clinical document.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
18. ClinicalDocument.sdtcCategory
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory.
20. ClinicalDocument.code
Definition

The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).

ShortKind of document
Control1..1
BindingFor example codes, see FHIRDocumentTypeCodes
(example to http://hl7.org/fhir/ValueSet/doc-typecodes)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
22. ClinicalDocument.title
Comments

It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a 'consultation' or 'progress note'). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
24. ClinicalDocument.sdtcStatusCode
Definition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
26. ClinicalDocument.effectiveTime
Definition

Signifies the document creation time, when the document first came into being.

ShortDocument creation time
Comments

Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
28. ClinicalDocument.confidentialityCode
ShortControls the disclosure of information in this document
Comments

Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. ClinicalDocument.languageCode
Definition

Specifies the human language of character data (whether they be in contents or attribute values).

ShortHuman language of character data
Comments

Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
32. ClinicalDocument.setId
ShortAn identifier that is common across all document revisions
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
34. ClinicalDocument.versionNumber
ShortAn integer value used to version successive replacement documents
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
36. ClinicalDocument.copyTime
Definition

Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

ShortDeprecated - use is discouraged
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Requirements

Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.

38. ClinicalDocument.recordTarget
ShortMedical record that this document belongs to
Comments

A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Requirements

The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.

40. ClinicalDocument.author
ShortHumans and/or machines that authored the document
Comments

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Medical Student Progress Note'. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Physician Progress Note' and the value of Author.functionCode is 'rounding physician'), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
42. ClinicalDocument.dataEnterer
ShortParticipant who has transformed a dictated note into text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
Alternate NamesTranscriptionist
44. ClinicalDocument.informant
Definition

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

ShortPerson that provides relevant information
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
46. ClinicalDocument.custodian
Definition

Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.

ShortOrganization that is in charge of maintaining the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
Requirements

The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.

48. ClinicalDocument.informationRecipient
ShortA recipient who should receive a copy of the document
Comments

The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
50. ClinicalDocument.legalAuthenticator
ShortParticipant who has legally authenticated the document
Comments

The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Requirements

While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

52. ClinicalDocument.authenticator
Definition

Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.

ShortParticipant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document
Comments

A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
54. ClinicalDocument.participant
Definition

Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.

ShortOther participants not explicitly mentioned by other classes
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
56. ClinicalDocument.inFulfillmentOf
ShortOrders that are fulfilled by this document
Comments

For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with 'Diagnostic Imaging Report'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
58. ClinicalDocument.documentationOf
ShortThe main Act being documented
Comments

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'History and Physical Report' and the procedure being documented is a 'History and Physical' act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply 'Procedure Report' and the procedure was a 'colonoscopy'. If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
60. ClinicalDocument.relatedDocument
ShortSource of a document revision, addenda, or transformation
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
Requirements

A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.

62. ClinicalDocument.authorization
ShortConsents associated with this document
Comments

The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal 'completed') and should be on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
64. ClinicalDocument.componentOf
Definition

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.

ShortSetting of the clinical encounter during which the documented act(s) or ServiceEvent occurred.
Comments

In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Diabetes Clinic Progress Note'. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Clinic Progress Note' and the value of HealthCareFacility.code is 'cardiology clinic'), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
66. ClinicalDocument.component
ShortBody of the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component

Guidance on how to interpret the contents of this table can be foundhere

0. ClinicalDocument
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ClinicalDocument.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. ClinicalDocument.classCode
Control0..1
BindingFor example codes, see CDAActClass
(example to http://hl7.org/cda/stds/core/ValueSet/CDAActClass)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueDOCCLIN
6. ClinicalDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from CDAActMood
(required to http://hl7.org/cda/stds/core/ValueSet/CDAActMood)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
8. ClinicalDocument.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. ClinicalDocument.typeId
Definition

ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
12. ClinicalDocument.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
14. ClinicalDocument.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
16. ClinicalDocument.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
18. ClinicalDocument.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
20. ClinicalDocument.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Fixed ValuePOCD_HD000040
22. ClinicalDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
24. ClinicalDocument.id
Definition

Represents the unique instance identifier of a clinical document.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. ClinicalDocument.sdtcCategory
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namecategory.
28. ClinicalDocument.code
Definition

The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).

ShortKind of document
Control1..1
BindingFor example codes, see FHIRDocumentTypeCodes
(example to http://hl7.org/fhir/ValueSet/doc-typecodes)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. ClinicalDocument.title
Comments

It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a 'consultation' or 'progress note'). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
32. ClinicalDocument.sdtcStatusCode
Definition

The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.

Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namestatusCode.
34. ClinicalDocument.effectiveTime
Definition

Signifies the document creation time, when the document first came into being.

ShortDocument creation time
Comments

Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
36. ClinicalDocument.confidentialityCode
ShortControls the disclosure of information in this document
Comments

Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. ClinicalDocument.languageCode
Definition

Specifies the human language of character data (whether they be in contents or attribute values).

ShortHuman language of character data
Comments

Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value.

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
40. ClinicalDocument.setId
ShortAn identifier that is common across all document revisions
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
42. ClinicalDocument.versionNumber
ShortAn integer value used to version successive replacement documents
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
44. ClinicalDocument.copyTime
Definition

Represents the time a document is released (i.e. copied or sent to a display device) from a document management system that maintains revision control over the document. Once valued, it cannot be changed. The intent is to give the viewer of the document some notion as to how long the document has been out of the safe context of its document management system.

ShortDeprecated - use is discouraged
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
Requirements

Included for backwards compatibility with CDA, Release One. ClinicalDocument.copyTime has been deprecated because it is not part of the document at the time it is authenticated, but instead represents metadata about the document, applied at some variable time after authentication. Further use is discouraged.

46. ClinicalDocument.recordTarget
ShortMedical record that this document belongs to
Comments

A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RecordTarget
Requirements

The recordTarget(s) of a document are stated in the header and propagate to nested content, where they cannot be overridden.

48. ClinicalDocument.author
ShortHumans and/or machines that authored the document
Comments

In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Medical Student Progress Note'. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Physician Progress Note' and the value of Author.functionCode is 'rounding physician'), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
50. ClinicalDocument.dataEnterer
ShortParticipant who has transformed a dictated note into text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DataEnterer
Alternate NamesTranscriptionist
52. ClinicalDocument.informant
Definition

An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma.

ShortPerson that provides relevant information
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
54. ClinicalDocument.custodian
Definition

Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian.

ShortOrganization that is in charge of maintaining the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Custodian
Requirements

The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document, the custodian represents the steward of the original source document.

56. ClinicalDocument.informationRecipient
ShortA recipient who should receive a copy of the document
Comments

The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient
58. ClinicalDocument.legalAuthenticator
ShortParticipant who has legally authenticated the document
Comments

The CDA is a standard that specifies the structure of exchanged clinical documents. In the case where a local document is transformed into a CDA document for exchange, authentication occurs on the local document, and that fact is reflected in the exchanged CDA document. A CDA document can reflect the unauthenticated, authenticated, or legally authenticated state. The unauthenticated state exists when no authentication information has been recorded (i.e., it is the absence of being either authenticated or legally authenticated).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator
Requirements

While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. A legalAuthenticator has a required legalAuthenticator.time indicating the time of authentication, and a required legalAuthenticator.signatureCode, indicating that a signature has been obtained and is on file.

60. ClinicalDocument.authenticator
Definition

Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it.

ShortParticipant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document
Comments

A clinical document can have zero to many authenticators. While electronic signatures are not captured in a CDA document, both authentication and legal authentication require that a document has been signed manually or electronically by the responsible individual. An authenticator has a required authenticator.time indicating the time of authentication, and a required authenticator.signatureCode, indicating that a signature has been obtained and is on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authenticator
62. ClinicalDocument.participant
Definition

Used to represent other participants not explicitly mentioned by other classes, that were somehow involved in the documented acts.

ShortOther participants not explicitly mentioned by other classes
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant1
64. ClinicalDocument.inFulfillmentOf
ShortOrders that are fulfilled by this document
Comments

For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with 'Diagnostic Imaging Report'.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf
66. ClinicalDocument.documentationOf
ShortThe main Act being documented
Comments

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'History and Physical Report' and the procedure being documented is a 'History and Physical' act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply 'Procedure Report' and the procedure was a 'colonoscopy'. If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf
68. ClinicalDocument.relatedDocument
ShortSource of a document revision, addenda, or transformation
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument
Requirements

A conformant CDA document can have a single relatedDocument with typeCode 'APND'; a single relatedDocument with typeCode 'RPLC'; a single relatedDocument with typeCode 'XFRM'; a combination of two relatedDocuments with typeCodes 'XFRM' and 'RPLC'; or a combination of two relatedDocuments with typeCodes 'XFRM' and 'APND'. No other combinations are allowed.

70. ClinicalDocument.authorization
ShortConsents associated with this document
Comments

The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal 'completed') and should be on file.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Authorization
72. ClinicalDocument.componentOf
Definition

This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note.

ShortSetting of the clinical encounter during which the documented act(s) or ServiceEvent occurred.
Comments

In some cases, the setting of the encounter is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is 'Diabetes Clinic Progress Note'. The setting of an encounter can also be transmitted in the HealthCareFacility.code attribute. If HealthCareFacility.code is sent, it should be equivalent to or further specialize the value inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply 'Clinic Progress Note' and the value of HealthCareFacility.code is 'cardiology clinic'), and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ComponentOf
74. ClinicalDocument.component
ShortBody of the document
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Component