Procedure read

get/Procedure/{id}

Page View

This resource contains details about a current or past action taken for a patient. This could be something like a surgery, long-term services like counseling, or an at-home treatment done by a patient or caregiver.

You can review or retrieve patient records.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific Procedure resource with details about a patient's procedure.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Procedure/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
Procedure identifier

Response fields and example

Completed Chest X-Ray

json

1
{}

A profile on the procedure resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: Procedure
status
required, string
A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
Possible Values: preparation, in-progress, not-done, on-hold, stopped, completed, entered-in-error, unknown
_status
required, object
This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.
- extension
  Array of OriginalText or Other
  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
code
required, object
The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
subject
required, object
The person, animal or group on which the procedure was performed.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
category
object
A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
encounter
object
The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
recorder
object
Individual who recorded the record and takes responsibility for its content.

Must reference one of the following types of resources:
- Patient
- RelatedPerson
- Practitioner
- PractitionerRole
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
asserter
object
Individual who is making the procedure statement.

Must reference one of the following types of resources:
- Patient
- RelatedPerson
- Practitioner
- PractitionerRole
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
performer
Array of object
Limited to "real" people rather than equipment.
- actor
  required, object
  The practitioner who was involved in the procedure.
  
  Must be a resource of type Practitioner.
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
- function
  object
  Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
location
object
The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

Must be a resource of type Location.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
bodySite
Array of object
Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
note
Array of object
Any other notes and comments about the procedure.
- text
  required, string
  The text of the annotation in markdown format.
- authorReference
  object
  The individual responsible for making the annotation.
  
  Only one of authorReference, authorString may be present.
  
  Must be a resource of type Practitioner.
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
- authorString
  string
  The individual responsible for making the annotation.
  
  Only one of authorReference, authorString may be present.
focalDevice
Array of object
A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
- manipulated
  required, object
  The device that was manipulated (changed) during the procedure.
  
  Must be a resource of type Device.
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
performedDateTime
string
Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Only one of performedDateTime, performedPeriod may be present.
performedPeriod
object
Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Only one of performedDateTime, performedPeriod may be present.
- start
  string
  The start of the period. The boundary is inclusive.
- end
  string
  The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.