Schedule Template Rule Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-schedule-template-rule |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | Schedule (element) |
| Source | FSH · 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.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | One schedule-template rule: which template covers a time range on the days it names |
|---|---|
| Definition | 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.
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. |
| Cardinality | 0..* |
| Invariants | ele-1, ext-1, nexus-schedule-template-rule-days-or-date, nexus-schedule-template-rule-end-after-start, nexus-schedule-template-rule-effective-recurring-only, nexus-schedule-template-rule-interval-needs-start |
Extension.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 3..* |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:daysOfWeek¶
| Short | The weekdays a recurring rule applies on |
|---|---|
| Definition | The weekdays a recurring rule applies on, one code per day. Present on a recurring rule and absent from a dated one: a rule carries this or date, never both. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..* |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:daysOfWeek.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:daysOfWeek.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:daysOfWeek.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | daysOfWeek |
Extension.extension:daysOfWeek.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | code |
| Must Support | yes |
| Binding | days-of-week (required) |
| Invariants | ele-1 |
Extension.extension:date¶
| Short | The one day a dated rule applies on |
|---|---|
| Definition | The one day a dated rule applies on. A dated rule describes that date in full: when any dated rule exists for a date, no recurring rule is applied on it. A rule carries this or daysOfWeek, never both. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:date.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:date.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:date.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | date |
Extension.extension:date.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | date |
| Must Support | yes |
| Invariants | ele-1 |
Extension.extension:start¶
| Short | Clinic-local wall-clock time the rule begins |
|---|---|
| Definition | The time of day the rule begins, in the clinic's time zone. A time of day and not an instant, so it holds across a daylight-saving change. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:start.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:start.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:start.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | start |
Extension.extension:start.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | time |
| Must Support | yes |
| Invariants | ele-1 |
Extension.extension:end¶
| Short | Clinic-local wall-clock time the rule ends; after start |
|---|---|
| Definition | The time of day the rule ends, in the clinic's time zone, after start. Exclusive: 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:end.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:end.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:end.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | end |
Extension.extension:end.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | time |
| Must Support | yes |
| Invariants | ele-1 |
Extension.extension:template¶
| Short | The template that covers the range, coded from the templates value set |
|---|---|
| Definition | The template that covers the range, as one coding from the clinic's stored nexus-schedule-templates value set: a default from nexus-schedule-template, or one of the clinic's own under its own code system. The template's colour, booking limit and booking warning are read from that code's concept in the value set, not from the rule. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:template.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:template.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:template.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | template |
Extension.extension:template.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | Coding |
| Must Support | yes |
| Binding | Schedule Templates (extensible) |
| Invariants | ele-1 |
Extension.extension:effective¶
| Short | The dates a recurring rule applies between; absent means open-ended |
|---|---|
| Definition | The dates a recurring rule applies between, both inclusive. Either bound may be absent: no start means the rule has always applied, no end means it applies until further notice, and no effective at all means both. Only a recurring rule carries it; a dated rule already names its one day. A rule with a weekInterval above 1 needs start. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:effective.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:effective.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:effective.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | effective |
Extension.extension:effective.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | Period |
| Must Support | yes |
| Invariants | ele-1 |
Extension.extension:weekInterval¶
| Short | How many weeks apart a recurring rule applies; absent means every week |
|---|---|
| Definition | How many weeks apart the rule applies: 2 is every other week, 3 every third; absent means every week. Weeks are counted from the week containing effective.start, weeks starting on Monday in the clinic's time zone, and the rule applies on a date whose week count from that week is a multiple of this value. A value above 1 needs effective.start, or there is no week to count from. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:weekInterval.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:weekInterval.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May 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. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:weekInterval.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | weekInterval |
Extension.extension:weekInterval.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 1..1 |
| Type | positiveInt |
| Must Support | yes |
| Invariants | ele-1 |
Extension.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | https://fhir.apps.health/StructureDefinition/nexus-schedule-template-rule |
Extension.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..0 |
| Type | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Invariants | ele-1 |