Entry (CDA Class) - Clinical Document Architecture v2.0.1-sd

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

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Entry				Version: 2.0.1-sd
Active as of 2024-12-18				Computable Name: Entry

CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.

Usage:

Use this Logical Model Profile: Section (CDA Class)

Formal Views of Template Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
templateId		0..*	II
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Entry.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Entry.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
templateId		0..*	II
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Entry.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Entry.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
templateId		0..*	II
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Entry.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Entry.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Entry	C	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) entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
@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
templateId		0..*	II
@typeCode		0..1	cs	Binding: x_ActRelationshipEntry (required)
@contextConductionInd		0..1	bl	Fixed Value: true
(Choice of one)		1..1
act		0..1	Act
encounter		0..1	Encounter
observation		0..1	Observation
observationMedia		0..1	ObservationMedia
organizer		0..1	Organizer
procedure		0..1	Procedure
regionOfInterest		0..1	RegionOfInterest
substanceAdministration		0..1	SubstanceAdministration
supply		0..1	Supply
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Entry.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Entry.typeCode	required	XActRelationshipEntry `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Entry.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
entry-only-one	error	Entry	SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act \| encounter \| observation \| observationMedia \| organizer \| procedure \| regionOfInterest \| substanceAdministration \| supply).count() = 1

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel

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