SupplyRequest | Medplum
On this page
A record of a request for a medication, substance or device used in the healthcare setting.
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| identifier | Identifier[] | Business Identifier for SupplyRequest | |
| Details | |||
| Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | |||
| The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. | |||
| status | code | draft | active | suspended + | |
| Details | |||
| Status of the supply request. | |||
| category | CodeableConcept | The kind of supply (central, non-stock, etc.) | |
| Details | |||
| Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. | |||
| priority | code | routine | urgent | asap | stat | |
| Details | |||
| Indicates how quickly this SupplyRequest should be addressed with respect to other requests. | |||
| item[x] | ✓ | CodeableConcept, Reference< Medication | Substance | Device > |
Medication, Substance, or Device requested to be supplied |
| Details | |||
| The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |||
| Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions. | |||
| quantity | ✓ | Quantity | The requested amount of the item indicated |
| Details | |||
| The amount that is being ordered of the indicated item. | |||
| parameter | SupplyRequestParameter[] | Ordered item details | |
| Details | |||
| Specific parameters for the ordered item. For example, the size of the indicated item. | |||
| id | string | Unique id for inter-element referencing | |
| Details | |||
| Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
| extension | Extension[] | Additional content defined by implementations | |
| Details | |||
| May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized | |
| Details | |||
| May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | |||
| Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||
| There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| code | CodeableConcept | Item detail | |
| Details | |||
| A code or string that identifies the device detail being asserted. | |||
| value[x] | CodeableConcept, Quantity, Range, boolean | Value of detail | |
| Details | |||
| The value of the device detail. | |||
| Range means device should have a value that falls somewhere within the specified range. | |||
| occurrence[x] | dateTime, Period, Timing | When the request should be fulfilled | |
| Details | |||
| When the request should be fulfilled. | |||
| authoredOn | dateTime | When the request was made | |
| Details | |||
| When the request was made. | |||
| requester | Reference< Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device > |
Individual making the request | |
| Details | |||
| The device, practitioner, etc. who initiated the request. | |||
| supplier | Reference< Organization | HealthcareService >[] | Who is intended to fulfill the request | |
| Details | |||
| Who is intended to fulfill the request. | |||
| reasonCode | CodeableConcept[] | The reason why the supply item was requested | |
| Details | |||
| The reason why the supply item was requested. | |||
| reasonReference | Reference< Condition | Observation | DiagnosticReport | DocumentReference >[] |
The reason why the supply item was requested | |
| Details | |||
| The reason why the supply item was requested. | |||
| deliverFrom | Reference< Organization | Location > | The origin of the supply | |
| Details | |||
| Where the supply is expected to come from. | |||
| deliverTo | Reference< Organization | Location | Patient > |
The destination of the supply | |
| Details | |||
| Where the supply is destined to go. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| date | date | When the request was made | SupplyRequest.authoredOn |
| identifier | token | Business Identifier for SupplyRequest | SupplyRequest.identifier |
| category | token | The kind of supply (central, non-stock, etc.) | SupplyRequest.category |
| requester | reference | Individual making the request | SupplyRequest.requester |
| status | token | draft | active | suspended + | SupplyRequest.status |
| subject | reference | The destination of the supply | SupplyRequest.deliverTo |
| supplier | reference | Who is intended to fulfill the request | SupplyRequest.supplier |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact | |
| Details | |||
| The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||
| The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||
| meta | Meta | Metadata about the resource | |
| Details | |||
| The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||
| implicitRules | uri | A set of rules under which this content was created | |
| Details | |||
| A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||
| language | code | Language of the resource content | |
| Details | |||
| The base language in which the resource is written. | |||
| Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. | |||
| text | Narrative | Text summary of the resource, for human interpretation | |
| Details | |||
| A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||
| contained | Resource[] | Contained, inline Resources | |
| Details | |||
| These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||
| This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||
| extension | Extension[] | Additional content defined by implementations | |
| Details | |||
| May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| modifierExtension | Extension[] | Extensions that cannot be ignored | |
| Details | |||
| May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | |||
| Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||
| There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Trial-Use Note: In terms of scope and usage, the Orders and Observations workgroups wish to draw the attention of reviewers and implementers to the following issues and changes.
- We are seeking input from the implementation community on whether to combine SupplyRequest and DeviceRequest for R4.
- The parameters element was added to SupplyRequest for representing custom details for ordering devices.
Feedback is welcome here
This resource is a request resource from a FHIR workflow perspective - see Workflow. It is the intent of the Orders and Observation Workgroup to align this resource with the workflow pattern for request resources.
The scope of the SupplyRequest resource is for recording the request of supplies used in the healthcare process. This includes supplies specifically used in the treatment of patients as well as supply movement within an institution (transport a set of supplies from materials management to a service unit (nurse station). This resource does not include the provisioning of transportation services.
The SupplyRequest resource allows requesting only a single item. If a workflow requires requesting multiple items simultaneously, this is done using multiple instances of this resource. These instances can be linked in different ways, depending on the needs of the workflow. For guidance, refer to the Request pattern
Note that the SupplyRequest records the fact that a request was made. To actually act on that request, additional workflow beyond simply the existence of a SupplyRequest is required. This can be achieved by using an Task resource, with the SupplyRequest referenced from the Task.focus, or by using the SupplyRequest resource in the context of an messaging or service workflow where the request is explicit or implicit. The SupplyDelivery resource represents the fulfillment as a result of SupplyRequest being acted upon.
The SupplyRequest resource is used for inventory management. When requesting medication, substances and devices when there is a patient focus or instructions regarding their use, DeviceRequest or MedicationRequest should be used instead