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

A subtype of Entity that is inanimate and locationally independent.

Materials are entities that are neither Living Subjects nor places. Manufactured or processed products are considered material, even if they originate as living matter. Materials come in a wide variety of physical forms and can pass through different states (ie. Gas, liquid, solid) while still retaining their physical composition and material characteristics.

Clarify the meaning of "locationally independent"; suggest removing it and supplanting with first Usage Note sentence.

Pharmaceutical substances (including active vaccines containing retarded virus), disposable supplies, durable equipment, implantable devices, food items (including meat or plant products), waste, traded goods.

Usage:

• Use this Logical Model Profile: ManufacturedProduct (CDA Class)

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
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Name	Flags	Card.	Type	Description & Constraints
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Material.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Material.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Material.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)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode		0..1	cs	Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Material.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Material.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
Material		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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: EntityClassManufacturedMaterial (required) Fixed Value: MMAT
@determinerCode		0..1	cs	Binding: EntityDeterminerDetermined (required) Fixed Value: KIND
code		0..1	CE	Binding: CDAMaterialEntityClassType (example)
name		0..1	EN
lotNumberText		0..1	ST
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Material.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG
Material.classCode	required	Fixed Value: MMAT http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial
Material.determinerCode	required	Fixed Value: KIND http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined
Material.code	example	CDAMaterialEntityClassType http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Material.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)

Other representations of profile: CSV, Excel