Substance
A homogeneous material with a definite composition.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| 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 | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Unique identifier |
status | code | 0..1 | active | inactive | entered-in-error |
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 |
|---|---|---|
category | token | The category of the substance |
code | token | The code of the substance or ingredient |
container-identifier | token | Identifier of the package/container |
expiry | date | Expiry date of package or container of substance |
identifier | token | Unique identifier for the substance |
quantity | quantity | Amount of substance in the package |
status | token | active | inactive | entered-in-error |
substance-reference | reference | A component of the substance |
Reference
Official FHIR R4 spec: Substance.
Maturity: Trial Use 2 (FMM 2).