Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

12.21.7 12.27.7 Resource SupplyRequest - Detailed Descriptions

Orders and Observations icon 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 for a medication, substance or device used in the healthcare setting.

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 SupplyRequestStatus ( 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.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.item[x] SupplyRequest.item
Element Id SupplyRequest.item[x] 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 CodeableConcept | Reference CodeableReference ( Medication | Substance | Device ) [x] Note See Choice of Data Types | DeviceDefinition for further information about how to use [x] )
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 Data Types 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 Data Types 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.reasonCode SupplyRequest.reason
Element Id SupplyRequest.reasonCode 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 SupplyRequestReason ( Example )
Type CodeableConcept Summary false SupplyRequest.reasonReference Element Id SupplyRequest.reasonReference Definition The reason why the supply item was requested. Cardinality 0..* Type Reference 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 )
Summary false