Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.26 Resource OrderResponse - Content

This resource is marked as a draft.

Orders and Observations

Work Group

Maturity Level: 0

Compartments: Device, Patient, Practitioner

A response to an order.

5.26.1 Scope and Usage

The response to an order indicates the outcome of processing the order itself - whether it was accepted or rejected, or is still in process. The order response resource does not itself convey or represent information that arises as a result of performing the actual order, but it may have references to other resources that do have this information, in order to link between the original order and its outcome.

5.26.2 Background and Context

There may be multiple responses for a given order. For some requests, a responding system may issue a sequence of responses, where each response replaces previous responses as the original order is processed/performed. In these cases, each response should have the same logical identity, and the multiple responses are different versions of the same overall response.

If there are multiple systems responding to the request, or if there request may have multiple different responses, then the different logical responses should have different logical ids.

Structure

Name	Flags	Card.	Type	Description & Constraints
OrderResponse	Σ		DomainResource	A response to an order
identifier	Σ	0..*	Identifier	Identifiers assigned to this order by the orderer or by the receiver
request	Σ	1..1	Reference(Order)	The order that this is a response to
date	Σ	0..1	dateTime	When the response was made
who	Σ	0..1	Reference(Practitioner \| Organization \| Device)	Who made the response
orderStatus	?! Σ	1..1	code	pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| completed OrderStatus (Required)
description	Σ	0..1	string	Additional description of the response
fulfillment	Σ	0..*	Reference(Any)	Details of the outcome of performing the order
Documentation for this format

UML Diagram

XML Template

<OrderResponse xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers assigned to this order by the orderer or by the receiver --></identifier>
 <request><!-- 1..1 Reference(Order) The order that this is a response to --></request>
 <date value="[dateTime]"/><!-- 0..1 When the response was made -->
 <who><!-- 0..1 Reference(Practitioner|Organization|Device) Who made the response --></who>
 <orderStatus value="[code]"/><!-- 1..1 pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed -->
 <description value="[string]"/><!-- 0..1 Additional description of the response -->
 <fulfillment><!-- 0..* Reference(Any) Details of the outcome of performing the order --></fulfillment>
</OrderResponse>

JSON Template

{
  "resourceType" : "OrderResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers assigned to this order by the orderer or by the receiver
  "request" : { Reference(Order) }, // R!  The order that this is a response to
  "date" : "<dateTime>", // When the response was made
  "who" : { Reference(Practitioner|Organization|Device) }, // Who made the response
  "orderStatus" : "<code>", // R!  pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed
  "description" : "<string>", // Additional description of the response
  "fulfillment" : [{ Reference(Any) }] // Details of the outcome of performing the order
}

Structure

Name	Flags	Card.	Type	Description & Constraints
OrderResponse	Σ		DomainResource	A response to an order
identifier	Σ	0..*	Identifier	Identifiers assigned to this order by the orderer or by the receiver
request	Σ	1..1	Reference(Order)	The order that this is a response to
date	Σ	0..1	dateTime	When the response was made
who	Σ	0..1	Reference(Practitioner \| Organization \| Device)	Who made the response
orderStatus	?! Σ	1..1	code	pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| completed OrderStatus (Required)
description	Σ	0..1	string	Additional description of the response
fulfillment	Σ	0..*	Reference(Any)	Details of the outcome of performing the order
Documentation for this format

UML Diagram

XML Template

<OrderResponse xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers assigned to this order by the orderer or by the receiver --></identifier>
 <request><!-- 1..1 Reference(Order) The order that this is a response to --></request>
 <date value="[dateTime]"/><!-- 0..1 When the response was made -->
 <who><!-- 0..1 Reference(Practitioner|Organization|Device) Who made the response --></who>
 <orderStatus value="[code]"/><!-- 1..1 pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed -->
 <description value="[string]"/><!-- 0..1 Additional description of the response -->
 <fulfillment><!-- 0..* Reference(Any) Details of the outcome of performing the order --></fulfillment>
</OrderResponse>

JSON Template

{
  "resourceType" : "OrderResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers assigned to this order by the orderer or by the receiver
  "request" : { Reference(Order) }, // R!  The order that this is a response to
  "date" : "<dateTime>", // When the response was made
  "who" : { Reference(Practitioner|Organization|Device) }, // Who made the response
  "orderStatus" : "<code>", // R!  pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed
  "description" : "<string>", // Additional description of the response
  "fulfillment" : [{ Reference(Any) }] // Details of the outcome of performing the order
}

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.26.3.1 Terminology Bindings

Path	Definition	Type	Reference
OrderResponse.orderStatus	The status of the response to an order.	Required	OrderStatus

Path

Definition

Type

Reference

OrderResponse.orderStatus

The status of the response to an order.

Required

OrderStatus

5.26.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Paths
code	token	pending \| review \| rejected \| error \| accepted \| cancelled \| replaced \| aborted \| completed	OrderResponse.orderStatus
date	date	When the response was made	OrderResponse.date
fulfillment	reference	Details of the outcome of performing the order	OrderResponse.fulfillment (Any)
identifier	token	Identifiers assigned to this order by the orderer or by the receiver	OrderResponse.identifier
request	reference	The order that this is a response to	OrderResponse.request (Order)
who	reference	Who made the response	OrderResponse.who (Device, Organization, Practitioner)