FHIR CI-Build
WorkflowThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
Logical Model Request
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Request"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Request"/> <version value="6.0.0-cibuild"/> <name value="Request"/> <title value="request"/> <status value="draft"/> <experimental value="false"/> <date value="2024-04-19T18:19:53+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="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."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="6.0.0-cibuild"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 V2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="Request"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> <snapshot> <element id="Request"> <path value="Request"/> <short value="Request Pattern"/> <definition value="A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service."/> <min value="0"/> <max value="*"/> <base> <path value="Request"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="ORC"/> </mapping> <mapping> <identity value="rim"/> <map value="Act[moodCode<=INT]"/> </mapping> </element> <element id="Request.identifier"> <path value="Request.identifier"/> <short value="Business Identifier for {{title}}"/> <definition value="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."/> <comment value="The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. Note: This is a business identifier, not a resource identifier (see [discussion](resource.htm l#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."/> <requirements value="Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers."/> <min value="0"/> <max value="*"/> <base> <path value="Request.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC.2, ORC.3"/> </mapping> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="Request.basedOn"> <path value="Request.basedOn"/> <short value="Fulfills plan, proposal or order"/> <definition value="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}}."/> <comment value="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" [The allowed reference resources may be adjusted as appropriate for the request resource]."/> <requirements value="Allows tracing of authorization for the request and tracking whether proposals/recommendation s were acted upon."/> <alias value="fulfills"/> <min value="0"/> <max value="*"/> <base> <path value="Request.basedOn"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AppointmentResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CarePlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Claim"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CommunicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionOrder"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RequestOrchestration"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SupplyRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Task"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Transport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/VisionPrescription"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC.8 (plus others)"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=FLFS].target"/> </mapping> </element> <element id="Request.replaces"> <path value="Request.replaces"/> <short value="Request(s) replaced by this {{title}}"/> <definition value="Completed or terminated request(s) whose function is taken by this new {{title}}."/> <comment value="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."/> <requirements value="Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests."/> <alias value="supersedes"/> <alias value="prior"/> <alias value="renewed order"/> <min value="0"/> <max value="*"/> <base> <path value="Request.replaces"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AppointmentResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CarePlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Claim"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CommunicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionOrder"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RequestOrchestration"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SupplyRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Task"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Transport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/VisionPrescription"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Handled by message location of ORC (ORC.1=RO or RU)"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=RPLC].target"/> </mapping> </element> <element id="Request.groupIdentifier"> <path value="Request.groupIdentifier"/> <short value="Composite request this is part of"/> <definition value="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."/> <comment value="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."/> <requirements value="Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes."/> <alias value="grouperId"/> <alias value="requisition"/> <min value="0"/> <max value="1"/> <base> <path value="Request.groupIdentifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC.4"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"/> </mapping> </element> <element id="Request.status"> <path value="Request.status"/> <short value="draft | active | on-hold | revoked | completed | entered-in-error | unknown"/> <definition value="The current state of the {{title}}."/> <comment value="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. A status of completed for a "doNotPerform" request indicates that the period of non-performance is now satisfied and the request no longer holds."/> <min value="1"/> <max value="1"/> <base> <path value="Request.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="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 value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Codes identifying the lifecycle stage of a request."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestStatus"/> </extension> <strength value="required"/> <description value="Codes identifying the lifecycle stage of a request."/> <valueSet value="http://hl7.org/fhir/ValueSet/request-status|6.0.0-cibuild"/> </binding> <mapping> <identity value="v2"/> <map value="ORC.5"/> </mapping> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> </element> <element id="Request.statusReason"> <path value="Request.statusReason"/> <short value="Reason for current status"/> <definition value="Captures the reason for the current state of the {{title}}."/> <comment value="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]."/> <alias value="Suspended Reason"/> <alias value="Cancelled Reason"/> <min value="0"/> <max value="1"/> <base> <path value="Request.statusReason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Codes identifying the reason for the current state of a request."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestStatusReason"/> </extension> <strength value="example"/> <description value="Codes identifying the reason for the current state of a request."/> </binding> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"/> </mapping> </element> <element id="Request.intent"> <path value="Request.intent"/> <short value="proposal | plan | order (immutable)"/> <definition value="Indicates the level of authority/intentionality associated with the {{title}} and where the request fits into the workflow chain."/> <comment value="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. One 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. When 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."/> <requirements value="Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain."/> <alias value="category"/> <min value="1"/> <max value="1"/> <base> <path value="Request.intent"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="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 value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Codes indicating the degree of authority/intentionality associated with a request."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestIntent"/> </extension> <strength value="required"/> <description value="Codes indicating the degree of authority/intentionality associated with a request."/> <valueSet value="http://hl7.org/fhir/ValueSet/request-intent|6.0.0-cibuild"/> </binding> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value=".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.class"/> </mapping> </element> <element id="Request.priority"> <path value="Request.priority"/> <short value="routine | urgent | asap | stat"/> <definition value="Indicates how quickly the {{title}} should be addressed with respect to other requests."/> <min value="0"/> <max value="1"/> <base> <path value="Request.priority"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <meaningWhenMissing value="If missing, this task should be performed with normal priority"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Identifies the level of importance to be assigned to actioning the request."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestPriority"/> </extension> <strength value="required"/> <description value="Identifies the level of importance to be assigned to actioning the request."/> <valueSet value="http://hl7.org/fhir/ValueSet/request-priority|6.0.0-cibuild"/> </binding> <mapping> <identity value="v2"/> <map value="TQ1.9"/> </mapping> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.grade"/> </mapping> </element> <element id="Request.doNotPerform"> <path value="Request.doNotPerform"/> <short value="true if request is prohibiting action"/> <definition value="If true indicates that the {{title}} is asking for the specified action to *not* occur."/> <comment value="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. In 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")."/> <requirements value="Supports things like Do Not Recussitate, Nothing by mouth, etc."/> <alias value="prohibited"/> <min value="0"/> <max value="1"/> <base> <path value="Request.doNotPerform"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <meaningWhenMissing value="If do not perform is not specified, the request is a positive request e.g. "do perform""/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="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 value="true"/> </element> <element id="Request.category"> <path value="Request.category"/> <short value="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."/> <definition value="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."/> <requirements value="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'. In 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 value="0"/> <max value="*"/> <base> <path value="Request.category"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Request.code"> <path value="Request.code"/> <short value="Service requested/ordered"/> <definition value="A code that identifies the specific service or action being asked to be done (or not done)."/> <requirements value="[In some cases, the service type is implicit based on the scope of the resource and only a product element will be present]."/> <alias value="type"/> <min value="0"/> <max value="1"/> <base> <path value="Request.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="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."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestCode"/> </extension> <strength value="example"/> <description value="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."/> </binding> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.what[x]"/> </mapping> </element> <element id="Request.product"> <path value="Request.product"/> <short value="Product requested/ordered"/> <definition value="Indicates the product whose supply or manipulation is authorized by this {{title}}."/> <min value="0"/> <max value="1"/> <base> <path value="Request.product"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceDefinition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionProduct"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Varies by domain"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRD].role"/> </mapping> </element> <element id="Request.subject"> <path value="Request.subject"/> <short value="Individual the service is ordered/prohibited for"/> <definition value="The individual or set of individuals the action is to be performed/not performed on or for."/> <comment value="[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.)]."/> <requirements value="Links the request to the Patient context."/> <alias value="patient"/> <min value="1"/> <max value="1"/> <base> <path value="Request.subject"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Accompanying PID segment"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=SBJ].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject[x]"/> </mapping> </element> <element id="Request.encounter"> <path value="Request.encounter"/> <short value="Encounter the {{title}} is tied to"/> <definition value="The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated."/> <comment value="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)."/> <requirements value="Links the {{title}} to the Encounter context."/> <alias value="context"/> <min value="0"/> <max value="1"/> <base> <path value="Request.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Accompanying PV1"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> </element> <element id="Request.occurrence[x]"> <path value="Request.occurrence[x]"/> <short value="When service should (not) occur"/> <definition value="The date or time(s) at which the activity or service is desired to occur or not occur."/> <comment value="[The list of types may be constrained as appropriate for the type of event]."/> <alias value="timing"/> <min value="0"/> <max value="1"/> <base> <path value="Request.occurrence[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <type> <code value="Timing"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="Accompanying TQ1/TQ2 segments"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.planned"/> </mapping> </element> <element id="Request.authoredOn"> <path value="Request.authoredOn"/> <short value="When request was created/transitioned to active"/> <definition value="For draft {{title}}s, indicates the date of initial creation. For requests with other statuses, indicates the date of activation."/> <alias value="createdOn"/> <alias value="signedOn"/> <min value="0"/> <max value="1"/> <base> <path value="Request.authoredOn"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC.9"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].time"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.recorded"/> </mapping> </element> <element id="Request.requester"> <path value="Request.requester"/> <short value="Who/what is requesting service"/> <definition value="Who initiated the {{request}} and has responsibility for its activation."/> <comment value="[Resources may choose to constrain potential requesters, though should consider proposals and plans as well as orders]."/> <alias value="author"/> <min value="0"/> <max value="1"/> <base> <path value="Request.requester"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ORC.12"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=AUT].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.author"/> </mapping> </element> <element id="Request.reported[x]"> <path value="Request.reported[x]"/> <short value="Reported rather than primary record"/> <definition value="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."/> <requirements value="Reported data may have different rules on editing and may be visually distinguished from primary data."/> <alias value="informer"/> <min value="0"/> <max value="1"/> <base> <path value="Request.reported[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".participation[typeCode=RPT].role"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.source"/> </mapping> </element> <element id="Request.performerType"> <path value="Request.performerType"/> <short value="Desired kind of service performer"/> <definition value="The type of individual that is desired to act upon/ not act upon the {{request}}."/> <comment value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Request.performerType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="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."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PerformerType"/> </extension> <strength value="example"/> <description value="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."/> </binding> <mapping> <identity value="v2"/> <map value="PRT"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> </element> <element id="Request.performer"> <path value="Request.performer"/> <short value="Specific desired (non)performer"/> <definition value="Indicates who or what is being asked to perform (or not perform) the {{request}}."/> <min value="0"/> <max value="1"/> <base> <path value="Request.performer"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PRT"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> </element> <element id="Request.deliverTo"> <path value="Request.deliverTo"/> <short value="Who should receive result of {{title}}"/> <definition value="Identifies the entity(ies) who should receive the results of executing the {{title}} (or the location to which the results should be delivered)."/> <min value="0"/> <max value="*"/> <base> <path value="Request.deliverTo"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Endpoint"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Request.reason"> <path value="Request.reason"/> <short value="Why is service (not) needed?"/> <definition value="Describes why the request is being made in coded or textual form, or Indicates another resource whose existence justifies this request."/> <comment value="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."/> <min value="0"/> <max value="*"/> <base> <path value="Request.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableReference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="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."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="RequestReason"/> </extension> <strength value="example"/> <description value="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."/> </binding> <mapping> <identity value="v2"/> <map value="ORC.16"/> </mapping> <mapping> <identity value="rim"/> <map value=".reasonCode"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> </element> <element id="Request.insurance"> <path value="Request.insurance"/> <short value="Associated insurance coverage"/> <definition value="Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service."/> <min value="0"/> <max value="*"/> <base> <path value="Request.insurance"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Coverage"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ClaimResponse"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="IN1/IN2"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=COVBY].target"/> </mapping> </element> <element id="Request.supportingInfo"> <path value="Request.supportingInfo"/> <short value="Extra information to use in performing request"/> <definition value="Information that may be needed by/relevant to the performer in their execution of this {{title}}."/> <comment value="See guidance on [notes vs. supportingInfo](request.html#notes)."/> <min value="0"/> <max value="*"/> <base> <path value="Request.supportingInfo"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="Accompanying segments"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=PERT].target"/> </mapping> </element> <element id="Request.note"> <path value="Request.note"/> <short value="Comments made about {{title}}"/> <definition value="Comments made about the {{title}} by the requester, performer, subject or other participants."/> <comment value="See guidance on [notes vs. supportingInfo](request.html#notes)."/> <min value="0"/> <max value="*"/> <base> <path value="Request.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="NTE"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"/> </mapping> </element> <element id="Request.relevantHistory"> <path value="Request.relevantHistory"/> <short value="Key events in history of {{title}}"/> <definition value="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."/> <comment value="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). See additional guidance [here](request.html#history)."/> <alias value="eventHistory"/> <min value="0"/> <max value="*"/> <base> <path value="Request.relevantHistory"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Provenance"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"/> </mapping> </element> </snapshot> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-cibuild generated on Fri, Apr 19, 2024 18:22+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change