Clinical Document Architecture
2.0.1-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.1-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: Subject (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Subject Version: 2.0.1-sd
Active as of 2025-10-02 Computable Name: Subject

The subject participant represents the primary target of the entries recorded in the document. Most of the time the subject is the same as the recordTarget, but need not be, for instance when the subject is a fetus observed in an obstetrical ultrasound.

The subject participant can be ascribed to a CDA section or a CDA entry. It propagates to nested components, unless overridden. The subject of a document is presumed to be the patient.

Usages:

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 InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subject InfrastructureRoot XML Namespace: urn:hl7-org:v3

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subject 1..* InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)
... relatedSubject 1..1 RelatedSubject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subject.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2

Constraints

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)
... relatedSubject 1..1 RelatedSubject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subject.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Subject.typeId An 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 & Constraints    Filter: Filtersdoco
.. Subject InfrastructureRoot XML Namespace: urn:hl7-org:v3

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2

Key Elements View

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)
... relatedSubject 1..1 RelatedSubject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subject.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2

Constraints

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

Snapshot View

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

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @typeCode 0..1 cs Binding: ParticipationTargetSubject (required)
Fixed Value: SBJ
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... awarenessCode 0..1 CE Binding: TargetAwareness (example)
... relatedSubject 1..1 RelatedSubject

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subject.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Subject.typeCode Base required ParticipationTargetSubject 📦2.0.0 THO v5.2
Subject.contextControlCode Base required CDAContextControl 📦2.0.1-sd This IG
Subject.awarenessCode Base example TargetAwareness 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Subject.typeId An 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