1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. ServiceRequest

Get a list of service requests

get

/ServiceRequest/

Retrieves a list of service requests that meet supplied query parameters.

Note:

  • When multiple pages of service request results are returned for a single query:
    • All referrals (if any qualify for the query) are returned on the first page of results. The next item on this list does not apply to service request referrals.
  • Querying for a service request with both code and category query parameters is not permitted.
  • Querying for a service request with both _lastUpdated and authored query parameters is not permitted.

Authorization Types

This resource supports the following authorization types:

Request

Query Parameters
  • Minimum Value: 1

    The maximum number of results to return.

    • The first page is unaffected because all referral data is displayed on the first page regardless of requested count.
    • The default count is 50.
    • From the second page onward, the returned item count may be less than requested.

    Example: _count=15

  • Minimum Number of Items: 1

    The logical resource ID. This parameter is required if the patient or subject parameter is not used.

    Search by _id supports multiple IDs for both orders and referrals.

    Example: _id=12345,R-23456

  • An explicit or implied date and 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.

    May be provided:

    • Once with a ge or le prefix representing the earliest date or latest date. Example: _lastUpdated=ge2015-01-01, _lastUpdated=le2016-01-01.
    • Twice with the ge and le prefixes to indicate a specific range. Example: _lastUpdated=ge2015-01-01&_lastUpdated=le2016-01-01.

    Example: _lastUpdated=ge2014-05-19T20:54:02.000Z

  • The Provenance resource entries to be returned as part of the bundle.
    • May be provided once with the Provenance:target value. Example: _revinclude=Provenance:target.
    • May be provided with the _id or patient parameters. Example: _id=214938095&_revinclude=Provenance:target.
    • When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding with the authorization type, such as user/Provenance.read, patient/Provenance.read, or system/Provenance.read.
    Example: _revinclude=Provenance:target

  • An explicit or implied date and time range within which the request was made.

    Must include a time and can be prefixed by: eq (if prefix is not present, eq is assumed), ge, gt, le, or lt.

    May be provided:

    • Once to indicate earliest date, latest date, or equal to a specific date and time (with or without prefix)

      Examples:

      • authored=2023-08-23T12:05:32Z (eq is assumed when no prefix is provided)
      • authored=eq2023-08-23T12:05:32Z
      • authored=ge2023-08-23T12:05:32Z
      • authored=gt2023-08-23T12:05:32Z
      • authored=le2023-08-23T12:05:32Z
      • authored=lt2023-08-23T12:05:32Z
    • Twice to indicate a specific range (only ge or gt and le or lt are supported)

      Examples:

      • authored=ge2023-08-23T12:05:32Z&authored=le2023-08-24T12:05:32Z
      • authored=ge2023-08-23T12:05:32Z&authored=lt2023-08-24T12:05:32Z
      • authored=gt2023-08-23T12:05:32Z&authored=le2023-08-24T12:05:32Z
      • authored=gt2023-08-23T12:05:32Z&authored=lt2023-08-24T12:05:32Z

    Example: authored=ge2023-09-24T07:36:13Z

  • The category of service requests being requested. The system can be one of the following options and is not required:

      • http://snomed.info/sct
      • http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh

    Example:

    • category=http://snomed.info/sct|22337316
    • category=22337316

    Note: To retrieve results that contain referrals, you must use the following category: http://snomed.info/sct|386053000.

  • What is being requested or ordered. The system can be one of the following options and is not required:

    • https://fhir.cerner.com/{EHR source ID}/codeSet/200
    • https://fhir.cerner.com/{EHR source ID}/codeSet/34
    • http://snomed.info/sct
    • http://loinc.org

    Example:

    • code=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200|22337316
    • code=22337316

  • The specific patient to return service requests for. This parameter is required if the _id or subject parameter is not used.

    Example: patient=12345

  • The specific subject to return service requests for. Must represent a patient. May use the :Patient modifier. This parameter is required if the _id or patient parameter is not used.

    Example:

    • subject=Patient/12345
    • subject:Patient=12345

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Headers
Body
Example Response (application/fhir+json)
{
    "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>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-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><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"
                    }
                ]
            }
        }
    ]
}

Default Response

An OperationOutcome describing any error that occurred.

Headers
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : issue
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : details
Type: object
Show Source
Nested Schema : location
Type: array
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

x-search-with-_revinclude Response

Example search by _id using _revinclude.
Example Request: 
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?_id=445122305,R-1&_revinclude=Provenance:target
Example Response: 
{
    {
      "resourceType": "Bundle",
      "id": "6c67r6de-b52d-43a0-bb52-68132c926s7c",
      "type": "searchset",
      "link": [
        {
          "relation": "self",
          "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest?_id=445122305%2CR-1&_revinclude=Provenance%3Atarget"
        }
      ],
      "entry": [
        {
          "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/445122305",
          "resource": {
            "resourceType": "ServiceRequest",
            "id": "445122305",
            "meta": {
              "versionId": "0",
              "lastUpdated": "2024-12-18T15:26:04Z"
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Service Request</b></p><p><b>Patient</b>: SMART, ANNA</p><p><b>Code</b>: Referral Ambulatory</p><p><b>Occurrence</b>: Dec 18, 2024  3:23 P.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Reason</b>:</p><ul><li>CHF - Congestive heart failure</li><li>Echo Stress Test</li></ul><p><b>Status</b>: Completed</p><p><b>Intent</b>: Order</p><p><b>Requester</b>: Cerner, Physician - Primary Care PCP One Cerner</p><p><b>Order Detail</b>: Medical Service: Cardiology, Reason: Echo Stress Test, Type: Procedure, Start: 12/18/24, Service By: 12/27/24</p></div>"
            },
            "status": "completed",
            "intent": "order",
            "category": [
              {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/6000",
                    "code": "23276383",
                    "display": "Referral",
                    "userSelected": true
                  }
                ],
                "text": "Referral"
              }
            ],
            "priority": "routine",
            "code": {
              "coding": [
                {
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/200",
                  "code": "273989553",
                  "userSelected": true
                }
              ],
              "text": "Referral Ambulatory"
            },
            "orderDetail": [
              {
                "text": "Medical Service: Cardiology, Reason: Echo Stress Test, Type: Procedure, Start: 12/18/24, Service By: 12/27/24"
              }
            ],
            "subject": {
              "reference": "Patient/12746484",
              "display": "SMART, ANNA"
            },
            "encounter": {
              "reference": "Encounter/97973423"
            },
            "occurrenceDateTime": "2024-12-18T15:23:00Z",
            "authoredOn": "2024-12-18T15:23:54Z",
            "requester": {
              "reference": "Practitioner/11460104",
              "display": "Cerner, Physician - Primary Care PCP One Cerner"
            },
            "reasonCode": [
              {
                "coding": [
                  {
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "code": "I50.9",
                    "display": "Heart failure, unspecified",
                    "userSelected": true
                  }
                ],
                "text": "CHF - Congestive heart failure"
              },
              {
                "text": "Echo Stress Test"
              }
            ]
          },
          "search": {
            "mode": "match"
          }
        },
        {
          "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest/R-1",
          "resource": {
            "resourceType": "ServiceRequest",
            "id": "R-1",
            "meta": {
              "versionId": "0",
              "lastUpdated": "2024-12-18T15:26:05Z"
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Service Request</b></p><p><b>Patient</b>: SMART, ANNA</p><p><b>Code</b>: Cardiology</p><p><b>Occurrence Start</b>: Dec 18, 2024  3:23 P.M. UTC</p><p><b>Occurrence End</b>: Dec 28, 2024  5:59 A.M. UTC</p><p><b>Priority</b>: Routine</p><p><b>Authored On</b>: Dec 18, 2024  3:26 P.M. UTC</p><p><b>Reason</b>:</p><ul><li>CHF - Congestive heart failure</li></ul><p><b>Status</b>: Active</p><p><b>Intent</b>: Order</p><p><b>Requester</b>: Cerner, Physician - Primary Care PCP One Cerner</p><p><b>Categories</b>: Evaluation Procedure</p></div>"
            },
            "basedOn": [
              {
                "reference": "ServiceRequest/445122305"
              }
            ],
            "status": "active",
            "intent": "order",
            "category": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "386053000",
                    "display": "Evaluation Procedure (procedure)"
                  }
                ],
                "text": "Evaluation Procedure"
              }
            ],
            "priority": "routine",
            "code": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "183519002",
                  "display": "Referral to cardiology service (procedure)"
                }
              ],
              "text": "Cardiology"
            },
            "subject": {
              "reference": "Patient/12746484",
              "display": "SMART, ANNA"
            },
            "encounter": {
              "reference": "Encounter/97973423"
            },
            "occurrencePeriod": {
              "start": "2024-12-18T15:23:00Z",
              "end": "2024-12-28T05:59:00Z"
            },
            "authoredOn": "2024-12-18T15:26:05Z",
            "requester": {
              "reference": "Practitioner/11460104",
              "display": "Cerner, Physician - Primary Care PCP One Cerner"
            },
            "reasonCode": [
              {
                "coding": [
                  {
                    "system": "http://hl7.org/fhir/sid/icd-10-cm",
                    "code": "I50.9",
                    "display": "Heart failure, unspecified"
                  }
                ],
                "text": "CHF - Congestive heart failure"
              }
            ]
          },
          "search": {
            "mode": "match"
          }
        },
        {
          "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/SER-INT.med-445122305",
          "resource": {
            "resourceType": "Provenance",
            "id": "SER-INT.med-445122305",
            "meta": {
              "versionId": "445122305",
              "lastUpdated": "2024-12-18T15:26:04Z"
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>ServiceRequest/445122305</li></ul><p><b>Recorded</b>: Dec 18, 2024  3:26 P.M. UTC</p><p><b>Agents</b>:</p><dl><dt>Cerner, Physician - Primary Care PCP One Cerner</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd><dt>Model Clinic 1</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>"
            },
            "target": [
              {
                "reference": "ServiceRequest/445122305"
              }
            ],
            "recorded": "2024-12-18T15:26:04Z",
            "agent": [
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                      "code": "author"
                    }
                  ],
                  "text": "Author"
                },
                "role": [
                  {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                        "code": "SOURCE"
                      }
                    ],
                    "text": "Source"
                  }
                ],
                "who": {
                  "reference": "Practitioner/11460104",
                  "display": "Cerner, Physician - Primary Care PCP One Cerner"
                },
                "onBehalfOf": {
                  "reference": "Organization/685844",
                  "display": "Model Clinic 1"
                }
              },
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                      "code": "author"
                    }
                  ],
                  "text": "Author"
                },
                "role": [
                  {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                        "code": "SOURCE"
                      }
                    ],
                    "text": "Source"
                  }
                ],
                "who": {
                  "reference": "Organization/685844",
                  "display": "Model Clinic 1"
                }
              }
            ]
          },
          "search": {
            "mode": "include"
          }
        },
        {
          "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/SER-INT.rfrl-1",
          "resource": {
            "resourceType": "Provenance",
            "id": "SER-INT.rfrl-1",
            "meta": {
              "versionId": "1",
              "lastUpdated": "2024-12-18T15:26:05Z"
            },
            "text": {
              "status": "generated",
              "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>ServiceRequest/R-1</li></ul><p><b>Recorded</b>: Dec 18, 2024  3:26 P.M. UTC</p><p><b>Agents</b>:</p><dl><dt>Cerner, Physician - Primary Care PCP One Cerner</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>"
            },
            "target": [
              {
                "reference": "ServiceRequest/R-1"
              }
            ],
            "recorded": "2024-12-18T15:26:05Z",
            "agent": [
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                      "code": "author"
                    }
                  ],
                  "text": "Author"
                },
                "role": [
                  {
                    "coding": [
                      {
                        "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                        "code": "SOURCE"
                      }
                    ],
                    "text": "Source"
                  }
                ],
                "who": {
                  "reference": "Practitioner/11460104",
                  "display": "Cerner, Physician - Primary Care PCP One Cerner"
                },
                "onBehalfOf": {
                  "extension": [
                    {
                      "valueCode": "unknown",
                      "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
                    }
                  ],
                  "display": "unknown"
                }
              }
            ]
          },
          "search": {
            "mode": "include"
          }
        }
      ]
  }
  }
Headers
Back to Top