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 order
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A request to perform an action.\" class=\"dict\" href=\"order-definitions.html#Order\"><b>Order</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 by the orderer or by the receiver.\" class=\"dict\" href=\"order-definitions.html#Order.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=\"When the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.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 order was made</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Patient this order is about.\" class=\"dict\" href=\"order-definitions.html#Order.subject\"><b>subject</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=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Patient this order is about</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Who initiated the order.\" class=\"dict\" href=\"order-definitions.html#Order.source\"><b>source</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>)</span> <span style=\"color: navy\">Who initiated the order</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"Who is intended to fulfill the order.\" class=\"dict\" href=\"order-definitions.html#Order.target\"><b>target</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=\"organization.html#Organization\">Organization</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is intended to fulfill the order</span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Text - why the order was made.\" class=\"dict\" href=\"order-definitions.html#Order.reason_x_\"><b>reason[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\">Text - why the order was made</span><span style=\"color: Gray\"> --></span></reason[x]>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"order-definitions.html#Order.authority\"><b>authority</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=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">If required by policy</span><span style=\"color: Gray\"> --></span></authority>\r\n <<a title=\"When order should be fulfilled.\" class=\"dict\" href=\"order-definitions.html#Order.when\"><b>when</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> When order should be fulfilled --></span>\r\n <<a title=\"Code specifies when request should be done. The code may simply be a priority code.\" class=\"dict\" href=\"order-definitions.html#Order.when.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">\r\n Code specifies when request should be done. The code may simply be a priority code</span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"A formal schedule.\" class=\"dict\" href=\"order-definitions.html#Order.when.schedule\"><b>schedule</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">A formal schedule</span><span style=\"color: Gray\"> --></span></schedule>\r\n </when>\r\n <<a title=\"What action is being ordered.\" class=\"dict\" href=\"order-definitions.html#Order.detail\"><b>detail</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">What action is being ordered</span><span style=\"color: Gray\"> --></span></detail>\r\n</Order>\r\n</pre></div>"
},
"name": "order",
"publisher": "FHIR Project",
"description": "Basic Profile. A request to perform an action.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage An order resource describes a request that an action be performed. An order is expected to lead to one or more responses that describe the outcome of processing/handling the order. The order resource is focused on the process of actually requesting an action be performed; the actual action to be performed is detailed in a separate resource that contains the details. Note that orders are often called \"requests\", but this name is not used here since the word \"request\" is used differently elsewhere in this specification. \r\n\r\nNote that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient actually presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "Order",
"publish": true,
"element": [
{
"path": "Order",
"definition": {
"short": "A request to perform an action",
"formal": "A request to perform an action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=RQO]"
}
]
}
},
{
"path": "Order.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": "Order.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": "Order.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": "Order.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": "Order.identifier",
"definition": {
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"formal": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "Order.date",
"definition": {
"short": "When the order was made",
"formal": "When the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "ORC-9"
}
]
}
},
{
"path": "Order.subject",
"definition": {
"short": "Patient this order is about",
"formal": "Patient this order is about.",
"comments": "May be left blank if the request reference identifies the patient, or if the request is not associated with a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3"
}
]
}
},
{
"path": "Order.source",
"definition": {
"short": "Who initiated the order",
"formal": "Who initiated the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
}
]
}
},
{
"path": "Order.target",
"definition": {
"short": "Who is intended to fulfill the order",
"formal": "Who is intended to fulfill the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
},
{
"identity": "v2",
"map": "Unclear: MSH-5 / IPC-7 / BPO-8 / RXO-32 / RXE-40 / RXD-30 / RXG-11 / RXG-27 / PRT-8 (PRT-4-participation in { 'AP', 'DP', 'PO', 'RT' })"
}
]
}
},
{
"path": "Order.reason[x]",
"definition": {
"short": "Text - why the order was made",
"formal": "Text - why the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode or .outboundRelationship[typeCode=RSON].target"
},
{
"identity": "v2",
"map": "ORC-16.2 / OBR-31.2 / BPO-13.2-BP / RXO-20.2 / RXE-27.2 / RXD-21.2 / RXG-22.2 / RXA-19.2"
}
]
}
},
{
"path": "Order.authority",
"definition": {
"short": "If required by policy",
"formal": "If required by policy.",
"comments": "reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role"
},
{
"identity": "v2",
"map": "if ordering provider, then ORC-12, OBR-16, etc."
}
]
}
},
{
"path": "Order.when",
"definition": {
"short": "When order should be fulfilled",
"formal": "When order should be fulfilled.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1",
"name": "Scheduling Details",
"severity": "error",
"human": "Provide a code or a schedule, but not both",
"xpath": "exists(f:code) != exists(f:schedule)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "TQ1, TQ2"
}
]
}
},
{
"path": "Order.when.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": "Order.when.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": "Order.when.code",
"definition": {
"short": "Code specifies when request should be done. The code may simply be a priority code",
"formal": "Code specifies when request should be done. The code may simply be a priority code.",
"comments": "This is usually a local code agreed in the context of the ordering workflow.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RequestedTime",
"isExtensible": true,
"conformance": "preferred",
"description": "When a requested action should be performed. E.g. STAT, daily, evenings, etc."
},
"mapping": [
{
"identity": "rim",
"map": "GTS is a coded value"
}
]
}
},
{
"path": "Order.when.schedule",
"definition": {
"short": "A formal schedule",
"formal": "A formal schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "GTS is a complex schedule"
}
]
}
},
{
"path": "Order.detail",
"definition": {
"short": "What action is being ordered",
"formal": "What action is being ordered.",
"min": 1,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target"
}
]
}
}
],
"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": "authority",
"type": "reference",
"documentation": "If required by policy",
"xpath": "f:Order/f:authority"
},
{
"name": "date",
"type": "date",
"documentation": "When the order was made",
"xpath": "f:Order/f:date"
},
{
"name": "detail",
"type": "reference",
"documentation": "What action is being ordered",
"xpath": "f:Order/f:detail"
},
{
"name": "source",
"type": "reference",
"documentation": "Who initiated the order",
"xpath": "f:Order/f:source"
},
{
"name": "subject",
"type": "reference",
"documentation": "Patient this order is about",
"xpath": "f:Order/f:subject"
},
{
"name": "target",
"type": "reference",
"documentation": "Who is intended to fulfill the order",
"xpath": "f:Order/f:target"
},
{
"name": "when",
"type": "date",
"documentation": "A formal schedule",
"xpath": "f:Order/f:when/f:schedule"
},
{
"name": "when_code",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code",
"xpath": "f:Order/f:when/f:code"
}
]
}
]
}
© 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