Home
API reference
FHIR® API
FHIR® notifications
Order
Referral Request Cancelled

Referral Request Cancelled Detailed

Page View

Order notifications contain details about any order placed by your connection’s system to your organization. This could include device, medication, service, or referral requests, depending on what your organization provides or manages for patients.

For standard FHIR®, you can receive notifications when an order is created, cancelled, or updated.

For 360X workflows, you can receive notifications about your referral statuses or receive a referral from your connection.

cancelled

Open beta feature

This is an open beta feature, which means you won’t see it available in your organization until you opt in. If you’re interested in joining this beta, talk to a Redoxer to find out if you’d be a good fit.

Indicates that a referred patient service or procedure has been cancelled by your connection.

This notification includes this bundle of resources:

Required

  • Procedure
  • Patient

Optional

  • Composition
  • DocumentReference
  • Organization
  • Practitioner
  • ServiceRequest
No lightweight notifications

There’s no lightweight version of this notification type because it relies on DirectTrust’s 360 Exchange for Closed Loop Referrals (360X) specs. Learn more about 360X.

Select payload example

ReferralRequestCancelledFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "ReferralRequestCancelledFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/ReferralRequestCancelled",
9
        "resourceType": "MessageHeader",
10
        "id": "6e6b7aa6-a326-5e63-8178-9905953fc9ab",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "mailto:goodhealthclinics@direct.redoxengine.com"
14
        },
15
        "destination": [
16
          {
17
            "endpoint": "mailto:receiving-provider@direct.example.com"
18
          }
19
        ],
20
        "focus": [
21
          {
22
            "reference": "urn:uuid:769d82f8-3d12-5a4e-b5b3-b32ffcca13a2"
23
          },
24
          {
25
            "reference": "urn:uuid:88d3b919-ced7-5ead-8bff-5f5197e3c8d9"
26
          }
27
        ],
28
        "definition": "https://fhir.redoxengine.com/MessageDefinition/ReferralRequestCancelledFull"
29
      },
30
      "fullUrl": "urn:uuid:6e6b7aa6-a326-5e63-8178-9905953fc9ab"
31
    },
32
    {
33
      "fullUrl": "urn:uuid:769d82f8-3d12-5a4e-b5b3-b32ffcca13a2",
34
      "resource": {
35
        "resourceType": "ServiceRequest",
36
        "id": "769d82f8-3d12-5a4e-b5b3-b32ffcca13a2",
37
        "identifier": [
38
          {
39
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
40
            "value": "6547891230"
41
          }
42
        ],
43
        "intent": "order",
44
        "priority": "stat",
45
        "status": "revoked",
46
        "code": {
47
          "coding": [
48
            {
49
              "code": "49086-2",
50
              "system": "http://loinc.org",
51
              "display": "First trimester maternal screen with nuchal translucency panel"
52
            }
53
          ]
54
        },
55
        "authoredOn": "2022-08-08T08:00:00.000Z",
56
        "note": [
57
          {
58
            "text": "Additional information"
59
          }
60
        ],
61
        "subject": {
62
          "reference": "urn:uuid:88d3b919-ced7-5ead-8bff-5f5197e3c8d9"
63
        },
64
        "requester": {
65
          "reference": "urn:uuid:afcd3bfc-2735-5eb8-9df0-fbc08cfce432"
66
        },
67
        "performer": [
68
          {
69
            "reference": "Practitioner/RedoxPractitionerExampleJoan"
70
          }
71
        ]
72
      }
73
    },
74
    {
75
      "fullUrl": "urn:uuid:88d3b919-ced7-5ead-8bff-5f5197e3c8d9",
76
      "resource": {
77
        "resourceType": "Patient",
78
        "id": "88d3b919-ced7-5ead-8bff-5f5197e3c8d9",
79
        "meta": {
80
          "extension": [
81
            {
82
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
83
              "valueInteger": 1
84
            }
85
          ]
86
        },
87
        "extension": [
88
          {
89
            "extension": [
90
              {
91
                "url": "text",
92
                "valueString": "White"
93
              }
94
            ],
95
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
96
          },
97
          {
98
            "extension": [
99
              {
100
                "url": "ombCategory",
101
                "valueCoding": {
102
                  "code": "2135-2",
103
                  "system": "urn:oid:2.16.840.1.113883.6.238",
104
                  "display": "Hispanic or Latino"
105
                }
106
              },
107
              {
108
                "url": "text",
109
                "valueString": "Hispanic"
110
              }
111
            ],
112
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
113
          }
114
        ],
115
        "identifier": [
116
          {
117
            "value": "0000000001",
118
            "system": "urn:redox:health-one:MR"
119
          },
120
          {
121
            "value": "101-01-0001",
122
            "system": "http://hl7.org/fhir/sid/us-ssn"
123
          }
124
        ],
125
        "name": [
126
          {
127
            "given": [
128
              "Timothy",
129
              "Paul"
130
            ],
131
            "family": "Bixby",
132
            "use": "official"
133
          },
134
          {
135
            "text": "Billy",
136
            "use": "usual"
137
          }
138
        ],
139
        "gender": "male",
140
        "birthDate": "2008-01-06",
141
        "telecom": [
142
          {
143
            "value": "+18088675301",
144
            "system": "phone",
145
            "use": "home"
146
          },
147
          {
148
            "value": "+18008675309",
149
            "system": "phone",
150
            "use": "work"
151
          },
152
          {
153
            "value": "timothy.bixby@redoxengine.com",
154
            "system": "email"
155
          }
156
        ],
157
        "address": [
158
          {
159
            "line": [
160
              "4762 Hickory Street"
161
            ],
162
            "city": "Monroe",
163
            "district": "Greene",
164
            "state": "WI",
165
            "postalCode": "53566",
166
            "country": "US",
167
            "use": "home"
168
          }
169
        ],
170
        "maritalStatus": {
171
          "coding": [
172
            {
173
              "code": "M",
174
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
175
              "display": "Married"
176
            }
177
          ],
178
          "text": "Married"
179
        },
180
        "communication": [
181
          {
182
            "language": {
183
              "coding": [
184
                {
185
                  "code": "en",
186
                  "system": "urn:ietf:bcp:47"
187
                }
188
              ],
189
              "text": "English"
190
            }
191
          }
192
        ],
193
        "contact": [
194
          {
195
            "name": {
196
              "given": [
197
                "Barbara"
198
              ],
199
              "family": "Bixby"
200
            },
201
            "telecom": [
202
              {
203
                "value": "+18088675303",
204
                "system": "phone",
205
                "use": "home"
206
              },
207
              {
208
                "value": "barbara.bixby@redoxengine.com",
209
                "system": "email"
210
              }
211
            ],
212
            "address": {
213
              "line": [
214
                "4762 Hickory St."
215
              ],
216
              "city": "Monroe",
217
              "district": "Green",
218
              "state": "WI",
219
              "postalCode": "53566",
220
              "country": "USA"
221
            },
222
            "relationship": [
223
              {
224
                "coding": [
225
                  {
226
                    "code": "MTH",
227
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
228
                    "display": "mother"
229
                  }
230
                ],
231
                "text": "Mother"
232
              },
233
              {
234
                "coding": [
235
                  {
236
                    "code": "C",
237
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
238
                    "display": "Emergency Contact"
239
                  }
240
                ],
241
                "text": "Emergency Contact"
242
              }
243
            ]
244
          }
245
        ],
246
        "generalPractitioner": [
247
          {
248
            "reference": "urn:uuid:afcd3bfc-2735-5eb8-9df0-fbc08cfce432"
249
          }
250
        ],
251
        "managingOrganization": {
252
          "reference": "urn:uuid:cdce5d71-0beb-5a66-9c3e-074a9af1c130"
253
        }
254
      }
255
    },
256
    {
257
      "fullUrl": "urn:uuid:afcd3bfc-2735-5eb8-9df0-fbc08cfce432",
258
      "resource": {
259
        "resourceType": "Practitioner",
260
        "id": "afcd3bfc-2735-5eb8-9df0-fbc08cfce432",
261
        "identifier": [
262
          {
263
            "system": "http://hl7.org/fhir/sid/us-npi",
264
            "value": "4356789876"
265
          }
266
        ],
267
        "name": [
268
          {
269
            "given": [
270
              "Pat"
271
            ],
272
            "family": "Granite"
273
          }
274
        ],
275
        "address": [
276
          {
277
            "line": [
278
              "123 Main St."
279
            ],
280
            "city": "Madison",
281
            "district": "Dane",
282
            "state": "WI",
283
            "postalCode": "53703",
284
            "country": "USA"
285
          }
286
        ],
287
        "telecom": [
288
          {
289
            "value": "+16085551234"
290
          }
291
        ]
292
      }
293
    },
294
    {
295
      "fullUrl": "urn:uuid:cdce5d71-0beb-5a66-9c3e-074a9af1c130",
296
      "resource": {
297
        "resourceType": "Organization",
298
        "id": "cdce5d71-0beb-5a66-9c3e-074a9af1c130",
299
        "identifier": [
300
          {
301
            "value": "1234",
302
            "system": "urn:oid:1.2.3.4"
303
          }
304
        ],
305
        "active": true,
306
        "name": "Custodial Org",
307
        "address": [
308
          {
309
            "line": [
310
              "123 Main St"
311
            ],
312
            "city": "Madison",
313
            "state": "WI"
314
          }
315
        ],
316
        "telecom": [
317
          {
318
            "value": "1-800-123-4567",
319
            "system": "phone"
320
          }
321
        ],
322
        "type": [
323
          {
324
            "text": "Test Type"
325
          }
326
        ]
327
      }
328
    }
329
  ],
330
  "timestamp": "2026-03-24T12:00:00.000Z"
331
}

Request Body Schema

    Bundle sent as part of a referral-request-cancelled 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, serviceRequest, patient, practitioner

    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.

        • name
          string

          Human-readable name for the source system.

      • 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/ReferralRequestCancelled
      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      • destination
        Array of object

        The destination(s) for the message, including the Direct Address of the intended recipient.

        • endpoint
          required, string

          The Direct Address of the intended message recipient (DirectAddressTo). For messages received via DirectTrust, this identifies the target direct address.

  • timestamp
    string

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

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