Clinical Document Architecture
2.0.0-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.0-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: Entity (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Entity Version: 2.0.0-sd
Active as of 2024-05-16 Computable Name: Entity

A physical thing, group of physical things or an organization capable of participating in Acts while in a role.

An entity is a physical object that has, had or will have existence. The only exception to this is Organization, which while not having a physical presence, fulfills the other characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play: the Role of Patient, e.g., is played by the Person Entity.

Living subjects (including human beings), organizations, materials, places and their specializations.

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
.. Entity 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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Entity 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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Entity 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 0..1 II
.... @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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... code 0..1 CE Binding: CDAEntityCode (example)
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Entity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG

This structure is derived from InfrastructureRoot

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Entity 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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Entity 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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Entity 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 0..1 II
.... @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: EntityClassRoot (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 0..* II
... code 0..1 CE Binding: CDAEntityCode (example)
... desc 0..1 ED

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Entity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Entity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Entity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode
from this IG

This structure is derived from InfrastructureRoot

 

Other representations of profile: CSV, Excel