ServiceRequest

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example
  • Errors
• Retrieve by id
  • Authorization Types
  • Headers
  • Example
  • Errors

Overview

The ServiceRequest resource returns the requests or orders for procedures, diagnostic tests or other services to be performed on a patient. This resource includes a wide range of requests including diagnostic procedures, therapies, patient care activities, referrals, and consults. Medication, dietary and appointment requests are NOT returned with the ServiceRequest resource.

The following fields are returned if valued:

• ServiceRequest id
• BasedOn
• Status
• Intent
• Category
• Priority
• Code
• Order Detail
• Quantity
• Patient
• Encounter
• Occurrence
• As needed
• Authored on Date
• Requester
• Performer
• Location Reference
• Reason Code
• Body site
• Note

Terminology Bindings

ServiceRequest.status

Description The status of a service order. Details: Request Status System: http://hl7.org/fhir/request-status

ServiceRequest.intent

Description The kind of service request. Details: Request Intent System: http://hl7.org/fhir/request-intent

ServiceRequest.category

Description A code that classifies the request for service. Details: Millennium Catalog Types System: https://fhir.cerner.com/<EHRsourceid>/codeSet/6000

ServiceRequest.priority

Description Identifies the level of importance to be assigned to actioning the request. Details: Request Priority System: http://hl7.org/fhir/request-priority

ServiceRequest.code

Description A code that identifies a particular service that has been requested. Details: SNOMED CT System: http://snomed.info/sct Details: LOINC System: http://loinc.org Details: Millennium Order Catalog System: https://fhir.cerner.com/<EHRsourceid>/codeSet/200

ServiceRequest.occurrence.timing

Description Code for a known/defined timing pattern. Details: TimingAbbreviation System: https://hl7.org/fhir/r4/v3/GTSAbbreviation/cs.html Details: SNOMED CT System: http://snomed.info/sct Details: Millennium Frequency System: https://fhir.cerner.com/<EHRsourceid>/codeSet/4003

ServiceRequest.asNeededCodeableConcept

Description A code representing the pre-condition for performing the service. Details: SNOMED CT System: http://snomed.info/sct Details: Millennium Reason Codes System: https://fhir.cerner.com/<EHRsourceid>/codeSet/4005

ServiceRequest.reasonCode

Description A reason code for why the service is being requested. Details: SNOMED CT System: http://snomed.info/sct Details: ICD-9 System: http://hl7.org/fhir/sid/icd-9 Details: ICD-10 System: http://hl7.org/fhir/sid/icd-10

ServiceRequest.bodySite

Description A code representing the anatomic location where the procedure should be performed. Details: SNOMED CT System: http://snomed.info/sct Details: Millennium Bodysite System: https://fhir.cerner.com/<EHRsourceid>/codeSet/1028 Details: Millennium Surgical Procedure Modifier System: https://fhir.cerner.com/<EHRsourceid>/codeSet/14045

Search

Search for ServiceRequests that meet supplied query parameters:

GET /ServiceRequest?:parameters

Authorization Types

Parameters

Name	Required?	Type	Description
_id	This, or patient or subject	token	The logical resource id associated with the resource. Example: 12345
patient	This, or _id or subject	reference	The specific patient to return ServiceRequests for. Example: 12345
subject	This, or _id or patient	reference	The subject associated with the ServiceRequest. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/12345 or subject:Patient=12345
code	N	token	What is being requested/ordered. Example: code=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200|22337316
_lastUpdated	N	date	An explicit or implied date-time range within which the most recent clinically relevant update was made to the service request. Must include a time, and must be prefixed by ge or le. Example: ge2014-05-19T20:54:02.000Z
_count	N	number	The maximum number of ServiceRequests to retrieve in a page. Example: 50

Notes:

• If _id is provided, no other parameters may be provided.
• When searching via code, the system must be ‘https://fhir.cerner.com/<EHR source id>/codeSet/200’ and should always be provided.
• The _lastUpdated parameter may be provided:
  • once with a prefix ge or le representing the earliest date or latest date. (e.g. date=ge2015-01-01, date=le2016-01-01)
  • twice with the prefixes ge, le to indicate a specific range. (e.g. date=ge2015-01-01&date=le2016-01-01)

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?patient=12457977

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "209b1587-251d-4ac8-9d6d-35660e9476fb",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?patient=12457977"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294664205",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "294664205",
        "meta": {
          "versionId": "2",
          "lastUpdated": "2018-02-02T20:01:59.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Code</b>: Pain Assessment Adult</p><p><b>Occurrence</b>: every 4 hr</p><p><b>Priority</b>: Routine</p><p><b>Status</b>: Entered in Error</p><p><b>Intent</b>: Order</p><p><b>Requester</b>: Martin, MD, Mary Cerner</p><p><b>Order Detail</b>: 12/08/16 9:41:00 CST, every 4 hr</p></div>"
        },
        "status": "entered-in-error",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
                "code": "2515",
                "display": "Patient Care",
                "userSelected": true
              }
            ],
            "text": "Patient Care"
          }
        ],
        "priority": "routine",
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
              "code": "2780687",
              "userSelected": true
            }
          ],
          "text": "Pain Assessment Adult"
        },
        "orderDetail": [
          {
            "text": "12/08/16 9:41:00 CST, every 4 hr"
          }
        ],
        "subject": {
          "reference": "Patient/12457977",
          "display": "FRIAS,"
        },
        "encounter": {
          "reference": "Encounter/97697398"
        },
        "occurrenceTiming": {
          "repeat": {
            "boundsPeriod": {
              "start": "2016-12-08T09:41:00.000-06:00",
              "end": "2018-02-02T14:01:59.000-06:00"
            }
          },
          "code": {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003",
                "code": "696547",
                "display": "every 4 hr",
                "userSelected": true
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-GTSAbbreviation",
                "code": "Q4H",
                "display": "Q4H",
                "userSelected": false
              }
            ],
            "text": "every 4 hr"
          }
        },
        "authoredOn": "2016-12-08T09:41:35.000-06:00",
        "requester": {
          "reference": "Practitioner/11724002",
          "display": "Martin, MD, Mary Cerner"
        },
        "note": [
          {
            "text": "Additional assessments may be required if pain level unacceptable"
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294664221",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "294664221",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2016-12-29T02:00:21.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Code</b>: Consult to Case Management</p><p><b>Occurrence</b>: Dec  8, 2016  3:41 P.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Status</b>: Revoked</p><p><b>Intent</b>: Order</p><p><b>Requester</b>: Martin, MD, Mary Cerner</p><p><b>Order Detail</b>: 12/08/16 9:41:00 CST, Routine</p></div>"
        },
        "status": "revoked",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
                "code": "636063",
                "display": "Consults",
                "userSelected": true
              }
            ],
            "text": "Consults"
          }
        ],
        "priority": "routine",
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
              "code": "2551292823",
              "userSelected": true
            }
          ],
          "text": "Consult to Case Management"
        },
        "orderDetail": [
          {
            "text": "12/08/16 9:41:00 CST, Routine"
          }
        ],
        "subject": {
          "reference": "Patient/12457977",
          "display": "FRIAS,"
        },
        "encounter": {
          "reference": "Encounter/97697398"
        },
        "occurrenceDateTime": "2016-12-08T09:41:00.000-06:00",
        "authoredOn": "2016-12-08T09:41:54.000-06:00",
        "requester": {
          "reference": "Practitioner/11724002",
          "display": "Martin, MD, Mary Cerner"
        },
        "note": [
          {
            "text": "Appropriate discharge referrals and schedule follow-up appointment before discharge"
          }
        ]
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?patient=12457977

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "209b1587-251d-4ac8-9d6d-35660e9476fb",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?patient=12457977"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294664205",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "294664205",
        "meta": {
          "versionId": "2",
          "lastUpdated": "2018-02-02T20:01:59.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Status</b>: Entered in Error</p><p><b>Intent</b>: Order</p></div>"
        },
        "status": "entered-in-error",
        "intent": "order",
        "subject": {
          "reference": "Patient/12457977",
          "display": "FRIAS,"
        }
      }
    },
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294664221",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "294664221",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2016-12-29T02:00:21.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Code</b>: Consult to Case Management</p><p><b>Occurrence</b>: Dec  8, 2016  3:41 P.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Status</b>: Revoked</p><p><b>Intent</b>: Order</p><p><b>Requester</b>: Martin, MD, Mary Cerner</p></div>"
        },
        "status": "revoked",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
                "code": "636063",
                "display": "Consults",
                "userSelected": true
              }
            ],
            "text": "Consults"
          }
        ],
        "priority": "routine",
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
              "code": "2551292823",
              "userSelected": true
            }
          ],
          "text": "Consult to Case Management"
        },
        "subject": {
          "reference": "Patient/12457977",
          "display": "FRIAS,"
        },
        "encounter": {
          "reference": "Encounter/97697398"
        },
        "occurrenceDateTime": "2016-12-08T09:41:00.000-06:00",
        "authoredOn": "2016-12-08T09:41:54.000-06:00",
        "requester": {
          "reference": "Practitioner/11724002",
          "display": "Martin, MD, Mary Cerner"
        }
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual ServiceRequest by its id:

GET /ServiceRequest/:id

Authorization Types

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294672281

Response

Status: 200 OK

{
  "resourceType": "ServiceRequest",
  "id": "294672281",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2018-02-05T16:01:45.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Code</b>: Pain Assessment Adult</p><p><b>Occurrence Starts</b>: Dec 12, 2016 12:00 P.M. UTC</p><p><b>Occurrence Ends</b>: Feb  5, 2018  4:01 P.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Status</b>: Revoked</p><p><b>Intent</b>: Instance Order</p><p><b>Requester</b>: Martin, MD, Mary Cerner</p><p><b>Order Detail</b>: 12/12/16 6:00:00 CST</p></div>"
  },
  "basedOn": [
    {
      "reference": "ServiceRequest/294664205"
    }
  ],
  "status": "revoked",
  "intent": "instance-order",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
          "code": "2515",
          "display": "Patient Care",
          "userSelected": true
        }
      ],
      "text": "Patient Care"
    }
  ],
  "priority": "routine",
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
        "code": "2780687",
        "userSelected": true
      }
    ],
    "text": "Pain Assessment Adult"
  },
  "orderDetail": [
    {
      "text": "12/12/16 6:00:00 CST"
    }
  ],
  "subject": {
    "reference": "Patient/12457977",
    "display": "FRIAS,"
  },
  "encounter": {
    "reference": "Encounter/97697398"
  },
  "occurrencePeriod": {
    "start": "2016-12-12T06:00:00.000-06:00",
    "end": "2018-02-05T10:01:45.000-06:00"
  },
  "authoredOn": "2016-12-08T09:41:35.000-06:00",
  "requester": {
    "reference": "Practitioner/11724002",
    "display": "Martin, MD, Mary Cerner"
  },
  "note": [
    {
      "text": "Additional assessments may be required if pain level unacceptable"
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294672281

Response

Status: 200 OK

{
  "resourceType": "ServiceRequest",
  "id": "294672281",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2018-02-05T16:01:45.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Code</b>: Pain Assessment Adult</p><p><b>Occurrence Starts</b>: Dec 12, 2016 12:00 P.M. UTC</p><p><b>Occurrence Ends</b>: Feb  5, 2018  4:01 P.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Status</b>: Revoked</p><p><b>Intent</b>: Instance Order</p><p><b>Requester</b>: Martin, MD, Mary Cerner</p></div>"
  },
  "basedOn": [
    {
      "reference": "ServiceRequest/294664205"
    }
  ],
  "status": "revoked",
  "intent": "instance-order",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
          "code": "2515",
          "display": "Patient Care",
          "userSelected": true
        }
      ],
      "text": "Patient Care"
    }
  ],
  "priority": "routine",
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
        "code": "2780687",
        "userSelected": true
      }
    ],
    "text": "Pain Assessment Adult"
  },
  "subject": {
    "reference": "Patient/12457977",
    "display": "FRIAS,"
  },
  "encounter": {
    "reference": "Encounter/97697398"
  },
  "occurrencePeriod": {
    "start": "2016-12-12T06:00:00.000-06:00",
    "end": "2018-02-05T10:01:45.000-06:00"
  },
  "authoredOn": "2016-12-08T09:41:35.000-06:00",
  "requester": {
    "reference": "Practitioner/11724002",
    "display": "Martin, MD, Mary Cerner"
  }
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request For Entered in Error Status

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/294664205

Response

Status: 200 OK

{
  "resourceType": "ServiceRequest",
  "id": "294664205",
  "meta": {
    "versionId": "2",
    "lastUpdated": "2018-02-02T20:01:59.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Service Request</b></p><p><b>Patient</b>: FRIAS,</p><p><b>Status</b>: Entered in Error</p><p><b>Intent</b>: Order</p></div>"
  },
  "status": "entered-in-error",
  "intent": "order",
  "subject": {
    "reference": "Patient/12457977",
    "display": "FRIAS,"
  }
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.