This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Profile for orderresponse
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A response to an order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse\"><b>OrderResponse</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">\r\n Identifiers assigned to this order by the orderer or by the receiver</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A reference to the order that this is in response to.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.request\"><b>request</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"order.html#Order\">Order</a>)</span> <span style=\"color: navy\">The order that this is a response to</span><span style=\"color: Gray\"> --></span></request>\r\n <<a title=\"The date and time at which this order response was made (created/posted).\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the response was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person, organization, or device credited with making the response.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.who\"><b>who</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Who made the response</span><span style=\"color: Gray\"> --></span></who>\r\n <<a title=\"A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.authority_x_\"><b>authority[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority[x]>\r\n <<a title=\"What this response says about the status of the original order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"order-outcome-code.html\">pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Additional description of the response</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.\" class=\"dict\" href=\"orderresponse-definitions.html#OrderResponse.fulfillment\"><b>fulfillment</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Details of the outcome of performing the order</span><span style=\"color: Gray\"> --></span></fulfillment>\r\n</OrderResponse>\r\n</pre></div>"
},
"name": "orderresponse",
"publisher": "FHIR Project",
"description": "Basic Profile. A response to an order.",
"status": "draft",
"date": "2014-09-30",
"requirements": "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.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "OrderResponse",
"publish": true,
"element": [
{
"path": "OrderResponse",
"definition": {
"short": "A response to an order",
"formal": "A response to an order.",
"comments": "There might be more than one response to an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=EVN]"
}
]
}
},
{
"path": "OrderResponse.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "OrderResponse.identifier",
"definition": {
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"formal": "Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "OrderResponse.request",
"definition": {
"short": "The order that this is a response to",
"formal": "A reference to the order that this is in response to.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Order"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=FLFS].target"
},
{
"identity": "v2",
"map": "ORC-2 / ORC-3, or OBR-2 | OBR-3"
}
]
}
},
{
"path": "OrderResponse.date",
"definition": {
"short": "When the response was made",
"formal": "The date and time at which this order response was made (created/posted).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "ORC-9"
}
]
}
},
{
"path": "OrderResponse.who",
"definition": {
"short": "Who made the response",
"formal": "The person, organization, or device credited with making the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "Practitioner: ORC-19 | PRT / Organization: PRT"
}
]
}
},
{
"path": "OrderResponse.authority[x]",
"definition": {
"short": "If required by policy",
"formal": "A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.",
"comments": "reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN].code\n\nor\n\n.outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN]"
},
{
"identity": "v2",
"map": "Defined in FHIR as 'if required by policy'; unclear how this would map to V2 except ORC-19.9-action by.assigning authority or ORC-30-enterer authorization mode, neither of which exactly scales to a resource"
}
]
}
},
{
"path": "OrderResponse.code",
"definition": {
"short": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete",
"formal": "What this response says about the status of the original order.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "OrderOutcomeStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/order-outcome-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (different trigger events for different outcomes)"
},
{
"identity": "v2",
"map": "ORC-1 + ORC-5"
}
]
}
},
{
"path": "OrderResponse.description",
"definition": {
"short": "Additional description of the response",
"formal": "Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "v2",
"map": "ORC-16.2-order control code reason.text"
}
]
}
},
{
"path": "OrderResponse.fulfillment",
"definition": {
"short": "Details of the outcome of performing the order",
"formal": "Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ]/target[moodCode=RQO]"
},
{
"identity": "v2",
"map": "OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | complete",
"xpath": "f:OrderResponse/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "When the response was made",
"xpath": "f:OrderResponse/f:date"
},
{
"name": "fulfillment",
"type": "reference",
"documentation": "Details of the outcome of performing the order",
"xpath": "f:OrderResponse/f:fulfillment"
},
{
"name": "request",
"type": "reference",
"documentation": "The order that this is a response to",
"xpath": "f:OrderResponse/f:request"
},
{
"name": "who",
"type": "reference",
"documentation": "Who made the response",
"xpath": "f:OrderResponse/f:who"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change