Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.Subject - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Subject logical model.

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

0. Subject
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Subject.typeCode
Definition

Element Act.typeCode

Control0..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
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 ValueSBJ
4. Subject.contextControlCode
Definition

Element Act.contextControlCode

Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
6. Subject.awarenessCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from TargetAwareness
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
8. Subject.relatedSubject
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedSubject

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

0. Subject
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..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Subject.typeCode
Definition

Element Act.typeCode

Control0..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
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 ValueSBJ
4. Subject.contextControlCode
Definition

Element Act.contextControlCode

Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
6. Subject.awarenessCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from TargetAwareness
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
8. Subject.relatedSubject
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedSubject

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

0. Subject
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..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Subject.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 NullFlavor
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. Subject.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
6. Subject.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. Subject.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
10. Subject.typeCode
Definition

Element Act.typeCode

Control0..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
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 ValueSBJ
12. Subject.contextControlCode
Definition

Element Act.contextControlCode

Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
14. Subject.awarenessCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from TargetAwareness
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
16. Subject.relatedSubject
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RelatedSubject