Appointment $appointment-update

post/Appointment/$appointment-update
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.

$appointment-update

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

Request Body Schema

    Bundle sent as part of an Appointment-update 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/AppointmentUpdate
  • 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"