Delete

Description

The Delete event type can be used to remove education assignments from a patient's chart. This event is typically triggered when a previously assigned education task or assignment is no longer relevant or needs to be removed from the patient's record.

API endpoints for Patient Education Delete

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

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

Data Model JSON for Delete

Delete - Sample Payload

{
   "Meta": {
      "DataModel": "PatientEducation",
      "EventType": "Delete",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "75e63f63-cd42-42c7-8c12-310dffdd21e2 ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "5d8a0bf9-b1cb-425b-9707-e133ab409e45 ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "9662d3cf-9a25-481e-9d6b-e09524dc5802",
            "AttemptID": "eb2e13c7-fe47-49e1-be1b-acf307d65444"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "994002",
            "IDType": "MRN"
         }
      ],
      "Demographics": {
         "FirstName": "Anne",
         "MiddleName": null,
         "LastName": "Laurel",
         "DOB": "1978-01-25",
         "SSN": "111-22-3333",
         "Sex": "Female",
         "Race": "Black",
         "IsHispanic": false,
         "Religion": null,
         "MaritalStatus": "Married",
         "IsDeceased": false,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18022675310",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [
            "ase@nzesi.th"
         ],
         "Language": "en",
         "Citizenship": [
            "US",
            "TH",
            "CR"
         ],
         "Address": {
            "StreetAddress": "Mill Docks Soi 6/3",
            "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": "Kristian",
         "LastName": "Tarin",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "678 Gold Rit Rd",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "50200",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+6653920300"
         },
         "Location": {
            "Type": "Department",
            "Facility": "Medical Center",
            "Department": " 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": "Mary",
         "LastName": "Jyoshist",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "3-342 Tophill Bracks",
            "City": "San Jose",
            "State": "HI",
            "ZIP": "96766",
            "County": "Santa Clara",
            "Country": "United States"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+18082451511"
         },
         "Location": {
            "Type": "Alaska Pacific Health Hospital",
            "Facility": "Wilson Medical Center",
            "Department": "Gynecology",
            "Room": "32"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "Ryan 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.534Z",
         "Status": "Active",
         "ActionStatus": "Assign",
         "ActionDateTime": null,
         "Assignments": [
            {
               "Code": "DN-PREG-01A",
               "Codeset": "HCOPATED",
               "Description": "Diet and Nutrition-Prenatal Vitamins",
               "Topic": {
                  "Code": "DN-PREG-01",
                  "Codeset": "HCOPATED",
                  "Description": "Diet and Nutrition"
               },
               "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": []
                  }
               ]
            }
         ]
      }
   ]
}