ADHA Entry (CDA Class) - Definitions - Clinical Document Architecture with Australian Schema v1.0.0

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: au-Entry - Detailed Descriptions

Active as of 2024-11-22

Definitions for the au-Entry logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Entry
Short	Australian adaptation of the HL7 International CDA Entry class
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	entry-only-one: 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`)
2. Entry.typeCode
Control	0..1
Binding	The codes SHALL be taken from x_ActRelationshipEntry (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`COMP`
4. Entry.contextConductionInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`true`
6. Entry.act
Short	Australian-adapted Act class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act(ADHA Act (CDA Class))
8. Entry.encounter
Short	Australian-adapted Encounter class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter(ADHA Encounter (CDA Class))
10. Entry.observation
Short	Australian-adapted Observation class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation(ADHA Observation (CDA Class))
12. Entry.observationMedia
Short	Australian-adapted ObservationMedia class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia(ADHA ObservationMedia (CDA Class))
14. Entry.organizer
Short	Australian-adapted Organizer class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer(ADHA Organizer (CDA Class))
16. Entry.procedure
Short	Australian-adapted Procedure class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure(ADHA Procedure (CDA Class))
18. Entry.regionOfInterest
Short	Australian-adapted RegionOfInterest class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest(ADHA RegionOfInterest (CDA Class))
20. Entry.substanceAdministration
Short	Australian-adapted SubstanceAdministration class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration(ADHA SubstanceAdministration (CDA Class))
22. Entry.supply
Short	Australian-adapted Supply class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply(ADHA Supply (CDA Class))
24. Entry.controlAct
Short	ADHA CDA extension to represent control act
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct(ADHA extension controlAct)
XML Format	In the XML format, this property has the namespace `http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0`.

Guidance on how to interpret the contents of this table can be found here

0. Entry
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short	Australian adaptation of the HL7 International CDA Entry classBase for all types and resources
Control	10..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	entry-only-one: 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`)
2. Entry.typeCode
Control	0..1
Binding	The codes SHALL be taken from x_ActRelationshipEntry (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`COMP`
4. Entry.contextConductionInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`true`
6. Entry.act
Short	Australian-adapted Act class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act(ADHA Act (CDA Class))
8. Entry.encounter
Short	Australian-adapted Encounter class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter(ADHA Encounter (CDA Class))
10. Entry.observation
Short	Australian-adapted Observation class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation(ADHA Observation (CDA Class))
12. Entry.observationMedia
Short	Australian-adapted ObservationMedia class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia(ADHA ObservationMedia (CDA Class))
14. Entry.organizer
Short	Australian-adapted Organizer class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer(ADHA Organizer (CDA Class))
16. Entry.procedure
Short	Australian-adapted Procedure class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure(ADHA Procedure (CDA Class))
18. Entry.regionOfInterest
Short	Australian-adapted RegionOfInterest class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest(ADHA RegionOfInterest (CDA Class))
20. Entry.substanceAdministration
Short	Australian-adapted SubstanceAdministration class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration(ADHA SubstanceAdministration (CDA Class))
22. Entry.supply
Short	Australian-adapted Supply class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply(ADHA Supply (CDA Class))
24. Entry.controlAct
Short	ADHA CDA extension to represent control act
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct(ADHA extension controlAct)
XML Format	In the XML format, this property has the namespace `http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0`.

Guidance on how to interpret the contents of this table can be found here

0. Entry
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Australian adaptation of the HL7 International CDA Entry class
Control	1..*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	entry-only-one: 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`)
2. Entry.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Entry.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. Entry.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
8. Entry.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. Entry.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. Entry.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. Entry.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. Entry.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. Entry.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
20. Entry.typeCode
Control	0..1
Binding	The codes SHALL be taken from x_ActRelationshipEntry (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`COMP`
22. Entry.contextConductionInd
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`true`
24. Entry.act
Short	Australian-adapted Act class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act(ADHA Act (CDA Class))
26. Entry.encounter
Short	Australian-adapted Encounter class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter(ADHA Encounter (CDA Class))
28. Entry.observation
Short	Australian-adapted Observation class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation(ADHA Observation (CDA Class))
30. Entry.observationMedia
Short	Australian-adapted ObservationMedia class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia(ADHA ObservationMedia (CDA Class))
32. Entry.organizer
Short	Australian-adapted Organizer class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer(ADHA Organizer (CDA Class))
34. Entry.procedure
Short	Australian-adapted Procedure class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure(ADHA Procedure (CDA Class))
36. Entry.regionOfInterest
Short	Australian-adapted RegionOfInterest class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest(ADHA RegionOfInterest (CDA Class))
38. Entry.substanceAdministration
Short	Australian-adapted SubstanceAdministration class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration(ADHA SubstanceAdministration (CDA Class))
40. Entry.supply
Short	Australian-adapted Supply class
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply(ADHA Supply (CDA Class))
42. Entry.controlAct
Short	ADHA CDA extension to represent control act
Control	0..1
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct(ADHA extension controlAct)
XML Format	In the XML format, this property has the namespace `http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0`.