# Substance

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Unique identifier |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | active \| inactive \| entered-in-error |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | What class/type of substance this is |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | What substance this is |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Textual description of the substance, comments |
| <span id="element-instance"></span>`instance` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | If this describes a specific package/container of the substance |
| <span id="element-ingredient"></span>`ingredient` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Composition information about the substance |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Substance](https://hl7.org/fhir/R4/substance.html).  
Maturity: Trial Use 2 (FMM 2).
