Clinical Document Architecture with Australian Schema

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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: ST: CharacterString (V3 Data Type)

The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.

Usage:

• Derived from this Logical Model Profile: ADXP: CharacterString (V3 Data Type), ENXP: Entity Name Part (V3 Data Type) and SC: CharacterStringWithCode (V3 Data Type)
• Use this Logical Model Profile: Criterion (CDA Class), Material (CDA Class), Observation (CDA Class), ObservationRange (CDA Class)... Show 8 more, Section (CDA Class), ADHA extension assigningGeographicArea used in asEntityIdentifier, ADHA ClinicalDocument (CDA Class), ADHA Material (CDA Class), ADHA Observation (CDA Class), ADHA ObservationRange (CDA Class), ADHA Section (CDA Class) and Agency extension desc

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
xmlText		0..1	st	Allows for mixed text content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

This structure is derived from ANY

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
xmlText		0..1	st	Allows for mixed text content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ST	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ADHA ClinicalDocument (CDA Class) text-null: xmlText and nullFlavor are mutually exclusive (one must be present)
(Choice of one)		1..1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
xmlText		0..1	st	Allows for mixed text content
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ST.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
text-null	error	ST	xmlText and nullFlavor are mutually exclusive (one must be present) : (xmlText | nullFlavor).count() = 1

This structure is derived from ANY

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Maturity: 1

Other representations of profile: CSV, Excel