Clinical Document Architecture with Australian Schema
1.0.0 - current
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
| Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter | Version: 1.0.0 | |||
| Active as of 2024-11-22 | Computable Name: au-Encounter | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA Encounter class.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
 id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
 InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @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 | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Encounter class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @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 | ||
| templateId |
0..* | II | ||
| @classCode |
1..1 | cs | Binding: CDAActClass (required) Fixed Value: ENC | |
| @moodCode |
1..1 | cs | Binding: XDocumentEncounterMood (2.0.0) (required) | |
| id |
0..* | II | ||
| code |
0..1 | CD | Binding: ActEncounterCode (example) | |
| text |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| effectiveTime |
0..1 | IVL_TS | ||
| admissionReferralSourceCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent admission referral source code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| dischargeDispositionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent discharge disposition code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| priorityCode |
0..1 | CE | Binding: ActPriority (example) | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | au-Performer2 | Australian-adapted Performer class | |
| author |
0..* | au-Author | Australian-adapted Author class | |
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| participant |
0..* | Participant2 | Australian-adapted Participant2 class | |
| entryRelationship |
0..* | EntryRelationship | Australian-adapted EntryRelationship class | |
| reference |
0..* | au-Reference | Australian-adapted Reference class | |
| precondition |
0..* | au-Precondition | Australian-adapted Precondition class | |
| InFulfillmentOf |
0..* | au-InFulfillmentOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent InFulfillmentOf XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Encounter.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Encounter.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Encounter.classCode | required | Fixed Value: ENChttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| Encounter.moodCode | required | XDocumentEncounterMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0 | |
| Encounter.code | example | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Encounter.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-22
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
