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
Active as of 2024-12-18 |
Definitions for the au-EntryRelationship logical model.
Guidance on how to interpret the contents of this table can be found here
0. EntryRelationship | |
Short | Australian adaptation of the HL7 International CDA EntryRelationship 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-rel-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. EntryRelationship.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
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. |
4. EntryRelationship.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
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. |
6. EntryRelationship.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
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. |
Default Value | true |
8. EntryRelationship.negationInd | |
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. |
10. EntryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
12. EntryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
14. EntryRelationship.act | |
Short | Australian-adapted Act class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act |
16. EntryRelationship.encounter | |
Short | Australian-adapted Encounter class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter |
18. EntryRelationship.observation | |
Short | Australian-adapted Observation class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation |
20. EntryRelationship.observationMedia | |
Short | Australian-adapted ObservationMedia class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia |
22. EntryRelationship.organizer | |
Short | Australian-adapted Organizer class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer |
24. EntryRelationship.procedure | |
Short | Australian-adapted Procedure class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure |
26. EntryRelationship.regionOfInterest | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest |
28. EntryRelationship.substanceAdministration | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration |
30. EntryRelationship.supply | |
Short | Australian-adapted Supply class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply |
32. EntryRelationship.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. EntryRelationship | |
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 EntryRelationship 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-rel-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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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 |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
8. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
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. |
22. EntryRelationship.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
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. |
24. EntryRelationship.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
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. |
Default Value | true |
26. EntryRelationship.negationInd | |
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. |
28. EntryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
30. EntryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
32. EntryRelationship.act | |
Short | Australian-adapted Act class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act |
34. EntryRelationship.encounter | |
Short | Australian-adapted Encounter class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter |
36. EntryRelationship.observation | |
Short | Australian-adapted Observation class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation |
38. EntryRelationship.observationMedia | |
Short | Australian-adapted ObservationMedia class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia |
40. EntryRelationship.organizer | |
Short | Australian-adapted Organizer class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer |
42. EntryRelationship.procedure | |
Short | Australian-adapted Procedure class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure |
44. EntryRelationship.regionOfInterest | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest |
46. EntryRelationship.substanceAdministration | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration |
48. EntryRelationship.supply | |
Short | Australian-adapted Supply class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply |
50. EntryRelationship.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. EntryRelationship | |
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 EntryRelationship 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-rel-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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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 |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
8. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.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. EntryRelationship.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
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. |
22. EntryRelationship.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
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. |
24. EntryRelationship.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
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. |
Default Value | true |
26. EntryRelationship.negationInd | |
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. |
28. EntryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
30. EntryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
32. EntryRelationship.act | |
Short | Australian-adapted Act class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act |
34. EntryRelationship.encounter | |
Short | Australian-adapted Encounter class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter |
36. EntryRelationship.observation | |
Short | Australian-adapted Observation class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation |
38. EntryRelationship.observationMedia | |
Short | Australian-adapted ObservationMedia class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia |
40. EntryRelationship.organizer | |
Short | Australian-adapted Organizer class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer |
42. EntryRelationship.procedure | |
Short | Australian-adapted Procedure class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure |
44. EntryRelationship.regionOfInterest | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest |
46. EntryRelationship.substanceAdministration | |
Short | Australian-adapted SubstanceAdministration class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration |
48. EntryRelationship.supply | |
Short | Australian-adapted Supply class |
Control | 0..1 |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply |
50. EntryRelationship.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 . |