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: Subject (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Subject Version: 2.0.1-sd
Active as of 2024-12-18 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.

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
.. 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)

PathConformanceValueSet / CodeURI
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subject 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
... @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

PathConformanceValueSet / CodeURI
Subject.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSubject.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subject 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
... @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

PathConformanceValueSet / CodeURI
Subject.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSubject.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
.. 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)

PathConformanceValueSet / CodeURI
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subject 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
... @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

PathConformanceValueSet / CodeURI
Subject.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subject 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
... @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

PathConformanceValueSet / CodeURI
Subject.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Subject.typeCoderequiredFixed Value: SBJ
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetSubject
Subject.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
from this IG
Subject.awarenessCodeexampleTargetAwareness
http://terminology.hl7.org/ValueSet/v3-TargetAwareness

Constraints

IdGradePath(s)DetailsRequirements
II-1errorSubject.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