Listen for patient record updates

Last updated: Apr 30, 2024
PRODUCT OWNER
IMPLEMENTATION
HEALTH TECH VENDOR

You may want to listen for patient record updates to maintain a patient database for your own system (whether for the long-term or short-term) or if you need updates on patient insurance data.

Use cases

This API action may be a good fit for your organization if you want to be notified about these events in your connection’s EHR system:

  • A new patient is added.
  • An existing patient has updates for registration or demographic information.
  • An existing patient has either new insurance or updates to existing insurance.
  • An existing patient checks in for a specific visit or registers for an outpatient visit.
  • An existing patient cancels an outpatient visit.

Supported systems

You can receive notifications like this with the Redox FHIR® API.

Your connection's system can push notifications with a polling or subscription type of system.

Things you need to know

Action steps

Listen for patient registration updates

For patient registration, the EHR system sends a notification when a patient's demographics are updated during an inpatient or outpatient visit.

To review technical specifications for this notification, refer to the Patient Registered schema.

Patient Registered
Payload
json
1
{
2
"id": "PatientAdminEventPatientRegisteredBundleExample",
3
"type": "message",
4
"entry": [
5
{
6
"resource": {
7
"id": "RedoxMessageHeaderExample",
8
"source": {
9
"name": "Good Health Clinics",
10
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
11
},
12
"eventCoding": {
13
"code": "PatientAdmin-event-patient-registered",
14
"system": "urn:redox:event-type"
15
},
16
"resourceType": "MessageHeader"
17
}
18
},
19
{
20
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
21
"resource": {
22
"resourceType": "Patient"
23
}
24
},
25
{
26
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
27
"resource": {
28
"class": {
29
"code": "AMB",
30
"system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
31
},
32
"status": "planned",
33
"resourceType": "Encounter"
34
}
35
}
36
],
37
"timestamp": "2021-06-17T20:33:22.422Z",
38
"resourceType": "Bundle"
39
}

Listen for new patient notifications

The EHR system sends a notification whenever a patient record is created. To review technical specifications for this notification, refer to the Patient Created schema.

This one step is also encompassed in listening for patient registration notifications. Depending on what the EHR system supports, you may need to use this independent action step instead of the combined patient registration action step to get the same data.

Patient Created
Payload
json
1
{
2
"resourceType": "Bundle",
3
"id": "PatientAdminEventPatientCreatedBundleExample",
4
"type": "message",
5
"timestamp": "2021-06-17T20:33:22.422Z",
6
"entry": [
7
{
8
"resource": {
9
"resourceType": "MessageHeader",
10
"id": "RedoxMessageHeaderExample",
11
"source": {
12
"name": "Good Health Clinics",
13
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
},
15
"eventCoding": {
16
"system": "urn:redox:event-type",
17
"code": "PatientAdmin-event-patient-created"
18
}
19
}
20
},
21
{
22
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
23
"resource": {
24
"resourceType": "Patient"
25
}
26
}
27
]
28
}

Listen for patient update notifications

The EHR system sends a notification whenever a patient's record is updated (e.g., a patient's phone number is updated to a new number). To review technical specifications for this notification, refer to the Patient Updated schema.

This one step is also encompassed in listening for patient registration notifications. Depending on what the EHR system supports, you may need to use this independent action step instead of the combined patient registration action step to get the same data.

Patient Updated
Payload
json
1
{
2
"resourceType": "Bundle",
3
"id": "PatientAdminEventPatientUpdatedBundleExample",
4
"type": "message",
5
"timestamp": "2021-06-17T20:33:22.422Z",
6
"entry": [
7
{
8
"resource": {
9
"resourceType": "MessageHeader",
10
"id": "RedoxMessageHeaderExample",
11
"source": {
12
"name": "Good Health Clinics",
13
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
},
15
"eventCoding": {
16
"system": "urn:redox:event-type",
17
"code": "PatientAdmin-event-patient-updated"
18
}
19
}
20
},
21
{
22
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
23
"resource": {
24
"resourceType": "Patient"
25
}
26
}
27
]
28
}

Listen for patient merge notifications

The EHR system sends a notification whenever two patient records are merged. To review technical specifications for this notification, refer to the Patient Merged schema.

This one step is also encompassed in listening for patient registration notifications. Depending on what the EHR system supports, you may need to use this independent action step instead of the combined patient registration action step to get the same data.

Patient Merged
Payload
json
1
{
2
"resourceType": "Bundle",
3
"id": "PatientAdminEventPatientMergedBundleExample",
4
"type": "message",
5
"entry": [
6
{
7
"resource": {
8
"eventCoding": {
9
"code": "PatientAdmin-event-patient-merged",
10
"system": "urn:redox:event-type"
11
},
12
"resourceType": "MessageHeader",
13
"id": "RedoxMessageHeaderExample",
14
"meta": {
15
"profile": [
16
"https://fhir.redoxengine.com/StructureDefinition/redox-message-header"
17
]
18
},
19
"source": {
20
"name": "Good Health Clinics",
21
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
22
},
23
"focus": [
24
{
25
"reference": "Patient/RedoxPatientExampleTimothyMinimalMergedNew"
26
}
27
],
28
"definition": "https://fhir.redoxengine.com/MessageDefinition/PatientAdminEventPatientMergedMessageDefinition"
29
}
30
},
31
{
32
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothyMinimalMergedNew",
33
"resource": {
34
"resourceType": "Patient",
35
"id": "RedoxPatientExampleTimothyMinimalMergedNew",
36
"meta": {
37
"profile": [
38
"https://fhir.redoxengine.com/StructureDefinition/redox-patient"
39
]
40
},
41
"identifier": [
42
{
43
"value": "0000000001",
44
"system": "urn:redox:health-one:MR"
45
},
46
{
47
"value": "101-01-0001",
48
"system": "http://hl7.org/fhir/sid/us-ssn"
49
}
50
],
51
"link": [
52
{
53
"other": {
54
"reference": "Patient/RedoxPatientExampleTimothyMinimalMergedOld"
55
},
56
"type": "replaces"
57
}
58
],
59
"name": [
60
{
61
"given": [
62
"Timothy",
63
"Paul"
64
],
65
"family": "Bixby"
66
}
67
],
68
"gender": "male",
69
"birthDate": "2008-01-06"
70
}
71
},
72
{
73
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothyMinimalMergedOld",
74
"resource": {
75
"resourceType": "Patient",
76
"id": "RedoxPatientExampleTimothyMinimalMergedOld",
77
"meta": {
78
"profile": [
79
"https://fhir.redoxengine.com/StructureDefinition/redox-patient"
80
]
81
},
82
"identifier": [
83
{
84
"value": "0000000002",
85
"system": "urn:redox:health-one:MR"
86
},
87
{
88
"value": "101-01-0001",
89
"system": "http://hl7.org/fhir/sid/us-ssn"
90
}
91
],
92
"link": [
93
{
94
"other": {
95
"reference": "Patient/RedoxPatientExampleTimothyMinimalMergedNew"
96
},
97
"type": "replaced-by"
98
}
99
],
100
"name": [
101
{
102
"given": [
103
"Timothy",
104
"Paul"
105
],
106
"family": "Bixby"
107
}
108
],
109
"gender": "male",
110
"birthDate": "2008-01-06"
111
}
112
}
113
],
114
"timestamp": "2021-06-17T20:33:22.422Z"
115
}