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: SC: CharacterStringWithCode (V3 Data Type)

A character string that optionally may have a code attached. The text must always be present if a code is present. The code is often a local code.

Usage:

• Use this Logical Model Profile: AuthoringDevice (CDA Class), Criterion (CDA Class), Device (CDA Class), Observation (CDA Class)... Show 5 more, ObservationRange (CDA Class), ADHA AuthoringDevice (CDA Class), ADHA Device (CDA Class), ADHA Observation (CDA Class) and ADHA ObservationRange (CDA Class)

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
SC	C	1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference 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
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Terminology Bindings

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

Constraints

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

This structure is derived from ST

Name	Flags	Card.	Type	Description & Constraints
SC		1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference Logical Container: ADHA ClinicalDocument (CDA Class)
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
SC	C	1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference 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
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Terminology Bindings

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

Constraints

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

This structure is derived from ST

Summary

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
SC	C	1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference 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
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Terminology Bindings

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

Constraints

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

Differential View

This structure is derived from ST

Name	Flags	Card.	Type	Description & Constraints
SC		1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference Logical Container: ADHA ClinicalDocument (CDA Class)
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
SC	C	1..*	ST	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @representation, @mediaType, @language, xmlText Base for all types and resources Binding: This type can be bound to a value set using the CDA binding style Instances of this logical model are not marked to be the target of a Reference 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
@code		0..1	cs
@codeSystem		0..1	oid, uuid, ruid
@codeSystemName		0..1	st
@codeSystemVersion		0..1	st
@displayName		0..1	st
Documentation for this format

Terminology Bindings

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

Constraints

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

This structure is derived from ST

Summary

Structures

This structure refers to these other structures:

• cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)
• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)

Maturity: 1

Other representations of profile: CSV, Excel