Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectSlot1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Slot-1 Version: 0.1.0
Draft as of 2018-09-27 Computable Name: CareConnect-Slot-1

Copyright/Legal: Copyright © 2020 NHS Digital

CareConnectSlot profile.

NOT CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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.

... identifier 1..1IdentifierExternal Ids for this item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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.


... identifier Σ1..1IdentifierExternal Ids for this item
... schedule Σ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status Σ1..1codebusy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.

... start Σ1..1instantDate/Time that the slot is to begin
... end Σ1..1instantDate/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Slot.statusrequiredSlotStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorSlotIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-1errorSlot.extension:deliveryChannelAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorSlot.extension:deliveryChannelMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe 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: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred): Additional details about where the content was created (e.g. clinical specialty).


... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that may be booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
... schedule Σ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status Σ1..1codebusy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.

... start Σ1..1instantDate/Time that the slot is to begin
... end Σ1..1instantDate/Time that the slot is to conclude
... overbooked 0..1booleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1stringComments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Slot.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Slot.serviceCategoryexampleServiceCategory
Slot.serviceTypeexampleServiceType
Slot.specialtypreferredPractice Setting Code Value Set
Slot.appointmentTypepreferredv2 Appointment reason codes
Slot.statusrequiredSlotStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorSlot.extension:deliveryChannelAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorSlot.extension:deliveryChannelMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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.

... identifier 1..1IdentifierExternal Ids for this item

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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.


... identifier Σ1..1IdentifierExternal Ids for this item
... schedule Σ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status Σ1..1codebusy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.

... start Σ1..1instantDate/Time that the slot is to begin
... end Σ1..1instantDate/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Slot.statusrequiredSlotStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorSlotIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf 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-4errorSlotIf 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-1errorSlot.extension:deliveryChannelAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorSlot.extension:deliveryChannelMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..*SlotA slot of time on a schedule that may be available for booking appointments
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... deliveryChannel 0..1codeAn 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..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe 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: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred): Additional details about where the content was created (e.g. clinical specialty).


... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that may be booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
... schedule Σ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status Σ1..1codebusy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.

... start Σ1..1instantDate/Time that the slot is to begin
... end Σ1..1instantDate/Time that the slot is to conclude
... overbooked 0..1booleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1stringComments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Slot.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Slot.serviceCategoryexampleServiceCategory
Slot.serviceTypeexampleServiceType
Slot.specialtypreferredPractice Setting Code Value Set
Slot.appointmentTypepreferredv2 Appointment reason codes
Slot.statusrequiredSlotStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorSlot.extension:deliveryChannelAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorSlot.extension:deliveryChannelMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron