xCaliber healthCare Data Mesh

Event

Event

Source Object: Event

The Event source object serves as a fundamental building block for recording and managing various events within a healthcare platform. These events can include appointments, consultations, or any significant interactions related to patient care.

Overview

In healthcare systems, the concept of an "event" is broad and can encompass a wide range of interactions. Events may include appointments, consultations, telehealth sessions, recurring schedules, and more. The Event source object is designed to capture the details of these events comprehensively, providing structured data for various purposes within a healthcare platform.

Usage

The Event source object plays a pivotal role in managing and tracking different aspects of patient care and healthcare operations:

  1. Appointment Management: It is widely used to manage and schedule patient appointments, recording essential details like scheduled date, duration, and location.
  2. Billing and Payment: The billing details, including notes and payment information, are crucial for financial and administrative purposes, ensuring proper reimbursement.
  3. Patient History: Events are stored as part of the patient's history, enabling healthcare providers to access and review past interactions.
  4. Telehealth Sessions: In the era of telehealth, event data can capture details of remote consultations, telehealth-specific information, and service locations.
  5. Recurring Schedules: For recurring events or follow-up appointments, this source object can be used to manage schedules efficiently.
  6. Practice Management: Event data supports the efficient operation of healthcare practices, ensuring that all patient interactions are well-documented.
  7. Status Tracking: The status information of an event is critical for monitoring its progress, room allocation, and current state.
  8. Referral Provider: When applicable, the referring provider and their state information can be captured to ensure proper coordination.

The Event source object is a versatile and essential component in healthcare platforms, contributing to patient care, practice management, billing, and administrative functions.

Mapping Table

Data FieldSource Field Data TypeResource Mapping ContextSource Data Field CardinalitySource Data Field DescriptionExample ValueSource Data Field Validation RuleMapped FHIR ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapped FHIR Data Field Type
billing_detailsObjectTop Level0..1billing information for appointments must be enabled for practice--Appointment--NA-TBD
billing_details.billing_noteStringTop Level0..1--string(500)Appointmentcontained[*].note[1].text-NA-markdown
billing_details.referring_providerStringTop Level0..1--string(100)Appointmentcontained[*].issuer.reference-NA-TBD
billing_details.referring_provider_stateStringTop Level0..1--string(2)Appointmentcontained[*].issuer.display-NA-TBD
created_dateDateTimeTop Level0..1read-only2016-10-13T00:47:01Zdatetime(iso8601)Appointmentcreated-NA-TBD
deleted_dateDateTimeTop Level0..1read-onlynulldatetime(iso8601)Appointmentextension[*].valueDate-NAdeleted-dateTBD
descriptionStringTop Level0..1-follow up to procedurestring(500)Appointmentdescription-NA-TBD
durationIntegerTop Level0..1in minutes. 5-min increment and must be between 1 to 144015integerAppointmentminutesDuration-NA-TBD
idLongTop Level0..1read-only67176890458long(64)Appointmentid-NA-TBD
last_modified_dateDateTimeTop Level0..1read-only2016-10-13T00:59:16Zdatetime(iso8601)Appointmentextension[*].valueDate-NAmodified-dateTBD
metadataTBDTop Level0..1-null-Appointmentmeta-NA-TBD
modeStringTop Level0..1-VIDEOVIDEO, IN_PERSONAppointmentextension[*].valueString-NAappointment-modestring
patientLongTop Level1..1-64058687489long(64)Appointmentparticipant[*].actor.reference-NA-TBD
paymentObjectTop Level0..1---Appointment--NA-TBD
payment.amountStringTop Level0..1-20.00-Appointmentcontained[*].paymentAmount.value-NA-TBD
payment.appointmentIntegerTop Level0..1-67176890458-Appointmentcontained[*].identifier[1].id-NA-TBD
payment.billTBDTop Level0..1-null-Appointmentcontained[*].text-NA-string
payment.create_dateDateTimeTop Level0..1-2020-01-27T16:17:43Z-Appointmentcontained[*].period.start-NA-TBD
payment.delete_dateDateTimeTop Level0..1-null-Appointmentcontained[*].period.end-NA-TBD
payment.when_collectedDateTimeTop Level0..1-2020-01-27T16:17:43Z-Appointmentcontained[*].paymentDate-NA-TBD
physicianLongTop Level1..1-131074long(64)Appointmentparticipant[*].actor.reference-NA-TBD
practiceLongTop Level1..1-65540long(64)Appointmentparticipant[*].actor.reference-NA-TBD
reasonStringTop Level1..1The "reason" field should not be free-text. The values are mapped to "appointment types" in the EMR. Reasons that aren't already represented by a structured Appointment Type in Elation will cause one to be created for the practice automatically when we receive them.Follow-Upstring(50), not nullableAppointmentreasonCode[0].coding[0].display-NA-TBD
recurring_event_scheduleTBDTop Level0..1-null-Appointmentextension[*].valueString-NArecurring-eventstring
scheduled_dateDateTimeTop Level1..1-2016-10-13T11:15:00Zdatetime(iso8601)Appointmentstart-NA-TBD
statusObjectTop Level0..1optional in "Create"--Appointment--NA-TBD
status.roomStringTop Level0..1the value must be one of available roomsRoom 102-Appointmentextension[].extension[].valueString-NAroomstring
status.statusValueSetTop Level0..1required in "Update"Confirmed"Scheduled", "Confirmed", "Checked Out", "Cancelled", "With Doctor", "In Room", "Checked In", "In Room - Vitals Taken", "Not Seen", "Billed"Appointmentstatus-NA-TBD
status.status_dateDateTimeTop Level0..1read-only2016-10-13T01:02:37-Appointmentextension[].extension[].valueString-NAstatus-datestring
telehealth_detailsStringTop Level0..1-video platform-Appointmentextension[*].valueString-NAtelehealth-detailsstring
time_slot_statusStringTop Level0..1-null-Appointmentextension[*].valueString-NAslot-statusstring
time_slot_typeValueSetTop Level0..1-appointment-Appointmentextension[*].valueString-NAslot-typestring
service_locationObjectContained0..1---Location--NA-TBD
service_location.address_line1StringContained0..1-1234 First Practice Way-Locationcontained[*].address.line[1]-NA-TBD
service_location.address_line2StringContained0..1---Locationcontained[*].address.line[2]-NA-TBD
service_location.cityStringContained0..1-San Francisco-Locationcontained[*].address.city-NA-TBD
service_location.created_dateDateTimeContained0..1-2017-08-28T22:46:14.445876Z-Locationcontained[].extension[].valueString-NAcreated-dateTBD
service_location.deleted_dateDateTimeContained0..1-2017-08-28T22:46:14.445876Z-Locationcontained[].extension[].valueString-NAdeleted-dateTBD
service_location.idIntegerContained0..1-13631735-Locationcontained[*].id-NA-TBD
service_location.is_primaryBooleanContained0..1--Locationcontained[].extension[].valueStringNAprimarystring
service_location.nameStringContained0..1-Elation North-Locationcontained[*].name-NA-string
service_location.phoneStringContained0..1-555-555-5555-Locationcontained[].telecom[].valuesystem == phoneNA-TBD
service_location.place_of_serviceStringContained0..1-Office-Locationcontained[].type[].text-NA-string
service_location.stateStringContained0..1-CA-Locationcontained[*].address.state-NA-TBD
service_location.zipStringContained0..1-94114-Locationcontained[*].address.postalCode-NA-TBD