Request.json

Logical Model Request

{
  "resourceType": "StructureDefinition",
  "id": "Request",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Request",
  "name": "Request",
  "title": "request",
  "status": "draft",
  "publisher": "Health Level Seven International fhir",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2016-12-06T12:22:34+11:00",
  "description": "Logical Model: A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
  "fhirVersion": "1.8.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/w5",
      "name": "W5 Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "snapshot": {
    "element": [
      {
        "id": "Request",
        "path": "Request",
        "short": "Request Pattern",
        "definition": "A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
        "min": 0,
        "max": "*",
        "mapping": [
          {
            "identity": "rim",
            "map": "Act[moodCode<=INT]"
          }
        ]
      },
      {
        "id": "Request.identifier",
        "path": "Request.identifier",
        "short": "Business Identifer for request/order",
        "definition": "Identifiers assigned to this request by the requester, performer and other systems.",
        "comments": "The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.",
        "requirements": "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".identifier"
          },
          {
            "identity": "w5",
            "map": "id"
          }
        ]
      },
      {
        "id": "Request.definition",
        "path": "Request.definition",
        "short": "Instantiates protocol or definition",
        "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
        "comments": "[The allowed reference resources may be adjusted as appropriate for the request resource].",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Definition"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=DEFN].target"
          }
        ]
      },
      {
        "id": "Request.basedOn",
        "path": "Request.basedOn",
        "short": "Fulfills plan, proposal or order",
        "definition": "A plan, proposal or order that is fulfilled in whole or in part by this request.",
        "comments": "[The allowed reference resources may be adjusted as appropriate for the request resource].",
        "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
        "alias": [
          "fufills"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Request"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=FLFS].target"
          }
        ]
      },
      {
        "id": "Request.replaces",
        "path": "Request.replaces",
        "short": "Request(s) replaced by this request",
        "definition": "Completed or terminated request(s) whose function is taken by this new request.",
        "comments": "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": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
        "alias": [
          "supersedes",
          "prior",
          "renewed order"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Request"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=RPLC].target"
          }
        ]
      },
      {
        "id": "Request.groupIdentifier",
        "path": "Request.groupIdentifier",
        "short": "Composite request this is part of",
        "definition": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
        "comments": "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": "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": [
          "grouperId",
          "requisition"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
          }
        ]
      },
      {
        "id": "Request.status",
        "path": "Request.status",
        "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
        "definition": "The current state of the request.",
        "comments": "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.\n\nA nominal state-transition diagram can be found in the [[request.html#statemachine | Request pattern]] documentation\n\nUnknown 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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "strength": "required",
          "description": "Codes identifying the stage lifecycle stage of a request",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/request-status"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".status"
          },
          {
            "identity": "w5",
            "map": "status"
          }
        ]
      },
      {
        "id": "Request.intent",
        "path": "Request.intent",
        "short": "proposal | plan | order",
        "definition": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.",
        "comments": "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": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
        "alias": [
          "category"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "strength": "required",
          "description": "Codes indicating the degree of authority/intentionality associated with a request",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/request-intent"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
          },
          {
            "identity": "w5",
            "map": "class"
          }
        ]
      },
      {
        "id": "Request.priority",
        "path": "Request.priority",
        "short": "routine | urgent | asap | stat",
        "definition": "Indicates how quickly the {{title}} should be addressed with respect to other requests.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "meaningWhenMissing": "If missing, this task should be performed with normal priority",
        "isSummary": true,
        "binding": {
          "strength": "required",
          "description": "Identifies the level of importance to be assigned to actioning the request",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/request-priority"
          }
        },
        "mapping": [
          {
            "identity": "w5",
            "map": "grade"
          }
        ]
      },
      {
        "id": "Request.code",
        "path": "Request.code",
        "short": "What's being requested/ordered",
        "definition": "A code that identifies the specific service or action being requested.",
        "alias": [
          "type"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "strength": "example",
          "description": "Codes indicating the details of what is being requested.  These will vary significantly based on the type of request resource and will often be example/preferred rather than extensible/required."
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".code"
          },
          {
            "identity": "w5",
            "map": "what"
          }
        ]
      },
      {
        "id": "Request.subject",
        "path": "Request.subject",
        "short": "Individual the service is ordered for",
        "definition": "The individual or set of individuals the action is to be performed on or for.",
        "comments": "[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": "Links the request to the Patient context.",
        "alias": [
          "patient"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=SBJ].role"
          },
          {
            "identity": "w5",
            "map": "who.focus"
          }
        ]
      },
      {
        "id": "Request.context",
        "path": "Request.context",
        "short": "Encounter / Episode associated with request",
        "definition": "The encounter or episode of care that establishes the context for making this request.",
        "comments": "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": "Links the request to the Encounter context.",
        "alias": [
          "encounter"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
          },
          {
            "identity": "w5",
            "map": "context"
          }
        ]
      },
      {
        "id": "Request.occurrence[x]",
        "path": "Request.occurrence[x]",
        "short": "When service should occur",
        "definition": "The date or time(s) at which the activity or service is desired to occur.",
        "comments": "[The list of types may be constrained as appropriate for the type of event].",
        "alias": [
          "timing"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          },
          {
            "code": "Period"
          },
          {
            "code": "Timing"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".effectiveTime"
          },
          {
            "identity": "w5",
            "map": "when.planned"
          }
        ]
      },
      {
        "id": "Request.authoredOn",
        "path": "Request.authoredOn",
        "short": "When request transitioned to being actionable",
        "definition": "For draft requests, indicates the date of initial creation.  For requests with other statuses, indicates the date of activation.",
        "alias": [
          "createdOn",
          "signedOn"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=AUT].time"
          },
          {
            "identity": "w5",
            "map": "when.recorded"
          }
        ]
      },
      {
        "id": "Request.requester",
        "path": "Request.requester",
        "short": "Who/what is requesting service",
        "definition": "The individual who initiated the request and has responsibility for its activation.",
        "comments": "[Resources may choose to replace this with just a single requester where there's no need to responsible organization].",
        "alias": [
          "author"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Element"
          }
        ],
        "constraint": [
          {
            "key": "inv-1",
            "severity": "error",
            "human": "onBehalfOf can only be specified if agent is practitioner or device",
            "expression": "(agent is Practitioner) or (agent is Device) or onBehalfOf.exists().not()",
            "xpath": "contains(f:agent, '/Practitioner') or contains(f:agent, '/Device') or not(exists(f:onBehalfOf))"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=AUT].role"
          }
        ]
      },
      {
        "id": "Request.requester.agent",
        "path": "Request.requester.agent",
        "short": "Individual making the request",
        "definition": "The device, practitioner, etc. who initiated the request.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".player"
          },
          {
            "identity": "w5",
            "map": "who.author"
          }
        ]
      },
      {
        "id": "Request.requester.onBehalfOf",
        "path": "Request.requester.onBehalfOf",
        "short": "Organization agent is acting for",
        "definition": "The organization the device or practitioner was acting on behalf of.",
        "requirements": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          }
        ],
        "condition": [
          "inv-1"
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".scoper"
          }
        ]
      },
      {
        "id": "Request.performerType",
        "path": "Request.performerType",
        "short": "Desired kind of service performer",
        "definition": "The type of individual that is desired to act upon the request.",
        "comments": "If performer is also specified, this indicates what type of performer is desired in the event the requested performer is not available.\n\nIf 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": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "strength": "example",
          "description": "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"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
          },
          {
            "identity": "w5",
            "map": "who.actor"
          }
        ]
      },
      {
        "id": "Request.performer",
        "path": "Request.performer",
        "short": "Specific desired performer",
        "definition": "Indicates who or what is being asked to perform the request.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
          },
          {
            "identity": "w5",
            "map": "who.actor"
          }
        ]
      },
      {
        "id": "Request.reasonCode",
        "path": "Request.reasonCode",
        "short": "Why is service needed?",
        "definition": "Describes why the request is being made in coded or textual form.",
        "comments": "Textual reasons can be caprued using reasonCode.text.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "strength": "example",
          "description": "Codes identifying why this request was necessary.  These may be clinical reasons (e.g. diagnoses, symptoms) and/or administrative reasons.  While the detailed constraints of relevant reasons will vary by resource, some degree of consistency across resources around recommended codes would be desirable."
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".reasonCode"
          },
          {
            "identity": "w5",
            "map": "why"
          }
        ]
      },
      {
        "id": "Request.reasonReference",
        "path": "Request.reasonReference",
        "short": "Why is service needed?",
        "definition": "Indicates another resource whose existence justifies this request.",
        "comments": "[Additional resources may be added as appropriate].",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=RSON].target"
          },
          {
            "identity": "w5",
            "map": "why"
          }
        ]
      },
      {
        "id": "Request.supportingInfo",
        "path": "Request.supportingInfo",
        "short": "Extra information to use in performing request",
        "definition": "Information that may be needed by/relevant to the performer in their execution of this request.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=PERT].target"
          }
        ]
      },
      {
        "id": "Request.note",
        "path": "Request.note",
        "short": "Comments made about service request",
        "definition": "Comments made about the request by the requester, performer, subject or other participants.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
          }
        ]
      },
      {
        "id": "Request.relevantHistory",
        "path": "Request.relevantHistory",
        "short": "Key events in history of request",
        "definition": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
        "comments": "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": [
          "eventHistory"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
          }
        ]
      }
    ]
  }
}