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: CR: ConceptRole (V3 Data Type)

A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system of the CD containing the concept qualifier. For example, if SNOMED RT defines a concept "leg", a role relation "has-laterality", and another concept "left", the concept role relation allows to add the qualifier "has-laterality: left" to a primary code "leg" to construct the meaning "left leg".

Usage:

• Use this Logical Model Profile: CD: ConceptDescriptor (V3 Data Type), CE: CodedWithEquivalents (V3 Data Type) and ADHA extension code: CodedWithEquivalents (V3 Data Type)

Formal Views of Profile Content

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

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

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• bn: BooleanNonNull (http://hl7.org/cda/stds/core/StructureDefinition/bn)

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
CR	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) value-null-cr: Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@inverted		0..1	bn
name		0..1	CV
value		0..1	CD
Documentation for this format

Terminology Bindings

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

Constraints

Id	Grade	Path(s)	Details	Requirements
value-null-cr	error	CR	Must contain value or nullFlavor. If nullFlavor is present, name and value must not be present. : (value.exists() or nullFlavor.exists()) and (nullFlavor.exists() implies (name | value).empty())

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• bn: BooleanNonNull (http://hl7.org/cda/stds/core/StructureDefinition/bn)

Other representations of profile: CSV, Excel