Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ 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: 1.0.0
Active as of 2024-12-18 Responsible: HL7 Computable Name: Entry

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
.. 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: ADHA 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
entry-only-oneerrorEntrySHALL 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
.. 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: ADHA 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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Entry.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEntry.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
entry-only-oneerrorEntrySHALL 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
.. 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: ADHA 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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Entry.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEntry.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
entry-only-oneerrorEntrySHALL 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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: ADHA 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
entry-only-oneerrorEntrySHALL 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
.. 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: ADHA 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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Entry.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEntry.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
entry-only-oneerrorEntrySHALL 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
.. 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: ADHA 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
... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Entry.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Entry.typeCoderequiredXActRelationshipEntry
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

Constraints

IdGradePath(s)DetailsRequirements
II-1errorEntry.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
entry-only-oneerrorEntrySHALL 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

 

Other representations of profile: CSV, Excel