Substance

Trial Use 2 Specialized — Public Health & Research

A homogeneous material with a definite composition.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/Substance

Interaction	Method	Path
Read	GET	/fhir/R4/Substance/[id]
Vread	GET	/fhir/R4/Substance/[id]/_history/[vid]
Update	PUT	/fhir/R4/Substance/[id]
Patch	PATCH	/fhir/R4/Substance/[id]
Delete	DELETE	/fhir/R4/Substance/[id]
Create	POST	/fhir/R4/Substance
Search	GET	/fhir/R4/Substance
History	GET	/fhir/R4/Substance/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Unique identifier
status	code	0..1	active | inactive | entered-in-error modifier
category	CodeableConcept	0..*	What class/type of substance this is
code	CodeableConcept	1..1	What substance this is
description	string	0..1	Textual description of the substance, comments
instance	BackboneElement	0..*	If this describes a specific package/container of the substance
ingredient	BackboneElement	0..*	Composition information about the substance

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
category	string	http://hl7.org/fhir/SearchParameter/Substance-category
code	string	http://hl7.org/fhir/SearchParameter/Substance-code
container-identifier	string	http://hl7.org/fhir/SearchParameter/Substance-container-identifier
expiry	string	http://hl7.org/fhir/SearchParameter/Substance-expiry
identifier	string	http://hl7.org/fhir/SearchParameter/Substance-identifier
quantity	string	http://hl7.org/fhir/SearchParameter/Substance-quantity
status	string	http://hl7.org/fhir/SearchParameter/Substance-status
substance-reference	string	http://hl7.org/fhir/SearchParameter/Substance-substance-reference

Reference

• Official FHIR R4 spec: Substance
• Maturity: Trial Use 2 (FMM 2).