Entity (CDA Class) - Clinical Document Architecture v2.0.0-sd-ballot

Clinical Document Architecture
2.0.0-sd-ballot - ballot

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-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ 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-ballot
Active as of 2024-03-04				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:

Use this Logical Model Profile: ParticipantRole (CDA Class)

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances 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
templateId	0..*	II
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entity.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

Key Elements View

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

Snapshot View

Name	Card.	Type	Description & Constraints
Entity	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId Base for all types and resources Instances 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
templateId	0..*	II
@classCode	1..1	cs	Binding: EntityClassRoot (required)
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..*	II
code	0..1	CE	Binding: EntityCode (example)
desc	0..1	ED
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Entity.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entity.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entity.classCode	required	EntityClassRoot `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot`
Entity.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Entity.code	example	EntityCode `http://terminology.hl7.org/ValueSet/v3-EntityCode`

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd-ballot based on FHIR 5.0.0. Generated 2024-03-04
Links: Table of Contents | QA Report | Version History external | | Propose a change