xCaliber healthCare Data Mesh

Appointment

Overview

Appointments represent scheduled encounters and bookings between patients, providers, resources, etc. These APIs allow creating, searching, accessing and managing Appointment resources. Useful for building scheduling interfaces and integrating booking data into other systems.

Use Cases

  • Scheduling - Add, update and view booked time slots allocated for patients on calendars.
  • Rescheduling - Modify previously booked appointment dates/times.
  • Cancellations - Set statuses to mark appointments as cancelled by patients/providers.
  • Reminders - Trigger automated notifications to remind participants of upcoming appointments.
  • Availability - Manage and view schedules to identify schedulable appointment slots.
  • Referrals - Share specialist appointment slots information for referrals and coordination.
  • Video Visits - Indicate and integrate video urls to enable telehealth/virtual appointments.
  • Patients Registries - Link appointments to maintained patient registry profiles.
  • Analytics - Run reports to analyze appointment utilization, cancel rates, workload etc.
  • Integrations - Keep appointment data in EHR, scheduling and PMS systems in sync.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaAppointment, Waitlist
ElationAppointment, Event
EpicSchedule Enterer, Schedule Filler, Schedule Placer, Schedule Participant, Schedule

Object Definition

{
  "resourceType": "Appointment",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "status": "booked",
  "serviceCategory": [
    {
      "coding": [
        {
          "system": "http://example.org/service-category",
          "code": "gp",
          "display": "General Practice"
        }
      ]
    }
  ],
  "serviceType": [
    {
      "coding": [
        {
          "code": "52",
          "display": "General Discussion"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394814009",
          "display": "General practice"
        }
      ]
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
        "code": "FOLLOWUP",
        "display": "A follow up visit from a previous appointment"
      }
    ]
  },
  "reasonReference": [
    {
      "reference": "Condition/example",
      "display": "Severe burn of left ear"
    }
  ],
  "priority": 5,
  "description": "Discussion on the results of your recent MRI",
  "start": "2013-12-10T09:00:00Z",
  "end": "2013-12-10T11:00:00Z",
  "created": "2013-10-10",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "basedOn": [
    {
      "reference": "ServiceRequest/myringotomy"
    }
  ],
  "participant": [
    {
      "actor": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "ATND"
            }
          ]
        }
      ],
      "actor": {
        "reference": "Practitioner/example",
        "display": "Dr Adam Careful"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Location/1",
        "display": "South Wing, second floor"
      },
      "required": "required",
      "status": "accepted"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeAppointmentThis is a Appointment resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
statuscodeThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
cancelationReasonCodeableConceptThe coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
serviceCategoryCodeableConceptA broad categorization of the service that is to be performed during this appointment.
serviceTypeCodeableConceptThe specific service that is to be performed during this appointment.
specialtyCodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment.
appointmentTypeCodeableConceptThe style of appointment or patient that has been booked in the slot (not service type).
reasonCodeCodeableConceptThe coded reason that this appointment is being scheduled. This is more clinical than administrative.
reasonReferenceReferenceReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
priorityunsignedIntThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
descriptionstringThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
supportingInformationReferenceAdditional information to support the appointment provided when making the appointment.
startinstantDate/Time that the appointment is to take place.
endinstantDate/Time that the appointment is to conclude.
minutesDurationpositiveIntNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
slotReferenceThe slots from the participants' schedules that will be filled by the appointment.
createddateTimeThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
commentstringAdditional comments about the appointment.
patientInstructionstringWhile Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
basedOnReferenceThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
participantBackboneElementList of participants involved in the appointment.
participant.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
participant.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
participant.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
participant.typeCodeableConceptRole of participant in the appointment.
participant.actorReferenceA Person, Location/HealthcareService or Device that is participating in the appointment.
participant.requiredcodeWhether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
participant.statuscodeParticipation status of the actor.
participant.periodPeriodParticipation period of the actor.
requestedPeriodPeriodA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

Extensions

NameURL
APPOINTMENT_MODEhttp://xcaliber-fhir/structureDefinition/appointment-mode
APPOINTMENT_STATUShttp://xcaliber-fhir/structureDefinition/appointment-status
TIME_SLOT_TYPEhttp://xcaliber-fhir/structureDefinition/slot-type
TIME_SLOT_STATUShttp://xcaliber-fhir/structureDefinition/slot-status
REASONhttp://xcaliber-fhir/structureDefinition/appointment-reason
STATUShttp://xcaliber-fhir/structureDefinition/status
TELEHEALTH_DETAILShttp://xcaliber-fhir/structureDefinition/telehealth-details
RECURRING_EVENT_SCHEDULEhttp://xcaliber-fhir/structureDefinition/recurring-event
LAST_MODIFIED_DATEhttp://xcaliber-fhir/structureDefinition/modified-date
DELETED_DATEhttp://xcaliber-fhir/structureDefinition/deleted-date
XCALIBER_ELATION_EXTENSIONhttp://xcaliber-fhir/structureDefinition/elation-appointment
APPOINTMENTCANCELREASONIDhttp://xcaliber-fhir/structureDefinition/cancel-reasonid
APPOINTMENTCOPAYhttp://xcaliber-fhir/structureDefinition/copay
CANCELLEDDATEhttp://xcaliber-fhir/structureDefinition/cancelled-date
CANCELLEDREASONNOSHOWhttp://xcaliber-fhir/structureDefinition/cancelled-reason-no-show
CANCELLEDREASONSLOTAVAILABLEhttp://xcaliber-fhir/structureDefinition/cancelled-reason-slot-available
CANCELLEDBYhttp://xcaliber-fhir/structureDefinition/cancelled-by
COPAYhttp://xcaliber-fhir/structureDefinition/copay
FROZENYNhttp://xcaliber-fhir/structureDefinition/frozen-yn
FROZENhttp://xcaliber-fhir/structureDefinition/frozen
HL7PROVIDERIDhttp://xcaliber-fhir/structureDefinition/hl7-provider-id
NATIVEATHENATELEHEALTHhttp://xcaliber-fhir/structureDefinition/native-athena-telehealth
PATIENThttp://xcaliber-fhir/structureDefinition/patient
PATIENTAPPOINTMENTTYPENAMEhttp://xcaliber-fhir/structureDefinition/type-name
REFERRINGPROVIDERIDhttp://xcaliber-fhir/structureDefinition/referring-provider-id
RENDERINGPROVIDERIDhttp://xcaliber-fhir/structureDefinition/rendering-provider-id
RESCHEDULEDAPPOINTMENTIDhttp://xcaliber-fhir/structureDefinition/rescheduled-id
STARTCHECKINhttp://xcaliber-fhir/structureDefinition/start-checkin
STOPCHECKINhttp://xcaliber-fhir/structureDefinition/stop-checkin
SUPERVISINGPROVIDERIDhttp://xcaliber-fhir/structureDefinition/supervising-provider-id
URGENTYNhttp://xcaliber-fhir/structureDefinition/urgent-yn
DEPARTMENTIDhttp://xcaliber-fhir/structureDefinition/department-id
STATUS_DATEhttp://xcaliber-fhir/structureDefinition/status-date
ROOMhttp://xcaliber-fhir/structureDefinition/room
INSURANCEPLANDISPLAYNAMEhttp://xcaliber-fhir/structureDefinition/insurance-plan-display-name
INSURANCEPOLICYHOLDERADDRESShttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-address
INSURANCEPOLICYHOLDERDOBhttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-dob
INSURANCEPOLICYHOLDERCOUNTRYCODEhttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-country-code
INSURANCEPOLICYHOLDERSEXhttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-sex
INSURANCEPOLICYHOLDERSSNhttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-ssn
INSURANCEPOLICYHOLDERNAMEhttp://xcaliber-fhir/structureDefinition/insurance-policy-holder-name
ADJUSTERFAXhttp://xcaliber-fhir/structureDefinition/adjuster-fax
ADJUSTERNAMEhttp://xcaliber-fhir/structureDefinition/adjuster-name
ADJUSTERPHONEhttp://xcaliber-fhir/structureDefinition/adjuster-phone
ANOTHERPARTYRESPONSIBLEhttp://xcaliber-fhir/structureDefinition/another-party-responsible
AUTOACCIDENTSTATEhttp://xcaliber-fhir/structureDefinition/auto-accident-state
CASEINJURYDATEhttp://xcaliber-fhir/structureDefinition/case-injury-date
CASEPOLICYTYPENAMEhttp://xcaliber-fhir/structureDefinition/case-policy-type-name
CCMSTATUSIDhttp://xcaliber-fhir/structureDefinition/ccm-status-id
CCMSTATUSNAMEhttp://xcaliber-fhir/structureDefinition/ccm-status-name
COINSURANCEPERCENThttp://xcaliber-fhir/structureDefinition/coinsurance-percent
COPAYShttp://xcaliber-fhir/structureDefinition/copays
DESCRIPTIONOFINJURYhttp://xcaliber-fhir/structureDefinition/description-of-injury
ELIGIBILITYLASTCHECKEDhttp://xcaliber-fhir/structureDefinition/eligibility-last-checked
ELIGIBILITYMESSAGEhttp://xcaliber-fhir/structureDefinition/eligibility-message
ELIGIBILITYREASONhttp://xcaliber-fhir/structureDefinition/eligibility-reason
ELIGIBILITYSTATUShttp://xcaliber-fhir/structureDefinition/eligibility-status
EMPLOYERIDhttp://xcaliber-fhir/structureDefinition/employer-id
ENCOUNTER_STATUShttp://xcaliber-fhir/structureDefinition/encounter-status
ENCOUNTERSTATEhttp://xcaliber-fhir/structureDefinition/encounter-state
ICD10CODEShttp://xcaliber-fhir/structureDefinition/icd10codes
ICD9CODEShttp://xcaliber-fhir/structureDefinition/icd9codes
INJUREDBODYPARThttp://xcaliber-fhir/structureDefinition/injured-body-part
INSURANCECLAIMNUMBERhttp://xcaliber-fhir/structureDefinition/insurance-claim-number
INSURANCEPHONEhttp://xcaliber-fhir/structureDefinition/insurance-phone
INSURANCEPRODUCTTYPEhttp://xcaliber-fhir/structureDefinition/insurance-product-type
INSUREDENTITYTYPEIDhttp://xcaliber-fhir/structureDefinition/insured-entity-type-id
INSUREDIDNUMBERhttp://xcaliber-fhir/structureDefinition/insured-id-number
INSUREDPCPhttp://xcaliber-fhir/structureDefinition/insured-pcp
INSUREDPCPNPIhttp://xcaliber-fhir/structureDefinition/insured-pcp-npi
INSUREDREFERRINGPROVIDERhttp://xcaliber-fhir/structureDefinition/insured-referring-provider
IRCIDhttp://xcaliber-fhir/structureDefinition/irc-id
IRCNAMEhttp://xcaliber-fhir/structureDefinition/-irc-name
ISSUEDATEhttp://xcaliber-fhir/structureDefinition/issue-date
NOTEShttp://xcaliber-fhir/structureDefinition/notes
NOTEhttp://xcaliber-fhir/structureDefinition/note
RELATEDTOAUTOACCIDENThttp://xcaliber-fhir/structureDefinition/related-to-auto-accident
RELATEDTOEMPLOYMENThttp://xcaliber-fhir/structureDefinition/related-to-employment
RELATEDTOOTHERACCIDENThttp://xcaliber-fhir/structureDefinition/related-to-other-accident
REPRICERNAMEhttp://xcaliber-fhir/structureDefinition/repricer-name
REPRICERPHONEhttp://xcaliber-fhir/structureDefinition/repricer-phone
SEQUENCENUMBERhttp://xcaliber-fhir/structureDefinition/sequence-number
SLIDINGFEEPLANIDhttp://xcaliber-fhir/structureDefinition/sliding-fee-plan-id
STATEOFREPORTEDINJURYhttp://xcaliber-fhir/structureDefinition/state-of-reported-injury
INSURANCEPACKAGEADDRESShttp://xcaliber-fhir/structureDefinition/insurance-package-address
APPOINTMENTIDhttp://xcaliber-fhir/structureDefinition/appointment-id
PATIENTPAYERhttp://xcaliber-fhir/structureDefinition/patient-payer
TRANSACTIONDETAILShttp://xcaliber-fhir/structureDefinition/transaction-details
TRANSACTIONIDhttp://xcaliber-fhir/structureDefinition/transaction-id
SECONDARYINSURANCEPAYERhttp://xcaliber-fhir/structureDefinition/secondary-insurance-payer
BILLEDPROVIDERIDhttp://xcaliber-fhir/structureDefinition/billed-provider-id
DELETEDDIAGNOSIShttp://xcaliber-fhir/structureDefinition/deleted-diagnosis
ALLOWABLEAMOUNThttp://xcaliber-fhir/structureDefinition/allowable-amount
ALLOWABLEMAXhttp://xcaliber-fhir/structureDefinition/allowable-max
ALLOWABLEMINhttp://xcaliber-fhir/structureDefinition/allowable-min
CHARGEAMOUNThttp://xcaliber-fhir/structureDefinition/charge-amount
SERIESSTARThttp://xcaliber-fhir/structureDefinition/series-start
SERIESSTOPhttp://xcaliber-fhir/structureDefinition/series-stop
PRACTITIONERhttp://xcaliber-fhir/structureDefinition/practitioner
DOWMONDAYhttp://xcaliber-fhir/structureDefinition/dow-mon
DOWTUESDAYhttp://xcaliber-fhir/structureDefinition/dow-tue
DOWWEDNESDAYhttp://xcaliber-fhir/structureDefinition/dow-wed
DOWTHURSDAYhttp://xcaliber-fhir/structureDefinition/dow-thur
DOWFRIDAYhttp://xcaliber-fhir/structureDefinition/dow-fri
DOWSATURDAYhttp://xcaliber-fhir/structureDefinition/dow-sat
DOWSUNDAYhttp://xcaliber-fhir/structureDefinition/dow-sun
CREATEDDATEhttp://xcaliber-fhir/structureDefinition/created-date
REPEATShttp://xcaliber-fhir/structureDefinition/repeats
DESChttp://xcaliber-fhir/structureDefinition/description
CHARGE_ENTRY_NOT_REQUIREDhttp://xcaliber-fhir/structureDefinition/charge-entry-not-required
CHARGE_ENTRY_NOT_REQUIRED_REASONhttp://xcaliber-fhir/structureDefinition/charge-entry-not-required-reason
ENCOUNTER_IDhttp://xcaliber-fhir/structureDefinition/encounter-id
ENCOUNTER_PREPhttp://xcaliber-fhir/structureDefinition/encounter-prep
PATIENT_LOCATION_IDhttp://xcaliber-fhir/structureDefinition/patient-location-id
DISPLAYONSCHEDULEhttp://xcaliber-fhir/structureDefinition/display-on-schedule
NOTELASTMODIFIEDhttp://xcaliber-fhir/structureDefinition/note-last-modified
NOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/note-last-modified-by
NOTEDELETEDhttp://xcaliber-fhir/structureDefinition/note-deleted
NOTEDELETEDBYhttp://xcaliber-fhir/structureDefinition/note-deleted-by
CATEGORYhttp://xcaliber-fhir/structureDefinition/category
DAYOFWEEKIDShttp://xcaliber-fhir/structureDefinition/day-of-week-ids
HOURFROMhttp://xcaliber-fhir/structureDefinition/hour-from
HOURTOhttp://xcaliber-fhir/structureDefinition/hour-to
PRIORITYhttp://xcaliber-fhir/structureDefinition/priority

Operations & APIs

Appointment-GET

Appointment-POST

Appointment ID-GET

Appointment ID-PUT

Appointment ID-DELETE

Appointment Export-POST