Home
API reference
FHIR® API
FHIR® resources
Appointment
$appointment-cancel

Appointment $appointment-cancel

post/Appointment/$appointment-cancel
Page View

This resource contains entries with a patient, provider, or location schedule. Each appointment entry contains the status, participants, date/time, and other details. 

For standard FHIR®, you can review, retrieve, create, update, or cancel appointment information.

For 360x workflows, you can update appointment information for a referred patient service or procedure.

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.

$appointment-cancel

Cancel an existing appointment in your connection's system.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Appointment/$appointment-cancel' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxAppointmentCancelBundleExample",
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/AppointmentCancel",
13
        "resourceType": "MessageHeader",
14
        "id": "fae415aa-3d61-5599-9fb8-1216f69d2e22",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "focus": [
20
          {
21
            "reference": "urn:uuid:f00560bc-90de-5009-b52a-576515867fd9"
22
          }
23
        ]
24
      },
25
      "fullUrl": "urn:uuid:fae415aa-3d61-5599-9fb8-1216f69d2e22"
26
    },
27
    {
28
      "fullUrl": "urn:uuid:f00560bc-90de-5009-b52a-576515867fd9",
29
      "resource": {
30
        "resourceType": "Appointment",
31
        "id": "f00560bc-90de-5009-b52a-576515867fd9",
32
        "participant": [
33
          {
34
            "status": "accepted",
35
            "actor": {
36
              "reference": "urn:uuid:98abbfbe-0131-5ffa-9fe5-9922b23b376b"
37
            }
38
          },
39
          {
40
            "actor": {
41
              "reference": "Location/RedoxLocationExampleDepartment"
42
            },
43
            "status": "accepted"
44
          },
45
          {
46
            "actor": {
47
              "reference": "urn:uuid:59a0fa19-f377-5d1c-809b-8c859f58aab1"
48
            },
49
            "status": "accepted"
50
          }
51
        ],
52
        "status": "cancelled",
53
        "cancelationReason": {
54
          "coding": [
55
            {
56
              "system": "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason",
57
              "code": "pat-crs",
58
              "display": "Patient: Canceled via automated reminder system"
59
            }
60
          ]
61
        },
62
        "appointmentType": {
63
          "coding": [
64
            {
65
              "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
66
              "code": "FOLLOWUP",
67
              "display": "A follow up visit from a previous appointment"
68
            }
69
          ]
70
        },
71
        "reasonCode": [
72
          {
73
            "coding": [
74
              {
75
                "code": "409002",
76
                "system": "http://snomed.info/sct",
77
                "display": "Food allergy diet"
78
              }
79
            ]
80
          }
81
        ],
82
        "minutesDuration": 60
83
      }
84
    },
85
    {
86
      "fullUrl": "urn:uuid:0343e5dc-75ff-5f72-bcea-b123e4a3bc5f",
87
      "resource": {
88
        "resourceType": "Location",
89
        "id": "0343e5dc-75ff-5f72-bcea-b123e4a3bc5f",
90
        "name": "RHS Vista Oaks Clinic",
91
        "type": [
92
          {
93
            "coding": [
94
              {
95
                "code": "OF",
96
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
97
                "display": "Outpatient Facility"
98
              }
99
            ]
100
          }
101
        ],
102
        "physicalType": {
103
          "coding": [
104
            {
105
              "code": "bu",
106
              "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
107
              "display": "Building"
108
            }
109
          ]
110
        }
111
      }
112
    },
113
    {
114
      "fullUrl": "urn:uuid:98abbfbe-0131-5ffa-9fe5-9922b23b376b",
115
      "resource": {
116
        "resourceType": "Patient",
117
        "id": "98abbfbe-0131-5ffa-9fe5-9922b23b376b",
118
        "meta": {
119
          "extension": [
120
            {
121
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
122
              "valueInteger": 1
123
            }
124
          ]
125
        },
126
        "extension": [
127
          {
128
            "extension": [
129
              {
130
                "url": "text",
131
                "valueString": "White"
132
              }
133
            ],
134
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
135
          },
136
          {
137
            "extension": [
138
              {
139
                "url": "ombCategory",
140
                "valueCoding": {
141
                  "code": "2135-2",
142
                  "system": "urn:oid:2.16.840.1.113883.6.238",
143
                  "display": "Hispanic or Latino"
144
                }
145
              },
146
              {
147
                "url": "text",
148
                "valueString": "Hispanic"
149
              }
150
            ],
151
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
152
          }
153
        ],
154
        "identifier": [
155
          {
156
            "value": "0000000001",
157
            "system": "urn:redox:health-one:MR"
158
          },
159
          {
160
            "value": "101-01-0001",
161
            "system": "http://hl7.org/fhir/sid/us-ssn"
162
          }
163
        ],
164
        "name": [
165
          {
166
            "given": [
167
              "Timothy",
168
              "Paul"
169
            ],
170
            "family": "Bixby",
171
            "use": "official"
172
          },
173
          {
174
            "text": "Billy",
175
            "use": "usual"
176
          }
177
        ],
178
        "gender": "male",
179
        "birthDate": "2008-01-06",
180
        "telecom": [
181
          {
182
            "value": "+18088675301",
183
            "system": "phone",
184
            "use": "home"
185
          },
186
          {
187
            "value": "+18008675309",
188
            "system": "phone",
189
            "use": "work"
190
          },
191
          {
192
            "value": "timothy.bixby@redoxengine.com",
193
            "system": "email"
194
          }
195
        ],
196
        "address": [
197
          {
198
            "line": [
199
              "4762 Hickory Street"
200
            ],
201
            "city": "Monroe",
202
            "district": "Greene",
203
            "state": "WI",
204
            "postalCode": "53566",
205
            "country": "US",
206
            "use": "home"
207
          }
208
        ],
209
        "maritalStatus": {
210
          "coding": [
211
            {
212
              "code": "M",
213
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
214
              "display": "Married"
215
            }
216
          ],
217
          "text": "Married"
218
        },
219
        "communication": [
220
          {
221
            "language": {
222
              "coding": [
223
                {
224
                  "code": "en",
225
                  "system": "urn:ietf:bcp:47"
226
                }
227
              ],
228
              "text": "English"
229
            }
230
          }
231
        ],
232
        "contact": [
233
          {
234
            "name": {
235
              "given": [
236
                "Barbara"
237
              ],
238
              "family": "Bixby"
239
            },
240
            "telecom": [
241
              {
242
                "value": "+18088675303",
243
                "system": "phone",
244
                "use": "home"
245
              },
246
              {
247
                "value": "barbara.bixby@redoxengine.com",
248
                "system": "email"
249
              }
250
            ],
251
            "address": {
252
              "line": [
253
                "4762 Hickory St."
254
              ],
255
              "city": "Monroe",
256
              "district": "Green",
257
              "state": "WI",
258
              "postalCode": "53566",
259
              "country": "USA"
260
            },
261
            "relationship": [
262
              {
263
                "coding": [
264
                  {
265
                    "code": "MTH",
266
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
267
                    "display": "mother"
268
                  }
269
                ],
270
                "text": "Mother"
271
              },
272
              {
273
                "coding": [
274
                  {
275
                    "code": "C",
276
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
277
                    "display": "Emergency Contact"
278
                  }
279
                ],
280
                "text": "Emergency Contact"
281
              }
282
            ]
283
          }
284
        ],
285
        "generalPractitioner": [
286
          {
287
            "reference": "urn:uuid:59a0fa19-f377-5d1c-809b-8c859f58aab1"
288
          }
289
        ],
290
        "managingOrganization": {
291
          "reference": "urn:uuid:96f7863c-4719-5a50-8011-dcb774f02697"
292
        }
293
      }
294
    },
295
    {
296
      "fullUrl": "urn:uuid:59a0fa19-f377-5d1c-809b-8c859f58aab1",
297
      "resource": {
298
        "resourceType": "Practitioner",
299
        "id": "59a0fa19-f377-5d1c-809b-8c859f58aab1",
300
        "identifier": [
301
          {
302
            "system": "http://hl7.org/fhir/sid/us-npi",
303
            "value": "4356789876"
304
          }
305
        ],
306
        "name": [
307
          {
308
            "given": [
309
              "Pat"
310
            ],
311
            "family": "Granite"
312
          }
313
        ],
314
        "address": [
315
          {
316
            "line": [
317
              "123 Main St."
318
            ],
319
            "city": "Madison",
320
            "district": "Dane",
321
            "state": "WI",
322
            "postalCode": "53703",
323
            "country": "USA"
324
          }
325
        ],
326
        "telecom": [
327
          {
328
            "value": "+16085551234"
329
          }
330
        ]
331
      }
332
    },
333
    {
334
      "fullUrl": "urn:uuid:96f7863c-4719-5a50-8011-dcb774f02697",
335
      "resource": {
336
        "resourceType": "Organization",
337
        "id": "96f7863c-4719-5a50-8011-dcb774f02697",
338
        "identifier": [
339
          {
340
            "value": "1234",
341
            "system": "urn:oid:1.2.3.4"
342
          }
343
        ],
344
        "active": true,
345
        "name": "Custodial Org",
346
        "address": [
347
          {
348
            "line": [
349
              "123 Main St"
350
            ],
351
            "city": "Madison",
352
            "state": "WI"
353
          }
354
        ],
355
        "telecom": [
356
          {
357
            "value": "1-800-123-4567",
358
            "system": "phone"
359
          }
360
        ],
361
        "type": [
362
          {
363
            "text": "Test Type"
364
          }
365
        ]
366
      }
367
    }
368
  ],
369
  "timestamp": "2021-06-17T20:33:22.422Z",
370
  "Meta": {
371
    "Logs": [
372
      {
373
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
374
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
375
      }
376
    ],
377
    "Test": true,
378
    "EventDateTime": "2026-06-04T19:30:06.894Z",
379
    "Source": {
380
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
381
      "Name": "Redox Dev Tools"
382
    },
383
    "Destinations": [
384
      {
385
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
386
        "Name": "Redox EMR"
387
      }
388
    ],
389
    "DataModel": "FHIR.Appointment",
390
    "EventType": "$appointment-cancel"
391
  }
392
}'

Request Body Schema

    Bundle sent as part of an Appointment-cancel message

  • 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, appointment, encounter

    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 and the Bundle content.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • focus
        required, Array of object

        This describes the focal target resource of the message from which the remainder of the content is referenced from

        Must be a resource of type Resource.

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

      • eventUri
        required, string

        This describes the message being communicated

        Value: https://fhir.redoxengine.com/EventDefinition/AppointmentCancel
  • 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
json
1
"Operation Response"

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