# SupplyRequest

Canonical page: https://docs.ovok.com/api/fhir/r4/supply-request

A record of a request for a medication, substance or device used in the healthcare setting.

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/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 [#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..*` | Business Identifier for SupplyRequest |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `0..1` | draft \| active \| suspended + |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The kind of supply (central, non-stock, etc.) |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-item-x"></span>`item[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `1..1` | Medication, Substance, or Device requested to be supplied |
| <span id="element-quantity"></span>`quantity` | [Quantity](/fhir-elements/complex/quantity) | `1..1` | The requested amount of the item indicated |
| <span id="element-parameter"></span>`parameter` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Ordered item details |
| <span id="element-occurrence-x"></span>`occurrence[x]` | [dateTime](/fhir-elements/primitive/date-time), [Period](/fhir-elements/complex/period), [Timing](/fhir-elements/complex/timing) | `0..1` | When the request should be fulfilled |
| <span id="element-authored-on"></span>`authoredOn` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When the request was made |
| <span id="element-requester"></span>`requester` | [Reference](/fhir-elements/complex/reference) | `0..1` | Individual making the request |
| <span id="element-supplier"></span>`supplier` | [Reference](/fhir-elements/complex/reference) | `0..*` | Who is intended to fulfill the request |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The reason why the supply item was requested |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | The reason why the supply item was requested |
| <span id="element-deliver-from"></span>`deliverFrom` | [Reference](/fhir-elements/complex/reference) | `0..1` | The origin of the supply |
| <span id="element-deliver-to"></span>`deliverTo` | [Reference](/fhir-elements/complex/reference) | `0..1` | The destination of the supply |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `category` | token | The kind of supply (central, non-stock, etc.) |
| `date` | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination  (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made  |
| `identifier` | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier  |
| `requester` | reference | Individual making the request |
| `status` | token | draft \| active \| suspended + |
| `subject` | reference | The destination of the supply |
| `supplier` | reference | Who is intended to fulfill the request |

## Reference [#reference]

Official FHIR R4 spec: [SupplyRequest](https://hl7.org/fhir/R4/supplyrequest.html).  
Maturity: Trial Use 1 (FMM 1).
