Canonical_URL | Current_Version | Last_Updated | Description |
---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule | 1.3.0 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource Schedule. |
Profile_Purpose |
---|
Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked. The schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available. |
UKCoreSchedule (Schedule) | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | S Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 0..* | CodeableConcept |
serviceType | Σ | 0..* | CodeableConcept |
specialty | S Σ | 0..* | CodeableConceptBinding |
actor | S Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
planningHorizon | S Σ I | 0..1 | Period |
comment | 0..1 | string |
UKCoreSchedule (Schedule) | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | S Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 0..* | CodeableConcept |
serviceType | Σ | 0..* | CodeableConcept |
specialty | S Σ | 0..* | CodeableConceptBinding |
actor | S Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
planningHorizon | S Σ I | 0..1 | Period |
comment | 0..1 | string |
UKCoreSchedule (Schedule) | I | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | S Σ ?! | 0..1 | boolean |
serviceCategory | Σ | 0..* | CodeableConcept |
serviceType | Σ | 0..* | CodeableConcept |
specialty | S Σ | 0..* | CodeableConceptBinding |
actor | S Σ I | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) |
planningHorizon | S Σ I | 0..1 | Period |
comment | 0..1 | string |
Schedule | 0..* | |
Schedule.id | string | 0..1 |
Schedule.meta | Meta | 0..1 |
Schedule.implicitRules | uri | 0..1 |
Schedule.language | code | 0..1 |
Schedule.text | Narrative | 0..1 |
Schedule.contained | Resource | 0..* |
Schedule.extension | Extension | 0..* |
Schedule.modifierExtension | Extension | 0..* |
Schedule.identifier | Identifier | 0..* |
Schedule.active | boolean | 0..1 |
Schedule.serviceCategory | CodeableConcept | 0..* |
Schedule.serviceType | CodeableConcept | 0..* |
Schedule.specialty | CodeableConcept | 0..* |
Schedule.actor | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 1..* |
Schedule.planningHorizon | Period | 0..1 |
Schedule.comment | string | 0..1 |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Schedule" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule" /> <version value="1.3.0" /> <name value="UKCoreSchedule" /> <title value="UK Core Schedule" /> <status value="active" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Schedule](https://hl7.org/fhir/R4/Schedule.html)." /> <purpose value="Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Schedule" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" /> <derivation value="constraint" /> <snapshot> <element id="Schedule"> <path value="Schedule" /> <short value="A container for slots of time that may be available for booking appointments" /> <definition value="A container for slots of time that may be available for booking appointments." /> <alias value="Availability" /> <min value="0" /> <max value="*" /> <base> <path value="Schedule" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" /> <expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" /> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." /> </extension> <key value="dom-6" /> <severity value="warning" /> <human value="A resource should have narrative for robust management" /> <expression value="text.`div`.exists()" /> <xpath value="exists(f:text/h:div)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-5" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a security label" /> <expression value="contained.meta.security.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:security))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="ical" /> <map value="BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)" /> </mapping> </element> <element id="Schedule.id"> <path value="Schedule.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isSummary value="true" /> </element> <element id="Schedule.meta"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Schedule.implicitRules"> <path value="Schedule.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." /> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Schedule.language"> <path value="Schedule.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Schedule.text"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." /> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="Schedule.contained"> <path value="Schedule.contained" /> <short value="Contained, inline Resources" /> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." /> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Schedule.extension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. 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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Schedule.modifierExtension"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.modifierExtension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="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." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Schedule.identifier"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.identifier" /> <short value="External Ids for this item" /> <definition value="External Ids for this item." /> <min value="0" /> <max value="*" /> <base> <path value="Schedule.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" /> </mapping> <mapping> <identity value="rim" /> <map value="II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" /> </mapping> <mapping> <identity value="servd" /> <map value="Identifier" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="ical" /> <map value="UID" /> </mapping> </element> <element id="Schedule.active"> <path value="Schedule.active" /> <short value="Whether this schedule is in active use" /> <definition value="Whether this schedule record is in active use or should not be used (such as was entered in error)." /> <comment value="This element is labeled as a modifier because it may be used to mark that the resource was created in error." /> <min value="0" /> <max value="1" /> <base> <path value="Schedule.active" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <meaningWhenMissing value="This resource is generally assumed to be active if no value is provided for the active element" /> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> </element> <element id="Schedule.serviceCategory"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.serviceCategory" /> <short value="High-level category" /> <definition value="A broad categorization of the service that is to be performed during this appointment." /> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." /> <min value="0" /> <max value="*" /> <base> <path value="Schedule.serviceCategory" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="service-category" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/service-category" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> </element> <element id="Schedule.serviceType"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.serviceType" /> <short value="Specific service" /> <definition value="The specific service that is to be performed during this appointment." /> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." /> <min value="0" /> <max value="*" /> <base> <path value="Schedule.serviceType" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="service-type" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/service-type" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="ical" /> <map value="n/a" /> </mapping> </element> <element id="Schedule.specialty"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.specialty" /> <short value="Type of specialty needed" /> <definition value="The specialty of a practitioner that would be required to perform the service requested in this appointment." /> <comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." /> <min value="0" /> <max value="*" /> <base> <path value="Schedule.specialty" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="specialty" /> </extension> <strength value="extensible" /> <description value="Additional details about where the content was created (e.g. clinical specialty)." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="CE/CNE/CWE" /> </mapping> <mapping> <identity value="rim" /> <map value="CD" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> </element> <element id="Schedule.actor"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.actor" /> <short value="Resource(s) that availability information is being provided for" /> <definition value="Slots that reference this schedule resource provide the availability details to these referenced resource(s)." /> <comment value="The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system." /> <min value="1" /> <max value="*" /> <base> <path value="Schedule.actor" /> <min value="1" /> <max value="*" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ref-1" /> <severity value="error" /> <human value="SHALL have a contained resource if a local reference is provided" /> <expression value="reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))" /> <xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Reference" /> </constraint> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject[x]" /> </mapping> <mapping> <identity value="ical" /> <map value="ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.subject" /> </mapping> </element> <element id="Schedule.planningHorizon"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <path value="Schedule.planningHorizon" /> <short value="Period of time covered by schedule" /> <definition value="The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates." /> <comment value="A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration)." /> <min value="0" /> <max value="1" /> <base> <path value="Schedule.planningHorizon" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="per-1" /> <severity value="error" /> <human value="If present, start SHALL have a lower value than end" /> <expression value="start.hasValue().not() or end.hasValue().not() or (start <= end)" /> <xpath value="not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))" /> <source value="http://hl7.org/fhir/StructureDefinition/Period" /> </constraint> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="v2" /> <map value="DR" /> </mapping> <mapping> <identity value="rim" /> <map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.planned" /> </mapping> <mapping> <identity value="ical" /> <map value="DTSTART:20131201T003000Z DTEND:2014030101T003000Z" /> </mapping> </element> <element id="Schedule.comment"> <path value="Schedule.comment" /> <short value="Comments on availability" /> <definition value="Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated." /> <comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" /> <min value="0" /> <max value="1" /> <base> <path value="Schedule.comment" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> <mapping> <identity value="ical" /> <map value="COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry" /> </mapping> </element> </snapshot> <differential> <element id="Schedule.active"> <path value="Schedule.active" /> <mustSupport value="true" /> </element> <element id="Schedule.specialty"> <path value="Schedule.specialty" /> <mustSupport value="true" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" /> </binding> </element> <element id="Schedule.actor"> <path value="Schedule.actor" /> <mustSupport value="true" /> </element> <element id="Schedule.planningHorizon"> <path value="Schedule.planningHorizon" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "UKCore-Schedule", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule", "version": "1.3.0", "name": "UKCoreSchedule", "title": "UK Core Schedule", "status": "active", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Schedule](https://hl7.org/fhir/R4/Schedule.html).", "purpose": "Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked.\n\nThe schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Schedule", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule", "derivation": "constraint", "snapshot": { "element": [ { "id": "Schedule", "path": "Schedule", "short": "A container for slots of time that may be available for booking appointments", "definition": "A container for slots of time that may be available for booking appointments.", "alias": [ "Availability" ], "min": 0, "max": "*", "base": { "path": "Schedule", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" }, { "identity": "ical", "map": "BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)" } ] }, { "id": "Schedule.id", "path": "Schedule.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isSummary": true }, { "id": "Schedule.meta", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Schedule.implicitRules", "path": "Schedule.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Schedule.language", "path": "Schedule.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Schedule.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Schedule.contained", "path": "Schedule.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Schedule.extension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Schedule.modifierExtension", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "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.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Schedule.identifier", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.identifier", "short": "External Ids for this item", "definition": "External Ids for this item.", "min": 0, "max": "*", "base": { "path": "Schedule.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "ical", "map": "UID" } ] }, { "id": "Schedule.active", "path": "Schedule.active", "short": "Whether this schedule is in active use", "definition": "Whether this schedule record is in active use or should not be used (such as was entered in error).", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "min": 0, "max": "1", "base": { "path": "Schedule.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "FiveWs.status" } ] }, { "id": "Schedule.serviceCategory", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.serviceCategory", "short": "High-level category", "definition": "A broad categorization of the service that is to be performed during this appointment.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "Schedule.serviceCategory", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-category" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.class" } ] }, { "id": "Schedule.serviceType", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.serviceType", "short": "Specific service", "definition": "The specific service that is to be performed during this appointment.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "Schedule.serviceType", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-type" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "ical", "map": "n/a" } ] }, { "id": "Schedule.specialty", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.specialty", "short": "Type of specialty needed", "definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "Schedule.specialty", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "specialty" } ], "strength": "extensible", "description": "Additional details about where the content was created (e.g. clinical specialty).", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.class" } ] }, { "id": "Schedule.actor", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.actor", "short": "Resource(s) that availability information is being provided for", "definition": "Slots that reference this schedule resource provide the availability details to these referenced resource(s).", "comment": "The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.", "min": 1, "max": "*", "base": { "path": "Schedule.actor", "min": 1, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "ical", "map": "ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "id": "Schedule.planningHorizon", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "path": "Schedule.planningHorizon", "short": "Period of time covered by schedule", "definition": "The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Schedule.planningHorizon", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)", "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "w5", "map": "FiveWs.planned" }, { "identity": "ical", "map": "DTSTART:20131201T003000Z DTEND:2014030101T003000Z" } ] }, { "id": "Schedule.comment", "path": "Schedule.comment", "short": "Comments on availability", "definition": "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Schedule.comment", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "ical", "map": "COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry" } ] } ] }, "differential": { "element": [ { "id": "Schedule.active", "path": "Schedule.active", "mustSupport": true }, { "id": "Schedule.specialty", "path": "Schedule.specialty", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" } }, { "id": "Schedule.actor", "path": "Schedule.actor", "mustSupport": true }, { "id": "Schedule.planningHorizon", "path": "Schedule.planningHorizon", "mustSupport": true } ] } }
The following are example usage scenarios for the UK Core Schedule profile:
The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.
Element | Reason |
---|---|
Schedule.active |
Whether this schedule is in active use. |
Schedule.specialty |
Type of specialty needed. |
Schedule.actor |
Resource(s) that availability information is being provided for. |
Schedule.planningHorizon |
Period of time covered by schedule. |
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
Schedule.specialty | Extensible | ValueSet UKCore-PracticeSettingCode |
actor
The resource being referenced SHOULD conform to one of the following: