The FHIR R4 Procedure resource represents an activity performed on or for a patient as part of the provision of care. It may include surgical operations, diagnostic testing, counseling, or other clinical interventions. In Health Gorilla, Procedure records are typically imported from external networks, EHRs, or encounter documentation.
Use Cases
- View historical procedures performed during hospital visits or specialty care
- Filter procedures by type (e.g., colonoscopy, biopsy)
- Link procedures to specific encounters or diagnoses
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/Procedure
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/Procedure
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required Scopes
procedure.readfor GETprocedure.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read Procedure | Retrieves a specific Procedure record by its FHIR ID. |
GET | Search Procedure | Searches for Procedure records for a specified patient. |
POST | Create Procedure | Submits a new Procedure record to the Health Gorilla FHIR server. |
PUT | Update Procedure | Updates an existing Procedure record by full resource replacement. |
DELETE | Delete Procedure | Removes an existing Procedure record from the system by full resource deletion. |
Search Parameters
Searches are scoped to a single patient. Provide patient, then narrow with the optional filters.
| Parameter | Required | Description |
|---|---|---|
patient | Yes | The patient whose procedures you want, as Patient/{id}. You can also search by a patient identifier using patient.identifier. |
encounter | No | Returns procedures recorded during the given encounter, as Encounter/{id}. |
_lastUpdated | No | Filters on when the record was last written in the Health Gorilla FHIR server. Accepts a comparison prefix, for example ge2025-01-01. |
_offset | No | Skips the given number of results. |
_count | No | Limits the number of results returned per page. |
_tag | No | Filters on meta.tag. |
_security | No | Filters on meta.security. |
The search also accepts _revinclude=Provenance:target, which returns the Provenance records describing where the results came from.
Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
id | Unique FHIR ID for the procedure | procedure-98765 | id | Yes |
status | Status of the procedure record | completed | code | Yes |
code | Procedure performed | 80146002 (Colonoscopy) | CodeableConcept | Yes |
subject | The patient on whom the procedure was performed | Patient/{id} | Reference(Patient) | Yes |
performedDateTime | Date/time the procedure occurred | 2023-11-05T14:00:00-07:00 | dateTime | Yes |
encounter | Associated encounter | Encounter/{id} | Reference(Encounter) | No |
performer | Who carried out the procedure | Practitioner/{id} | Procedure.Performer[] | No |
reasonCode | Reason the procedure was performed | Screening for colorectal cancer | CodeableConcept[] | No |
note | Comments or annotations | "No complications observed." | Annotation[] | No |
bodySite | Location on the body where the procedure occurred | colon, left arm | CodeableConcept[] | No |
Webhooks
Clients can subscribe to webhook notifications when new Procedure records are imported into a patient’s chart, often following diagnostic or surgical encounters.
For more information, go to: Webhooks & Polling.
Error Handling
All Procedure operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses.
For more information, go to: Error Handling.