This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Orders and Observations Work Group | Maturity Level: 1 | Trial Use | Security Category: Patient | Compartments: Device, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the SupplyRequest resource.
SupplyRequest | |
Element Id | SupplyRequest |
Definition | A record of a request to deliver a medication, substance or device used in the healthcare setting to a particular destination for a particular person or organization. |
Short Display | Request for a medication, substance or device |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
SupplyRequest.identifier | |
Element Id | SupplyRequest.identifier |
Definition | 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. |
Short Display | Business Identifier for SupplyRequest |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
Summary | true |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. |
SupplyRequest.status | |
Element Id | SupplyRequest.status |
Definition | Status of the supply request. |
Short Display | draft | active | suspended + |
Cardinality | 0..1 |
Terminology Binding | Supply Request Status (Required) |
Type | code |
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
SupplyRequest.intent | |
Element Id | SupplyRequest.intent |
Definition | Whether the request is a proposal, plan, or an original order. |
Short Display | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
Cardinality | 1..1 |
Terminology Binding | RequestIntent (Required) |
Type | code |
Is Modifier | true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request) |
Summary | true |
Comments | This element is immutable. It cannot be changed for the same resource instance. It is expected that the type of requester will be restricted for different stages of a SupplyRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
SupplyRequest.basedOn | |
Element Id | SupplyRequest.basedOn |
Definition | Plan/proposal/order fulfilled by this request. |
Short Display | What other request is fulfilled by this supply request |
Cardinality | 0..* |
Type | Reference(Any) |
Summary | true |
SupplyRequest.category | |
Element Id | SupplyRequest.category |
Definition | Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. |
Short Display | The kind of supply (central, non-stock, etc.) |
Cardinality | 0..1 |
Terminology Binding | Supply Type (Example) |
Type | CodeableConcept |
Alternate Names | kind |
Summary | true |
SupplyRequest.priority | |
Element Id | SupplyRequest.priority |
Definition | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. |
Short Display | routine | urgent | asap | stat |
Cardinality | 0..1 |
Terminology Binding | RequestPriority (Required) |
Type | code |
Meaning if Missing | If missing, this task should be performed with normal priority |
Summary | true |
SupplyRequest.deliverFor | |
Element Id | SupplyRequest.deliverFor |
Definition | The patient to whom the supply will be given or for whom they will be used. |
Short Display | The patient for who the supply request is for |
Cardinality | 0..1 |
Type | Reference(Patient) |
Alternate Names | subject |
Summary | false |
SupplyRequest.item | |
Element Id | SupplyRequest.item |
Definition | 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. |
Short Display | Medication, Substance, or Device requested to be supplied |
Cardinality | 1..1 |
Terminology Binding | SNOMED CT Supply Item (Example) |
Type | CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) |
Summary | true |
Comments | 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. |
SupplyRequest.quantity | |
Element Id | SupplyRequest.quantity |
Definition | The amount that is being ordered of the indicated item. |
Short Display | The requested amount of the item indicated |
Cardinality | 1..1 |
Type | Quantity |
Summary | true |
SupplyRequest.parameter | |
Element Id | SupplyRequest.parameter |
Definition | Specific parameters for the ordered item. For example, the size of the indicated item. |
Short Display | Ordered item details |
Cardinality | 0..* |
Summary | false |
SupplyRequest.parameter.code | |
Element Id | SupplyRequest.parameter.code |
Definition | A code or string that identifies the device detail being asserted. |
Short Display | Item detail |
Cardinality | 0..1 |
Terminology Binding | ParameterCode: |
Type | CodeableConcept |
Summary | false |
SupplyRequest.parameter.value[x] | |
Element Id | SupplyRequest.parameter.value[x] |
Definition | The value of the device detail. |
Short Display | Value of detail |
Cardinality | 0..1 |
Type | CodeableConcept|Quantity|Range|boolean |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | false |
Comments | Range means device should have a value that falls somewhere within the specified range. |
SupplyRequest.occurrence[x] | |
Element Id | SupplyRequest.occurrence[x] |
Definition | When the request should be fulfilled. |
Short Display | When the request should be fulfilled |
Cardinality | 0..1 |
Type | dateTime|Period|Timing |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Alternate Names | when; timing |
Summary | true |
SupplyRequest.authoredOn | |
Element Id | SupplyRequest.authoredOn |
Definition | When the request was made. |
Short Display | When the request was made |
Cardinality | 0..1 |
Type | dateTime |
Alternate Names | date; createdOn; signedOn |
Summary | true |
SupplyRequest.requester | |
Element Id | SupplyRequest.requester |
Definition | The device, practitioner, etc. who initiated the request. |
Short Display | Individual making the request |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) |
Alternate Names | author; source |
Summary | true |
SupplyRequest.supplier | |
Element Id | SupplyRequest.supplier |
Definition | Who is intended to fulfill the request. |
Short Display | Who is intended to fulfill the request |
Cardinality | 0..* |
Type | Reference(Organization | HealthcareService) |
Alternate Names | performer |
Summary | true |
SupplyRequest.reason | |
Element Id | SupplyRequest.reason |
Definition | The reason why the supply item was requested. |
Short Display | The reason why the supply item was requested |
Cardinality | 0..* |
Terminology Binding | Supply Request Reason (Example) |
Type | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) |
Summary | false |
SupplyRequest.deliverFrom | |
Element Id | SupplyRequest.deliverFrom |
Definition | Where the supply is expected to come from. |
Short Display | The origin of the supply |
Cardinality | 0..1 |
Type | Reference(Organization | Location) |
Summary | false |
SupplyRequest.deliverTo | |
Element Id | SupplyRequest.deliverTo |
Definition | Where the supply is destined to go. |
Short Display | The destination of the supply |
Cardinality | 0..1 |
Type | Reference(Organization | Location | Patient | RelatedPerson) |
Summary | false |