The Procedure resource implements the FHIR R4 Procedure specification and US Core v3.1.1 Procedure profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   External Identifiers for this procedure
instantiatesCanonical canonical 0..*   Instantiates FHIR protocol or definition
instantiatesUri uri 0..*   Instantiates external protocol or definition
basedOn Reference 0..*   A request for this procedure
partOf Reference 0..*   Part of referenced event
status code 1..1 * preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
statusReason CodeableConcept 0..1   Reason for current status
category CodeableConcept 0..1   Classification of the procedure
code CodeableConcept 1..1 * Identification of the procedure - Binding
subject Reference(US Core Patient Profile) 1..1 * Who the procedure was performed on
encounter Reference 0..1   Encounter created as part of
recorder Reference 0..1   Who recorded the procedure
asserter Reference 0..1   Person who asserts this procedure
performedDateTime dateTime 1..1 * Date/Period the procedure was performed - either performedDateTime or performedPeriod must be set
performedPeriod Period 1..1 * Date/Period the procedure was performed - either performedDateTime or performedPeriod must be set
performer BackboneElement 0..*   The people who performed the procedure
location Reference 0..1   Where the procedure happened
reasonCode CodeableConcept 0..*   Coded reason procedure performed
reasonReference Reference 0..*   Condition that is the reason the procedure performed
bodySite CodeableConcept 0..*   Target body sites
outcome CodeableConcept 0..1   The result of procedure
report Reference 0..*   Any report resulting from the procedure
complication CodeableConcept 0..*   Complication following the procedure
complicationDetail Reference 0..*   A condition that is a result of the procedure
followUp CodeableConcept 0..*   Instructions for follow up
note Annotation 0..*   Additional information about the procedure
focalDevice BackboneElement 0..*   Device changed in procedure
usedReference Reference 0..*   Items used during procedure
usedCode CodeableConcept 0..*   Coded items used during the procedure

Interactions

Read

Get an Procedure entry by id

GET /Procedure/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Procedure/e67862fe-c772-d813-e2df-2014f79d257e

Response

{
  "resourceType": "Procedure",
  "status": "completed",
  "code": {
    "coding": [
      {
        "code": "228557008",
        "system": "http://snomed.info/sct",
        "display": "Cognitive and behavioral therapy"
      }
    ],
    "text": "Cognitive and behavioral therapy"
  },
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "encounter": {
    "reference": "Encounter/4072175c-0fb0-f5c1-dd9f-534d5d65a831"
  },
  "performedPeriod": {
    "start": "1951-11-23T09:56:44-05:00",
    "end": "1951-11-23T10:56:44-05:00"
  },
  "location": {
    "reference": "Location/80e11f9b-dff5-3ffe-7b86-badb7cb41ad0",
    "display": "BETH ISRAEL DEACONESS HOSPITAL - PLYMOUTH"
  },
  "id": "e67862fe-c772-d813-e2df-2014f79d257e"
}

Query Procedure resources

GET /Procedure?:query_parameters

Parameters

Name Type Description
date date Date/Period the procedure was performed
code token A code to identify a procedure
code_display string A code to identify a procedure
code:text string A code to identify a procedure
performer reference The reference to the practitioner
subject reference Search by subject
encounter reference Search by encounter
patient reference Search by subject - a patient
context reference Encounter or episode associated with the procedure
status token preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
_include undefined Procedure:performer | Procedure:subject | Procedure:encounter | Procedure:focalDevice | Procedure:patient | Procedure:report | Procedure:context | Procedure:reasonreference
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found