Request
type: StructureDefinition
node role: treeRoot
id:
  v: Request
text:
  status:
    v: generated
  div:
    v: to do
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: informative
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: fhir
url:
  v: http://hl7.org/fhir/StructureDefinition/Request
  l: Request
version:
  v: 6.0.0-ballot4
name:
  v: Request
title:
  v: request
status:
  v: draft
experimental:
  v: false
date:
  v: 2026-06-19T17:29:18+00:00
publisher:
  v: HL7 International / FHIR Infrastructure
contact:
  telecom:
    system:
      v: url
    value:
      v: http://hl7.org/fhir
contact:
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
description:
  v: 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:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 6.0.0-ballot4
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 V2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: Request
  l: Request
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
snapshot:
  element:
    id:
      v: Request
    path:
      v: Request
    short:
      v: Request Pattern
    definition:
      v: A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Request
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: v2
      map:
        v: ORC
    mapping:
      identity:
        v: rim
      map:
        v: Act[moodCode<=INT]
  element:
    id:
      v: Request.identifier
    path:
      v: Request.identifier
    short:
      v: Business Identifier for {{title}}
    definition:
      v: 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:
      v: 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.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.
    requirements:
      v: Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Request.identifier
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Identifier
        l: Identifier
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    is modifier:
      v: false
    is summary:
      v: true
    mapping:
      identity:
        v: v2
      map:
        v: ORC.2, ORC.3
    mapping:
      identity:
        v: rim
      map:
        v: .identifier
    mapping:
      identity:
        v: w5
      map:
        v: FiveWs.identifier

id:
  v: Request.basedOn
path:
  v: Request.basedOn
short:
  v: Fulfills plan, proposal or order
definition:
  v: 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:
  v: 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:
  v: Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
alias:
  v: fulfills
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.basedOn
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Appointment
    l: Appointment
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CarePlan
    l: CarePlan
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Claim
    l: Claim
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
    l: CommunicationRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest
    l: CoverageEligibilityRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DeviceRequest
    l: DeviceRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/EnrollmentRequest
    l: EnrollmentRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/MedicationRequest
    l: MedicationRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/NutritionOrder
    l: NutritionOrder
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RequestOrchestration
    l: RequestOrchestration
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ServiceRequest
    l: ServiceRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Task
    l: Task
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/VisionPrescription
    l: VisionPrescription
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: ORC.8 (plus others)
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=FLFS].target

id:
  v: Request.replaces
path:
  v: Request.replaces
short:
  v: Request(s) replaced by this {{title}}
definition:
  v: Completed or terminated request(s) whose function is taken by this new {{title}}.
comment:
  v: 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:
  v: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
alias:
  v: supersedes
alias:
  v: prior
alias:
  v: renewed order
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.replaces
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Appointment
    l: Appointment
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CarePlan
    l: CarePlan
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Claim
    l: Claim
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
    l: CommunicationRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest
    l: CoverageEligibilityRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DeviceRequest
    l: DeviceRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/EnrollmentRequest
    l: EnrollmentRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/MedicationRequest
    l: MedicationRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/NutritionOrder
    l: NutritionOrder
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RequestOrchestration
    l: RequestOrchestration
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ServiceRequest
    l: ServiceRequest
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Task
    l: Task
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/VisionPrescription
    l: VisionPrescription
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Handled by message location of ORC (ORC.1=RO or RU)
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RPLC].target

id:
  v: Request.groupIdentifier
path:
  v: Request.groupIdentifier
short:
  v: Composite request this is part of
definition:
  v: 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:
  v: 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:
  v: 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:
  v: grouperId
alias:
  v: requisition
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.groupIdentifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: ORC.4
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

id:
  v: Request.status
path:
  v: Request.status
short:
  v: draft | active | on-hold | revoked | completed | entered-in-error | unknown
definition:
  v: The current state of the {{title}}.
comment:
v: 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 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:
  v: 1
max:
  v: 1
base:
  path:
    v: Request.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: 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
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: Codes identifying the lifecycle stage of a request.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestStatus
  strength:
    v: required
  description:
    v: Codes identifying the lifecycle stage of a request.
  value set:
    v: http://hl7.org/fhir/ValueSet/request-status|6.0.0-ballot4
    l: http://hl7.org/fhir/ValueSet/request-status
mapping:
  identity:
    v: v2
  map:
    v: ORC.5
mapping:
  identity:
    v: rim
  map:
    v: .status
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status

id:
  v: Request.statusReason
path:
  v: Request.statusReason
short:
  v: Reason for current status
definition:
  v: 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.
comment:
  v: 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:
  v: Suspended Reason
alias:
  v: Cancelled Reason
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.statusReason
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: Codes identifying the reason for the current state of a request.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestStatusReason
  strength:
    v: example
  description:
    v: Codes identifying the reason for the current state of a request.
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

id:
  v: Request.intent
path:
  v: Request.intent
short:
  v: proposal | plan | order (immutable)
definition:
  v: Indicates the level of authority/intentionality associated with the {{title}} and where the request fits into the workflow chain.
comment:
  v: 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:
  v: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
alias:
  v: category
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Request.intent
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: 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
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: Codes indicating the degree of authority/intentionality associated with a request.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestIntent
  strength:
    v: required
  description:
    v: Codes indicating the degree of authority/intentionality associated with a request.
  value set:
    v: http://hl7.org/fhir/ValueSet/request-intent|6.0.0-ballot4
    l: http://hl7.org/fhir/ValueSet/request-intent
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: .moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class

id:
  v: Request.priority
path:
  v: Request.priority
short:
  v: routine | urgent | asap | stat
definition:
  v: Indicates how quickly the {{title}} should be addressed with respect to other requests.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.priority
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
meaning when missing:
  v: If missing, this task should be performed with normal priority
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: Identifies the level of importance to be assigned to actioning the request.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestPriority
  strength:
    v: required
  description:
    v: Identifies the level of importance to be assigned to actioning the request.
  value set:
    v: http://hl7.org/fhir/ValueSet/request-priority|6.0.0-ballot4
    l: http://hl7.org/fhir/ValueSet/request-priority
mapping:
  identity:
    v: v2
  map:
    v: TQ1.9
mapping:
  identity:
    v: rim
  map:
    v: .priorityCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.grade

id:
  v: Request.doNotPerform
path:
  v: Request.doNotPerform
short:
  v: true if request is prohibiting action
definition:
  v: If true indicates that the {{title}} is asking for the specified action to *not* occur.
comment:
  v: 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:
  v: Supports things like Do Not Recussitate, Nothing by mouth, etc.
alias:
  v: prohibited
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.doNotPerform
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
meaning when missing:
  v: If do not perform is not specified, the request is a positive request e.g. "do perform"
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: 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.
is summary:
  v: true

id:
  v: Request.category
path:
  v: Request.category
short:
  v: 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:
  v: 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:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: Request.category
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Request.code
path:
  v: Request.code
short:
  v: Service requested/ordered
definition:
  v: A code that identifies the specific service or action being asked to be done (or not done).
requirements:
  v: [In some cases, the service type is implicit based on the scope of the resource and only a product element will be present].
alias:
  v: type
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.code
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: 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:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestCode
  strength:
    v: example
  description:
    v: 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.
mapping:
  identity:
    v: v2
  map:
    v: Varies by domain
mapping:
  identity:
    v: rim
  map:
    v: .code
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.what[x]

id:
  v: Request.product
path:
  v: Request.product
short:
  v: Product requested/ordered
definition:
  v: Indicates the product whose supply or manipulation is authorized by this {{title}}.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.product
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableReference
    l: CodeableReference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct
    l: BiologicallyDerivedProduct
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DeviceDefinition
    l: DeviceDefinition
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Medication
    l: Medication
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/NutritionProduct
    l: NutritionProduct
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Substance
    l: Substance
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Varies by domain
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=PRD].role

id:
  v: Request.subject
path:
  v: Request.subject
short:
  v: Individual the service is ordered/prohibited for
definition:
  v: The individual or set of individuals the action is to be performed/not performed on or for.
comment:
  v: [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:
  v: Links the request to the Patient context.
alias:
  v: patient
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Request.subject
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Group
    l: Group
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Accompanying PID segment
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=SBJ].role
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject

id:
  v: Request.encounter
path:
  v: Request.encounter
short:
  v: Encounter the {{title}} is tied to
definition:
  v: The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated.
comment:
  v: 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:
  v: Links the {{title}} to the Encounter context.
alias:
  v: context
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Encounter
    l: Encounter
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Accompanying PV1
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.context

id:
  v: Request.occurrence[x]
path:
  v: Request.occurrence[x]
short:
  v: When service should (not) occur
definition:
  v: The date or time(s) at which the activity or service is desired to occur or not occur.
comment:
  v: [The list of types may be constrained as appropriate for the type of event].
alias:
  v: timing
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.occurrence[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: Period
    l: Period
type:
  code:
    v: Timing
    l: Timing
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: Accompanying TQ1/TQ2 segments
mapping:
  identity:
    v: rim
  map:
    v: .effectiveTime
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.planned

id:
  v: Request.authoredOn
path:
  v: Request.authoredOn
short:
  v: When request was created/transitioned to active (e.g. signed/authorized)
definition:
  v: For draft {{title}}s, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
alias:
  v: createdOn
alias:
  v: signedOn
alias:
  v: authorizedOn
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.authoredOn
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: ORC.9
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=AUT].time
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.recorded

id:
  v: Request.requester
path:
  v: Request.requester
short:
  v: Who/what is requesting service
definition:
  v: Who initiated the {{request}} and has responsibility for its activation.
comment:
  v: [Resources may choose to constrain potential requesters, though should consider proposals and plans as well as orders].
alias:
  v: author
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.requester
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    l: PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: ORC.12
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=AUT].role
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.author

id:
  v: Request.reported[x]
path:
  v: Request.reported[x]
short:
  v: Reported rather than primary record
definition:
  v: 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:
  v: Reported data may have different rules on editing and may be visually distinguished from primary data.
alias:
  v: informer
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.reported[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    l: PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=RPT].role
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.source

id:
  v: Request.performerType
path:
  v: Request.performerType
short:
  v: Desired kind of service performer
definition:
  v: The type of individual that is desired to act upon/ not act upon the {{request}}.
comment:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.performerType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: 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:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PerformerType
  strength:
    v: example
  description:
    v: 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.
mapping:
  identity:
    v: v2
  map:
    v: PRT
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=PRF].role[scoper.determinerCode=KIND].code
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.actor

id:
  v: Request.performer
path:
  v: Request.performer
short:
  v: Specific desired (non)performer
definition:
  v: Indicates who or what is being asked to perform (or not perform) the {{request}}.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Request.performer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    l: PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CareTeam
    l: CareTeam
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    l: HealthcareService
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: PRT
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.actor

id:
  v: Request.deliverTo
path:
  v: Request.deliverTo
short:
  v: Who should receive result of {{title}}
definition:
  v: Identifies the entity(ies) who should receive the results of executing the {{title}} (or the location to which the results should be delivered).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.deliverTo
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    l: RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    l: PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: Location
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    l: HealthcareService
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CareTeam
    l: CareTeam
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    l: Device
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Endpoint
    l: Endpoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Request.reason
path:
  v: Request.reason
short:
  v: Why is service (not) needed?
definition:
  v: Describes why the request is being made in coded or textual form, or Indicates another resource whose existence justifies this request.
comment:
  v: 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:
  v: 0
max:
  v: *
base:
  path:
    v: Request.reason
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableReference
    l: CodeableReference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Condition
    l: Condition
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Observation
    l: Observation
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DiagnosticReport
    l: DiagnosticReport
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DocumentReference
    l: DocumentReference
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
      l: binding-definition
    value: Markdown
      v: 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:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: RequestReason
  strength:
    v: example
  description:
    v: 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.
mapping:
  identity:
    v: v2
  map:
    v: ORC.16
mapping:
  identity:
    v: rim
  map:
    v: .reasonCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]

id:
  v: Request.insurance
path:
  v: Request.insurance
short:
  v: Associated insurance coverage
definition:
  v: Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.insurance
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Coverage
    l: Coverage
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ClaimResponse
    l: ClaimResponse
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: IN1/IN2
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=COVBY].target

id:
  v: Request.supportingInfo
path:
  v: Request.supportingInfo
short:
  v: Extra information to use in performing request
definition:
  v: Information that may be needed by/relevant to the performer in their execution of this {{title}}.
comment:
  v: See guidance on [notes vs. supportingInfo](request.html#notes).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.supportingInfo
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: Accompanying segments
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=PERT].target

id:
  v: Request.note
path:
  v: Request.note
short:
  v: Comments made about {{title}}
definition:
  v: Comments made about the {{title}} by the requester, performer, subject or other participants.
comment:
  v: See guidance on [notes vs. supportingInfo](request.html#notes).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.note
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Annotation
    l: Annotation
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: NTE
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]

id:
  v: Request.relevantHistory
path:
  v: Request.relevantHistory
short:
  v: Key events in history of {{title}}
definition:
  v: 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:
  v: 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:
  v: eventHistory
min:
  v: 0
max:
  v: *
base:
  path:
    v: Request.relevantHistory
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/provenance-relevant-history
    l: provenance-relevant-history
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]