Home
API reference
FHIR® API
FHIR® resources
Procedure
$write

Procedure $write

post/Procedure/$write
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 receive, retrieve, or save patient records.

$write

This operation allows you to save procedure details to a patient’s chart.

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Procedure/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxProcedureExampleTimothy",
8
  "type": "message",
9
  "timestamp": "2021-12-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventCoding": {
20
          "system": "urn:redox:event-type",
21
          "code": "Procedure-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "Patient",
28
        "id": "RedoxPatientExampleTimothyMinimal",
29
        "identifier": [
30
          {
31
            "value": "0000000001",
32
            "system": "urn:redox:health-one:MR"
33
          },
34
          {
35
            "value": "101-01-0001",
36
            "system": "http://hl7.org/fhir/sid/us-ssn"
37
          }
38
        ],
39
        "name": [
40
          {
41
            "given": [
42
              "Timothy",
43
              "Paul"
44
            ],
45
            "family": "Bixby"
46
          }
47
        ],
48
        "gender": "male",
49
        "birthDate": "2008-01-06"
50
      }
51
    },
52
    {
53
      "resource": {
54
        "resourceType": "Procedure",
55
        "id": "RedoxProcedureExampleMinimumCompleted",
56
        "identifier": [
57
          {
58
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
59
            "value": "6891241274"
60
          }
61
        ],
62
        "subject": {
63
          "reference": "Patient/RedoxPatientExampleTimothy"
64
        },
65
        "encounter": {
66
          "reference": "Encounter/RedoxEncompassingEncounterExample"
67
        },
68
        "performedDateTime": "2022-02-08T19:00:00.000Z",
69
        "performedPeriod": {
70
          "start": "2022-02-08T19:00:00.000Z",
71
          "end": "2022-02-08T20:00:00.000Z"
72
        },
73
        "status": "completed",
74
        "_status": {
75
          "extension": [
76
            {
77
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
78
              "valueString": "Finished"
79
            }
80
          ]
81
        },
82
        "bodySite": [
83
          {
84
            "coding": [
85
              {
86
                "code": "181608004",
87
                "system": "http://snomed.info/sct",
88
                "display": "Entire chest wall (body structure)"
89
              }
90
            ]
91
          }
92
        ],
93
        "code": {
94
          "coding": [
95
            {
96
              "code": "168731009",
97
              "system": "http://snomed.info/sct",
98
              "display": "Chest X-Ray"
99
            }
100
          ]
101
        },
102
        "category": {
103
          "coding": [
104
            {
105
              "code": "Procedures",
106
              "system": "urn:redox:procedure_act_type",
107
              "display": "Procedures"
108
            }
109
          ]
110
        },
111
        "location": {
112
          "reference": "Location/RedoxLocationExample"
113
        },
114
        "note": [
115
          {
116
            "authorReference": {
117
              "reference": "Practitioner/RedoxPractitionerExamplePat"
118
            },
119
            "text": "A comment."
120
          }
121
        ],
122
        "performer": [
123
          {
124
            "actor": {
125
              "reference": "Practitioner/RedoxPractitionerExamplePat"
126
            },
127
            "function": {
128
              "coding": [
129
                {
130
                  "code": "41904004",
131
                  "system": "http://snomed.info/sct",
132
                  "display": "Medical X-ray technician"
133
                }
134
              ]
135
            }
136
          }
137
        ]
138
      }
139
    },
140
    {
141
      "resource": {
142
        "resourceType": "Practitioner",
143
        "id": "RedoxPractitionerExamplePat",
144
        "identifier": [
145
          {
146
            "system": "http://hl7.org/fhir/sid/us-npi",
147
            "value": "4356789876"
148
          }
149
        ],
150
        "name": [
151
          {
152
            "given": [
153
              "Pat"
154
            ],
155
            "family": "Granite"
156
          }
157
        ],
158
        "address": [
159
          {
160
            "line": [
161
              "123 Main St."
162
            ],
163
            "city": "Madison",
164
            "district": "Dane",
165
            "state": "WI",
166
            "postalCode": "53703",
167
            "country": "USA"
168
          }
169
        ],
170
        "telecom": [
171
          {
172
            "value": "+16085551234"
173
          }
174
        ]
175
      }
176
    },
177
    {
178
      "resource": {
179
        "resourceType": "Location",
180
        "id": "RedoxLocationExample",
181
        "name": "RHS Vista Oaks Clinic",
182
        "type": [
183
          {
184
            "coding": [
185
              {
186
                "code": "OF",
187
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
188
                "display": "Outpatient Facility"
189
              }
190
            ]
191
          }
192
        ],
193
        "physicalType": {
194
          "coding": [
195
            {
196
              "code": "bu",
197
              "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
198
              "display": "Building"
199
            }
200
          ]
201
        }
202
      }
203
    }
204
  ]
205
}'

Request Body Schema

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of MessageHeader, Patient, Procedure, Practitioner, Location or Other

    An array of FHIR resources. At a minimum, a Procedure should include the following entries:

    • Patient - the patient
    • Procedure - the procedure performed

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

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

          Value: Procedure-New
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

1
"Operation Response"