Home
API reference
FHIR® API
FHIR® notifications
PatientAdmin
Patient Pre Admitted

Patient Pre Admitted 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.

admitted

Indicates that pre-work can start prior to surgery or that a patient has been admitted to the emergency department and is ready to be seen.

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

PatientAdminPreAdmittedFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "PatientAdminPreAdmittedFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientAdminPreAdmitted",
9
        "resourceType": "MessageHeader",
10
        "id": "8c549064-79ca-50d2-9e34-03c365afc618",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "focus": [
16
          {
17
            "reference": "urn:uuid:527bf7bd-7402-5a09-a36f-319b00453d61"
18
          },
19
          {
20
            "reference": "urn:uuid:c903794d-07f0-559c-8c9c-0eb14afbe125"
21
          }
22
        ],
23
        "definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminPreAdmittedFull"
24
      },
25
      "fullUrl": "urn:uuid:8c549064-79ca-50d2-9e34-03c365afc618"
26
    },
27
    {
28
      "fullUrl": "urn:uuid:527bf7bd-7402-5a09-a36f-319b00453d61",
29
      "resource": {
30
        "resourceType": "Patient",
31
        "id": "527bf7bd-7402-5a09-a36f-319b00453d61",
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:7b863606-ce72-5329-9f63-5304b1bcfc75"
202
          }
203
        ],
204
        "managingOrganization": {
205
          "reference": "urn:uuid:838c5adc-ba97-5aad-9800-01105537191e"
206
        }
207
      }
208
    },
209
    {
210
      "fullUrl": "urn:uuid:7b863606-ce72-5329-9f63-5304b1bcfc75",
211
      "resource": {
212
        "resourceType": "Practitioner",
213
        "id": "7b863606-ce72-5329-9f63-5304b1bcfc75",
214
        "identifier": [
215
          {
216
            "system": "http://hl7.org/fhir/sid/us-npi",
217
            "value": "4356789876"
218
          }
219
        ],
220
        "name": [
221
          {
222
            "given": [
223
              "Pat"
224
            ],
225
            "family": "Granite"
226
          }
227
        ],
228
        "address": [
229
          {
230
            "line": [
231
              "123 Main St."
232
            ],
233
            "city": "Madison",
234
            "district": "Dane",
235
            "state": "WI",
236
            "postalCode": "53703",
237
            "country": "USA"
238
          }
239
        ],
240
        "telecom": [
241
          {
242
            "value": "+16085551234"
243
          }
244
        ]
245
      }
246
    },
247
    {
248
      "fullUrl": "urn:uuid:838c5adc-ba97-5aad-9800-01105537191e",
249
      "resource": {
250
        "resourceType": "Organization",
251
        "id": "838c5adc-ba97-5aad-9800-01105537191e",
252
        "identifier": [
253
          {
254
            "value": "1234",
255
            "system": "urn:oid:1.2.3.4"
256
          }
257
        ],
258
        "active": true,
259
        "name": "Custodial Org",
260
        "address": [
261
          {
262
            "line": [
263
              "123 Main St"
264
            ],
265
            "city": "Madison",
266
            "state": "WI"
267
          }
268
        ],
269
        "telecom": [
270
          {
271
            "value": "1-800-123-4567",
272
            "system": "phone"
273
          }
274
        ],
275
        "type": [
276
          {
277
            "text": "Test Type"
278
          }
279
        ]
280
      }
281
    },
282
    {
283
      "fullUrl": "urn:uuid:c903794d-07f0-559c-8c9c-0eb14afbe125",
284
      "resource": {
285
        "resourceType": "Encounter",
286
        "id": "c903794d-07f0-559c-8c9c-0eb14afbe125",
287
        "identifier": [
288
          {
289
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
290
            "value": "9601346482"
291
          }
292
        ],
293
        "status": "finished",
294
        "class": {
295
          "code": "IMP",
296
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
297
          "display": "inpatient encounter"
298
        },
299
        "type": [
300
          {
301
            "coding": [
302
              {
303
                "code": "99222",
304
                "system": "http://www.ama-assn.org/go/cpt",
305
                "display": "InPatient Admission"
306
              }
307
            ]
308
          }
309
        ],
310
        "diagnosis": [
311
          {
312
            "condition": {
313
              "reference": "Condition/RedoxConditionExampleEncounterDx"
314
            }
315
          }
316
        ],
317
        "participant": [
318
          {
319
            "individual": {
320
              "reference": "Practitioner/RedoxPractitionerExampleEncounter"
321
            }
322
          }
323
        ],
324
        "location": [
325
          {
326
            "location": {
327
              "reference": "Location/RedoxLocationExampleEncounter"
328
            }
329
          }
330
        ],
331
        "subject": {
332
          "reference": "urn:uuid:527bf7bd-7402-5a09-a36f-319b00453d61"
333
        },
334
        "period": {
335
          "start": "2022-02-06T04:00:00.000Z",
336
          "end": "2022-02-06T04:15:00.000Z"
337
        },
338
        "length": {
339
          "value": 16,
340
          "code": "m",
341
          "system": "http://unitsofmeasure.org"
342
        },
343
        "reasonCode": [
344
          {
345
            "coding": [
346
              {
347
                "code": "23360407",
348
                "system": "http://snomed.info/sct"
349
              }
350
            ],
351
            "text": "Pneumonia"
352
          }
353
        ]
354
      }
355
    }
356
  ],
357
  "timestamp": "2021-12-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-05-29T19:55:02.976Z",
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-pre-admitted"
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/PatientAdminPreAdmitted
  • 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®.