Home
API reference
FHIR® API
FHIR® resources
Procedure
_search

Procedure _search

post/Procedure/_search
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.

_search

Query for details about a patient's procedure.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.
  • patient

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Procedure/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'date=string' \
8
--data-urlencode 'status=string' \
9
--data-urlencode 'code=string'

Request Body Schema

  • patient
    Array of string

    The patient who underwent the procedure.

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • date
    Array of string

    When the procedure was performed.

  • status
    Array of string

    The status of the procedure: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

  • code
    Array of string

    A code to identify the procedure

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "Procedure",
9
        "id": "RedoxProcedureExampleMinimumCompleted",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
            "value": "6891241274"
14
          }
15
        ],
16
        "subject": {
17
          "reference": "Patient/RedoxPatientExampleTimothy"
18
        },
19
        "encounter": {
20
          "reference": "Encounter/RedoxEncompassingEncounterExample"
21
        },
22
        "performedDateTime": "2022-02-08T19:00:00.000Z",
23
        "performedPeriod": {
24
          "start": "2022-02-08T19:00:00.000Z",
25
          "end": "2022-02-08T20:00:00.000Z"
26
        },
27
        "status": "completed",
28
        "_status": {
29
          "extension": [
30
            {
31
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
32
              "valueString": "Finished"
33
            }
34
          ]
35
        },
36
        "bodySite": [
37
          {
38
            "coding": [
39
              {
40
                "code": "181608004",
41
                "system": "http://snomed.info/sct",
42
                "display": "Entire chest wall (body structure)"
43
              }
44
            ]
45
          }
46
        ],
47
        "code": {
48
          "coding": [
49
            {
50
              "code": "168731009",
51
              "system": "http://snomed.info/sct",
52
              "display": "Chest X-Ray"
53
            }
54
          ]
55
        },
56
        "category": {
57
          "coding": [
58
            {
59
              "code": "Procedures",
60
              "system": "urn:redox:procedure_act_type",
61
              "display": "Procedures"
62
            }
63
          ]
64
        },
65
        "location": {
66
          "reference": "Location/RedoxLocationExample"
67
        },
68
        "note": [
69
          {
70
            "authorReference": {
71
              "reference": "Practitioner/RedoxPractitionerExamplePat"
72
            },
73
            "text": "A comment."
74
          }
75
        ],
76
        "performer": [
77
          {
78
            "actor": {
79
              "reference": "Practitioner/RedoxPractitionerExamplePat"
80
            },
81
            "function": {
82
              "coding": [
83
                {
84
                  "code": "41904004",
85
                  "system": "http://snomed.info/sct",
86
                  "display": "Medical X-ray technician"
87
                }
88
              ]
89
            }
90
          }
91
        ]
92
      },
93
      "search": {
94
        "mode": "match"
95
      }
96
    }
97
  ]
98
}

    Response to a Procedure search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of Procedure or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A record of an action that was performed on or for a patient

      • 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.

            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, HumanName or Reference

          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.

          • 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.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the Procedure as matching the search parameters

        Value: match