type: resource-definitionsresource: SupplyRequest

SupplyRequest Definitions

SupplyRequest

Request for a medication, substance or device

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.

Cardinality: 0..*

Mappings: workflow=Request; v2=ORC; rim=Act[moodCode<=INT]; w5=workflow.order

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.

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

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Request.identifier; w5=FiveWs.identifier; v2=ORC.2, ORC.3; rim=.identifier

SupplyRequest.status

draft | active | suspended +

Definition: Status of the supply request.

Cardinality: 0..1

Type: code

Binding: required:supplyrequest-status

Summary: true

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)

Mappings: workflow=Request.status; w5=FiveWs.status; v2=ORC.5; rim=.status

SupplyRequest.intent

Definition: Whether the request is a proposal, plan, or an original order.

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.

Cardinality: 1..1

Type: code

Binding: required:request-intent

Summary: true

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)

Mappings: workflow=Request.intent; w5=FiveWs.class; rim=.moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)

SupplyRequest.basedOn

What other request is fulfilled by this supply request

Definition: Plan/proposal/order fulfilled by this request.

Cardinality: 0..*

Type: Reference(Resource)

Summary: true

Mappings: workflow=Request.basedOn

SupplyRequest.replaces

What request replaces

Definition: The request takes the place of the referenced completed or terminated request(s).

Aliases: supersedes, prior, renewed order

Cardinality: 0..*

Type: Reference(ServiceRequest, MedicationRequest, RequestOrchestration, CarePlan, DeviceRequest, CommunicationRequest, NutritionOrder, VisionPrescription, SupplyRequest)

Summary: true

Mappings: workflow=Request.replaces; v2=Handled by message location of ORC (ORC-1=RO or RU); rim=.outboundRelationship[typeCode=RPLC].target

SupplyRequest.groupIdentifier

Composite request this is part of

Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Comments: Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Aliases: grouperId

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: workflow=Request.groupIdentifier; rim=.inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

SupplyRequest.category

The kind of supply (central, non-stock, etc.)

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

Aliases: kind

Cardinality: 0..1

Type: CodeableConcept

Binding: example:supplyrequest-kind

Summary: true

Mappings: workflow=Request.category; w5=FiveWs.class; v2=N/A; rim=.code

SupplyRequest.priority

routine | urgent | asap | stat

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

Meaning if Missing: If missing, this task should be performed with normal priority

Cardinality: 0..1

Type: code

Binding: required:request-priority

Summary: true

Mappings: workflow=Request.priority; w5=FiveWs.grade; v2=TQ1.9; rim=.priorityCode

SupplyRequest.deliverFor

The patient for who the supply request is for

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

Aliases: subject

Cardinality: 0..1

Type: Reference(Patient)

Mappings: workflow=Request.subject

SupplyRequest.item

Medication, Substance, or Device requested to be supplied

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.

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.

Cardinality: 1..1

Type: CodeableReference

Binding: example:supply-item

Summary: true

Mappings: workflow=Request.product; rim=.code

SupplyRequest.quantity

The requested amount of the item indicated

Definition: The amount that is being ordered of the indicated item.

Cardinality: 1..1

Type: Quantity

Summary: true

Mappings: rim=.quantity

SupplyRequest.parameter

Ordered item details

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

Cardinality: 0..*

Type: BackboneElement

Mappings: w5=FiveWs.what[x]; v2=Varies by domain

SupplyRequest.parameter.code

Item detail

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

Cardinality: 0..1

Type: CodeableConcept

Mappings: w5=FiveWs.what[x]; v2=Varies by domain; rim=.code

SupplyRequest.parameter.value[x]

Value of detail

Definition: The value of the device detail.

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

Cardinality: 0..1

Type: CodeableConcept, Quantity, Range, boolean

Mappings: w5=FiveWs.what[x]; v2=Varies by domain; rim=.code

SupplyRequest.occurrence[x]

When the request should be fulfilled

Definition: When the request should be fulfilled.

Aliases: when, timing

Cardinality: 0..1

Type: dateTime, Period, Timing

Summary: true

Mappings: workflow=Request.occurrence[x]; w5=FiveWs.planned; v2=Accompanying TQ1/TQ2 segments; rim=.effectiveTime

SupplyRequest.authoredOn

When the request was made

Definition: When the request was made.

Aliases: date, createdOn, signedOn

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Request.authoredOn; w5=FiveWs.recorded; v2=ORC.9; rim=.participation[typeCode=AUT].time

SupplyRequest.requester

Individual making the request

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

Aliases: author, source

Cardinality: 0..1

Type: Reference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device, CareTeam)

Summary: true

Mappings: workflow=Request.requester; w5=FiveWs.author; v2=ORC.12; rim=.participation[typeCode=AUT].role

SupplyRequest.supplier

Who is intended to fulfill the request

Definition: Who is intended to fulfill the request.

Aliases: performer

Cardinality: 0..*

Type: Reference(Organization, HealthcareService)

Summary: true

Mappings: workflow=Request.performer; w5=FiveWs.actor; v2=PRT; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

SupplyRequest.reason

The reason why the supply item was requested

Definition: The reason why the supply item was requested.

Cardinality: 0..*

Type: CodeableReference

Binding: example:supplyrequest-reason

Mappings: workflow=Request.reason; w5=FiveWs.why[x]; v2=ORC.16; rim=.reasonCode

SupplyRequest.deliverFrom

The origin of the supply

Definition: Where the supply is expected to come from.

Cardinality: 0..1

Type: Reference(Organization, Location)

Mappings: v2=PRT; rim=.participation

SupplyRequest.deliverTo

The destination of the supply

Definition: Where the supply is destined to go.

Cardinality: 0..1

Type: Reference(Organization, Location, Patient, RelatedPerson)

Mappings: workflow=Request.deliverTo; v2=PRT; rim=.participation

SupplyRequest.requestedPerformer

Who should perform the SupplyRequest

Definition: The kind of participant or specific participant that should perform the supply request.

Comments: Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Requirements: Use to distinguish supply requests on different activity queues.

Cardinality: 0..*

Type: CodeableReference