SupplyRequest
A record of a request for a medication, substance or device used in the healthcare setting.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/SupplyRequest| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/SupplyRequest/[id] |
| Vread | GET | /fhir/R4/SupplyRequest/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/SupplyRequest/[id] |
| Patch | PATCH | /fhir/R4/SupplyRequest/[id] |
| Delete | DELETE | /fhir/R4/SupplyRequest/[id] |
| Create | POST | /fhir/R4/SupplyRequest |
| Search | GET | /fhir/R4/SupplyRequest |
| History | GET | /fhir/R4/SupplyRequest/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business Identifier for SupplyRequest |
status | code | 0..1 | draft | active | suspended + modifier |
category | CodeableConcept | 0..1 | The kind of supply (central, non-stock, etc.) |
priority | code | 0..1 | routine | urgent | asap | stat |
item[x] | CodeableConcept / Reference | 1..1 | Medication, Substance, or Device requested to be supplied |
quantity | Quantity | 1..1 | The requested amount of the item indicated |
parameter | BackboneElement | 0..* | Ordered item details |
occurrence[x] | dateTime / Period / Timing | 0..1 | When the request should be fulfilled |
authoredOn | dateTime | 0..1 | When the request was made |
requester | Reference | 0..1 | Individual making the request |
supplier | Reference | 0..* | Who is intended to fulfill the request |
reasonCode | CodeableConcept | 0..* | The reason why the supply item was requested |
reasonReference | Reference | 0..* | The reason why the supply item was requested |
deliverFrom | Reference | 0..1 | The origin of the supply |
deliverTo | Reference | 0..1 | The destination of the supply |
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/SupplyRequest-category |
date | string | http://hl7.org/fhir/SearchParameter/clinical-date |
identifier | string | http://hl7.org/fhir/SearchParameter/clinical-identifier |
requester | string | http://hl7.org/fhir/SearchParameter/SupplyRequest-requester |
status | string | http://hl7.org/fhir/SearchParameter/SupplyRequest-status |
subject | string | http://hl7.org/fhir/SearchParameter/SupplyRequest-subject |
supplier | string | http://hl7.org/fhir/SearchParameter/SupplyRequest-supplier |
Reference
- Official FHIR R4 spec:
SupplyRequest - Maturity: Trial Use 1 (FMM 1).