ADHA Material (CDA Class) - Clinical Document Architecture with Australian Schema v1.0.0

Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: ADHA Material (CDA Class)

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Material				Version: 1.0.0
Active as of 2024-08-29				Computable Name: au-Material
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

Australian adaptation of the HL7 International CDA Material 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 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	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material class 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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
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	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material class 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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

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	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material 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	0..1	II
@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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
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

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material class 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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
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	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material class 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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

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

Snapshot View

Name	Card.	Type	Description & Constraints
Material	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Material 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	0..1	II
@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
desc	0..1	ST	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's description XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
lotNumberText	0..1	ST
expirationTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's expiration time XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asIngredient	0..*	asIngredient	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's ingredient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
formCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent material's form code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
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

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel

IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-08-29
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change