Skip to content

Schedule Template Rule Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-schedule-template-rule
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextSchedule (element)
SourceFSH · JSON

One rule of a provider's schedule templates, carried on the Schedule: which template covers a time range on the days the rule names. A schedule carries one extension per rule.

Overview

Two kinds of rule. A recurring rule names in daysOfWeek the weekdays it applies on, and may name in effective the dates it applies between; with no effective it is open-ended. A dated rule names its one day in date. A rule carries daysOfWeek or date, never both.

A rule may apply on alternate weeks. weekInterval says how many weeks apart a recurring rule applies; how the weeks are counted is stated on that element.

A dated rule describes its date in full. When any dated rule exists for a date, the recurring rules are not applied on that date: the dated rules alone say what covers it. This is how a schedule assigns a whole day at once, and it keeps the reading a per-date entry has in the scheduling systems these rules are drawn from, where one scheduledate row assigns the whole day.

Rules on one day must not overlap in time. A writer keeps them apart. A reader that meets overlapping rules shows all of them rather than choosing between them, so the overlap is seen and corrected instead of hidden. The range is half-open: a rule ending at 12:00 covers up to but not including 12:00, so a rule starting at 12:00 on the same day does not overlap it.

Times are clinic-local wall-clock times. start and end are times of day in the clinic's time zone, not instants, so a rule stays put across a daylight-saving change: 09:00 is 09:00 on every day the rule applies. A reader placing a rule on a day resolves it in the clinic's time zone.

The rules describe templates only. They are not availability. Bookable time is still the Schedule's Slots. Nothing about Slot, free/busy, Slot.appointmentType or Schedule.actor changes with this extension. A slot does not carry its template: Slot.serviceType keeps its delivery-mode and raw source codings and is not bound to the templates value set, and which template covers a slot is read from these rules.

A template's attributes still come from the value set. The rule names a template by its coding; its colour, booking limit and booking warning are read from that code's concept in the clinic's stored nexus-schedule-templates value set and are never repeated on the rule.

Terminology bindings

Path Strength Value set
Extension.extension.value[x] required days-of-week
Extension.extension.value[x] extensible Schedule Templates