Update

Description

The Update event type can be used to update education assignments in a patient's chart. This event is typically triggered when there are changes or updates to the content, status, or details of an existing education assignment.

API endpoints for Patient Education Update

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-education/update.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Update

Update - Sample Payload

{
   "Meta": {
      "DataModel": "PatientEducation",
      "EventType": "Update",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "7467dcf5-d822-46bb-8548-55712ae36d10",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "4562b2b8-46f6-4685-a0d2-189bef161168",
            "AttemptID": "c73aeab9-0bc0-4efd-a27d-e40ff16a15af "
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "994002",
            "IDType": "MRN"
         }
      ],
      "Demographics": {
         "FirstName": "Louis ",
         "MiddleName": null,
         "LastName": "Clarke",
         "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": [
            "louis@clarke.th"
         ],
         "Language": "en",
         "Citizenship": [
            "US",
            "TH",
            "CR"
         ],
         "Address": {
            "StreetAddress": "S V Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "50200",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitNumber": "3498128348",
      "AccountNumber": "12945932",
      "PatientClass": "Inpatient",
      "VisitDateTime": "2022-08-16T14:21:20.715Z",
      "AttendingProvider": {
         "NPI": null,
         "ID": "426986",
         "IDType": "NCT",
         "FirstName": "Marya",
         "LastName": "Jones",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "SW Street",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "50200",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+6653670300"
         },
         "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": "Vincent",
         "LastName": "Franklin",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "Country Hills ",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "96766",
            "County": "Santa Clara",
            "Country": "United States"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+18082451511"
         },
         "Location": {
            "Type": "Arizona Health Hospital",
            "Facility": "Pheonix Care Center",
            "Department": "Obstetrics and Gynecology",
            "Room": "32"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "Mayhen City Hospital",
         "Department": "MA",
         "Room": "13",
         "Bed": "A"
      }
   },
   "Education": [
      {
         "Subject": {
            "Code": "DN-01",
            "Codeset": null,
            "Description": "Diet and Nutrition"
         },
         "InstanceID": "20898465",
         "CreatedDateTime": "2022-08-16T14:21:21.532Z",
         "Status": "Active",
         "ActionStatus": "Assign",
         "ActionDateTime": null,
         "Assignments": [
            {
               "Code": "DN-PREG-01A",
               "Codeset": "HCOPATED",
               "Description": "Diet and Nutrition Vitamins",
               "Topic": {
                  "Code": "DN-PREG-01",
                  "Codeset": "HCOPATED",
                  "Description": "Diet in Pregnancy"
               },
               "InstanceID": "87300586",
               "CreatedDateTime": "2022-08-16T14:21:20.715Z",
               "Status": "Active",
               "ActionStatus": "Assign",
               "ActionDateTime": null,
               "Assignees": [
                  {
                     "Learner": "Patient",
                     "ContentType": "Video",
                     "Readiness": "Eager",
                     "Response": null,
                     "Notes": []
                  }
               ]
            }
         ]
      }
   ]
}