Status: Active: Approved (STU)

Introduction

This profile sets minimum expectations for the Slot resource. A slot of time on a schedule that may be available for booking appointments.

Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time.

Slots can also be marked as busy without having appointments associated.

A slot can have more than one appointment allocated to it. A scheduling system may permit multiple allocations up to a specific number of places. An example of this type of usage could be where the slot is being used for a group service that permits 5 participants at the same time.

If a service had a weekly schedule created that permitted eight 1 hour appointments each day of a working week (Monday - Friday), this would be constructed by a single Schedule resource with the dates for the start and end of the week set, and then 40 (5x8) Slot resources associated with it.

As appointments fill up the schedule, these slots would individually be marked as busy as the appointments are filled into the slots.

The slots in a schedule do not need to be the same size, and can be different for different days of the week.

Mandatory fields

The following mandatory fields are defined:

1. Service Type - The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). We pre-adopt the UKCore value set (based on SNOMED refset 1127531000000102: Services Simple Reference Set) - for consistency with the Encounter, and because it is more relevant than the default FHIR example and also covers social care.

2. Status - this is already mandatory in FHIR. Slots are categorized as free or busy. A free slot on a schedule indicates that the service or resource is available for provision or use during that period of time. A busy slot indicates that the service or resource is not available during the time period, because an appointment has been scheduled. A busy-unavailable slot indicates that a service or resource is unavailable for reasons other than a scheduled appointment.

3. Schedule - 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.

4. Start - Date/Time that the slot is to begin.

5. End - Date/Time that the slot is to conclude.

Must Support fields

In addition the following fields are “Must Support” - ie they must be populated if relevant and known.

1. Delivery Channel (Care Connect Extension) - simple and useful field to indicate whether in-person, telephone, or video.

2. Appointment Type - The style of appointment or patient that may be booked in the slot. In some situations a service may have a specific set of slots reserved for specific uses, such as “walk-ins” or a specific organization has a “standing booking” for Thursday mornings. These should be represented using the appointmentType field with a specified and agreed value. A simple list of codes eg “routine”, “emergency” etc. We add a value for “urgent” to cover scheduled but urgent appointments.

3. Overbooked - A slot can be marked as over-booked indicating that there are too many appointments allocated to it. Default value of ‘false’ is assumed.

4. Specialty - further information which may be useful about the type of specialty required. Knowing the Service Type is probably sufficient for a shared care record, with the Specialty being more relevant to resourcing the correct staff member in a scheduling system. However obviously useful additional information if available. We replace the default FHIR valueset with the list of SDS Job Roles - which appears to be more complete and relevant to the UK, and which offers better coverage of Social Care.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

• Service Category - A general description under broad categorisation of the types of services that is to be performed during this appointment.

• Comment - Comments on the slot to describe any extended information. Such as custom constraints on the slot.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CareConnect-Slot-1

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
extension:deliveryChannel	S	0..1	Extension-CareConnect-DeliveryChannel-1	An extension to record the delivery channel of a scheduled Appointment
serviceCategory		0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	S	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
specialty	S	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
appointmentType	S	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
schedule	S	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	S	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error
start	S	1..1	instant	Date/Time that the slot is to begin
end	S	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
deliveryChannel	S	0..1	code	An extension to record the delivery channel of a scheduled Appointment URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Binding: CareConnect-DeliveryChannel-1 (extensible): A ValueSet that identifies the delivery channel of an Appointment.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External Ids for this item
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	SΣ	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
specialty	SΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
appointmentType	SΣ	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
schedule	SΣ	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	SΣ	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot.
start	SΣ	1..1	instant	Date/Time that the slot is to begin
end	SΣ	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Slot.meta.security	extensible	All Security Labels
Slot.meta.tag	example	Common Tags
Slot.meta.tag:Source	example	Common Tags
Slot.meta.tag:Provenance	example	Common Tags
Slot.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType
Slot.status	required	SlotStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Slot	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Slot	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Slot	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Slot	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	Slot.extension:deliveryChannel	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	Slot.extension:deliveryChannel	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
deliveryChannel	S	0..1	code	An extension to record the delivery channel of a scheduled Appointment URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Binding: CareConnect-DeliveryChannel-1 (extensible): A ValueSet that identifies the delivery channel of an Appointment.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External Ids for this item
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	SΣ	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	SΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
appointmentType	SΣ	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
schedule	SΣ	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	SΣ	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot.
start	SΣ	1..1	instant	Date/Time that the slot is to begin
end	SΣ	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
comment		0..1	string	Comments on the slot to describe any extended information. Such as custom constraints on the slot
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Slot.meta.security	extensible	All Security Labels
Slot.meta.tag	example	Common Tags
Slot.meta.tag:Source	example	Common Tags
Slot.meta.tag:Provenance	example	Common Tags
Slot.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType
Slot.status	required	SlotStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	Slot.extension:deliveryChannel	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	Slot.extension:deliveryChannel	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from CareConnect-Slot-1

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
extension:deliveryChannel	S	0..1	Extension-CareConnect-DeliveryChannel-1	An extension to record the delivery channel of a scheduled Appointment
serviceCategory		0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	S	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
specialty	S	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
appointmentType	S	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
schedule	S	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	S	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error
start	S	1..1	instant	Date/Time that the slot is to begin
end	S	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
deliveryChannel	S	0..1	code	An extension to record the delivery channel of a scheduled Appointment URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Binding: CareConnect-DeliveryChannel-1 (extensible): A ValueSet that identifies the delivery channel of an Appointment.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External Ids for this item
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	SΣ	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
specialty	SΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
appointmentType	SΣ	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
schedule	SΣ	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	SΣ	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot.
start	SΣ	1..1	instant	Date/Time that the slot is to begin
end	SΣ	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Slot.meta.security	extensible	All Security Labels
Slot.meta.tag	example	Common Tags
Slot.meta.tag:Source	example	Common Tags
Slot.meta.tag:Provenance	example	Common Tags
Slot.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType
Slot.status	required	SlotStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Slot	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Slot	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Slot	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	Slot	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	Slot.extension:deliveryChannel	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	Slot.extension:deliveryChannel	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Slot		0..*	CareConnect-Slot-1	A slot of time on a schedule that may be available for booking appointments
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
deliveryChannel	S	0..1	code	An extension to record the delivery channel of a scheduled Appointment URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Binding: CareConnect-DeliveryChannel-1 (extensible): A ValueSet that identifies the delivery channel of an Appointment.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External Ids for this item
serviceCategory	Σ	0..1	CodeableConcept	A broad categorisation of the service that is to be performed during this appointment Binding: Service category (preferred)
serviceType	SΣ	1..*	CodeableConcept	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: Interweave UkCore Care Setting Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	SΣ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: Care Connect SDS Job Role Name (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
appointmentType	SΣ	0..1	CodeableConcept	The style of appointment or patient that may be booked in the slot (not service type) Binding: InterweaveAppointmentType (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
schedule	SΣ	1..1	Reference(CareConnect-Schedule-1)	The schedule resource that this slot defines an interval of status information
status	SΣ	1..1	code	busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot.
start	SΣ	1..1	instant	Date/Time that the slot is to begin
end	SΣ	1..1	instant	Date/Time that the slot is to conclude
overbooked	S	0..1	boolean	if this slot has already been overbooked, appointments are unlikely to be accepted for this time. Default value of 'false' is assumed.
comment		0..1	string	Comments on the slot to describe any extended information. Such as custom constraints on the slot
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Slot.meta.security	extensible	All Security Labels
Slot.meta.tag	example	Common Tags
Slot.meta.tag:Source	example	Common Tags
Slot.meta.tag:Provenance	example	Common Tags
Slot.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Slot.serviceCategory	preferred	ServiceCategory
Slot.serviceType	preferred	Interweave UkCore Care Setting Type
Slot.specialty	preferred	Care Connect SDS Job Role Name
Slot.appointmentType	required	InterweaveAppointmentType
Slot.status	required	SlotStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	Slot.extension:deliveryChannel	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	Slot.extension:deliveryChannel	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CareConnect-Slot-1

Summary

Mandatory: 1 element (15 nested mandatory elements)
Must-Support: 19 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

• CareConnect-Schedule-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Schedule-1)

Slices

This structure defines the following Slices:

• The element Slot.meta.tag is sliced based on the value of value:system