{
"description": "Logical Model: A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
"_filename": "StructureDefinition-Request.json",
"package_name": "hl7.fhir.r6.examples",
"date": "2025-04-01T12:16:37+11:00",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot3",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "Request",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Request",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "request",
"package_version": "6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request",
"min": 0,
"definition": "A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
"isModifier": false,
"short": "Request Pattern",
"mapping": [ {
"map": "ORC",
"identity": "v2"
}, {
"map": "Act[moodCode<=INT]",
"identity": "rim"
} ],
"max": "*",
"id": "Request",
"base": {
"max": "*",
"min": 0,
"path": "Request"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.identifier",
"requirements": "Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"definition": "Business identifiers assigned to this {{title}} by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
"isModifier": false,
"short": "Business Identifier for {{title}}",
"mapping": [ {
"map": "ORC.2, ORC.3",
"identity": "v2"
}, {
"map": ".identifier",
"identity": "rim"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Request.identifier",
"comment": "The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.\n\nNote: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"base": {
"max": "*",
"min": 0,
"path": "Request.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.basedOn",
"requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"min": 0,
"definition": "A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this {{title}}. Authorization from the 'basedOn' request flows through to the referencing {{title}}.",
"isModifier": false,
"short": "Fulfills plan, proposal or order",
"mapping": [ {
"map": "ORC.8 (plus others)",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference"
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "Request.basedOn",
"comment": "basedOn represents the 'authorization' chain for an action, not the 'reason for action'. For example, an order might be placed on hold under the authorization for a surgery. However the 'reason' for placing the hold is \"to avoid interaction with anesthesia medications\"\n\n[The allowed reference resources may be adjusted as appropriate for the request resource].",
"base": {
"max": "*",
"min": 0,
"path": "Request.basedOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.replaces",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"min": 0,
"definition": "Completed or terminated request(s) whose function is taken by this new {{title}}.",
"isModifier": false,
"short": "Request(s) replaced by this {{title}}",
"mapping": [ {
"map": "Handled by message location of ORC (ORC.1=RO or RU)",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=RPLC].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference"
} ],
"alias": [ "supersedes", "prior", "renewed order" ],
"max": "*",
"id": "Request.replaces",
"comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"base": {
"max": "*",
"min": 0,
"path": "Request.replaces"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.groupIdentifier",
"requirements": "Some business processes need to know if multiple items were ordered as part of the same \"prescription\" or \"requisition\" for billing or other purposes.",
"min": 0,
"definition": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"isModifier": false,
"short": "Composite request this is part of",
"mapping": [ {
"map": "ORC.4",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"alias": [ "grouperId", "requisition" ],
"max": "1",
"id": "Request.groupIdentifier",
"comment": "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"base": {
"max": "1",
"min": 0,
"path": "Request.groupIdentifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.status",
"min": 1,
"definition": "The current state of the {{title}}.",
"isModifier": true,
"short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"mapping": [ {
"map": "ORC.5",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-status|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes identifying the lifecycle stage of a request."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestStatus"
} ],
"description": "Codes identifying the lifecycle stage of a request."
},
"max": "1",
"id": "Request.status",
"comment": "The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, completed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding [Event](event.html)(s) or using the [Task](task.html) resource. A nominal state-transition diagram can be found in the [[request.html#statemachine | Request pattern]] documentation Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. A status of 'active' when doNotPerform is true means that the request to not perform is currently in force.\n\nA status of completed for a \"doNotPerform\" request indicates that the period of non-performance is now satisfied and the request no longer holds.",
"base": {
"max": "1",
"min": 1,
"path": "Request.status"
},
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the {{title}}. Note that any change to the state requires the removal of any existing statusReasons, and, if appropriate, populating new statusReasons.",
"isModifier": false,
"short": "Reason for current status",
"mapping": [ {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes identifying the reason for the current state of a request."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestStatusReason"
} ],
"description": "Codes identifying the reason for the current state of a request."
},
"alias": [ "Suspended Reason", "Cancelled Reason" ],
"max": "*",
"id": "Request.statusReason",
"comment": "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the {{title}} was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].",
"base": {
"max": "*",
"min": 0,
"path": "Request.statusReason"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.intent",
"requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"min": 1,
"definition": "Indicates the level of authority/intentionality associated with the {{title}} and where the request fits into the workflow chain.",
"isModifier": true,
"short": "proposal | plan | order (immutable)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)",
"identity": "rim"
}, {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-intent|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes indicating the degree of authority/intentionality associated with a request."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestIntent"
} ],
"description": "Codes indicating the degree of authority/intentionality associated with a request."
},
"alias": [ "category" ],
"max": "1",
"id": "Request.intent",
"comment": "This element is expected to be immutable. E.g. A \"proposal\" instance should never change to be a \"plan\" instance or \"order\" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.\n\nOne exception to this is that the granularity of Request.intent is allowed to change. For example, a Request identified as an \"order\" might later be clarified to be a \"filler-order\". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.\n\nWhen resources map to this element, they are free to define as many codes as necessary to cover their space and will map to \"proposal, plan or order\". Can have multiple codes that map to one of these. E.g. \"original order\", \"encoded order\", \"reflex order\" would all map to \"order\". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy.",
"base": {
"max": "1",
"min": 1,
"path": "Request.intent"
},
"isModifierReason": "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.priority",
"min": 0,
"definition": "Indicates how quickly the {{title}} should be addressed with respect to other requests.",
"isModifier": false,
"short": "routine | urgent | asap | stat",
"mapping": [ {
"map": "TQ1.9",
"identity": "v2"
}, {
"map": ".priorityCode",
"identity": "rim"
}, {
"map": "FiveWs.grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this task should be performed with normal priority",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-priority|6.0.0-ballot3",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Identifies the level of importance to be assigned to actioning the request."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestPriority"
} ],
"description": "Identifies the level of importance to be assigned to actioning the request."
},
"max": "1",
"id": "Request.priority",
"base": {
"max": "1",
"min": 0,
"path": "Request.priority"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.doNotPerform",
"requirements": "Supports things like Do Not Recussitate, Nothing by mouth, etc.",
"min": 0,
"definition": "If true indicates that the {{title}} is asking for the specified action to *not* occur.",
"isModifier": true,
"short": "true if request is prohibiting action",
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "If do not perform is not specified, the request is a positive request e.g. \"do perform\"",
"alias": [ "prohibited" ],
"max": "1",
"id": "Request.doNotPerform",
"comment": "The attributes provided with the request qualify what is not to be done. For example, if an effectiveTime is provided, the \"do not\" request only applies within the specified time. If a performerType is specified then the \"do not\" request only applies to performers of that type. Qualifiers include: code, subject, occurrence, performerType and performer.\n\nIn some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. \"NPO\" (nothing by mouth), \"DNR\" (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. \"Do not DNR\").",
"base": {
"max": "1",
"min": 0,
"path": "Request.doNotPerform"
},
"isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.category",
"requirements": "Categorization might be done automatically (inferred by code) or manually by user assertion. The absence of a category may limit the ability to determine when the element should be handled, so strong consideration should be given to how systems will be able to determine category values for legacy data and how data that cannot be categorized will be handled. As well, some categories might not be mutually exclusive, so systems should prepare for multiple declared categories - even within a single category 'axis'.\nIn general, there should not be a 'strong' binding ('required' or 'extensible') on the category element overall. Instead, the element can be sliced and bindings can be asserted that apply to particular repetitions.",
"min": 0,
"definition": "Partitions the {{title}} into one or more categories that can be used to filter searching, to govern access control and/or to guide system behavior.",
"isModifier": false,
"short": "Partitions the {{title}} into one or more categories that can be used to filter searching, to govern access control and/or to guide system behavior.",
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "Request.category",
"base": {
"max": "*",
"min": 0,
"path": "Request.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.code",
"requirements": "[In some cases, the service type is implicit based on the scope of the resource and only a product element will be present].",
"min": 0,
"definition": "A code that identifies the specific service or action being asked to be done (or not done).",
"isModifier": false,
"short": "Service requested/ordered",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes indicating the details of what is being requested. These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestCode"
} ],
"description": "Codes indicating the details of what is being requested. These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required."
},
"alias": [ "type" ],
"max": "1",
"id": "Request.code",
"base": {
"max": "1",
"min": 0,
"path": "Request.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.product",
"min": 0,
"definition": "Indicates the product whose supply or manipulation is authorized by this {{title}}.",
"isModifier": false,
"short": "Product requested/ordered",
"mapping": [ {
"map": "Varies by domain",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRD].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/NutritionProduct", "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"max": "1",
"id": "Request.product",
"base": {
"max": "1",
"min": 0,
"path": "Request.product"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.subject",
"requirements": "Links the request to the Patient context.",
"min": 1,
"definition": "The individual or set of individuals the action is to be performed/not performed on or for.",
"isModifier": false,
"short": "Individual the service is ordered/prohibited for",
"mapping": [ {
"map": "Accompanying PID segment",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"alias": [ "patient" ],
"max": "1",
"id": "Request.subject",
"comment": "[For resources that aren't patient-specific, the set of allowed resources may be extended to include other things. Group should generally be retained unless there's certainty this resource won't be used for veterinary, research or public health settings where Group may be necessary (e.g. this cage of rats/crate of chickens, group of people in a 5 mile radious of the incident, etc.)].",
"base": {
"max": "1",
"min": 1,
"path": "Request.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.encounter",
"requirements": "Links the {{title}} to the Encounter context.",
"min": 0,
"definition": "The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated.",
"isModifier": false,
"short": "Encounter the {{title}} is tied to",
"mapping": [ {
"map": "Accompanying PV1",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]",
"identity": "rim"
}, {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"alias": [ "context" ],
"max": "1",
"id": "Request.encounter",
"comment": "This will typically be the encounter during which the {{title}} was created. However, some {{title}s may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission activities).",
"base": {
"max": "1",
"min": 0,
"path": "Request.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.occurrence[x]",
"min": 0,
"definition": "The date or time(s) at which the activity or service is desired to occur or not occur.",
"isModifier": false,
"short": "When service should (not) occur",
"mapping": [ {
"map": "Accompanying TQ1/TQ2 segments",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "FiveWs.planned",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
}, {
"code": "Timing"
} ],
"alias": [ "timing" ],
"max": "1",
"id": "Request.occurrence[x]",
"comment": "[The list of types may be constrained as appropriate for the type of event].",
"base": {
"max": "1",
"min": 0,
"path": "Request.occurrence[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.authoredOn",
"min": 0,
"definition": "For draft {{title}}s, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"isModifier": false,
"short": "When request was created/transitioned to active",
"mapping": [ {
"map": "ORC.9",
"identity": "v2"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "createdOn", "signedOn" ],
"max": "1",
"id": "Request.authoredOn",
"base": {
"max": "1",
"min": 0,
"path": "Request.authoredOn"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.requester",
"min": 0,
"definition": "Who initiated the {{request}} and has responsibility for its activation.",
"isModifier": false,
"short": "Who/what is requesting service",
"mapping": [ {
"map": "ORC.12",
"identity": "v2"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
}, {
"map": "FiveWs.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"alias": [ "author" ],
"max": "1",
"id": "Request.requester",
"comment": "[Resources may choose to constrain potential requesters, though should consider proposals and plans as well as orders].",
"base": {
"max": "1",
"min": 0,
"path": "Request.requester"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.reported[x]",
"requirements": "Reported data may have different rules on editing and may be visually distinguished from primary data.",
"min": 0,
"definition": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.",
"isModifier": false,
"short": "Reported rather than primary record",
"mapping": [ {
"map": ".participation[typeCode=RPT].role",
"identity": "rim"
}, {
"map": "FiveWs.source",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"alias": [ "informer" ],
"max": "1",
"id": "Request.reported[x]",
"base": {
"max": "1",
"min": 0,
"path": "Request.reported[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.performerType",
"min": 0,
"definition": "The type of individual that is desired to act upon/ not act upon the {{request}}.",
"isModifier": false,
"short": "Desired kind of service performer",
"mapping": [ {
"map": "PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code",
"identity": "rim"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Identifies types of practitioners, devices or other agents that should fulfill a request. While the detailed constraints of relevant agents will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PerformerType"
} ],
"description": "Identifies types of practitioners, devices or other agents that should fulfill a request. While the detailed constraints of relevant agents will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable."
},
"max": "1",
"id": "Request.performerType",
"comment": "If specified without indicating a performer, this indicates that the performer must be (or can't be) of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available. If doNotPerform is true, then only one of performerType and performer should be present.",
"base": {
"max": "1",
"min": 0,
"path": "Request.performerType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.performer",
"min": 0,
"definition": "Indicates who or what is being asked to perform (or not perform) the {{request}}.",
"isModifier": false,
"short": "Specific desired (non)performer",
"mapping": [ {
"map": "PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"max": "1",
"id": "Request.performer",
"base": {
"max": "1",
"min": 0,
"path": "Request.performer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.deliverTo",
"min": 0,
"definition": "Identifies the entity(ies) who should receive the results of executing the {{title}} (or the location to which the results should be delivered).",
"isModifier": false,
"short": "Who should receive result of {{title}}",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"max": "*",
"id": "Request.deliverTo",
"base": {
"max": "*",
"min": 0,
"path": "Request.deliverTo"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.reason",
"min": 0,
"definition": "Describes why the request is being made in coded or textual form, or Indicates another resource whose existence justifies this request.",
"isModifier": false,
"short": "Why is service (not) needed?",
"mapping": [ {
"map": "ORC.16",
"identity": "v2"
}, {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Codes identifying why this request was necessary. These may be clinical reasons (e.g. diagnoses, symptoms) and/or administrative reasons. While the detailed constraints of relevant reasons will vary by resource, some degree of consistency across resources around recommended codes would be desirable."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RequestReason"
} ],
"description": "Codes identifying why this request was necessary. These may be clinical reasons (e.g. diagnoses, symptoms) and/or administrative reasons. While the detailed constraints of relevant reasons will vary by resource, some degree of consistency across resources around recommended codes would be desirable."
},
"max": "*",
"id": "Request.reason",
"comment": "Textual reasons can be captured using reasonCode.text. If doNoPerform is true, this will be the reason why the request is being made to not act.",
"base": {
"max": "*",
"min": 0,
"path": "Request.reason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.insurance",
"min": 0,
"definition": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service.",
"isModifier": false,
"short": "Associated insurance coverage",
"mapping": [ {
"map": "IN1/IN2",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=COVBY].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Coverage", "http://hl7.org/fhir/StructureDefinition/ClaimResponse" ]
} ],
"max": "*",
"id": "Request.insurance",
"base": {
"max": "*",
"min": 0,
"path": "Request.insurance"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.supportingInfo",
"min": 0,
"definition": "Information that may be needed by/relevant to the performer in their execution of this {{title}}.",
"isModifier": false,
"short": "Extra information to use in performing request",
"mapping": [ {
"map": "Accompanying segments",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=PERT].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "*",
"id": "Request.supportingInfo",
"comment": "See guidance on [notes vs. supportingInfo](request.html#notes).",
"base": {
"max": "*",
"min": 0,
"path": "Request.supportingInfo"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.note",
"min": 0,
"definition": "Comments made about the {{title}} by the requester, performer, subject or other participants.",
"isModifier": false,
"short": "Comments made about {{title}}",
"mapping": [ {
"map": "NTE",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Request.note",
"comment": "See guidance on [notes vs. supportingInfo](request.html#notes).",
"base": {
"max": "*",
"min": 0,
"path": "Request.note"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Request.relevantHistory",
"min": 0,
"definition": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
"isModifier": false,
"short": "Key events in history of {{title}}",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ]
} ],
"alias": [ "eventHistory" ],
"max": "*",
"id": "Request.relevantHistory",
"comment": "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. Referenced provenances SHOULD adhere to the [provenance-relevant-history profile](provenance-relevant-history.html).\n\nSee additional guidance [here](request.html#history).",
"base": {
"max": "*",
"min": 0,
"path": "Request.relevantHistory"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "d7dfa61a-65eb-419e-a4ce-ddc86ca9e985",
"kind": "logical",
"url": "http://hl7.org/fhir/StructureDefinition/Request",
"version": "6.0.0-ballot3",
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}