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

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship Version: 2.0.0-sd
Active as of 2024-10-25 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 Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. EntryRelationship 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-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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 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-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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 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-rel-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 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
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... @negationInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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 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-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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 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-rel-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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 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-rel-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 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
... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
... @inversionInd 0..1 bl
... @contextConductionInd 0..1 bl
... @negationInd 0..1 bl
... sequenceNumber 0..1 INT
... seperatableInd 0..1 BL
... (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

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