2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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.23 Resource OrderResponse - Content

This resource maintained by the Orders and Observations Work Group

A response to an order.

5.23.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.23.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.

5.23.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrderResponse DomainResourceA response to an order
... identifier 0..*IdentifierIdentifiers assigned to this order by the orderer or by the receiver
... request 1..1OrderThe order that this is a response to
... date 0..1dateTimeWhen the response was made
... who 0..1Practitioner | Organization | DeviceWho made the response
... authority[x] If required by policy
.... authorityCodeableConcept0..1CodeableConcept
.... authorityReference0..1Any
... code M1..1codepending | review | rejected | error | accepted | cancelled | replaced | aborted | complete
OrderOutcomeStatus (Required)
... description 0..1stringAdditional description of the response
... fulfillment 0..*AnyDetails of the outcome of performing the order

XML Template

<OrderResponse xmlns="http://hl7.org/fhir"> doco
 <!-- 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>
 <authority[x]><!-- 0..1 CodeableConcept|Reference(Any) If required by policy --></authority[x]>
 <code value="[code]"/><!-- 1..1 pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete -->
 <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

{doco
  "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
  // authority[x]: If required by policy. One of these 2:
  "authorityCodeableConcept" : { CodeableConcept },
  "authorityReference" : { Reference(Any) },
  "code" : "<code>", // R! pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete
  "description" : "<string>", // Additional description of the response
  "fulfillment" : [{ Reference(Any) }] // Details of the outcome of performing the order
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrderResponse DomainResourceA response to an order
... identifier 0..*IdentifierIdentifiers assigned to this order by the orderer or by the receiver
... request 1..1OrderThe order that this is a response to
... date 0..1dateTimeWhen the response was made
... who 0..1Practitioner | Organization | DeviceWho made the response
... authority[x] If required by policy
.... authorityCodeableConcept0..1CodeableConcept
.... authorityReference0..1Any
... code M1..1codepending | review | rejected | error | accepted | cancelled | replaced | aborted | complete
OrderOutcomeStatus (Required)
... description 0..1stringAdditional description of the response
... fulfillment 0..*AnyDetails of the outcome of performing the order

XML Template

<OrderResponse xmlns="http://hl7.org/fhir"> doco
 <!-- 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>
 <authority[x]><!-- 0..1 CodeableConcept|Reference(Any) If required by policy --></authority[x]>
 <code value="[code]"/><!-- 1..1 pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete -->
 <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

{doco
  "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
  // authority[x]: If required by policy. One of these 2:
  "authorityCodeableConcept" : { CodeableConcept },
  "authorityReference" : { Reference(Any) },
  "code" : "<code>", // R! pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete
  "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.23.3.1 Terminology Bindings

PathDefinitionTypeReference
OrderResponse.code The status of the response to an orderFixedhttp://hl7.org/fhir/order-outcome-code

5.23.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.

NameTypeDescriptionPaths
codetokenpending | review | rejected | error | accepted | cancelled | replaced | aborted | completeOrderResponse.code
datedateWhen the response was madeOrderResponse.date
fulfillmentreferenceDetails of the outcome of performing the orderOrderResponse.fulfillment
(Any)
patientreferenceThe patient the reuqest order is related to
(Patient)
requestreferenceThe order that this is a response toOrderResponse.request
(Order)
whoreferenceWho made the responseOrderResponse.who
(Device, Organization, Practitioner)