xCaliber healthCare Data Mesh

ServiceRequest

Overview

The ServiceRequest resource represents a request for non-clinical patient services such as transportation, admission, procedures scheduling, equipment rental etc.

Use Cases

  • Orders and Scheduling - Create orders for procedures, labs, imaging and synchronize with scheduling systems.
  • Referral Management - Submit electronic specialty referral requests and track status.
  • Care Planning - Generate service requests for health services needed to implement care plans.
  • Supply Chain - Automate requests and fulfillment for supplies, devices, equipment.
  • Home Health - Manage orders for home health services needed for discharged patients.
  • Patient Transport - Coordinate transport requests and assignments for patient transfers.
  • Environmental Services - Manage requests for room cleaning, maintenance, equipment delivery.
  • Public Health - Submit service requests to public health agencies for required care services.
  • Payor Prior Authorization - Request prior approvals from payors electronically.
  • Patient Requests - Capture and track patient requests for administrative services.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaImaging Order, Lab Order, Procedure Order, Referral Order, Patient Info Order, Vaccine Order, Order Document, Surgery Document, PatientInfo, DME
ElationLab Order, Imaging Order, Cardiac Order, Pulmonary Order, Sleep Order, Lab Order Test
EpicOrder, Order Facility, Order Note, Diagnostic Order, Diagnostic Order Placer, Diagnostic Order Filler, Diagnostic Order Provider

Object Definition

{
  "resourceType": "ServiceRequest",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">To be added</div>"
  },
  "status": "completed",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "103693007",
          "display": "Diagnostic procedure (procedure)"
        }
      ],
      "text": "Diagnostics Procedure"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "303653007",
        "display": "Computed tomography of head"
      }
    ]
  },
  "subject": {
    "reference": "Patient/example"
  },
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeServiceRequestThis is a ServiceRequest resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
instantiatesCanonicalcanonicalThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
instantiatesUriuriThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
basedOnReferencePlan/proposal/order fulfilled by this request.
replacesReferenceThe request takes the place of the referenced completed or terminated request(s).
requisitionIdentifierA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
statuscodeThe status of the order.
intentcodeWhether the request is a proposal, plan, an original order or a reflex order.
categoryCodeableConceptA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
prioritycodeIndicates how quickly the ServiceRequest should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the record is saying that the service/procedure should NOT be performed.
codeCodeableConceptA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
orderDetailCodeableConceptAdditional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
quantityQuantityQuantityAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
quantityRatioRatioAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
quantityRangeRangeAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
subjectReferenceOn whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
encounterReferenceAn encounter that provides additional information about the healthcare context in which this request is made.
occurrenceDateTimestringThe date/time at which the requested service should occur.
occurrencePeriodPeriodThe date/time at which the requested service should occur.
occurrenceTimingTimingThe date/time at which the requested service should occur.
asNeededBooleanbooleanIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
asNeededCodeableConceptCodeableConceptIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
authoredOndateTimeWhen the request transitioned to being actionable.
requesterReferenceThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the requested service.
performerReferenceThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
locationCodeCodeableConceptThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
locationReferenceReferenceA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
reasonCodeCodeableConceptAn explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
reasonReferenceReferenceIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
insuranceReferenceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
supportingInfoReferenceAdditional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
specimenReferenceOne or more specimens that the laboratory procedure will use.
bodySiteCodeableConceptAnatomic location where the procedure should be performed. This is the target site.
noteAnnotationAny other notes and comments made about the service request. For example, internal billing notes.
patientInstructionstringInstructions in terms that are understood by the patient or consumer.
relevantHistoryReferenceKey events in the history of the request.

Extensions

NameURL
BILL_TYPEhttp://xcaliber-fhir/structureDefinition/bill-type
CCShttp://xcaliber-fhir/structureDefinition/ccs
CChttp://xcaliber-fhir/structureDefinition/cc
DOCUMENThttp://xcaliber-fhir/structureDefinition/document
FACILITYhttp://xcaliber-fhir/structureDefinition/facility
METADATAhttp://xcaliber-fhir/structureDefinition/metadata
RESOLVING_DOCUMENThttp://xcaliber-fhir/structureDefinition/resolving-document
STATEhttp://xcaliber-fhir/structureDefinition/state
TAGShttp://xcaliber-fhir/structureDefinition/tags
TAGhttp://xcaliber-fhir/structureDefinition/tag
TEST_DATEhttp://xcaliber-fhir/structureDefinition/test-date
FREQUENCYhttp://xcaliber-fhir/structureDefinition/frequency
END_DATEhttp://xcaliber-fhir/structureDefinition/end-date
COLLECTION_DATEhttp://xcaliber-fhir/structureDefinition/collection-date
STAT_METHODhttp://xcaliber-fhir/structureDefinition/stat-method
FOLLOW_UP_METHODhttp://xcaliber-fhir/structureDefinition/follow-up
PRACTICEhttp://xcaliber-fhir/structureDefinition/practice
CHART_DATEhttp://xcaliber-fhir/structureDefinition/chart-date
CONFIDENTIALhttp://xcaliber-fhir/structureDefinition/confidential
REQUISITIONhttp://xcaliber-fhir/structureDefinition/requisition
SIGNED_DATEhttp://xcaliber-fhir/structureDefinition/signed-date
SIGNED_BYhttp://xcaliber-fhir/structureDefinition/signed-by
FASTING_STATUShttp://xcaliber-fhir/structureDefinition/fasting-status
LAB_ORDER_TESThttp://xcaliber-fhir/structureDefinition/lab-order-test
TEST_IDhttp://xcaliber-fhir/structureDefinition/test-id
TEST_NAMEhttp://xcaliber-fhir/structureDefinition/test-name
TEST_PROCEDURE_CLASShttp://xcaliber-fhir/structureDefinition/procedure-class
PRACTICE_CREATEDhttp://xcaliber-fhir/structureDefinition/practice-created
LAB_VENDORhttp://xcaliber-fhir/structureDefinition/lab-vendor
COMPEDIUMhttp://xcaliber-fhir/structureDefinition/compendium
CPTShttp://xcaliber-fhir/structureDefinition/cpts
SYNONYMShttp://xcaliber-fhir/structureDefinition/synonyms
QUESTIONShttp://xcaliber-fhir/structureDefinition/questions
CREATED_DATEhttp://xcaliber-fhir/structureDefinition/created-date
DELETED_DATEhttp://xcaliber-fhir/structureDefinition/deleted-date
TESTShttp://xcaliber-fhir/structureDefinition/tests
CLINICAL_REASONhttp://xcaliber-fhir/structureDefinition/clinical-reason
TEST_CODEhttp://xcaliber-fhir/structureDefinition/test-code
DEPARTMENTIDhttp://xcaliber-fhir/structureDefinition/department-id
EARLIESTFILLDATEhttp://xcaliber-fhir/structureDefinition/earliest-fill-date
LASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/last-modified-by
MODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/modified-datetime
NDChttp://xcaliber-fhir/structureDefinition/ndc
ORDERINGPROVIDERhttp://xcaliber-fhir/structureDefinition/ordering-provider
REFILLShttp://xcaliber-fhir/structureDefinition/refills
SPECIMENCOLLECTIONSITEhttp://xcaliber-fhir/structureDefinition/specimen-collection-site
CONTRAINDICATIONREASONhttp://xcaliber-fhir/structureDefinition/contraindication-reason
CREATEDUSERhttp://xcaliber-fhir/structureDefinition/created-user
ASSIGNEDUSERhttp://xcaliber-fhir/structureDefinition/assigned-user
CLASShttp://xcaliber-fhir/structureDefinition/class
PRACTICEFACILITYhttp://xcaliber-fhir/structureDefinition/practice-facility
PRACTICESECONDARYIDhttp://xcaliber-fhir/structureDefinition/practice-secondary-id
LABFACILITYhttp://xcaliber-fhir/structureDefinition/lab-facility
DESCRIPTIONhttp://xcaliber-fhir/structureDefinition/description
USERFACINGhttp://xcaliber-fhir/structureDefinition/user-facing
TESThttp://xcaliber-fhir/structureDefinition/test
FORMAThttp://xcaliber-fhir/structureDefinition/format
MAXLENGTHhttp://xcaliber-fhir/structureDefinition/max-length
QUESTIONTYPEhttp://xcaliber-fhir/structureDefinition/question-type
SECONDARYCODEhttp://xcaliber-fhir/structureDefinition/secondary-code
SEQUENCEhttp://xcaliber-fhir/structureDefinition/sequence
REQUIREDhttp://xcaliber-fhir/structureDefinition/required
VENDORIDhttp://xcaliber-fhir/structureDefinition/vendor-id
REQUESTEDVISITShttp://xcaliber-fhir/structureDefinition/requested-visits
DATEOFSERVICEhttp://xcaliber-fhir/structureDefinition/date-of-service
SECTIONNAMEhttp://xcaliber-fhir/structureDefinition/section-name
SECTIONNAMEKEYhttp://xcaliber-fhir/structureDefinition/section-name-key
FLOWSHEETIDhttp://xcaliber-fhir/structureDefinition/flow-sheet-id

Operations & APIs

ServiceRequest-GET

ServiceRequest-POST

ServiceRequest ID-GET

ServiceRequest ID-PUT

ServiceRequest ID-DELETE

ServiceRequest Export-POST