Substance

ResourceBase · EntitiesTrial useMaturity 2

A homogeneous material with a definite composition.

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Unique identifier
status?!Σ	0..1	code	active \| inactive \| entered-in-errorBinding (required): substance-status
categoryΣ	0..*	CodeableConcept	What class/type of substance this isBinding (extensible): substance-category
codeRequiredΣ	1..1	CodeableConcept	What substance this isBinding (example): substance-code
descriptionΣ	0..1	string	Textual description of the substance, comments
instanceΣ	0..*	BackboneElement	If this describes a specific package/container of the substance
identifierΣ	0..1	Identifier	Identifier of the package/container
expiryΣ	0..1	dateTime	When no longer valid to use
quantityΣ	0..1	Quantity	Amount of substance in the package
ingredientΣ	0..*	BackboneElement	Composition information about the substance
quantityΣ	0..1	Ratio	Optional amount (concentration)
substance[x]RequiredΣ	1..1	CodeableConcept \| Reference(Substance)	A component of the substanceBinding (example): substance-code

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Query with GET [base]/Substance?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description
`category`	token	The category of the substance `Substance.category`
`code`	token	The code of the substance or ingredient `Substance.code \| (Substance.ingredient.substance.ofType(CodeableConcept))`
`container-identifier`	token	Identifier of the package/container `Substance.instance.identifier`
`expiry`	date	Expiry date of package or container of substance `Substance.instance.expiry`
`identifier`	token	Unique identifier for the substance `Substance.identifier`
`quantity`	quantity	Amount of substance in the package `Substance.instance.quantity`
`status`	token	active \| inactive \| entered-in-error `Substance.status`
`substance-reference`	reference	A component of the substance `(Substance.ingredient.substance.ofType(Reference))`

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

`_haste-health-author`	reference	The author of the resource
`_id`	token	Logical id of this artifact
`_lastUpdated`	date	When the resource version last changed
`_profile`	uri	Profiles this resource claims to conform to
`_security`	token	Security Labels applied to this resource
`_source`	uri	Identifies where the resource comes from
`_tag`	token	Tags applied to this resource
`_type`	token	Derived from the R4B Definition