Order - FHIR Resource (dstu2)
This Order Resource uses the
FHIR API standard for access and structure.
Validate an Order FHIR Resource (dstu2)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
date | false | dateTime | # When the order was made
|
detail | true | Reference | # What action is being ordered
|
identifier | true | Identifier | # Identifiers assigned to this order by the orderer or by the receiver
|
reasonCodeableConcept | false | CodeableConcept | # "reasonCodeableConcept" : { CodeableConcept },
|
reasonReference | false | Reference | # "reasonReference" : { Reference(Any) },
|
source | false | Reference | # Who initiated the order
|
subject | false | Reference | # Patient this order is about
|
target | false | Reference | # Who is intended to fulfill the order
|
when | false | Data Type | # When order should be fulfilled
|
Order Structure
{
"resourceType" : "Order",
// 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
"date" : "<dateTime>", // When the order was made
"subject" : { Reference(Patient|Group|Device|Substance) }, // Patient this order is about
"source" : { Reference(Practitioner|Organization) }, // Who initiated the order
"target" : { Reference(Organization|Device|Practitioner) }, // Who is intended to fulfill the order
// reason[x]: Text - why the order was made. One of these 2:
"reasonCodeableConcept" : { CodeableConcept },
"reasonReference" : { Reference(Any) },
"when" : { // When order should be fulfilled
"code" : { CodeableConcept }, // C? Code specifies when request should be done. The code may simply be a priority code
"schedule" : { Timing } // C? A formal schedule
},
"detail" : [{ Reference(Any) }] // R! What action is being ordered
}
Order Search Parameters
The following search parameters can be used to query Order resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Order?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
date | date | date |
detail | reference | detail |
identifier | text | identifier |
patient | reference | subject |
source | reference | source |
subject | reference | subject |
target | reference | target |
when | date | when.schedule |
when_code | text | when.code |