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: ADHA ON: OrganizationName (V3 Data Type)

Australian adaptation of the HL7 International CDA Organization Name dataType.

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:

• Use this Logical Model Profile: ADHA CustodianOrganization (CDA Class), ADHA Entity (CDA Class), ADHA Organization (CDA Class) and ADHA extension employerOrganization

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 au-EntityName

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
item
family		0..0
given		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: Entity Name Use (required)
item	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ON.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ON.use	required	entitynameuse http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	ON.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: Entity Name Use (required)
item	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ON.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ON.use	required	entitynameuse http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	ON.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1

This structure is derived from au-EntityName

Summary

Prohibited: 2 elements

Differential View

This structure is derived from au-EntityName

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
item
family		0..0
given		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: Entity Name Use (required)
item	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ON.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ON.use	required	entitynameuse http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	ON.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ON		1..*	au-EntityName	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Australian adaptation of the HL7 International CDA Organization Name (ON) dataType Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: Entity Name Use (required)
item	C	0..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ON.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
ON.use	required	entitynameuse http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	ON.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1

This structure is derived from au-EntityName

Summary

Prohibited: 2 elements

Other representations of profile: CSV, Excel