Clinical Document Architecture
2.0.1-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: ParentDocument (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ParentDocument Version: 2.0.1-sd
Active as of 2024-12-18 Computable Name: ParentDocument

The ParentDocument represents the source of a document revision, addenda, or transformation. ParentDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the parent document. It is not to be used to embed the related document, and thus ParentDocument.text.BIN is precluded from use.

Usage:

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParentDocument.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParentDocument.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParentDocument.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParentDocument.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParentDocument.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParentDocument.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParentDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParentDocument.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParentDocument.classCoderequiredFixed Value: DOCCLIN
http://terminology.hl7.org/ValueSet/v3-ActClassClinicalDocument
ParentDocument.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
ParentDocument.codeexampleFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParentDocument.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel