Schedule Templates Value set¶
| Canonical | https://fhir.apps.health/ValueSet/nexus-schedule-templates |
|---|---|
| Status | draft · 1.33.0 |
| Source | FSH · JSON |
The schedule templates a schedule's rules may name, bound extensible from the template of the
nexus-schedule-template-rule extension on Schedule. A slot does not carry its template.
Lists the default templates from the nexus-schedule-template code system. Each concept carries the
template's properties as the extensions nexus-schedule-template-booking-limit,
nexus-schedule-template-colour and nexus-schedule-template-booking-warning, on its compose
concept and on its expansion entry. Each extension's own definition states its meaning, range and
what its absence means.
Where a client reads them. Each clinic holds this value set in its own FHIR store, so a booking
surface lists the templates and reads their properties from the stored expansion, found with
ValueSet?url=.
The clinic owns its copy. The four defaults seed every clinic's store. A clinic may change a default's name, colour, limit or warning, and add or remove templates; re-seeding only adds back a default code that is missing, and never rewrites or removes what the clinic holds.
A clinic's own templates go in a second compose.include on its stored value set, under a code
system of its own, each concept carrying the same three extensions:
https://fhir.apps.health/CodeSystem/<tenant-id>-schedule-template
<tenant-id> is the clinic's tenant id, so two clinics using the same letter do not collide. It must
be stable over time: change it and rules already coded under it stop matching. This is a documented
convention, not an artifact this guide publishes: the code system belongs to the clinic that minted
it, so there is one per clinic and none could be declared centrally. The binding is extensible, so
a rule may name these codes.
A rule naming one of the clinic's own templates names a code outside the set published here. Under the extensible binding a validator reports that as a warning, not an error.
A reader meeting an unfamiliar code writes it back unchanged.
Codes from Schedule Template CodeSystem¶
| Code | Display | Definition |
|---|---|---|
B | Blocked | Time no appointment may be booked into. |
S | Same Day | Time kept for appointments booked on the day. |
P | Physical | Time kept for one in-person appointment. |
V | Virtual | Time kept for virtual appointments. |