Appointment $appointment-create

post/Appointment/$appointment-create

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-create

Save a new appointment to a patient’s, provider’s, or location’s schedule.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Appointment/$appointment-create' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxAppointmentCreateBundleExample",
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/AppointmentCreate",
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxAppointmentCreateMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "focus": [
20
          {
21
            "reference": "Appointment/RedoxAppointmentCreateExample"
22
          }
23
        ]
24
      }
25
    },
26
    {
27
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment/RedoxAppointmentCreateExample",
28
      "resource": {
29
        "resourceType": "Appointment",
30
        "id": "RedoxAppointmentCreateExample",
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": "proposed",
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
        "slot": [
74
          {
75
            "reference": "Slot/RedoxSlotExample"
76
          }
77
        ]
78
      }
79
    },
80
    {
81
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExample",
82
      "resource": {
83
        "resourceType": "Location",
84
        "id": "RedoxLocationExample",
85
        "name": "RHS Vista Oaks Clinic",
86
        "type": [
87
          {
88
            "coding": [
89
              {
90
                "code": "OF",
91
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
92
                "display": "Outpatient Facility"
93
              }
94
            ]
95
          }
96
        ],
97
        "physicalType": {
98
          "coding": [
99
            {
100
              "code": "bu",
101
              "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
102
              "display": "Building"
103
            }
104
          ]
105
        }
106
      }
107
    },
108
    {
109
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
110
      "resource": {
111
        "resourceType": "Patient",
112
        "id": "RedoxPatientExampleTimothy",
113
        "meta": {
114
          "extension": [
115
            {
116
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
117
              "valueInteger": 1
118
            }
119
          ]
120
        },
121
        "extension": [
122
          {
123
            "extension": [
124
              {
125
                "url": "text",
126
                "valueString": "White"
127
              }
128
            ],
129
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
130
          },
131
          {
132
            "extension": [
133
              {
134
                "url": "ombCategory",
135
                "valueCoding": {
136
                  "code": "2135-2",
137
                  "system": "urn:oid:2.16.840.1.113883.6.238",
138
                  "display": "Hispanic or Latino"
139
                }
140
              },
141
              {
142
                "url": "text",
143
                "valueString": "Hispanic"
144
              }
145
            ],
146
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
147
          }
148
        ],
149
        "identifier": [
150
          {
151
            "value": "0000000001",
152
            "system": "urn:redox:health-one:MR"
153
          },
154
          {
155
            "value": "101-01-0001",
156
            "system": "http://hl7.org/fhir/sid/us-ssn"
157
          }
158
        ],
159
        "name": [
160
          {
161
            "given": [
162
              "Timothy",
163
              "Paul"
164
            ],
165
            "family": "Bixby",
166
            "use": "official"
167
          },
168
          {
169
            "text": "Billy",
170
            "use": "usual"
171
          }
172
        ],
173
        "gender": "male",
174
        "birthDate": "2008-01-06",
175
        "telecom": [
176
          {
177
            "value": "+18088675301",
178
            "system": "phone",
179
            "use": "home"
180
          },
181
          {
182
            "value": "+18008675309",
183
            "system": "phone",
184
            "use": "work"
185
          },
186
          {
187
            "value": "timothy.bixby@redoxengine.com",
188
            "system": "email"
189
          }
190
        ],
191
        "address": [
192
          {
193
            "line": [
194
              "4762 Hickory Street"
195
            ],
196
            "city": "Monroe",
197
            "district": "Greene",
198
            "state": "WI",
199
            "postalCode": "53566",
200
            "country": "US",
201
            "use": "home"
202
          }
203
        ],
204
        "maritalStatus": {
205
          "coding": [
206
            {
207
              "code": "M",
208
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
209
              "display": "Married"
210
            }
211
          ],
212
          "text": "Married"
213
        },
214
        "communication": [
215
          {
216
            "language": {
217
              "coding": [
218
                {
219
                  "code": "en",
220
                  "system": "urn:ietf:bcp:47"
221
                }
222
              ],
223
              "text": "English"
224
            }
225
          }
226
        ],
227
        "contact": [
228
          {
229
            "name": {
230
              "given": [
231
                "Barbara"
232
              ],
233
              "family": "Bixby"
234
            },
235
            "telecom": [
236
              {
237
                "value": "+18088675303",
238
                "system": "phone",
239
                "use": "home"
240
              },
241
              {
242
                "value": "barbara.bixby@redoxengine.com",
243
                "system": "email"
244
              }
245
            ],
246
            "address": {
247
              "line": [
248
                "4762 Hickory St."
249
              ],
250
              "city": "Monroe",
251
              "district": "Green",
252
              "state": "WI",
253
              "postalCode": "53566",
254
              "country": "USA"
255
            },
256
            "relationship": [
257
              {
258
                "coding": [
259
                  {
260
                    "code": "MTH",
261
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
262
                    "display": "mother"
263
                  }
264
                ],
265
                "text": "Mother"
266
              },
267
              {
268
                "coding": [
269
                  {
270
                    "code": "C",
271
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
272
                    "display": "Emergency Contact"
273
                  }
274
                ],
275
                "text": "Emergency Contact"
276
              }
277
            ]
278
          }
279
        ],
280
        "generalPractitioner": [
281
          {
282
            "reference": "Practitioner/RedoxPractitionerExamplePat"
283
          }
284
        ],
285
        "managingOrganization": {
286
          "reference": "Organization/RedoxOrganizationManagingExample"
287
        }
288
      }
289
    },
290
    {
291
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
292
      "resource": {
293
        "resourceType": "Practitioner",
294
        "id": "RedoxPractitionerExamplePat",
295
        "identifier": [
296
          {
297
            "system": "http://hl7.org/fhir/sid/us-npi",
298
            "value": "4356789876"
299
          }
300
        ],
301
        "name": [
302
          {
303
            "given": [
304
              "Pat"
305
            ],
306
            "family": "Granite"
307
          }
308
        ],
309
        "address": [
310
          {
311
            "line": [
312
              "123 Main St."
313
            ],
314
            "city": "Madison",
315
            "district": "Dane",
316
            "state": "WI",
317
            "postalCode": "53703",
318
            "country": "USA"
319
          }
320
        ],
321
        "telecom": [
322
          {
323
            "value": "+16085551234"
324
          }
325
        ]
326
      }
327
    },
328
    {
329
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
330
      "resource": {
331
        "resourceType": "Organization",
332
        "id": "RedoxOrganizationManagingExample",
333
        "identifier": [
334
          {
335
            "value": "1234",
336
            "system": "urn:oid:1.2.3.4"
337
          }
338
        ],
339
        "active": true,
340
        "name": "Custodial Org",
341
        "address": [
342
          {
343
            "line": [
344
              "123 Main St"
345
            ],
346
            "city": "Madison",
347
            "state": "WI"
348
          }
349
        ],
350
        "telecom": [
351
          {
352
            "value": "1-800-123-4567",
353
            "system": "phone"
354
          }
355
        ],
356
        "type": [
357
          {
358
            "text": "Test Type"
359
          }
360
        ]
361
      }
362
    },
363
    {
364
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Slot/RedoxSlotExample",
365
      "resource": {
366
        "resourceType": "Slot",
367
        "id": "RedoxSlotExample",
368
        "identifier": [
369
          {
370
            "system": "urn:redox:example:Slot",
371
            "value": "1"
372
          }
373
        ],
374
        "status": "free",
375
        "serviceType": [
376
          {
377
            "text": "Office Visit"
378
          }
379
        ],
380
        "start": "2022-08-01T14:00:00Z",
381
        "end": "2022-08-01T15:00:00Z",
382
        "schedule": {
383
          "reference": "#RedoxScheduleExample"
384
        },
385
        "contained": [
386
          {
387
            "resourceType": "Schedule",
388
            "id": "RedoxScheduleExample",
389
            "active": true,
390
            "actor": [
391
              {
392
                "reference": "#RedoxPractitionerExamplePat"
393
              },
394
              {
395
                "reference": "#RedoxLocationExampleDepartment"
396
              },
397
              {
398
                "reference": "#RedoxLocationExampleFacility"
399
              },
400
              {
401
                "reference": "#RedoxLocationExampleRoom"
402
              }
403
            ]
404
          },
405
          {
406
            "resourceType": "Practitioner",
407
            "id": "RedoxPractitionerExamplePat",
408
            "identifier": [
409
              {
410
                "system": "http://hl7.org/fhir/sid/us-npi",
411
                "value": "4356789876"
412
              }
413
            ],
414
            "name": [
415
              {
416
                "given": [
417
                  "Pat"
418
                ],
419
                "family": "Granite"
420
              }
421
            ],
422
            "address": [
423
              {
424
                "line": [
425
                  "123 Main St."
426
                ],
427
                "city": "Madison",
428
                "district": "Dane",
429
                "state": "WI",
430
                "postalCode": "53703",
431
                "country": "USA"
432
              }
433
            ],
434
            "telecom": [
435
              {
436
                "value": "+16085551234"
437
              }
438
            ]
439
          },
440
          {
441
            "resourceType": "Location",
442
            "id": "RedoxLocationExampleDepartment",
443
            "identifier": [
444
              {
445
                "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
446
                "value": "3490285621"
447
              }
448
            ],
449
            "name": "3N",
450
            "type": [
451
              {
452
                "text": "Inpatient"
453
              }
454
            ],
455
            "physicalType": {
456
              "coding": [
457
                {
458
                  "code": "wa",
459
                  "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
460
                  "display": "Ward"
461
                }
462
              ],
463
              "text": "Department"
464
            },
465
            "partOf": {
466
              "reference": "#RedoxLocationExampleFacility"
467
            }
468
          },
469
          {
470
            "resourceType": "Location",
471
            "id": "RedoxLocationExampleFacility",
472
            "identifier": [
473
              {
474
                "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
475
                "value": "461904242"
476
              }
477
            ],
478
            "name": "RES General Hospital",
479
            "physicalType": {
480
              "coding": [
481
                {
482
                  "code": "si",
483
                  "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
484
                  "display": "Site"
485
                }
486
              ],
487
              "text": "Facility"
488
            }
489
          },
490
          {
491
            "resourceType": "Location",
492
            "id": "RedoxLocationExampleRoom",
493
            "identifier": [
494
              {
495
                "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
496
                "value": "6592045611"
497
              }
498
            ],
499
            "name": "136",
500
            "physicalType": {
501
              "coding": [
502
                {
503
                  "code": "ro",
504
                  "system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
505
                  "display": "Room"
506
                }
507
              ]
508
            },
509
            "partOf": {
510
              "reference": "#RedoxLocationExampleDepartment"
511
            }
512
          }
513
        ]
514
      }
515
    }
516
  ],
517
  "timestamp": "2021-06-17T20:33:22.422Z"
518
}'

Request Body Schema

Bundle sent as part of an Appointment-create 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®.