STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

??.??.5 Resource request - Detailed Descriptions

Detailed Descriptions for the elements in the request resource.

Request
Definition

A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.

Control1..1
Request.identifier
Definition

Identifiers assigned to this request by the requester, performer and other systems.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
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.

Request.definition
Definition

A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Control0..*
TypeReference(Definition)
Summarytrue
Comments

[The allowed reference resources may be adjusted as appropriate for the request resource].

Request.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this request.

Control0..*
TypeReference(Request)
Requirements

Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Alternate Namesfufills
Summarytrue
Comments

[The allowed reference resources may be adjusted as appropriate for the request resource].

Request.replaces
Definition

Completed or terminated request(s) whose function is taken by this new request.

Control0..*
TypeReference(Request)
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Alternate Namessupersedes; prior; renewed order
Summarytrue
Comments

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

Request.requisition
Definition

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

Control0..1
TypeIdentifier
Requirements

Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes.

Alternate NamesgrouperId
Summarytrue
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.

Request.status
Definition

The current state of the request.

Control1..1
BindingRequestStatus: Codes identifying the stage lifecycle stage of a request (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

The status is generally fully in the control of the requester - they determine whether the order is competed, cancelled, etc. after it has been activated. States relating to the activities of the performer are reflected on either the corresponding Event(s) or using the Task resource.

To DoShould this be a common code system for all requests?
Request.stage
Definition

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

Control1..1
BindingRequestStage: Codes indicating the degree of authority/intentionality associated with a request (Required)
TypeCodeableConcept
Is Modifiertrue
Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Alternate Namescategory
Summarytrue
Comments

The stage of a request is immutable. I.e. proposals don't change to plans or plans change to orders. Instead, a new instance of the appropriate stage is created "basedOn" the instance with the prior stage.

[The value set is extensible to allow inclusion of additional order layers. For example Encoded orders and MARs for pharmacy, Reflex orders for lab, etc.

To DoShould this be a common code system for all requests?
Request.code
Definition

A code that identifies the specific service or action being requested.

Control0..1
BindingRequestCode: Codes indicating the details of what is being requested. These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required.
TypeCodeableConcept
Alternate Namestype
Summarytrue
Request.subject
Definition

The individual or set of individuals the action is to be performed on or for.

Control1..1
TypeReference(Patient | Group)
Requirements

Links the request to the Patient context.

Alternate Namespatient
Summarytrue
Comments

[For resources that aren't patient-specific, the set of allowed resources may be extended to include other things. Group should generally be retained unless there's certainty this resource won't be used for veterinary, research or public health settings where Group may be necessary (e.g. this cage of rats/crate of chickens, group of people in a 5 mile radious of the incident, etc.)].

To DoFor mapping, is it better if we make this Any and then constrain it down?
Request.context
Definition

The encounter or episode of care that establishes the context for making this request.

Control0..1
TypeReference(Encounter | EpisodeOfCare)
Requirements

Links the request to the Encounter context.

Alternate Namesencounter
Summarytrue
Comments

This will typically be the encounter the request was created during, but some requests may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).

Request.occurrence[x]
Definition

The date or time(s) at which the activity or service is desired to occur.

Control0..1
TypedateTime|Period|Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate Namestiming
Summarytrue
Comments

[The list of types may be constrained as appropriate for the type of event].

Request.authored
Definition

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

Control0..1
TypedateTime
Alternate Namescreated
Summarytrue
To DoDo we need a "status date" too (for when the request was suspended, cancelled, etc.).
Request.requester
Definition

The individual who initiated the request and has responsibility for its activation.

Control0..1
TypeReference(Practitioner | Organization | Patient | RelatedPerson | Device)
Alternate Namesauthor
Summarytrue
Request.performerType
Definition

The type of individual that is desired to act upon the request.

Control0..1
BindingPerformerType: Identifies types of practitioners, devices or others that should fulfill a request. While the detailed constraints of relevant providers will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable
TypeCodeableConcept
Summarytrue
Comments

If performer is also specified, this indicates what type of performer is desired in the event the requested performer is not available.

To DoNeed to define who.performer.
Request.performer
Definition

Indicates who or what is being asked to perform the request.

Control0..1
TypeReference(Practitioner | Organization | Patient | Device | RelatedPerson)
Summarytrue
Request.reasonCode
Definition

Describes why the request is being made in coded or textual form.

Control0..*
BindingRequestReason: Codes identifying why this request was necessary. These may be clinical reasons (e.g. diagnoses, symptoms) and/or administrative reasons. While the detailed constraints of relevant reasons will vary by resource, some degree of consistency across resources around recommended codes would be desirable.
TypeCodeableConcept
Summarytrue
Comments

Textual reasons can be caprued using reasonCode.text.

Request.reasonReference
Definition

Indicates another resource whose existence justifies this request.

Control0..*
TypeReference(Condition | Observation)
Summarytrue
Comments

[Additional resources may be added as appropriate].

Request.supportingInfo
Definition

Information that may be needed by/relevant to the performer in their execution of this request.

Control0..1
TypeReference(Any)
Request.note
Definition

Comments made about the request by the requester, performer, subject or other participants.

Control0..*
TypeAnnotation
Request.relevantHistory
Definition

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Control0..*
TypeReference(Provenance)
Alternate NameseventHistory
Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.