Athena Core Implementation Guide
5.11.2 - release

Athena Core Implementation Guide - Local Development build (v5.11.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: athenahealth Patient Scheduling Time Window

Official URL: https://fhir.athena.io/StructureDefinition/ah-patient-scheduling-time-window Version: 5.11.2
Active as of 2026-07-07 Computable Name: AthenaPatientSchedulingTimeWindow

An extension containing patient scheduling configuration time-window constraints.

Indicates the constraints around allowable booking and cancellation actions in the time window surrounding the given appointment start time.

Context of Use

This extension may be used on the following element(s):

  • Element ID HealthcareService

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: An extension containing patient scheduling configuration time-window constraints.

  • bookingConstraint: Duration: A duration constraint applied to booking. Use comparator '<' for maximum advance booking window and '>' for minimum lead time before the appointment.
  • rescheduleConstraint: Duration: A duration constraint applied to rescheduling. Use comparator '>' for minimum lead time before the appointment.
  • cancellationConstraint: Duration: A duration constraint applied to cancellation. Use comparator '>' for minimum lead time before the appointment.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Patient Scheduling Time Window
... Slices for extension Content/Rules for all slices
.... extension:bookingConstraint 0..* Extension Time constraint for booking
..... extension 0..0 Extension
..... url 1..1 uri "bookingConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:rescheduleConstraint 0..* Extension Time constraint for rescheduling
..... extension 0..0 Extension
..... url 1..1 uri "rescheduleConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:cancellationConstraint 0..* Extension Time constraint for cancellation
..... extension 0..0 Extension
..... url 1..1 uri "cancellationConstraint"
..... value[x] 0..1 Duration Value of extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-patient-scheduling-time-window"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Patient Scheduling Time Window
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:bookingConstraint 0..* Extension Time constraint for booking
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "bookingConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:rescheduleConstraint 0..* Extension Time constraint for rescheduling
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "rescheduleConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:cancellationConstraint 0..* Extension Time constraint for cancellation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "cancellationConstraint"
..... value[x] 0..1 Duration Value of extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-patient-scheduling-time-window"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: An extension containing patient scheduling configuration time-window constraints.

  • bookingConstraint: Duration: A duration constraint applied to booking. Use comparator '<' for maximum advance booking window and '>' for minimum lead time before the appointment.
  • rescheduleConstraint: Duration: A duration constraint applied to rescheduling. Use comparator '>' for minimum lead time before the appointment.
  • cancellationConstraint: Duration: A duration constraint applied to cancellation. Use comparator '>' for minimum lead time before the appointment.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Patient Scheduling Time Window
... Slices for extension Content/Rules for all slices
.... extension:bookingConstraint 0..* Extension Time constraint for booking
..... extension 0..0 Extension
..... url 1..1 uri "bookingConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:rescheduleConstraint 0..* Extension Time constraint for rescheduling
..... extension 0..0 Extension
..... url 1..1 uri "rescheduleConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:cancellationConstraint 0..* Extension Time constraint for cancellation
..... extension 0..0 Extension
..... url 1..1 uri "cancellationConstraint"
..... value[x] 0..1 Duration Value of extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-patient-scheduling-time-window"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Patient Scheduling Time Window
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:bookingConstraint 0..* Extension Time constraint for booking
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "bookingConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:rescheduleConstraint 0..* Extension Time constraint for rescheduling
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "rescheduleConstraint"
..... value[x] 0..1 Duration Value of extension
.... extension:cancellationConstraint 0..* Extension Time constraint for cancellation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "cancellationConstraint"
..... value[x] 0..1 Duration Value of extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-patient-scheduling-time-window"

doco Documentation for this format

 

​Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()