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.

You can review, retrieve, create, update, or cancel appointment information.

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": "RedoxAppointmentCancelMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "focus": [
20
          {
21
            "reference": "Appointment/RedoxAppointmentCancelExample"
22
          }
23
        ]
24
      }
25
    },
26
    {
27
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment/RedoxAppointmentCancelExample",
28
      "resource": {
29
        "resourceType": "Appointment",
30
        "id": "RedoxAppointmentCancelExample",
31
        "participant": [
32
          {
33
            "status": "accepted",
34
            "actor": {
35
              "reference": "Patient/RedoxPatientExampleTimothy"
36
            }
37
          },
38
          {
39
            "actor": {
40
              "reference": "Location/RedoxLocationExampleDepartment"
41
            },
42
            "status": "accepted"
43
          },
44
          {
45
            "actor": {
46
              "reference": "Practitioner/RedoxPractitionerExamplePat"
47
            },
48
            "status": "accepted"
49
          }
50
        ],
51
        "status": "cancelled",
52
        "cancelationReason": {
53
          "coding": [
54
            {
55
              "system": "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason",
56
              "code": "pat-crs",
57
              "display": "Patient: Canceled via automated reminder system"
58
            }
59
          ]
60
        },
61
        "appointmentType": {
62
          "coding": [
63
            {
64
              "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
65
              "code": "FOLLOWUP",
66
              "display": "A follow up visit from a previous appointment"
67
            }
68
          ]
69
        },
70
        "reasonCode": [
71
          {
72
            "coding": [
73
              {
74
                "code": "409002",
75
                "system": "http://snomed.info/sct",
76
                "display": "Food allergy diet"
77
              }
78
            ]
79
          }
80
        ],
81
        "minutesDuration": 60
82
      }
83
    },
84
    {
85
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExample",
86
      "resource": {
87
        "resourceType": "Location",
88
        "id": "RedoxLocationExample",
89
        "name": "RHS Vista Oaks Clinic",
90
        "type": [
91
          {
92
            "coding": [
93
              {
94
                "code": "OF",
95
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
96
                "display": "Outpatient Facility"
97
              }
98
            ]
99
          }
100
        ],
101
        "physicalType": {
102
          "coding": [
103
            {
104
              "code": "bu",
105
              "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
106
              "display": "Building"
107
            }
108
          ]
109
        }
110
      }
111
    },
112
    {
113
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
114
      "resource": {
115
        "resourceType": "Patient",
116
        "id": "RedoxPatientExampleTimothy",
117
        "meta": {
118
          "extension": [
119
            {
120
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
121
              "valueInteger": 1
122
            }
123
          ]
124
        },
125
        "extension": [
126
          {
127
            "extension": [
128
              {
129
                "url": "text",
130
                "valueString": "White"
131
              }
132
            ],
133
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
134
          },
135
          {
136
            "extension": [
137
              {
138
                "url": "ombCategory",
139
                "valueCoding": {
140
                  "code": "2135-2",
141
                  "system": "urn:oid:2.16.840.1.113883.6.238",
142
                  "display": "Hispanic or Latino"
143
                }
144
              },
145
              {
146
                "url": "text",
147
                "valueString": "Hispanic"
148
              }
149
            ],
150
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
151
          }
152
        ],
153
        "identifier": [
154
          {
155
            "value": "0000000001",
156
            "system": "urn:redox:health-one:MR"
157
          },
158
          {
159
            "value": "101-01-0001",
160
            "system": "http://hl7.org/fhir/sid/us-ssn"
161
          }
162
        ],
163
        "name": [
164
          {
165
            "given": [
166
              "Timothy",
167
              "Paul"
168
            ],
169
            "family": "Bixby",
170
            "use": "official"
171
          },
172
          {
173
            "text": "Billy",
174
            "use": "usual"
175
          }
176
        ],
177
        "gender": "male",
178
        "birthDate": "2008-01-06",
179
        "telecom": [
180
          {
181
            "value": "+18088675301",
182
            "system": "phone",
183
            "use": "home"
184
          },
185
          {
186
            "value": "+18008675309",
187
            "system": "phone",
188
            "use": "work"
189
          },
190
          {
191
            "value": "timothy.bixby@redoxengine.com",
192
            "system": "email"
193
          }
194
        ],
195
        "address": [
196
          {
197
            "line": [
198
              "4762 Hickory Street"
199
            ],
200
            "city": "Monroe",
201
            "district": "Greene",
202
            "state": "WI",
203
            "postalCode": "53566",
204
            "country": "US",
205
            "use": "home"
206
          }
207
        ],
208
        "maritalStatus": {
209
          "coding": [
210
            {
211
              "code": "M",
212
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
213
              "display": "Married"
214
            }
215
          ],
216
          "text": "Married"
217
        },
218
        "communication": [
219
          {
220
            "language": {
221
              "coding": [
222
                {
223
                  "code": "en",
224
                  "system": "urn:ietf:bcp:47"
225
                }
226
              ],
227
              "text": "English"
228
            }
229
          }
230
        ],
231
        "contact": [
232
          {
233
            "name": {
234
              "given": [
235
                "Barbara"
236
              ],
237
              "family": "Bixby"
238
            },
239
            "telecom": [
240
              {
241
                "value": "+18088675303",
242
                "system": "phone",
243
                "use": "home"
244
              },
245
              {
246
                "value": "barbara.bixby@redoxengine.com",
247
                "system": "email"
248
              }
249
            ],
250
            "address": {
251
              "line": [
252
                "4762 Hickory St."
253
              ],
254
              "city": "Monroe",
255
              "district": "Green",
256
              "state": "WI",
257
              "postalCode": "53566",
258
              "country": "USA"
259
            },
260
            "relationship": [
261
              {
262
                "coding": [
263
                  {
264
                    "code": "MTH",
265
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
266
                    "display": "mother"
267
                  }
268
                ],
269
                "text": "Mother"
270
              },
271
              {
272
                "coding": [
273
                  {
274
                    "code": "C",
275
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
276
                    "display": "Emergency Contact"
277
                  }
278
                ],
279
                "text": "Emergency Contact"
280
              }
281
            ]
282
          }
283
        ],
284
        "generalPractitioner": [
285
          {
286
            "reference": "Practitioner/RedoxPractitionerExamplePat"
287
          }
288
        ],
289
        "managingOrganization": {
290
          "reference": "Organization/RedoxOrganizationManagingExample"
291
        }
292
      }
293
    },
294
    {
295
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
296
      "resource": {
297
        "resourceType": "Practitioner",
298
        "id": "RedoxPractitionerExamplePat",
299
        "identifier": [
300
          {
301
            "system": "http://hl7.org/fhir/sid/us-npi",
302
            "value": "4356789876"
303
          }
304
        ],
305
        "name": [
306
          {
307
            "given": [
308
              "Pat"
309
            ],
310
            "family": "Granite"
311
          }
312
        ],
313
        "address": [
314
          {
315
            "line": [
316
              "123 Main St."
317
            ],
318
            "city": "Madison",
319
            "district": "Dane",
320
            "state": "WI",
321
            "postalCode": "53703",
322
            "country": "USA"
323
          }
324
        ],
325
        "telecom": [
326
          {
327
            "value": "+16085551234"
328
          }
329
        ]
330
      }
331
    },
332
    {
333
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
334
      "resource": {
335
        "resourceType": "Organization",
336
        "id": "RedoxOrganizationManagingExample",
337
        "identifier": [
338
          {
339
            "value": "1234",
340
            "system": "urn:oid:1.2.3.4"
341
          }
342
        ],
343
        "active": true,
344
        "name": "Custodial Org",
345
        "address": [
346
          {
347
            "line": [
348
              "123 Main St"
349
            ],
350
            "city": "Madison",
351
            "state": "WI"
352
          }
353
        ],
354
        "telecom": [
355
          {
356
            "value": "1-800-123-4567",
357
            "system": "phone"
358
          }
359
        ],
360
        "type": [
361
          {
362
            "text": "Test Type"
363
          }
364
        ]
365
      }
366
    }
367
  ],
368
  "timestamp": "2021-06-17T20:33:22.422Z"
369
}'

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