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
| Active as of 2024-12-18 |
Definitions for the au-Person logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Person | |
| Short | Australian adaptation of the HL7 International CDA Person 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. Person.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| 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 | PSN |
| 4. Person.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 6. Person.name | |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-PersonName |
| 8. Person.administrativeGenderCode | |
| Short | ADHA CDA extension to represent a person's administrative gender code |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE(CE: CodedWithEquivalents (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 10. Person.birthTime | |
| Short | ADHA CDA extension to represent a person's time of birth |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 12. Person.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a person's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 14. Person.asEmployment | |
| Short | ADHA CDA extension to represent a person's employment |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEmployment(ADHA Extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 16. Person.asQualifications | |
| Short | ADHA CDA extension to represent a person's qualification |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifications(ADHA extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 18. Person.personalRelationship | |
| Short | ADHA CDA extension to represent a person's personal relationship with a patient |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 20. Person.languageCommunication | |
| Short | Australian-adapted languageCommunication class |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-languageCommunication(ADHA LanguageCommunication (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. Person | |
| 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 Person 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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| 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 | PSN |
| 22. Person.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 24. Person.name | |
| Definition | A name associated with the person. |
| Short | A name associated with the person |
| Comments | Person may have multiple names with different uses or applicable periods. |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-PersonNameHumanName |
| Is Modifier | false |
| Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Person.administrativeGenderCode | |
| Short | ADHA CDA extension to represent a person's administrative gender code |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE(CE: CodedWithEquivalents (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 28. Person.birthTime | |
| Short | ADHA CDA extension to represent a person's time of birth |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 30. Person.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a person's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 32. Person.asEmployment | |
| Short | ADHA CDA extension to represent a person's employment |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEmployment(ADHA Extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 34. Person.asQualifications | |
| Short | ADHA CDA extension to represent a person's qualification |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifications(ADHA extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 36. Person.personalRelationship | |
| Short | ADHA CDA extension to represent a person's personal relationship with a patient |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 38. Person.languageCommunication | |
| Short | Australian-adapted languageCommunication class |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-languageCommunication(ADHA LanguageCommunication (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. Person | |
| 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 Person 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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.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. Person.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| 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 | PSN |
| 22. Person.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| 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 | INSTANCE |
| 24. Person.name | |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-PersonName |
| 26. Person.administrativeGenderCode | |
| Short | ADHA CDA extension to represent a person's administrative gender code |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE(CE: CodedWithEquivalents (V3 Data Type)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 28. Person.birthTime | |
| Short | ADHA CDA extension to represent a person's time of birth |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 30. Person.asEntityIdentifier | |
| Short | ADHA CDA extension to represent a person's identifier |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 32. Person.asEmployment | |
| Short | ADHA CDA extension to represent a person's employment |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asEmployment(ADHA Extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 34. Person.asQualifications | |
| Short | ADHA CDA extension to represent a person's qualification |
| Control | 0..1 |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asQualifications(ADHA extension asEmployment) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 36. Person.personalRelationship | |
| Short | ADHA CDA extension to represent a person's personal relationship with a patient |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship(ADHA extension personalRelationship) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
| 38. Person.languageCommunication | |
| Short | Australian-adapted languageCommunication class |
| Control | 0..* |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/au-languageCommunication(ADHA LanguageCommunication (CDA Class)) |
| XML Format | In the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0. |
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
