Home
API reference
FHIR® API
FHIR® notifications
PatientAdmin
Patient Transferred

Patient Transferred Detailed

Page View

Patient administration notifications contain details about a patient's record or movements within a specific hospital or provider's office.

You can receive notifications when:

  • A patient record is created, merged, or updated.
  • A patient checks in, transfers to another unit, or leaves the hospital.

transferred

Indicates that a patient has been transferred from one unit to another within the hospital.

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the Patient reference, encounter identifier, and timestamp.
  • A detailed notification contains everything in the lightweight plus extended patient/encounter info, provider info, and related references.

Learn about listening for hospital admission notifications.

Select payload example

PatientAdminTransferredFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "PatientAdminTransferredFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminTransferred",
9
        "resourceType": "MessageHeader",
10
        "id": "ae11a692-6240-5049-8e7f-9282906db6da",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "focus": [
16
          {
17
            "reference": "urn:uuid:b57f209e-946f-506a-bff8-dee8e58e47ad"
18
          },
19
          {
20
            "reference": "urn:uuid:47966f3b-007d-5996-96cf-fd81480b4df7"
21
          }
22
        ],
23
        "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminTransferredFull"
24
      },
25
      "fullUrl": "urn:uuid:ae11a692-6240-5049-8e7f-9282906db6da"
26
    },
27
    {
28
      "fullUrl": "urn:uuid:b57f209e-946f-506a-bff8-dee8e58e47ad",
29
      "resource": {
30
        "resourceType": "Patient",
31
        "id": "b57f209e-946f-506a-bff8-dee8e58e47ad",
32
        "meta": {
33
          "extension": [
34
            {
35
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
36
              "valueInteger": 1
37
            }
38
          ]
39
        },
40
        "extension": [
41
          {
42
            "extension": [
43
              {
44
                "url": "text",
45
                "valueString": "White"
46
              }
47
            ],
48
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
49
          },
50
          {
51
            "extension": [
52
              {
53
                "url": "ombCategory",
54
                "valueCoding": {
55
                  "code": "2135-2",
56
                  "system": "urn:oid:2.16.840.1.113883.6.238",
57
                  "display": "Hispanic or Latino"
58
                }
59
              },
60
              {
61
                "url": "text",
62
                "valueString": "Hispanic"
63
              }
64
            ],
65
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
66
          }
67
        ],
68
        "identifier": [
69
          {
70
            "value": "0000000001",
71
            "system": "urn:redox:health-one:MR"
72
          },
73
          {
74
            "value": "101-01-0001",
75
            "system": "http://hl7.org/fhir/sid/us-ssn"
76
          }
77
        ],
78
        "name": [
79
          {
80
            "given": [
81
              "Timothy",
82
              "Paul"
83
            ],
84
            "family": "Bixby",
85
            "use": "official"
86
          },
87
          {
88
            "text": "Billy",
89
            "use": "usual"
90
          }
91
        ],
92
        "gender": "male",
93
        "birthDate": "2008-01-06",
94
        "telecom": [
95
          {
96
            "value": "+18088675301",
97
            "system": "phone",
98
            "use": "home"
99
          },
100
          {
101
            "value": "+18008675309",
102
            "system": "phone",
103
            "use": "work"
104
          },
105
          {
106
            "value": "timothy.bixby@redoxengine.com",
107
            "system": "email"
108
          }
109
        ],
110
        "address": [
111
          {
112
            "line": [
113
              "4762 Hickory Street"
114
            ],
115
            "city": "Monroe",
116
            "district": "Greene",
117
            "state": "WI",
118
            "postalCode": "53566",
119
            "country": "US",
120
            "use": "home"
121
          }
122
        ],
123
        "maritalStatus": {
124
          "coding": [
125
            {
126
              "code": "M",
127
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
128
              "display": "Married"
129
            }
130
          ],
131
          "text": "Married"
132
        },
133
        "communication": [
134
          {
135
            "language": {
136
              "coding": [
137
                {
138
                  "code": "en",
139
                  "system": "urn:ietf:bcp:47"
140
                }
141
              ],
142
              "text": "English"
143
            }
144
          }
145
        ],
146
        "contact": [
147
          {
148
            "name": {
149
              "given": [
150
                "Barbara"
151
              ],
152
              "family": "Bixby"
153
            },
154
            "telecom": [
155
              {
156
                "value": "+18088675303",
157
                "system": "phone",
158
                "use": "home"
159
              },
160
              {
161
                "value": "barbara.bixby@redoxengine.com",
162
                "system": "email"
163
              }
164
            ],
165
            "address": {
166
              "line": [
167
                "4762 Hickory St."
168
              ],
169
              "city": "Monroe",
170
              "district": "Green",
171
              "state": "WI",
172
              "postalCode": "53566",
173
              "country": "USA"
174
            },
175
            "relationship": [
176
              {
177
                "coding": [
178
                  {
179
                    "code": "MTH",
180
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
181
                    "display": "mother"
182
                  }
183
                ],
184
                "text": "Mother"
185
              },
186
              {
187
                "coding": [
188
                  {
189
                    "code": "C",
190
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
191
                    "display": "Emergency Contact"
192
                  }
193
                ],
194
                "text": "Emergency Contact"
195
              }
196
            ]
197
          }
198
        ],
199
        "generalPractitioner": [
200
          {
201
            "reference": "urn:uuid:3644f9a2-f21e-5ce7-a11d-8a92c78b82db"
202
          }
203
        ],
204
        "managingOrganization": {
205
          "reference": "urn:uuid:d5e3f39a-23f2-5f56-866d-9a294480b0c8"
206
        }
207
      }
208
    },
209
    {
210
      "fullUrl": "urn:uuid:47966f3b-007d-5996-96cf-fd81480b4df7",
211
      "resource": {
212
        "resourceType": "Encounter",
213
        "id": "47966f3b-007d-5996-96cf-fd81480b4df7",
214
        "identifier": [
215
          {
216
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
217
            "value": "9601346482"
218
          }
219
        ],
220
        "status": "finished",
221
        "class": {
222
          "code": "IMP",
223
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
224
          "display": "inpatient encounter"
225
        },
226
        "type": [
227
          {
228
            "coding": [
229
              {
230
                "code": "99222",
231
                "system": "http://www.ama-assn.org/go/cpt",
232
                "display": "InPatient Admission"
233
              }
234
            ]
235
          }
236
        ],
237
        "diagnosis": [
238
          {
239
            "condition": {
240
              "reference": "Condition/RedoxConditionExampleEncounterDx"
241
            }
242
          }
243
        ],
244
        "participant": [
245
          {
246
            "individual": {
247
              "reference": "Practitioner/RedoxPractitionerExampleEncounter"
248
            }
249
          }
250
        ],
251
        "location": [
252
          {
253
            "location": {
254
              "reference": "Location/RedoxLocationExampleEncounter"
255
            }
256
          }
257
        ],
258
        "subject": {
259
          "reference": "urn:uuid:b57f209e-946f-506a-bff8-dee8e58e47ad"
260
        },
261
        "period": {
262
          "start": "2022-02-06T04:00:00.000Z",
263
          "end": "2022-02-06T04:15:00.000Z"
264
        },
265
        "length": {
266
          "value": 16,
267
          "code": "m",
268
          "system": "http://unitsofmeasure.org"
269
        },
270
        "reasonCode": [
271
          {
272
            "coding": [
273
              {
274
                "code": "23360407",
275
                "system": "http://snomed.info/sct"
276
              }
277
            ],
278
            "text": "Pneumonia"
279
          }
280
        ]
281
      }
282
    },
283
    {
284
      "fullUrl": "urn:uuid:3644f9a2-f21e-5ce7-a11d-8a92c78b82db",
285
      "resource": {
286
        "resourceType": "Practitioner",
287
        "id": "3644f9a2-f21e-5ce7-a11d-8a92c78b82db",
288
        "identifier": [
289
          {
290
            "system": "http://hl7.org/fhir/sid/us-npi",
291
            "value": "4356789876"
292
          }
293
        ],
294
        "name": [
295
          {
296
            "given": [
297
              "Pat"
298
            ],
299
            "family": "Granite"
300
          }
301
        ],
302
        "address": [
303
          {
304
            "line": [
305
              "123 Main St."
306
            ],
307
            "city": "Madison",
308
            "district": "Dane",
309
            "state": "WI",
310
            "postalCode": "53703",
311
            "country": "USA"
312
          }
313
        ],
314
        "telecom": [
315
          {
316
            "value": "+16085551234"
317
          }
318
        ]
319
      }
320
    },
321
    {
322
      "fullUrl": "urn:uuid:d5e3f39a-23f2-5f56-866d-9a294480b0c8",
323
      "resource": {
324
        "resourceType": "Organization",
325
        "id": "d5e3f39a-23f2-5f56-866d-9a294480b0c8",
326
        "identifier": [
327
          {
328
            "value": "1234",
329
            "system": "urn:oid:1.2.3.4"
330
          }
331
        ],
332
        "active": true,
333
        "name": "Custodial Org",
334
        "address": [
335
          {
336
            "line": [
337
              "123 Main St"
338
            ],
339
            "city": "Madison",
340
            "state": "WI"
341
          }
342
        ],
343
        "telecom": [
344
          {
345
            "value": "1-800-123-4567",
346
            "system": "phone"
347
          }
348
        ],
349
        "type": [
350
          {
351
            "text": "Test Type"
352
          }
353
        ]
354
      }
355
    }
356
  ],
357
  "timestamp": "2021-06-17T20:33:22.422Z",
358
  "Meta": {
359
    "Logs": [
360
      {
361
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
362
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
363
      }
364
    ],
365
    "Test": true,
366
    "EventDateTime": "2026-06-05T20:14:42.204Z",
367
    "Source": {
368
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
369
      "Name": "Redox Dev Tools"
370
    },
371
    "Destinations": [
372
      {
373
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
374
        "Name": "Redox EMR"
375
      }
376
    ],
377
    "DataModel": "FHIR.Event.PatientAdmin",
378
    "EventType": "patient-transferred"
379
  }
380
}

Request Body Schema

  • 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, patient, practitioner, organization

    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/PatientAdminTransferred
  • 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®.