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 
StructureDefinition for The Order resource references the request being evaluated (for diagnostic tests, medications, procedures, referrals).
{
"resourceType": "StructureDefinition",
"id": "gao-order",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/gao-order",
"name": "Guideline Appropriate Order",
"display": "Guideline Appropriate Order",
"status": "draft",
"publisher": "HL7",
"date": "2015-09-22T20:02:49+10:00",
"description": "The Order resource references the request being evaluated (for diagnostic tests, medications, procedures, referrals).",
"requirements": "This resource is profiled to link the order details to the reason(s), date, patient and provider placing the order. ",
"fhirVersion": "1.1.0",
"kind": "resource",
"constrainedType": "Order",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Order",
"snapshot": {
"element": [
{
"path": "Order",
"short": "A request to perform an action",
"definition": "A request to perform an action.",
"alias": [
"Request"
],
"min": 0,
"max": "*",
"base": {
"path": "Order",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Order"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=RQO]"
},
{
"identity": "w5",
"map": "workflow.order"
}
]
},
{
"path": "Order.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Order.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Order.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Order.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "Order.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Order.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Order.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Order.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Order.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "Order.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Order.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "Order.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.extension",
"short": "Additional Content defined by implementations",
"definition": "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 set of 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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Order.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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 set of 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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Order.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"comments": "The placer order identifier associated with the order shall be provided.",
"requirements": "The placer order identifier is provided so that the receiver of the evaluation can verify that the order being placed was the same as an order that was authorized.",
"min": 1,
"max": "1",
"base": {
"path": "Order.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Order.date",
"short": "When the order was made",
"definition": "When the order was made.",
"comments": "The date associated with the order SHALL be provided.",
"requirements": "The date of the order is provided so that the receiver of the evaluation can verify that the order was produced within a reasonable time period for accepting the evaluation according to local policies, and to enable the Decision Support Service to apply relevant guidelines. The value shall be precise to the day.",
"min": 1,
"max": "1",
"base": {
"path": "Order.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"path": "Order.subject",
"short": "Patient this order is about",
"definition": "Patient this order is about.",
"comments": "The patient for whom the order is being placed SHALL be provided.",
"requirements": "The patient is provided so that relevant demographics, such as age and gender can be used to evaluate appropriateness.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"base": {
"path": "Order.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-patient"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "Order.source",
"short": "Who initiated the order",
"definition": "Who initiated the order.",
"comments": "The identifier of the provider SHALL be provided.",
"requirements": "The identifier of the provider is provided in order for the receiver of the evaluation to verify that the evaluation given is associated with the correct order. ",
"alias": [
"Author",
"Practitioner"
],
"min": 1,
"max": "1",
"base": {
"path": "Order.source",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-practitioner"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.cause"
}
]
},
{
"path": "Order.target",
"short": "Who is intended to fulfill the order",
"definition": "Who is intended to fulfill the order.",
"min": 0,
"max": "1",
"base": {
"path": "Order.target",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isSummary": true,
"mapping": [
{
"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' })"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"path": "Order.reason[x]",
"short": "Text - why the order was made",
"definition": "Text - why the order was made.",
"comments": "This field contains either a code or a contained resource that gives the reason (a.k.a. indication) for the order. This could include screening, signs or symptoms, diagnoses, diagnostic results, medications or procedures , or other resources. This information must be supported and SHALL be provided.",
"requirements": "The reason is required to support evaluation of the appropriateness of the order.",
"min": 1,
"max": "1",
"base": {
"path": "Order.reason[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Indicates the reason for seeking fulfillment of the order."
},
"mapping": [
{
"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"
},
{
"identity": "rim",
"map": ".reasonCode or .outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"path": "Order.when",
"short": "When order should be fulfilled",
"definition": "When order should be fulfilled.",
"min": 0,
"max": "1",
"base": {
"path": "Order.when",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression",
"valueString": "code.empty() or schedule.empty()"
}
],
"key": "ord-1",
"severity": "error",
"human": "Provide a code or a schedule, but not both",
"xpath": "exists(f:code) != exists(f:schedule)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "TQ1, TQ2"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Order.when.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Order.when.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Order.when.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Order.when.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Order.when.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, 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 set of 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 level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "Order.when.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.when.code",
"short": "Code specifies when request should be done. The code may simply be a priority code",
"definition": "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",
"base": {
"path": "Order.when.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ord-1"
],
"isSummary": true,
"binding": {
"strength": "example",
"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",
"short": "A formal schedule",
"definition": "A formal schedule.",
"min": 0,
"max": "1",
"base": {
"path": "Order.when.schedule",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Timing"
}
],
"condition": [
"ord-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "GTS is a complex schedule"
},
{
"identity": "w5",
"map": "when.planned"
}
]
},
{
"path": "Order.detail",
"short": "What action is being ordered",
"definition": "What action is being ordered.",
"comments": "The details of the order (e.g., service performed) SHALL be provided in order to evaluate them for appropriateness.",
"requirements": "The service being provided must be described so that the order can be evaluated for appropriateness. Only one order can be evaluated at a time.",
"min": 1,
"max": "1",
"base": {
"path": "Order.detail",
"min": 1,
"max": "*"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-diagnosticorder"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-medicationorder"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-procedurerequest"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-referralrequest"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Order",
"short": "A request to perform an action",
"definition": "A request to perform an action.",
"alias": [
"Request"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Order"
}
],
"isSummary": true
},
{
"path": "Order.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"comments": "The placer order identifier associated with the order shall be provided.",
"requirements": "The placer order identifier is provided so that the receiver of the evaluation can verify that the order being placed was the same as an order that was authorized.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Order.date",
"short": "When the order was made",
"definition": "When the order was made.",
"comments": "The date associated with the order SHALL be provided.",
"requirements": "The date of the order is provided so that the receiver of the evaluation can verify that the order was produced within a reasonable time period for accepting the evaluation according to local policies, and to enable the Decision Support Service to apply relevant guidelines. The value shall be precise to the day.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Order.subject",
"short": "Patient this order is about",
"definition": "Patient this order is about.",
"comments": "The patient for whom the order is being placed SHALL be provided.",
"requirements": "The patient is provided so that relevant demographics, such as age and gender can be used to evaluate appropriateness.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-patient"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true
},
{
"path": "Order.source",
"short": "Who initiated the order",
"definition": "Who initiated the order.",
"comments": "The identifier of the provider SHALL be provided.",
"requirements": "The identifier of the provider is provided in order for the receiver of the evaluation to verify that the evaluation given is associated with the correct order. ",
"alias": [
"Author",
"Practitioner"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-practitioner"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true
},
{
"path": "Order.reason[x]",
"short": "Text - why the order was made",
"definition": "Text - why the order was made.",
"comments": "This field contains either a code or a contained resource that gives the reason (a.k.a. indication) for the order. This could include screening, signs or symptoms, diagnoses, diagnostic results, medications or procedures , or other resources. This information must be supported and SHALL be provided.",
"requirements": "The reason is required to support evaluation of the appropriateness of the order.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Indicates the reason for seeking fulfillment of the order."
}
},
{
"path": "Order.detail",
"short": "What action is being ordered",
"definition": "What action is being ordered.",
"comments": "The details of the order (e.g., service performed) SHALL be provided in order to evaluate them for appropriateness.",
"requirements": "The service being provided must be described so that the order can be evaluated for appropriateness. Only one order can be evaluated at a time.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-diagnosticorder"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-medicationorder"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-procedurerequest"
],
"aggregation": [
"contained"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/gao-referralrequest"
],
"aggregation": [
"contained"
]
}
],
"isSummary": true
}
]
}
}
© HL7.org 2011+. FHIR DSTU2 (v1.2.0-7447) generated on Fri, Dec 11, 2015 17:44+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change