0.1.0 - ci-build
PatientScheduling - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| Appointment Coordination Appointment |
A patient-facing representation of an appointment used for coordination workflows (transportation, forms, etc.). This profile supports two creation patterns: 1) Manual appointments created by patients/caregivers (Appointment.slot may be absent). 2) Appointments derived from scheduling publishers (Appointment.slot SHOULD be present when known). |
| Appointment Coordination Location |
A Location used in SMART Scheduling Links workflows and downstream coordination (e.g., transportation). This profile keeps location requirements light to enable broad adoption while supporting practical consumer needs (display + routing). |
| Appointment Coordination Schedule |
A Schedule used for publishing availability in SMART Scheduling Links workflows. This profile is intentionally flexible: schedule actor(s) may include practitioners, roles, services, locations, and/or organizations depending on publisher capabilities. |
| Appointment Coordination Slot |
A Slot used for publishing discrete availability windows in SMART Scheduling Links workflows. Slots reference a Schedule and carry the time window and free/busy status. |
| Appointment Coordination Task |
A Task used by patient-facing applications to coordinate activities related to an appointment, including booking, transportation, and completion of forms. Task.code indicates the type of coordination task. Task.status represents the lifecycle state of the task. Task.businessStatus represents the business outcome for task types where an outcome is applicable (e.g., booking attempts). Task.intent is fixed to 'order' to indicate the task is actionable/authorized to proceed in the context of the patient-facing application (not a clinician order). Task.requester and Task.owner may reference the Patient, a RelatedPerson (caregiver), or an Organization representing the patient-facing application/platform. |
| SMART Healthcare Service |
This profile sets minimum expectations for the Healthcare Service resource to enable SMART Schedule Links use cases |
| SMART Location |
This profile sets minimum expectations for the Location resource to enable SMART Schedule Links use cases |
| SMART Practitioner |
This profile sets minimum expectations for the Practitioner resource to enable SMART Schedule Links use cases |
| SMART PractitionerRole |
This profile sets minimum expectations for the PractitionerRole resource to enable SMART Schedule Links use cases |
| SMART Schedule |
This profile sets minimum expectations for the Schedule resource to enable SMART Schedule Links use cases |
| Virtual Location |
This profile sets minimum expectations for the Virtual Location resource to enable SMART Schedule Links use cases |
These define sets of codes used by systems conforming to this implementation guide.
| Appointment Booking Outcome ValueSet |
Allowed booking outcome values for AppointmentCoordinationTask.businessStatus. |
| Appointment Coordination Task Type ValueSet |
Allowed task types for AppointmentCoordinationTask.code. |
| Common Service Types for Scheduling |
A subset of the HL7 service-type codes and possibly other code systems
to illustrate the more common service types that patients may
want to schedule appointments for. Ideally, this would be based on utilization
data and usually 1:1 with serviceType:schedule if the procedures can be performed
independently of each other (e.g. 2 x-ray machines, 2 CT machines, 3 MRI machines and the
schedule represents a pool of image technicians that can perform any of these procedures,
but are limited by the actual, physical machines). These also may likely be more limited by
both the technician/practitioner and the physical machine. |
These define new code systems used by systems conforming to this implementation guide.
| Appointment Booking Outcome |
Business outcome of an appointment booking attempt. |
| Appointment Coordination Task Type |
Task types used to classify coordination work related to appointments. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| AnnualWellnessVisit |
Annual wellness visit |
| BerkshireFamilyMedicine |
Primary care clinic located in downtown Pittsfield |
| BrianKFungPharmD |
Pharmacist |
| BrianKFungPharmDRole |
Pharmacist Role |
| BrianLBachelderMD |
Emergency Medicine Physician |
| BrianLBachelderMDRole |
Emergency Medicine Physician Role |
| DiagnosticRadiology |
Diagnostic Radiology/Xray/CT/Fluroscopy services at Outpatient Radiology Services. |
| ExampleAppointmentBooked |
Primary care visit |
| ExampleClinicLocation | |
| ExamplePatientJaneDoe | |
| ExampleSchedulePrimaryCare | |
| ExampleSlot2026Jan12_0900 | |
| ExampleTaskBookAppointmentCompleted | |
| FamilyMedicinePractice |
Family medicine clinic that offers in-person visits and virtual |
| FlynnsPharmacy |
Located behind old Berkshire Bank building |
| HybridInPersonAndVirtualScheduleWithPractitioner |
Visits offered both in-person and virtual with Dr. John Robert Smith. |
| InPersonScheduleWithPractitioner |
In-person visits at Berkshire Family Medicine with Dr. John Robert Smith (via PractitionerRole). |
| JohnRobertSmithMD | |
| JohnRobertSmithMDRole | |
| MRI |
MRI services at Outpatient Radiology Services. |
| MRIRadiology |
MRI Radiology |
| NancyRomeroFernandezAPRN |
Family Nurse Practitioner |
| NancyRomeroFernandezAPRNRole | |
| OutpatientRadiologyServices |
An outpatient radiology services location |
| Ultrasound |
Ultrasound services at Outpatient Radiology Services. |
| UltrasoundRadiology |
Ultrasound Radiology |
| VirtualLocationExample |
Primary care clinic located in downtown Pittsfield |
| VirtualSchedule |