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-11-22 |
Definitions for the au-Encounter logical model.
Guidance on how to interpret the contents of this table can be found here
0. Encounter | |
Short | Australian adaptation of the HL7 International CDA Encounter class |
Control | 1..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 . |
2. Encounter.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
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. |
Fixed Value | ENC |
4. Encounter.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentEncounterMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 ) |
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. |
6. Encounter.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Encounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
10. Encounter.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
12. Encounter.statusCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
14. Encounter.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
16. Encounter.admissionReferralSourceCode | |
Short | ADHA CDA extension to represent admission referral source code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
18. Encounter.dischargeDispositionCode | |
Short | ADHA CDA extension to represent discharge disposition code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
20. Encounter.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
22. Encounter.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
24. Encounter.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
26. Encounter.performer | |
Short | Australian-adapted Performer class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2(ADHA Performer2 (CDA Class)) |
28. Encounter.author | |
Short | Australian-adapted Author class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author(ADHA Author (CDA Class)) |
30. Encounter.informant | |
Short | Australian-adapted Informant class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant(ADHA Informant (CDA Class)) |
32. Encounter.participant | |
Short | Australian-adapted Participant2 class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2 |
34. Encounter.entryRelationship | |
Short | Australian-adapted EntryRelationship class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship(ADHA EntryRelationship (CDA Class)) |
36. Encounter.reference | |
Short | Australian-adapted Reference class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference(ADHA Reference (CDA Class)) |
38. Encounter.precondition | |
Short | Australian-adapted Precondition class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition(ADHA Precondition (CDA Class)) |
40. Encounter.InFulfillmentOf | |
Short | ADHA CDA extension to represent InFulfillmentOf |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-InFulfillmentOf(ADHA InFulfillmentOf (CDA Class)) |
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. Encounter | |
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 Encounter classBase for all types and resources |
Control | 10..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 . |
2. Encounter.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
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. |
Fixed Value | ENC |
4. Encounter.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentEncounterMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 ) |
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. |
6. Encounter.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..*1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
Is Modifier | false |
8. Encounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
10. Encounter.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EDNarrative |
Is Modifier | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Encounter.statusCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
14. Encounter.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
16. Encounter.admissionReferralSourceCode | |
Short | ADHA CDA extension to represent admission referral source code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
18. Encounter.dischargeDispositionCode | |
Short | ADHA CDA extension to represent discharge disposition code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
20. Encounter.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
22. Encounter.subject | |
Definition | The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam. |
Short | The patient or group related to this encounter |
Comments | While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubjectReference(Patient, Group) |
Is Modifier | false |
Alternate Names | patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Encounter.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
26. Encounter.performer | |
Short | Australian-adapted Performer class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2(ADHA Performer2 (CDA Class)) |
28. Encounter.author | |
Short | Australian-adapted Author class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author(ADHA Author (CDA Class)) |
30. Encounter.informant | |
Short | Australian-adapted Informant class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant(ADHA Informant (CDA Class)) |
32. Encounter.participant | |
Definition | The list of people responsible for providing the service. |
Short | Australian-adapted Participant2 classList of participants involved in the encounter |
Comments | Any Patient or Group present in the participation.actor must also be the subject, though the subject may be absent from the participation.actor for cases where the patient (or group) is not present, such as during a case review conference. |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2BackboneElement |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) enc-1: A type must be provided when no explicit actor is specified (actor.exists() or type.exists()) enc-2: A type cannot be provided for a patient or group participant (actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()) |
34. Encounter.entryRelationship | |
Short | Australian-adapted EntryRelationship class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship(ADHA EntryRelationship (CDA Class)) |
36. Encounter.reference | |
Short | Australian-adapted Reference class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference(ADHA Reference (CDA Class)) |
38. Encounter.precondition | |
Short | Australian-adapted Precondition class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition(ADHA Precondition (CDA Class)) |
40. Encounter.InFulfillmentOf | |
Short | ADHA CDA extension to represent InFulfillmentOf |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-InFulfillmentOf(ADHA InFulfillmentOf (CDA Class)) |
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. Encounter | |
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 Encounter class |
Control | 1..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 . |
2. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.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. Encounter.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
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. |
Fixed Value | ENC |
22. Encounter.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentEncounterMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 ) |
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. |
24. Encounter.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
26. Encounter.code | |
Control | 0..1 |
Binding | For example codes, see ActEncounterCode (example to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
28. Encounter.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
30. Encounter.statusCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
32. Encounter.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
34. Encounter.admissionReferralSourceCode | |
Short | ADHA CDA extension to represent admission referral source code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
36. Encounter.dischargeDispositionCode | |
Short | ADHA CDA extension to represent discharge disposition code |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |
38. Encounter.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
40. Encounter.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
42. Encounter.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
44. Encounter.performer | |
Short | Australian-adapted Performer class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2(ADHA Performer2 (CDA Class)) |
46. Encounter.author | |
Short | Australian-adapted Author class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author(ADHA Author (CDA Class)) |
48. Encounter.informant | |
Short | Australian-adapted Informant class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant(ADHA Informant (CDA Class)) |
50. Encounter.participant | |
Short | Australian-adapted Participant2 class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2 |
52. Encounter.entryRelationship | |
Short | Australian-adapted EntryRelationship class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship(ADHA EntryRelationship (CDA Class)) |
54. Encounter.reference | |
Short | Australian-adapted Reference class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference(ADHA Reference (CDA Class)) |
56. Encounter.precondition | |
Short | Australian-adapted Precondition class |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition(ADHA Precondition (CDA Class)) |
58. Encounter.InFulfillmentOf | |
Short | ADHA CDA extension to represent InFulfillmentOf |
Control | 0..* |
Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-InFulfillmentOf(ADHA InFulfillmentOf (CDA Class)) |
XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 . |