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 Organization (CDA Class)

Australian adaptation of the HL7 International CDA Organization class.

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 AssignedAuthor (CDA Class), ADHA AssignedEntity (CDA Class), ADHA AssociatedEntity (CDA Class), ADHA HealthCareFacility (CDA Class)... Show 5 more, ADHA IntendedRecipient (CDA Class), ADHA ManufacturedProduct (CDA Class), ADHA OrganizationPartOf (CDA Class), ADHA PatientRole (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 InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

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

This structure is derived from InfrastructureRoot

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)
• ADHA OrganizationPartOf (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf)
• ADHA extension asEntityIdentifier (http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Organization class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	II-1: An II instance must have either a root or an nullFlavor.
@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
@classCode		0..1	cs	Binding: EntityClassOrganization (required) Fixed Value: ORG
@determinerCode		0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id		0..*	II
name		0..*	ON	Australian-adapted Organization Name class
telecom		0..*	TEL	Australian-adapted TelecommunicationAddress datatype
addr		0..*	AD	Australian-adapted PostalAddress datatype
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	au-OrganizationPartOf	Australian-adapted OrganizationPartOf class
asEntityIdentifier		0..*	asEntityIdentifier	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent an entity identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Organization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Organization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

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

This structure is derived from InfrastructureRoot

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)
• ADHA OrganizationPartOf (CDA Class) (http://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationPartOf)
• ADHA extension asEntityIdentifier (http://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier)

Other representations of profile: CSV, Excel