Patient Registered 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.

registered

Indicates that a patient has checked in for an outpatient visit, whether at a hospital or clinic.

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.

Select payload example

PatientAdminPatientRegisteredFullBundleExample

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

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, encounter or Other

    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/PatientAdminPatientRegistered
  • timestamp
    string

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