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

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship Version: 2.0.0-sd-ballot
Active as of 2024-03-04 Computable Name: EntryRelationship

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

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... @negationInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EntryRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EntryRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship C1..*InfrastructureRootXML 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)
entry-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1bl
... @contextConductionInd 0..1bl
... @negationInd 0..1bl
... sequenceNumber 0..1INT
... seperatableInd 0..1BL
... (Choice of one) 1..1
.... act 0..1Act
.... encounter 0..1Encounter
.... observation 0..1Observation
.... observationMedia 0..1ObservationMedia
.... organizer 0..1Organizer
.... procedure 0..1Procedure
.... regionOfInterest 0..1RegionOfInterest
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EntryRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EntryRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EntryRelationship.typeCoderequiredXActRelationshipEntryRelationship
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entry-rel-only-oneerrorEntryRelationshipSHALL 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

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel