This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| 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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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![]() |
|---|---|---|---|---|
![]() |
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. |
![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() |
0..* | CS | ||
![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |
![]() ![]() ![]() |
0..1 | st | ||
![]() ![]() ![]() |
0..1 | bl | ||
![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
![]() ![]() ![]() |
1..1 | st | ||
![]() ![]() |
0..* | II | ||
![]() ![]() |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
![]() ![]() |
0..1 | bl | Fixed Value: true | |
![]() ![]() |
1..1 | |||
![]() ![]() ![]() |
0..1 | Act | ||
![]() ![]() ![]() |
0..1 | Encounter | ||
![]() ![]() ![]() |
0..1 | Observation | ||
![]() ![]() ![]() |
0..1 | ObservationMedia | ||
![]() ![]() ![]() |
0..1 | Organizer | ||
![]() ![]() ![]() |
0..1 | Procedure | ||
![]() ![]() ![]() |
0..1 | RegionOfInterest | ||
![]() ![]() ![]() |
0..1 | SubstanceAdministration | ||
![]() ![]() ![]() |
0..1 | Supply | ||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Entry.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entry.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
| 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