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 Extension id

Australian Digital Health Agency CDA extension for an Australian identifier that uniquely identifies a thing or object. Examples are object identifier for HL7 RIM objects, medical record number, order id, service catalog item id, Vehicle Identification Number (VIN), etc. Instance identifiers are defined based on ISO object identifiers.

Usages:

• Use this Logical Model: ADHA extension asEntityIdentifier and ADHA ParticipantRole ADHA (CDA Class)

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
id.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
id.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
II-1	error	id.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
id.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
id.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
II-1	error	id.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-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)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
id.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
id.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
II-1	error	id.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
id	C	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent the identifier Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
id.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG
id.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	id	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
II-1	error	id.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-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)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Maturity: 1

Other representations of profile: CSV, Excel