PatientEducation
The PatientEducation data model is used to manage patient education content, such as adding an assignment to a patient's chart and updating the patient's chart to reflect completion or understanding of the assignment.
Newlink
BETAThe New event is used to add education assignments to a patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientEducation
Meta.EventType
String
ReliableRequiredDelete
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ProbablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format
Visit.AttendingProvider.NPI
String
ProbableNPI of the attending provider
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.NPI
String
PossibleNPI of the consulting provider
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.NPI
String
PossibleNPI of the referring provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the visit
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Education
Education[]
Array of Objects
ReliableEducation concepts
Education[].Subject
Object
ProbableSubject of the education concept
Education[].Subject.Code
String
ProbableRequiredCode for the education subject
Education[].Subject.Codeset
String
ProbableCode set used to identify the education subject
Education[].Subject.Description
String
ProbableDescription of the education subject
Education[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].CreatedDateTime
String
PossibleThe date and time the instance of the education resource was assigned.
ISO 8601 format
Education[].Status
String
PossibleThe status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted
Education[].ActionStatus
String
ProbableThe action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update
Education[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education resource.
ISO 8601 Format
Education[].Assignments[]
Array of Objects
ReliableList of assigned patient education resources. Education assignments can be videos, handouts, etc.
Education[].Assignments[].Code
String
ReliableCode for the assignment
Education[].Assignments[].Codeset
String
ReliableCode set used to identify the assignment
Education[].Assignments[].Description
String
ReliableDescription of the assignment
Education[].Assignments[].Topic
Object
ProbableTopic of the education assignment
Education[].Assignments[].Topic.Code
String
ProbableCode for the assignment topic
Education[].Assignments[].Topic.Codeset
String
ProbableCode set used to identify the assignment topic
Education[].Assignments[].Topic.Description
String
ProbableDescription of the assignment topic
Education[].Assignments[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].Assignments[].CreatedDateTime
String
PossibleThe date and time the instance of the education assignment was created.
ISO 8601 format
Education[].Assignments[].Status
String
PossibleThe status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted
Education[].Assignments[].ActionStatus
String
ProbableThe action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update
Education[].Assignments[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education assignment.
ISO 8601 Format
Education[].Assignments[].Assignees[]
Array of Objects
ProbableThe list of assignees associated to the education assignment
Education[].Assignments[].Assignees[].Learner
String
ProbableThe learner type assigned.
Example: Patient, Parent, Caregiver
Education[].Assignments[].Assignees[].ContentType
String
ProbableThe type of content assigned to the learner.
Example: Video, pamphlet, demonstration
Education[].Assignments[].Assignees[].Readiness
String
PossibleAn indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling
Education[].Assignments[].Assignees[].Response
String
PossibleThe response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding
Education[].Assignments[].Assignees[].Notes[]
Array of Strings
PossibleNotes about the assignee's assignment
{
"Meta": {
"DataModel": "PatientEducation",
"EventType": "New",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "994002",
"IDType": "MRN"
}
],
"Demographics": {
"FirstName": "Ase",
"MiddleName": null,
"LastName": "Nzesi",
"DOB": "1978-01-25",
"SSN": "111-22-3333",
"Sex": "Female",
"Race": "Black",
"IsHispanic": false,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": false,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"[email protected]"
],
"Language": "en",
"Citizenship": [
"US",
"TH",
"CR"
],
"Address": {
"StreetAddress": "Suan Dok Soi 6/3",
"City": "Chaing Mai",
"State": "Chang Wat Chang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "3498128348",
"AccountNumber": "12945932",
"PatientClass": "Inpatient",
"VisitDateTime": "2022-07-01T17:19:28.556Z",
"AttendingProvider": {
"NPI": null,
"ID": "426986",
"IDType": "NCT",
"FirstName": "Krittiya",
"LastName": "Somaketarin",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "8 Bunrueang Rit Rd",
"City": "Chiang Mai",
"State": "Chang Wat Chiang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+6653920300"
},
"Location": {
"Type": "Department",
"Facility": "Medical Center",
"Department": "Obstetrics and Gynaecology",
"Room": "446"
}
},
"ConsultingProvider": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"NPI": null,
"ID": "12981294",
"IDType": "NCT",
"FirstName": "Carol",
"LastName": "Fujiyoshi",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "3-3420 Kuhio Hwy Suite B",
"City": "Lihue",
"State": "HI",
"ZIP": "96766",
"County": "Kauai",
"Country": "United States"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+18082451511"
},
"Location": {
"Type": "Hawaii Pacific Health Hospital",
"Facility": "Wilcox Medical Center",
"Department": "Obstetrics and Gynecology",
"Room": "32"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "Chiang Mai Ram Hospital",
"Department": "MA",
"Room": "13",
"Bed": "A"
}
},
"Education": [
{
"Subject": {
"Code": "DN-01",
"Codeset": null,
"Description": "Diet and Nutrition"
},
"InstanceID": "20898465",
"CreatedDateTime": "2022-07-01T17:19:29.356Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignments": [
{
"Code": "DN-PREG-01A",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy - Prenatal Vitamins",
"Topic": {
"Code": "DN-PREG-01",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy"
},
"InstanceID": "87300586",
"CreatedDateTime": "2022-07-01T17:19:28.556Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignees": [
{
"Learner": "Patient",
"ContentType": "Video",
"Readiness": "Eager",
"Response": null,
"Notes": []
}
]
}
]
}
]
}
Updatelink
BETAThe Update event is used to update education assignments in a patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientEducation
Meta.EventType
String
ReliableRequiredDelete
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ProbablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format
Visit.AttendingProvider.NPI
String
ProbableNPI of the attending provider
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.NPI
String
PossibleNPI of the consulting provider
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.NPI
String
PossibleNPI of the referring provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the visit
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Education
Education[]
Array of Objects
ReliableEducation concepts
Education[].Subject
Object
ProbableSubject of the education concept
Education[].Subject.Code
String
ProbableRequiredCode for the education subject
Education[].Subject.Codeset
String
ProbableCode set used to identify the education subject
Education[].Subject.Description
String
ProbableDescription of the education subject
Education[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].CreatedDateTime
String
PossibleThe date and time the instance of the education resource was assigned.
ISO 8601 format
Education[].Status
String
PossibleThe status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted
Education[].ActionStatus
String
ProbableThe action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update
Education[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education resource.
ISO 8601 Format
Education[].Assignments[]
Array of Objects
ReliableList of assigned patient education resources. Education assignments can be videos, handouts, etc.
Education[].Assignments[].Code
String
ReliableCode for the assignment
Education[].Assignments[].Codeset
String
ReliableCode set used to identify the assignment
Education[].Assignments[].Description
String
ReliableDescription of the assignment
Education[].Assignments[].Topic
Object
ProbableTopic of the education assignment
Education[].Assignments[].Topic.Code
String
ProbableCode for the assignment topic
Education[].Assignments[].Topic.Codeset
String
ProbableCode set used to identify the assignment topic
Education[].Assignments[].Topic.Description
String
ProbableDescription of the assignment topic
Education[].Assignments[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].Assignments[].CreatedDateTime
String
PossibleThe date and time the instance of the education assignment was created.
ISO 8601 format
Education[].Assignments[].Status
String
PossibleThe status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted
Education[].Assignments[].ActionStatus
String
ProbableThe action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update
Education[].Assignments[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education assignment.
ISO 8601 Format
Education[].Assignments[].Assignees[]
Array of Objects
ProbableThe list of assignees associated to the education assignment
Education[].Assignments[].Assignees[].Learner
String
ProbableThe learner type assigned.
Example: Patient, Parent, Caregiver
Education[].Assignments[].Assignees[].ContentType
String
ProbableThe type of content assigned to the learner.
Example: Video, pamphlet, demonstration
Education[].Assignments[].Assignees[].Readiness
String
PossibleAn indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling
Education[].Assignments[].Assignees[].Response
String
PossibleThe response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding
Education[].Assignments[].Assignees[].Notes[]
Array of Strings
PossibleNotes about the assignee's assignment
{
"Meta": {
"DataModel": "PatientEducation",
"EventType": "Update",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "994002",
"IDType": "MRN"
}
],
"Demographics": {
"FirstName": "Ase",
"MiddleName": null,
"LastName": "Nzesi",
"DOB": "1978-01-25",
"SSN": "111-22-3333",
"Sex": "Female",
"Race": "Black",
"IsHispanic": false,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": false,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"[email protected]"
],
"Language": "en",
"Citizenship": [
"US",
"TH",
"CR"
],
"Address": {
"StreetAddress": "Suan Dok Soi 6/3",
"City": "Chaing Mai",
"State": "Chang Wat Chang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "3498128348",
"AccountNumber": "12945932",
"PatientClass": "Inpatient",
"VisitDateTime": "2022-07-01T17:19:28.556Z",
"AttendingProvider": {
"NPI": null,
"ID": "426986",
"IDType": "NCT",
"FirstName": "Krittiya",
"LastName": "Somaketarin",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "8 Bunrueang Rit Rd",
"City": "Chiang Mai",
"State": "Chang Wat Chiang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+6653920300"
},
"Location": {
"Type": "Department",
"Facility": "Medical Center",
"Department": "Obstetrics and Gynaecology",
"Room": "446"
}
},
"ConsultingProvider": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"NPI": null,
"ID": "12981294",
"IDType": "NCT",
"FirstName": "Carol",
"LastName": "Fujiyoshi",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "3-3420 Kuhio Hwy Suite B",
"City": "Lihue",
"State": "HI",
"ZIP": "96766",
"County": "Kauai",
"Country": "United States"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+18082451511"
},
"Location": {
"Type": "Hawaii Pacific Health Hospital",
"Facility": "Wilcox Medical Center",
"Department": "Obstetrics and Gynecology",
"Room": "32"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "Chiang Mai Ram Hospital",
"Department": "MA",
"Room": "13",
"Bed": "A"
}
},
"Education": [
{
"Subject": {
"Code": "DN-01",
"Codeset": null,
"Description": "Diet and Nutrition"
},
"InstanceID": "20898465",
"CreatedDateTime": "2022-07-01T17:19:29.359Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignments": [
{
"Code": "DN-PREG-01A",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy - Prenatal Vitamins",
"Topic": {
"Code": "DN-PREG-01",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy"
},
"InstanceID": "87300586",
"CreatedDateTime": "2022-07-01T17:19:28.556Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignees": [
{
"Learner": "Patient",
"ContentType": "Video",
"Readiness": "Eager",
"Response": null,
"Notes": []
}
]
}
]
}
]
}
Deletelink
BETAThe Delete event is used to remove education assignments from a patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredPatientEducation
Meta.EventType
String
ReliableRequiredDelete
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Visit
Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ProbablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format
Visit.AttendingProvider.NPI
String
ProbableNPI of the attending provider
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.NPI
String
PossibleNPI of the consulting provider
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.NPI
String
PossibleNPI of the referring provider
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableLocation of the visit
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Education
Education[]
Array of Objects
ReliableEducation concepts
Education[].Subject
Object
ProbableSubject of the education concept
Education[].Subject.Code
String
ProbableRequiredCode for the education subject
Education[].Subject.Codeset
String
ProbableCode set used to identify the education subject
Education[].Subject.Description
String
ProbableDescription of the education subject
Education[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].CreatedDateTime
String
PossibleThe date and time the instance of the education resource was assigned.
ISO 8601 format
Education[].Status
String
PossibleThe status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted
Education[].ActionStatus
String
ProbableThe action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update
Education[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education resource.
ISO 8601 Format
Education[].Assignments[]
Array of Objects
ReliableList of assigned patient education resources. Education assignments can be videos, handouts, etc.
Education[].Assignments[].Code
String
ReliableCode for the assignment
Education[].Assignments[].Codeset
String
ReliableCode set used to identify the assignment
Education[].Assignments[].Description
String
ReliableDescription of the assignment
Education[].Assignments[].Topic
Object
ProbableTopic of the education assignment
Education[].Assignments[].Topic.Code
String
ProbableCode for the assignment topic
Education[].Assignments[].Topic.Codeset
String
ProbableCode set used to identify the assignment topic
Education[].Assignments[].Topic.Description
String
ProbableDescription of the assignment topic
Education[].Assignments[].InstanceID
String
PossibleUnique ID that is assigned to the instance of the education resource
Education[].Assignments[].CreatedDateTime
String
PossibleThe date and time the instance of the education assignment was created.
ISO 8601 format
Education[].Assignments[].Status
String
PossibleThe status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted
Education[].Assignments[].ActionStatus
String
ProbableThe action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update
Education[].Assignments[].ActionDateTime
String
ProbableThe date and time the action was taken on the instance of education assignment.
ISO 8601 Format
Education[].Assignments[].Assignees[]
Array of Objects
ProbableThe list of assignees associated to the education assignment
Education[].Assignments[].Assignees[].Learner
String
ProbableThe learner type assigned.
Example: Patient, Parent, Caregiver
Education[].Assignments[].Assignees[].ContentType
String
ProbableThe type of content assigned to the learner.
Example: Video, pamphlet, demonstration
Education[].Assignments[].Assignees[].Readiness
String
PossibleAn indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling
Education[].Assignments[].Assignees[].Response
String
PossibleThe response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding
Education[].Assignments[].Assignees[].Notes[]
Array of Strings
PossibleNotes about the assignee's assignment
{
"Meta": {
"DataModel": "PatientEducation",
"EventType": "Delete",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "994002",
"IDType": "MRN"
}
],
"Demographics": {
"FirstName": "Ase",
"MiddleName": null,
"LastName": "Nzesi",
"DOB": "1978-01-25",
"SSN": "111-22-3333",
"Sex": "Female",
"Race": "Black",
"IsHispanic": false,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": false,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"[email protected]"
],
"Language": "en",
"Citizenship": [
"US",
"TH",
"CR"
],
"Address": {
"StreetAddress": "Suan Dok Soi 6/3",
"City": "Chaing Mai",
"State": "Chang Wat Chang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "3498128348",
"AccountNumber": "12945932",
"PatientClass": "Inpatient",
"VisitDateTime": "2022-07-01T17:19:28.556Z",
"AttendingProvider": {
"NPI": null,
"ID": "426986",
"IDType": "NCT",
"FirstName": "Krittiya",
"LastName": "Somaketarin",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "8 Bunrueang Rit Rd",
"City": "Chiang Mai",
"State": "Chang Wat Chiang Mai",
"ZIP": "50200",
"County": "Amphoe Mueang Chiang Mai",
"Country": "Thailand"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+6653920300"
},
"Location": {
"Type": "Department",
"Facility": "Medical Center",
"Department": "Obstetrics and Gynaecology",
"Room": "446"
}
},
"ConsultingProvider": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"NPI": null,
"ID": "12981294",
"IDType": "NCT",
"FirstName": "Carol",
"LastName": "Fujiyoshi",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "3-3420 Kuhio Hwy Suite B",
"City": "Lihue",
"State": "HI",
"ZIP": "96766",
"County": "Kauai",
"Country": "United States"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+18082451511"
},
"Location": {
"Type": "Hawaii Pacific Health Hospital",
"Facility": "Wilcox Medical Center",
"Department": "Obstetrics and Gynecology",
"Room": "32"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "Chiang Mai Ram Hospital",
"Department": "MA",
"Room": "13",
"Bed": "A"
}
},
"Education": [
{
"Subject": {
"Code": "DN-01",
"Codeset": null,
"Description": "Diet and Nutrition"
},
"InstanceID": "20898465",
"CreatedDateTime": "2022-07-01T17:19:29.361Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignments": [
{
"Code": "DN-PREG-01A",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy - Prenatal Vitamins",
"Topic": {
"Code": "DN-PREG-01",
"Codeset": "HCOPATED",
"Description": "Diet and Nutrition in Pregnancy"
},
"InstanceID": "87300586",
"CreatedDateTime": "2022-07-01T17:19:28.556Z",
"Status": "Active",
"ActionStatus": "Assign",
"ActionDateTime": null,
"Assignees": [
{
"Learner": "Patient",
"ContentType": "Video",
"Readiness": "Eager",
"Response": null,
"Notes": []
}
]
}
]
}
]
}