Trial Use 2
Specialized — Public Health & Research
A homogeneous material with a definite composition.
Endpoints
devhttps://api.sandbox.ovok.com/fhir/R5/Substance
| Interaction | Method | Path |
|---|
| Read | GET | /fhir/R5/Substance/[id] |
| Vread | GET | /fhir/R5/Substance/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Substance/[id] |
| Patch | PATCH | /fhir/R5/Substance/[id] |
| Delete | DELETE | /fhir/R5/Substance/[id] |
| Create | POST | /fhir/R5/Substance |
| Search | GET | /fhir/R5/Substance?... |
| History | GET | /fhir/R5/Substance/[id]/_history |
| Type-history | GET | /fhir/R5/Substance/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|
identifier | Identifier | 0..* | Unique identifier |
instance | boolean | 1..1 | Is this an instance of a substance or a kind of one modifier |
status | code | 0..1 | active |
category | CodeableConcept | 0..* | What class/type of substance this is |
code | CodeableReference | 1..1 | What substance this is |
description | markdown | 0..1 | Textual description of the substance, comments |
expiry | dateTime | 0..1 | When no longer valid to use |
quantity | Quantity | 0..1 | Amount of substance in the package |
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 |
code-reference | reference | A reference to the defining substance |
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 |
substance-reference | reference | A component of the substance |
Reference
- Official FHIR R5 spec:
Substance
- Maturity: Trial Use 2 (FMM 2).