New
Description
A New event type is used to trigger a message when a new note or document is added to the patient's chart. This event type can contain the actual note content, along with related patient, visit, and provider information.
API endpoints for New Notes
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/notes/new.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
IntraConnects Unified Model
| Event Type | IntraConnects Request | Data Type | Cerner Request |
|---|---|---|---|
| New | Meta.DataModel | String | |
| New | Meta.EventType | String | |
| New | Meta.Test | Boolean | |
| New | Meta.Source | String | |
| New | Meta.Source.ID | String | |
| New | Meta.Source.Name | String | |
| New | Patient.Identifiers[] | Array of Objects | |
| New | Patient.Identifiers[].ID | String | subject.reference |
| New | Patient.Identifiers[].IDType | String | EHRID |
| New | Patient.Demographics | Object | |
| New | Patient.Demographics.FirstName | String | |
| New | Patient.Demographics.MiddleName | String | |
| New | Patient.Demographics.LastName | String | |
| New | Patient.Demographics.DOB | String | |
| New | Patient.Demographics.SSN | String | |
| New | Patient.Demographics.Sex | String | |
| New | Patient.Demographics.Race | String | |
| New | Patient.Demographics.isHispanic | Boolean | |
| New | Patient.Demographics.Religion | String | |
| New | Patient.Demographics.MaritalStatus | String | |
| New | Patient.Demographics.IsDeceased | Boolean | |
| New | Patient.Demographics.DeathDateTime | String | |
| New | Patient.Demographics.PhoneNumber | Object | |
| New | Patient.Demographics.PhoneNumber.Home | String | |
| New | Patient.Demographics.PhoneNumber.Office | String | |
| New | Patient.Demographics.PhoneNumber.Mobile | String | |
| New | Patient.Demographics.EmailAddresses | String | |
| New | Patient.Demographics.Language | String | |
| New | Patient.Demographics.Citizenship | String | |
| New | Patient.Demographics.Address | Object | |
| New | Patient.Demographics.Address.StreetAddress | String | |
| New | Patient.Demographics.Address.City | String | |
| New | Patient.Demographics.Address.State | String | |
| New | Patient.Demographics.Address.ZIP | String | |
| New | Patient.Demographics.Address.County | String | |
| New | Patient.Demographics.Address.Country | String | |
| New | Patient.Notes[] | Array | |
| New | Visit | Object | |
| New | Visit.VisitNumber | String | |
| New | Visit.AccountNumber | String | |
| New | Visit.PatientClass | String | |
| New | Visit.VisitDateTime | String | |
| New | Visit.Location | Object | |
| New | Visit.Location.Type | String | |
| New | Visit.Location.Facility | String | |
| New | Visit.Location.Department | String | |
| New | Visit.Location.Room | String | |
| New | Visit.Location.Bed | String | |
| New | Visit.AdditionalStaff[] | Array of Objects | |
| New | Visit.AdditionalStaff[].ID | String | |
| New | Visit.AdditionalStaff[].IDType | String | |
| New | Visit.AdditionalStaff[].FirstName | String | |
| New | Visit.AdditionalStaff[].LastName | String | |
| New | Visit.AdditionalStaff[].Credentials[] | Array of Strings | |
| New | Visit.AdditionalStaff[].Address | Object | |
| New | Visit.AdditionalStaff[].Address.StreetAddress | String | |
| New | Visit.AdditionalStaff[].Address.City | String | |
| New | Visit.AdditionalStaff[].Address.State | String | |
| New | Visit.AdditionalStaff[].Address.ZIP | String | |
| New | Visit.AdditionalStaff[].Address.County | String | |
| New | Orders | Array of Objects | |
| New | Orders[].ID | String | |
| New | Orders[].Name | String | |
| New | Note | Object | |
| New | Text | String | |
| New | Note.Code | String | |
| New | Note.System | String | |
| New | Note.ContentType | String | content[].attachment.contentType |
| New | Note.FileContents | String | content[].attachment.data |
| New | Note.FileName | String | content[].attachment.title |
| New | Note.FileType | String | |
| New | Note.DocumentSubClass | String | |
| New | Note.DocumentType | String | |
| New | Note.DocumentID | String | type.coding[].code |
| New | Note.DocumentDescription | String | type.coding[].display / type.text |
| New | Note.StartDate | String | context.period.start |
| New | Note.ServiceDateTime | String | context.period.end |
| New | Note.DocumentationDateTime | String | content[].attachment.creation |
| New | Note.Status | String | status |
| New | Note.Availability | String | |
| New | Note.Provider | Object | |
| New | Note.Provider.ID | String | author.reference / authenticator.reference |
| New | Note.Provider.IDType | String | |
| New | Note.Provider.FirstName | String | |
| New | Note.Provider.LastName | String | |
| New | Note.Provider.Credentials[] | Array of Strings | |
| New | Note.Provider.Address | Object | |
| New | Note.Provider.Address.StreetAddress | String | |
| New | Note.Provider.Address.City | String | |
| New | Note.Provider.Address.State | String | |
| New | Note.Provider.Address.ZIP | String | |
| New | Note.Provider.Address.County | String | |
| New | Note.Provider.Address.Country | String | |
| New | Note.Provider.EmailAddresses[] | Array | |
| New | Note.Provider.PhoneNumber | Object | |
| New | Note.Provider.PhoneNumber.Office | String | |
| New | Note.Provider.Location | Object | |
| New | Note.Provider.Location.Type | String | |
| New | Note.Provider.Location.Facility | String | |
| New | Note.Provider.Location.Department | String | |
| New | Note.Provider.Locationroom | String | |
| New | Note.Authenticator | Object | |
| New | Note.Authenticator.ID | String | |
| New | Note.Authenticator.IDType | String | |
| New | Note.Authenticator.FirstName | String | |
| New | Note.Authenticator.LastName | String | |
| New | Note.Authenticator.Credentials[] | Array of Strings | |
| New | Note.Authenticator.Address | Object | |
| New | Note.Authenticator.Address.StreetAddress | String | |
| New | Note.Authenticator.Address.CIty | String | |
| New | Note.Authenticator.Address.State | String | |
| New | Note.Authenticator.Address.ZIP | String | |
| New | Note.Authenticator.Address.County | String | |
| New | Note.Authenticator.Address.Country | String | |
| New | Note.Authenticator.EmailAddresses[] | Array | |
| New | Note.Authenticator.PhoneNumber | Object | |
| New | Note.Authenticator.PhoneNumber.Office | String | |
| New | Note.Authenticator.Location | Object | |
| New | Note.Authenticator.Location.Type | String | |
| New | Note.Authenticator.Location.Facility | String | |
| New | Note.Authenticator.Location.Department | String | |
| New | Note.Authenticator.Location.Room | String | |
| New | Note.Notifications[] | Array of objects | |
| New | Note.Notifications[].ID | String | |
| New | Note.Notifications[].IDType | String | |
| New | Note.Notifications[].FirstName | String | |
| New | Note.Notifications[].LastName | String | |
| New | Note.Notifications[].Credentials[] | Array of Strings | |
| New | Note.Notifications[].Address | Object | |
| New | Note.Notifications[].Address.StreetAddress | String | |
| New | Note.Notifications[].Address.City | String | |
| New | Note.Notifications[].Address.State | String | |
| New | Note.Notifications[].Address.ZIP | String | |
| New | Note.Notifications[].Address.County | String | |
| New | Note.Notifications[].Address.Country | String | |
| New | Note.Notifications[].EmailAddresses[] | Array of Strings | |
| New | Note.Notifications[].PhoneNumber | Object | |
| New | Note.Notifications[].PhoneNumber.Office | ||
| New | Note.Notifications[].Location | Object | |
| New | Note.Notifications[].Location.Type | String | |
| New | Note.Notifications[].Location.Facility | String | |
| New | Note.Notifications[].Location.Department | String | |
| New | Note.Notifications[].Location.Room | String | |
| New | Note.Components[] | Array |