Home
API reference
FHIR® API
FHIR® notifications
Scheduling
Scheduling Appointment Booked

Scheduling Appointment Booked Detailed

Page View

Scheduling notifications contain details about appointments that are managed in your connection's system.

You can receive notifications when an appointment is booked, cancelled, or updated.

booked

Indicates that a new appointment has been scheduled in your connection's system.

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the Appointment reference, patient identifier, and timestamp.
  • A detailed notification contains everything in the lightweight plus extended patient info, location and provider info, and any related references.

Learn about listening for scheduling notifications.

Select payload example

SchedulingAppointmentBookedFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "SchedulingAppointmentBookedFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/SchedulingAppointmentBooked",
9
        "resourceType": "MessageHeader",
10
        "id": "AppointmentBookedMessageHeader",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "focus": [
16
          {
17
            "reference": "Appointment/RedoxAppointmentExample"
18
          },
19
          {
20
            "reference": "Patient/RedoxPatientExampleTimothy"
21
          }
22
        ],
23
        "definition": "https://fhir.redoxengine.com/MessageDefinition/SchedulingAppointmentBookedFull"
24
      }
25
    },
26
    {
27
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?identifier=321654654|urn:redox:example:VIS",
28
      "resource": {
29
        "resourceType": "Appointment",
30
        "id": "RedoxAppointmentExample",
31
        "participant": [
32
          {
33
            "status": "accepted",
34
            "actor": {
35
              "reference": "Patient/RedoxPatientExampleTimothy"
36
            }
37
          },
38
          {
39
            "status": "accepted",
40
            "actor": {
41
              "reference": "Location/RedoxLocationExample"
42
            }
43
          }
44
        ],
45
        "identifier": [
46
          {
47
            "system": "urn:oid:1.2.840.114350.1.13.123.1.7.3.698084.8",
48
            "value": "321654654"
49
          }
50
        ],
51
        "appointmentType": {
52
          "coding": [
53
            {
54
              "code": "EMERGENCY",
55
              "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
56
              "display": "Emergency appointment"
57
            }
58
          ]
59
        },
60
        "status": "proposed",
61
        "_status": {
62
          "extension": [
63
            {
64
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
65
              "valueString": "Intent"
66
            }
67
          ]
68
        },
69
        "start": "2012-08-20T05:00:00.000Z",
70
        "end": "2012-08-20T05:15:00.000Z",
71
        "minutesDuration": 15,
72
        "reasonCode": [
73
          {
74
            "coding": [
75
              {
76
                "code": "99241",
77
                "system": "http://www.ama-assn.org/go/cpt",
78
                "display": "Office consultation - 15 minutes"
79
              }
80
            ]
81
          }
82
        ]
83
      }
84
    },
85
    {
86
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExample",
87
      "resource": {
88
        "resourceType": "Location",
89
        "id": "RedoxLocationExample",
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": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN",
115
      "resource": {
116
        "resourceType": "Patient",
117
        "id": "RedoxPatientExampleTimothy",
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": "Practitioner/RedoxPractitionerExamplePat"
288
          }
289
        ],
290
        "managingOrganization": {
291
          "reference": "Organization/RedoxOrganizationManagingExample"
292
        }
293
      }
294
    },
295
    {
296
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
297
      "resource": {
298
        "resourceType": "Practitioner",
299
        "id": "RedoxPractitionerExamplePat",
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": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
335
      "resource": {
336
        "resourceType": "Organization",
337
        "id": "RedoxOrganizationManagingExample",
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
}

Request Body Schema

    Bundle sent as part of a Scheduling-event-appointment-booked event

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Indicates the purpose of this bundle - how it is intended to be used.

    Value: message
  • entry
    required, Array of messageHeader, appointment, procedure, patient

    An entry in the bundle containing a FHIR resource

    • fullUrl
      string

      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
      • Results from operations might involve resources that are not identified.
    • resource
      object

      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        The source application from which this message originated.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

      • focus
        required, Array of object

        The actual data of the message - a reference to the root/focus class of the event.

        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.

      • definition
        required, string

        Permanent link to the MessageDefinition for this message.

      • eventUri
        required, string

        Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.

        Value: https://fhir.redoxengine.com/EventDefinition/SchedulingAppointmentBooked
  • timestamp
    string

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