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-ClinicalDocument | Version: 1.0.0 | |||
| Active as of 2024-11-22 | Computable Name: au-ClinicalDocument | |||
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 ClinicalDocument 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 ANY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
 realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
 @extension |
1..1 | st | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| 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 | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
This structure is derived from ANY
Summary
Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ANY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalDocument |
1..1 | ANY | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Australian adaptation of the HL7 International CDA ClinicalDocument class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @classCode |
0..1 | cs | Binding: CDAActClass (example) Fixed Value: DOCCLIN | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| 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 | Fixed Value: POCD_HD000040 | |
| templateId |
0..* | II | ||
| id |
1..1 | II | ||
| code |
1..1 | CE | ||
| title |
0..1 | ST | ||
| effectiveTime |
1..1 | TS | ||
| confidentialityCode |
1..1 | CE | ||
| languageCode |
0..1 | CS | ||
| setId |
0..1 | II | ||
| versionNumber |
0..1 | INT | ||
| completionCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent document lifecycle codes XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Binding: NCTIS Admin Codes Document Status (required) | |
| copyTime |
0..1 | TS | ||
| recordTarget |
1..* | au-RecordTarget | Australian-adapted RecordTarget class | |
| author |
1..* | au-Author | Australian-adapted Author class | |
| dataEnterer |
0..1 | DataEnterer | ||
| informant |
0..* | au-Informant | Australian-adapted Informant class | |
| custodian |
1..1 | au-Custodian | Australian-adapted Custodian class | |
| informationRecipient |
0..* | au-InformationRecipient | Australian-adapted InformationRecipient class | |
| legalAuthenticator |
0..1 | au-LegalAuthenticator | Australian-adapted LegalAuthenticator class | |
| authenticator |
0..* | Authenticator | ||
| participant |
0..* | au-Participant1 | Australian-adapted Participant class | |
| inFulfillmentOf |
0..* | au-InFulfillmentOf | Australian-adapted InFulfillmentOf class | |
| documentationOf |
0..* | DocumentationOf | ||
| relatedDocument |
0..* | au-RelatedDocument | Australian-adapted RelatedDocument class | |
| authorization |
0..* | Authorization | ||
| componentOf |
0..1 | au-ComponentOf | Australian-adapted ComponentOf class | |
| component |
1..1 | au-Component | Australian-adapted Component class | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalDocument.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ClinicalDocument.classCode | example | Fixed Value: DOCCLINhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassfrom this IG | |
| ClinicalDocument.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| ClinicalDocument.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ClinicalDocument.completionCode | required | dh-NctisAdminCodesDocumentStatushttp://ns.electronichealth.net.au/cda/ValueSet/dh-NctisAdminCodesDocumentStatusfrom this IG |
This structure is derived from ANY
Summary
Mandatory: 0 element(10 nested mandatory elements)
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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
