ProcedureRequest

Overview

The ProcedureRequest resource describes the request or order for a procedure or activity performed with or on a patient. This resource includes a wide range of requests including surgery procedures, diagnostic procedures, therapies, patient care activities, referrals, and consults. This resource does NOT include medication, dietary, and appointment requests. Due to the similarity and merging of resources in future FHIR versions, our current implementation of ProcedureRequest will include DiagnosticOrder and ReferralRequest.

The following fields are returned if valued:

Terminology Bindings

ProcedureRequest.code
  • Description
    • A code to identify a specific procedure.
  • Details: SNOMED CT
    System: http://snomed.info/sct

ProcedureRequest.bodySite
  • Description
    • A code that identifies the anatomical location.
  • Details: SNOMED CT
    System: http://snomed.info/sct

ProcedureRequest.reasonCodeableConcept
  • Description
    • A code that explains the reason why a procedure is required.
  • Details: SNOMED CT
    System: http://snomed.info/sct

  • Details: ICD-9-CM
    System: http://hl7.org/fhir/sid/icd-9-cm

  • Details: ICD-10-CM
    System: http://hl7.org/fhir/sid/icd-10-cm

ProcedureRequest.scheduledTiming.code
  • Description
    • Code for a known / defined timing pattern.
  • Details: TimingAbbreviation
    System: http://hl7.org/fhir/timing-abbreviation

  • Details: SNOMED CT
    System: http://snomed.info/sct

ProcedureRequest.asNeeded[x]
  • Description
    • A coded concept identifying the pre-condition that should hold prior to performing a procedure.
  • Note
    • Currently not bound to any terminology.

Search for ProcedureRequests that meet supplied query parameters:

GET /ProcedureRequest?:parameters

Authorization Types

Parameters

Name Required? Type Description
_id This, or patient or subject token The logical resource id associated with the ProcedureRequest. Example: _id=7891
patient This, or _id or subject reference The patient associated with the ProcedureRequest. Example: patient=12345 or patient=Patient/12345
subject This, or _id or patient reference The subject associated with the ProcedureRequest. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/12345 or subject:Patient=12345
_lastUpdated N date An explicit or implied date-time range within which the most recent clinically relevant update was made to the procedure request. Must be prefixed by ‘ge’ or ‘le’. Example: ge2014-05-19T20:54:02.000Z
_count N number The maximum number of ProcedureRequests to retrieve in a page.

Notes:

Headers

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

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/ProcedureRequest?patient=12724067

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "311a684c-3bc5-42c0-8a4e-a75a1bb6c9fd",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/ProcedureRequest?patient=12724067"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/ProcedureRequest/309771147",
      "resource": {
        "resourceType": "ProcedureRequest",
        "id": "309771147",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2020-03-19T01:01:01.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Procedure Request</b></p><p><b>Subject</b>: SMART, JOE</p><p><b>Procedure</b>: Immunizations Quality Measures</p><p><b>Scheduled</b>: Mar  4, 2020  5:52 P.M. UTC</p><p><b>Status</b>: Accepted</p><p><b>Orderer</b>: SYSTEM, SYSTEM Cerner</p></div>"
        },
        "subject": {
          "reference": "Patient/12724067",
          "display": "SMART, JOE"
        },
        "code": {
          "text": "Immunizations Quality Measures"
        },
        "scheduledDateTime": "2020-03-04T11:52:15.000-06:00",
        "encounter": {
          "reference": "Encounter/97953480"
        },
        "status": "accepted",
        "orderedOn": "2020-03-04T11:52:15.000-06:00",
        "orderer": {
          "reference": "Practitioner/1",
          "display": "SYSTEM, SYSTEM 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 ProcedureRequest by its id:

GET /ProcedureRequest/:id

Authorization Types

Headers

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

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/ProcedureRequest/309771147

Response

Status: 200 OK
{
  "resourceType": "ProcedureRequest",
  "id": "309771147",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2020-03-19T01:01:01.000Z"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Procedure Request</b></p><p><b>Subject</b>: SMART, JOE</p><p><b>Procedure</b>: Immunizations Quality Measures</p><p><b>Scheduled</b>: Mar  4, 2020  5:52 P.M. UTC</p><p><b>Status</b>: Accepted</p><p><b>Orderer</b>: SYSTEM, SYSTEM Cerner</p></div>"
  },
  "subject": {
    "reference": "Patient/12724067",
    "display": "SMART, JOE"
  },
  "code": {
    "text": "Immunizations Quality Measures"
  },
  "scheduledDateTime": "2020-03-04T11:52:15.000-06:00",
  "encounter": {
    "reference": "Encounter/97953480"
  },
  "status": "accepted",
  "orderedOn": "2020-03-04T11:52:15.000-06:00",
  "orderer": {
    "reference": "Practitioner/1",
    "display": "SYSTEM, SYSTEM 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.