StructureDefinition-UKCore-Schedule

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule1.2.02022-12-16

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.

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
planningHorizonΣ I0..1Period
comment0..1string

Table View

Schedule..
Schedule.identifier..
Schedule.identifier.assignerReference(UK Core Organization)..
Schedule.specialty..
Schedule.actorReference(UK Core Device | UK Core HealthcareService | UK Core Location | UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson)..
Schedule.actor.identifier..
Schedule.actor.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Schedule" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule" />
    <version value="1.2.0" />
    <name value="UKCoreSchedule" />
    <title value="UK Core Schedule" />
    <status value="active" />
    <date value="2022-12-16" />
    <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 &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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" />
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="ical" />
        <uri value="http://ietf.org/rfc/2445" />
        <name value="iCalendar" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Schedule" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" />
    <derivation value="constraint" />
    <differential>
        <element id="Schedule.identifier.assigner">
            <path value="Schedule.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Schedule.specialty">
            <path value="Schedule.specialty" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="Schedule.actor">
            <path value="Schedule.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
        <element id="Schedule.actor.identifier.assigner">
            <path value="Schedule.actor.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Schedule",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule",
    "version": "1.2.0",
    "name": "UKCoreSchedule",
    "title": "UK Core Schedule",
    "status": "active",
    "date": "2022-12-16",
    "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",
    "mapping":  [
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "ical",
            "uri": "http://ietf.org/rfc/2445",
            "name": "iCalendar"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Schedule",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Schedule.identifier.assigner",
                "path": "Schedule.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Schedule.specialty",
                "path": "Schedule.specialty",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "Schedule.actor",
                "path": "Schedule.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            },
            {
                "id": "Schedule.actor.identifier.assigner",
                "path": "Schedule.actor.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Immunization - An example to illustrate a schedule regarding an immunization.
Example UKCore-Schedule-Immunization

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:
idtargetProfile
UKCore-Slothttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization

Example Usage Scenarios

The following are example usage scenarios for the UK Core Schedule profile:

  • Query for details of a schedule
  • Exchange schedule information within a FHIR document or message.

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

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.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
Schedule.specialty Extensible ValueSet UKCore-PracticeSettingCode