Appointment
Appointment
Source Object: Appointment
The Appointment source object is a cornerstone of healthcare management systems, managing patient appointments and related information.
Overview
The Appointment source object contains various attributes that are fundamental to appointment scheduling and management in healthcare. It captures data related to appointments, including details of the patient, provider, billing, and more.
Usage
The Appointment source object is widely used in healthcare systems for the following purposes:
- Appointment Scheduling: It serves as a fundamental component in scheduling patient appointments with healthcare providers.
- Billing and Payment: Appointment data includes billing details, allowing healthcare organizations to manage payments, create bills, and handle billing-related notes.
- Telehealth Appointments: With the rise of telemedicine, the Appointment object also facilitates the scheduling and management of virtual appointments.
- Practice Management: The data contained within Appointment supports the effective administration and coordination of healthcare practices.
- Status Tracking: It tracks the status and details of appointments, providing insight into whether appointments are room-based or telehealth, their duration, and more.
Developers can use the Appointment source object to build comprehensive appointment scheduling and management systems, improving patient access to healthcare services, billing processes, and overall practice efficiency.
Mapping Table
| Data Field | Source Field Data Type | Resource Mapping Context | Source Data Field Cardinality | Source Data Field Description | Example Value | Source Data Field Validation Rule | Mapped FHIR Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapped FHIR Data Field Type |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| billing_details | Object | Top Level | 0..1 | billing information for appointments must be enabled for practice | - | - | Appointment | - | - | NA | - | TBD |
| billing_details.billing_note | String | Top Level | 0..1 | - | - | string(500) | Appointment | contained[*].note[1].text | - | NA | - | markdown |
| billing_details.referring_provider | String | Top Level | 0..1 | - | - | string(100) | Appointment | contained[*].issuer.reference | - | NA | - | TBD |
| billing_details.referring_provider_state | String | Top Level | 0..1 | - | - | string(2) | Appointment | contained[*].issuer.display | - | NA | - | TBD |
| created_date | DateTime | Top Level | 0..1 | read-only | 2016-10-13T00:47:01Z | datetime(iso8601) | Appointment | created | - | NA | - | TBD |
| deleted_date | DateTime | Top Level | 0..1 | read-only | null | datetime(iso8601) | Appointment | extension[*].valueDate | - | NA | deleted-date | TBD |
| description | String | Top Level | 0..1 | - | follow up to procedure | string(500) | Appointment | description | - | NA | - | TBD |
| duration | Integer | Top Level | 0..1 | in minutes. 5-min increment and must be between 1 to 1440 | 15 | integer | Appointment | minutesDuration | - | NA | - | TBD |
| id | Long | Top Level | 0..1 | read-only | 67176890458 | long(64) | Appointment | id | - | NA | - | TBD |
| last_modified_date | DateTime | Top Level | 0..1 | read-only | 2016-10-13T00:59:16Z | datetime(iso8601) | Appointment | extension[*].valueDate | - | NA | modified-date | TBD |
| metadata | TBD | Top Level | 0..1 | - | null | - | Appointment | meta | - | NA | - | TBD |
| mode | String | Top Level | 0..1 | - | VIDEO | VIDEO, IN_PERSON | Appointment | extension[*].valueString | - | NA | appointment-mode | string |
| patient | Long | Top Level | 1..1 | - | 64058687489 | long(64) | Appointment | participant[*].actor.reference | - | NA | - | TBD |
| payment | Object | Top Level | 0..1 | - | - | - | Appointment | - | - | NA | - | TBD |
| payment.amount | String | Top Level | 0..1 | - | 20.00 | - | Appointment | contained[*].paymentAmount.value | - | NA | - | TBD |
| payment.appointment | Integer | Top Level | 0..1 | - | 67176890458 | - | Appointment | contained[*].identifier[1].id | - | NA | - | TBD |
| payment.bill | TBD | Top Level | 0..1 | - | null | - | Appointment | contained[*].text | - | NA | - | string |
| payment.create_date | DateTime | Top Level | 0..1 | - | 2020-01-27T16:17:43Z | - | Appointment | contained[*].period.start | - | NA | - | TBD |
| payment.delete_date | DateTime | Top Level | 0..1 | - | null | - | Appointment | contained[*].period.end | - | NA | - | TBD |
| payment.when_collected | DateTime | Top Level | 0..1 | - | 2020-01-27T16:17:43Z | - | Appointment | contained[*].paymentDate | - | NA | - | TBD |
| physician | Long | Top Level | 1..1 | - | 131074 | long(64) | Appointment | participant[*].actor.reference | - | NA | - | TBD |
| practice | Long | Top Level | 1..1 | - | 65540 | long(64) | Appointment | participant[*].actor.reference | - | NA | - | TBD |
| reason | String | Top Level | 1..1 | The "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-Up | string(50), not nullable | Appointment | reasonCode[0].coding[0]. | - | NA | - | TBD |
| recurring_event_schedule | TBD | Top Level | 0..1 | - | null | - | Appointment | extension[*].valueString | - | NA | recurring-event | string |
| scheduled_date | DateTime | Top Level | 1..1 | - | 2016-10-13T11:15:00Z | datetime(iso8601) | Appointment | start | - | NA | - | TBD |
| status | Object | Top Level | 0..1 | optional in "Create" | - | - | Appointment | - | - | NA | - | TBD |
| status.room | String | Top Level | 0..1 | the value must be one of available rooms | Room 102 | - | Appointment | extension[].extension[].valueString | - | NA | room | string |
| status.status | ValueSet | Top Level | 0..1 | required in "Update" | Confirmed | "Scheduled", "Confirmed", "Checked Out", "Cancelled", "With Doctor", "In Room", "Checked In", "In Room - Vitals Taken", "Not Seen", "Billed" | Appointment | status | - | NA | - | TBD |
| status.status_date | DateTime | Top Level | 0..1 | read-only | 2016-10-13T01:02:37 | - | Appointment | extension[].extension[].valueString | - | NA | status-date | string |
| telehealth_details | String | Top Level | 0..1 | - | video platform | - | Appointment | extension[*].valueString | - | NA | telehealth-details | string |
| time_slot_status | String | Top Level | 0..1 | - | null | - | Appointment | extension[*].valueString | - | NA | slot-status | string |
| time_slot_type | ValueSet | Top Level | 0..1 | - | appointment | - | Appointment | extension[*].valueString | - | NA | slot-type | string |
| service_location | Object | Contained | 0..1 | - | - | - | Location | - | - | NA | - | TBD |
| service_location.address_line1 | String | Contained | 0..1 | - | 1234 First Practice Way | - | Location | - | - | NA | - | TBD |
| service_location.address_line2 | String | Contained | 0..1 | - | - | - | Location | - | - | NA | - | TBD |
| service_location.city | String | Contained | 0..1 | - | San Francisco | - | Location | - | - | NA | - | TBD |
| service_location.id | Integer | Contained | 0..1 | - | 13631735 | - | Location | participants[].actor.reference | - | NA | - | TBD |
| service_location.name | String | Contained | 0..1 | - | Elation North | - | Location | - | - | NA | - | TBD |
| service_location.phone | String | Contained | 0..1 | - | 555-555-5555 | - | Location | - | - | NA | - | TBD |
| service_location.place_of_service | String | Contained | 0..1 | - | 1 | - | Location | - | - | NA | - | TBD |
| service_location.state | String | Contained | 0..1 | - | CA | - | Location | - | - | NA | - | TBD |
| service_location.zip | String | Contained | 0..1 | - | 94114 | - | Location | - | - | NA | - | TBD |