Request.xml

Logical Model Request

<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>
  <url value="http://hl7.org/fhir/StructureDefinition/Request"/>
  <name value="Request"/>
  <title value="request"/>
  <status value="draft"/>
  <publisher value="Health Level Seven International fhir"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2016-12-06T12:22:34+11:00"/>
  <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."/>
  <fhirVersion value="1.8.0"/>
  <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/w5"/>
    <name value="W5 Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <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="*"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act[moodCode&lt;=INT]"/>
      </mapping>
    </element>
    <element id="Request.identifier">
      <path value="Request.identifier"/>
      <short value="Business Identifer for request/order"/>
      <definition value="Identifiers assigned to this request by the requester, performer and other systems."/>
      <comments value="The identifier.type element is used to distinguish between the identifiers assigned by
       the requester/placer and the performer/filler."/>
      <requirements value="Allows identification of the request as it is known by various participating systems and
       in a way that remains consistent across servers."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".identifier"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="id"/>
      </mapping>
    </element>
    <element id="Request.definition">
      <path value="Request.definition"/>
      <short value="Instantiates protocol or definition"/>
      <definition value="A protocol, guideline, orderset or other definition that is adhered to in whole or in
       part by this request."/>
      <comments value="[The allowed reference resources may be adjusted as appropriate for the request resource]."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Definition"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".outboundRelationship[typeCode=DEFN].target"/>
      </mapping>
    </element>
    <element id="Request.basedOn">
      <path value="Request.basedOn"/>
      <short value="Fulfills plan, proposal or order"/>
      <definition value="A plan, proposal or order that is fulfilled in whole or in part by this request."/>
      <comments value="[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/recommendations
       were acted upon."/>
      <alias value="fufills"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Request"/>
      </type>
      <isSummary value="true"/>
      <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 request"/>
      <definition value="Completed or terminated request(s) whose function is taken by this new request."/>
      <comments 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="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Request"/>
      </type>
      <isSummary value="true"/>
      <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."/>
      <comments value="Requests are linked either by a &quot;basedOn&quot; 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
       &quot;prescription&quot; or &quot;requisition&quot; for billing or other purposes."/>
      <alias value="grouperId"/>
      <alias value="requisition"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <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 | suspended | cancelled | completed | entered-in-error | unknown"/>
      <definition value="The current state of the request."/>
      <comments 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 &quot;other&quot; - one of the defined statuses
       must apply.  Unknown is used when the authoring system is not sure what the current status
       is."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="Codes identifying the stage lifecycle stage of a request"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/request-status"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".status"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="status"/>
      </mapping>
    </element>
    <element id="Request.intent">
      <path value="Request.intent"/>
      <short value="proposal | plan | order"/>
      <definition value="Indicates the level of authority/intentionality associated with the request and where
       the request fits into the workflow chain."/>
      <comments value="When resources map to this element, they are free to define as many codes as necessary
       to cover their space and will map to &quot;proposal, plan or order&quot;.  Can have multiple
       codes that map to one of these.  E.g. &quot;original order&quot;, &quot;encoded order&quot;,
       &quot;reflex order&quot; would all map to &quot;order&quot;.  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"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="Codes indicating the degree of authority/intentionality associated with a request"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/request-intent"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="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"/>
      <type>
        <code value="code"/>
      </type>
      <meaningWhenMissing value="If missing, this task should be performed with normal priority"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="Identifies the level of importance to be assigned to actioning the request"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/request-priority"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="w5"/>
        <map value="grade"/>
      </mapping>
    </element>
    <element id="Request.code">
      <path value="Request.code"/>
      <short value="What's being requested/ordered"/>
      <definition value="A code that identifies the specific service or action being requested."/>
      <alias value="type"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <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="rim"/>
        <map value=".code"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="what"/>
      </mapping>
    </element>
    <element id="Request.subject">
      <path value="Request.subject"/>
      <short value="Individual the service is ordered for"/>
      <definition value="The individual or set of individuals the action is to be performed on or for."/>
      <comments 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"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=SBJ].role"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.focus"/>
      </mapping>
    </element>
    <element id="Request.context">
      <path value="Request.context"/>
      <short value="Encounter / Episode associated with request"/>
      <definition value="The encounter or episode of care that establishes the context for making this request."/>
      <comments value="This will typically be the encounter the request was created during, but some requests
       may be initiated prior to or after the official completion of an encounter or episode
       but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests)."/>
      <requirements value="Links the request to the Encounter context."/>
      <alias value="encounter"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".inboundRelationship(typeCode=COMP].source[classCode&lt;=PCPR, moodCode=EVN]"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="context"/>
      </mapping>
    </element>
    <element id="Request.occurrence[x]">
      <path value="Request.occurrence[x]"/>
      <short value="When service should occur"/>
      <definition value="The date or time(s) at which the activity or service is desired to occur."/>
      <comments value="[The list of types may be constrained as appropriate for the type of event]."/>
      <alias value="timing"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <type>
        <code value="Period"/>
      </type>
      <type>
        <code value="Timing"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".effectiveTime"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.planned"/>
      </mapping>
    </element>
    <element id="Request.authoredOn">
      <path value="Request.authoredOn"/>
      <short value="When request transitioned to being actionable"/>
      <definition value="For draft requests, 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"/>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].time"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.recorded"/>
      </mapping>
    </element>
    <element id="Request.requester">
      <path value="Request.requester"/>
      <short value="Who/what is requesting service"/>
      <definition value="The individual who initiated the request and has responsibility for its activation."/>
      <comments value="[Resources may choose to replace this with just a single requester where there's no need
       to responsible organization]."/>
      <alias value="author"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="inv-1"/>
        <severity value="error"/>
        <human value="onBehalfOf can only be specified if agent is practitioner or device"/>
        <expression value="(agent is Practitioner) or (agent is Device) or onBehalfOf.exists().not()"/>
        <xpath value="contains(f:agent, '/Practitioner') or contains(f:agent, '/Device') or not(exists(f:onBehalfOf))"/>
      </constraint>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=AUT].role"/>
      </mapping>
    </element>
    <element id="Request.requester.agent">
      <path value="Request.requester.agent"/>
      <short value="Individual making the request"/>
      <definition value="The device, practitioner, etc. who initiated the request."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".player"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.author"/>
      </mapping>
    </element>
    <element id="Request.requester.onBehalfOf">
      <path value="Request.requester.onBehalfOf"/>
      <short value="Organization agent is acting for"/>
      <definition value="The organization the device or practitioner was acting on behalf of."/>
      <requirements value="Practitioners and Devices can be associated with multiple organizations.  This element
       indicates which organization they were acting on behalf of when authoring the request."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
      <condition value="inv-1"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".scoper"/>
      </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 the request."/>
      <comments value="If performer is also specified, this indicates what type of performer is desired in the
       event the requested performer is not available.  If specified without indicating a performer,
       this indicates that the performer must 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."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="Identifies types of practitioners, devices or others that should fulfill a request.  While
         the detailed constraints of relevant providers will vary by resource, some degree of consistency
         around recommended codes across request and definition resources would be desirable"/>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.actor"/>
      </mapping>
    </element>
    <element id="Request.performer">
      <path value="Request.performer"/>
      <short value="Specific desired performer"/>
      <definition value="Indicates who or what is being asked to perform the request."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.actor"/>
      </mapping>
    </element>
    <element id="Request.reasonCode">
      <path value="Request.reasonCode"/>
      <short value="Why is service needed?"/>
      <definition value="Describes why the request is being made in coded or textual form."/>
      <comments value="Textual reasons can be caprued using reasonCode.text."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <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="rim"/>
        <map value=".reasonCode"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="why"/>
      </mapping>
    </element>
    <element id="Request.reasonReference">
      <path value="Request.reasonReference"/>
      <short value="Why is service needed?"/>
      <definition value="Indicates another resource whose existence justifies this request."/>
      <comments value="[Additional resources may be added as appropriate]."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/>
      </type>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".outboundRelationship[typeCode=RSON].target"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="why"/>
      </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
       request."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
      </type>
      <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 service request"/>
      <definition value="Comments made about the request by the requester, performer, subject or other participants."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Annotation"/>
      </type>
      <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 request"/>
      <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."/>
      <comments 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."/>
      <alias value="eventHistory"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Provenance"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value=".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"/>
      </mapping>
    </element>
  </snapshot>
</StructureDefinition>