New

Description

The New event type can be used to add education assignments to a patient's chart. This event typically includes information such as the patient's demographics, the type of education assignment being added, the content or details of the education assignment, and any associated provider or clinician information.

API endpoints for New Patient Education

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

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

Data Model JSON for New

New - Sample Payload

{
   "Meta": {
      "DataModel": "PatientEducation",
      "EventType": "New",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "db444879-ccb0-4335-8682-da4e82a5a3f4",
         "Name": "EHR Bridege Dev Tools"
      },
      "Destinations": [
         {
            "ID": "568dfb6b-16be-435f-9eb5-eddd283dde8a",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "10cf535c-f68c-4aa5-82f5-afb78e73be55",
            "AttemptID": "8618b04a-f166-4531-8647-21887094720c"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "994002",
            "IDType": "MRN"
         }
      ],
      "Demographics": {
         "FirstName": "Danny",
         "MiddleName": null,
         "LastName": "Barros",
         "DOB": "1978-01-25",
         "SSN": "111-22-3333",
         "Sex": "Female",
         "Race": "Black",
         "IsHispanic": false,
         "Religion": null,
         "MaritalStatus": "Married",
         "IsDeceased": false,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18084575310",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [
            "danny@barros.th"
         ],
         "Language": "en",
         "Citizenship": [
            "US",
            "TH",
            "CR"
         ],
         "Address": {
            "StreetAddress": "Palms Road",
            "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": "Arthur",
         "LastName": "Royc",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "Karven Roaad",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "50200",
            "County": "Santa Clara",
            "Country": "USA"
         },
         "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": "Carolin",
         "LastName": "Fraster",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "Cally Hwy Suite B",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "96766",
            "County": "Santa Clara",
            "Country": "United States"
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": "+18082451511"
         },
         "Location": {
            "Type": "Alaska Health Hospital",
            "Facility": "Wilson 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-08-16T14:21:21.530Z",
         "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": []
                  }
               ]
            }
         ]
      }
   ]
}