This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: AU Core Substance

This profile sets minimum expectations for a Substance resource to record, search, and fetch substances associated with a patient. It is based on the AU Base Substance profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Substance when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

In AU Core a Substance resource is used within the context of a referencing resource.

Usage:

• Refer to this Resource Profile: AU Core Medication
• Examples for this Resource Profile: Substance/atectura-breezhaler, Substance/epiglottic-mucus and Substance/peanuts

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 AUBaseSubstance

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
identifier	S	0..*	Identifier	Unique identifier
category	S	0..*	CodeableConcept	What class/type of substance this is
code	S	1..1	CodeableConcept	What substance this is
description	S	0..1	string	Textual description of the substance, comments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique identifier
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
category	SΣ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	SΣ	1..1	CodeableConcept	What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
description	SΣ	0..1	string	Textual description of the substance, comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Substance.status	required	FHIRSubstanceStatus
Substance.category	extensible	SubstanceCategoryCodes
Substance.code	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique identifier
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
category	SΣ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	SΣ	1..1	CodeableConcept	What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
description	SΣ	0..1	string	Textual description of the substance, comments
instance	Σ	0..*	BackboneElement	If this describes a specific package/container of the substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	0..1	Identifier	Identifier of the package/container
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity	Amount of substance in the package
ingredient	Σ	0..*	BackboneElement	Composition information about the substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
quantity	Σ	0..1	Ratio	Optional amount (concentration)
substance[x]	Σ	1..1		A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
substanceCodeableConcept			CodeableConcept
substanceReference			Reference(Substance)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Substance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Substance.status	required	FHIRSubstanceStatus
Substance.category	extensible	SubstanceCategoryCodes
Substance.code	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1
Substance.ingredient.substance[x]	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1

This structure is derived from AUBaseSubstance

Summary

Must-Support: 4 elements

Maturity: 0

Differential View

This structure is derived from AUBaseSubstance

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
identifier	S	0..*	Identifier	Unique identifier
category	S	0..*	CodeableConcept	What class/type of substance this is
code	S	1..1	CodeableConcept	What substance this is
description	S	0..1	string	Textual description of the substance, comments
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique identifier
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
category	SΣ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	SΣ	1..1	CodeableConcept	What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
description	SΣ	0..1	string	Textual description of the substance, comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Substance.status	required	FHIRSubstanceStatus
Substance.category	extensible	SubstanceCategoryCodes
Substance.code	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Substance		0..*	AUBaseSubstance	A substance in an Australian healthcare context
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Unique identifier
status	?!Σ	0..1	code	active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
category	SΣ	0..*	CodeableConcept	What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
code	SΣ	1..1	CodeableConcept	What substance this is Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
description	SΣ	0..1	string	Textual description of the substance, comments
instance	Σ	0..*	BackboneElement	If this describes a specific package/container of the substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	0..1	Identifier	Identifier of the package/container
expiry	Σ	0..1	dateTime	When no longer valid to use
quantity	Σ	0..1	SimpleQuantity	Amount of substance in the package
ingredient	Σ	0..*	BackboneElement	Composition information about the substance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
quantity	Σ	0..1	Ratio	Optional amount (concentration)
substance[x]	Σ	1..1		A component of the substance Binding: https://healthterminologies.gov.au/fhir/ValueSet/substance-1 (preferred)
substanceCodeableConcept			CodeableConcept
substanceReference			Reference(Substance)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Substance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Substance.status	required	FHIRSubstanceStatus
Substance.category	extensible	SubstanceCategoryCodes
Substance.code	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1
Substance.ingredient.substance[x]	preferred	https://healthterminologies.gov.au/fhir/ValueSet/substance-1

This structure is derived from AUBaseSubstance

Summary

Must-Support: 4 elements

Maturity: 0

Other representations of profile: CSV, Excel, Schematron

Notes: