This page is part of the FHIR Specification (v3.0.2: STU 3). 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
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. |
Control | 1..1 |
Request.identifier | |
Definition | Identifiers assigned to this request by the requester, performer and other systems. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 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. |
Request.definition | |
Definition | A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. |
Control | 0..* |
Type | Reference(Definition) |
Summary | true |
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. |
Control | 0..* |
Type | Reference(Request) |
Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Summary | true |
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. |
Control | 0..* |
Type | Reference(Request) |
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. |
Alternate Names | supersedes; prior; renewed order |
Summary | true |
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.groupIdentifier | |
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. |
Control | 0..1 |
Type | Identifier |
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 Names | grouperId; requisition |
Summary | true |
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. |
Control | 1..1 |
Terminology Binding | RequestStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, completed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding Event(s) or using the Task resource. A nominal state-transition diagram can be found in the [[request.html#statemachine | Request pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
To Do | Should this be a common code system for all requests? |
Request.intent | |
Definition | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. |
Control | 1..1 |
Terminology Binding | RequestIntent (Required) |
Type | code |
Is Modifier | true |
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. |
Alternate Names | category |
Summary | true |
Comments | When resources map to this element, they are free to define as many codes as necessary to cover their space and will map to "proposal, plan or order". Can have multiple codes that map to one of these. E.g. "original order", "encoded order", "reflex order" would all map to "order". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy. |
To Do | Should this be a common code system for all requests? |
Request.priority | |
Definition | Indicates how quickly the {{title}} should be addressed with respect to other requests. |
Control | 0..1 |
Terminology Binding | RequestPriority (Required) |
Type | code |
Meaning if Missing | If missing, this task should be performed with normal priority |
Summary | true |
Request.code | |
Definition | A code that identifies the specific service or action being requested. |
Control | 0..1 |
Terminology Binding | RequestCode: |
Type | CodeableConcept |
Alternate Names | type |
Summary | true |
Request.subject | |
Definition | The individual or set of individuals the action is to be performed on or for. |
Control | 1..1 |
Type | Reference(Patient | Group) |
Requirements | Links the request to the Patient context. |
Alternate Names | patient |
Summary | true |
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 Do | For 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. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
Requirements | Links the request to the Encounter context. |
Alternate Names | encounter |
Summary | true |
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. |
Control | 0..1 |
Type | dateTime|Period|Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | timing |
Summary | true |
Comments | [The list of types may be constrained as appropriate for the type of event]. |
Request.authoredOn | |
Definition | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. |
Control | 0..1 |
Type | dateTime |
Alternate Names | createdOn; signedOn |
Summary | true |
To Do | Do 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. |
Control | 0..1 |
Alternate Names | author |
Summary | true |
Comments | [Resources may choose to replace this with just a single requester where there's no need to responsible organization]. |
Invariants | Defined on this element inv-1: onBehalfOf can only be specified if agent is practitioner or device (expression : (agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not(), xpath: contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))) |
Request.requester.agent | |
Definition | The device, practitioner, etc. who initiated the request. |
Control | 1..1 |
Type | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) |
Summary | true |
Request.requester.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Control | 0..1 |
Type | Reference(Organization) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. |
Summary | true |
Invariants | Affect this element inv-1: onBehalfOf can only be specified if agent is practitioner or device (expression : (agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not(), xpath: contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))) |
Request.performerType | |
Definition | The type of individual that is desired to act upon the request. |
Control | 0..1 |
Terminology Binding | PerformerType: |
Type | CodeableConcept |
Summary | true |
Comments | If performer is also specified, this indicates what type of performer is desired in the event the requested performer is not available. If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available. |
To Do | Need to define who.performer. |
Request.performer | |
Definition | Indicates who or what is being asked to perform the request. |
Control | 0..1 |
Type | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) |
Summary | true |
Request.reasonCode | |
Definition | Describes why the request is being made in coded or textual form. |
Control | 0..* |
Terminology Binding | RequestReason: |
Type | CodeableConcept |
Summary | true |
Comments | Textual reasons can be caprued using reasonCode.text. |
Request.reasonReference | |
Definition | Indicates another resource whose existence justifies this request. |
Control | 0..* |
Type | Reference(Condition | Observation) |
Summary | true |
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. |
Control | 0..* |
Type | Reference(Any) |
Request.note | |
Definition | Comments made about the request by the requester, performer, subject or other participants. |
Control | 0..* |
Type | Annotation |
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. |
Control | 0..* |
Type | Reference(Provenance) |
Alternate Names | eventHistory |
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. |