FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Device, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the SupplyRequest resource.

SupplyRequest
Element IdSupplyRequest
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 DisplayRequest for a medication, substance or device
Cardinality0..*
TypeDomainResource
Summaryfalse
SupplyRequest.identifier
Element IdSupplyRequest.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 DisplayBusiness Identifier for SupplyRequest
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Summarytrue
Comments

The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.

SupplyRequest.status
Element IdSupplyRequest.status
Definition

Status of the supply request.

Short Displaydraft | active | suspended +
Cardinality0..1
Terminology BindingSupplyRequestStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
SupplyRequest.basedOn
Element IdSupplyRequest.basedOn
Definition

Plan/proposal/order fulfilled by this request.

Short DisplayWhat other request is fulfilled by this supply request
Cardinality0..*
TypeReference(Any)
Summarytrue
SupplyRequest.category
Element IdSupplyRequest.category
Definition

Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.

Short DisplayThe kind of supply (central, non-stock, etc.)
Cardinality0..1
Terminology BindingSupply Type (Example)
TypeCodeableConcept
Alternate Nameskind
Summarytrue
SupplyRequest.priority
Element IdSupplyRequest.priority
Definition

Indicates how quickly this SupplyRequest should be addressed with respect to other requests.

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Meaning if MissingIf missing, this task should be performed with normal priority
Summarytrue
SupplyRequest.deliverFor
Element IdSupplyRequest.deliverFor
Definition

The patient to whom the supply will be given or for whom they will be used.

Short DisplayThe patient for who the supply request is for
Cardinality0..1
TypeReference(Patient)
Alternate Namessubject
Summaryfalse
SupplyRequest.item
Element IdSupplyRequest.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 DisplayMedication, Substance, or Device requested to be supplied
Cardinality1..1
Terminology BindingSNOMED CT Supply Item (Example)
TypeCodeableReference(Medication | Substance | Device | DeviceDefinition)
Summarytrue
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 IdSupplyRequest.quantity
Definition

The amount that is being ordered of the indicated item.

Short DisplayThe requested amount of the item indicated
Cardinality1..1
TypeQuantity
Summarytrue
SupplyRequest.parameter
Element IdSupplyRequest.parameter
Definition

Specific parameters for the ordered item. For example, the size of the indicated item.

Short DisplayOrdered item details
Cardinality0..*
Summaryfalse
SupplyRequest.parameter.code
Element IdSupplyRequest.parameter.code
Definition

A code or string that identifies the device detail being asserted.

Short DisplayItem detail
Cardinality0..1
Terminology BindingParameterCode:
TypeCodeableConcept
Summaryfalse
SupplyRequest.parameter.value[x]
Element IdSupplyRequest.parameter.value[x]
Definition

The value of the device detail.

Short DisplayValue of detail
Cardinality0..1
TypeCodeableConcept|Quantity|Range|boolean
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

Range means device should have a value that falls somewhere within the specified range.

SupplyRequest.occurrence[x]
Element IdSupplyRequest.occurrence[x]
Definition

When the request should be fulfilled.

Short DisplayWhen the request should be fulfilled
Cardinality0..1
TypedateTime|Period|Timing
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Alternate Nameswhen; timing
Summarytrue
SupplyRequest.authoredOn
Element IdSupplyRequest.authoredOn
Definition

When the request was made.

Short DisplayWhen the request was made
Cardinality0..1
TypedateTime
Alternate Namesdate; createdOn; signedOn
Summarytrue
SupplyRequest.requester
Element IdSupplyRequest.requester
Definition

The device, practitioner, etc. who initiated the request.

Short DisplayIndividual making the request
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam)
Alternate Namesauthor; source
Summarytrue
SupplyRequest.supplier
Element IdSupplyRequest.supplier
Definition

Who is intended to fulfill the request.

Short DisplayWho is intended to fulfill the request
Cardinality0..*
TypeReference(Organization | HealthcareService)
Alternate Namesperformer
Summarytrue
SupplyRequest.reason
Element IdSupplyRequest.reason
Definition

The reason why the supply item was requested.

Short DisplayThe reason why the supply item was requested
Cardinality0..*
Terminology BindingSupplyRequestReason (Example)
TypeCodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)
Summaryfalse
SupplyRequest.deliverFrom
Element IdSupplyRequest.deliverFrom
Definition

Where the supply is expected to come from.

Short DisplayThe origin of the supply
Cardinality0..1
TypeReference(Organization | Location)
Summaryfalse
SupplyRequest.deliverTo
Element IdSupplyRequest.deliverTo
Definition

Where the supply is destined to go.

Short DisplayThe destination of the supply
Cardinality0..1
TypeReference(Organization | Location | Patient)
Summaryfalse