1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SlotLiteSe

Official URL: https://fhir.cambio.se/fhir/StructureDefinition/SlotLiteSe/v1 Version:
Active as of 2024-02-29 Computable Name: SlotLiteSe

Introduction

SlotLiteSe is a profile based on the FHIR resource Slot.

Intended Use

SlotLiteSe may be used for getting slots that can be used for booking an appointment.

Specific Rules and Limitations

Type Description
Rule The patient header 'Patient' must be included.
Rule The start and end date range should never exceed one full day

Versions

COS version Profile version Required COSMIC version Date Description
3.0.0 1.0.0 R8.3.05 May 2022 Initial version, support for search.

Extensions

Extension Data type Description
permittedPatientActions Coding Describes what actions the patient have permission for. Never mapped on HealthcareServiceLiteSe. Only available on Appointment.

APIs & Supported Operations

HTTP Method Description
GET Used to search for slots based on a search parameter.

Search Parameters

Parameter Type Mandatory Comment
start date Yes Is used to define start and end of the date range to be searched for. Can be passed multiple times, use operators gt(greater than) and lt(less than) to define the range. Both gt and lt operators must be used, see query example.
healthcareFacility string Yes HSA ID
healthcareService string Yes Internal Id
_profile URL No  
appointmentId string No Internal Id

Note: healthcareFacility, healthcareService and appointmentId are not standard search parameters and cannot be found in the profile.

Supported Queries

GET [baseURL]/Slot/_search?start=gt<start date>&start=lt<end date>&healthcareFacility=<healthcare unit Id>&healthcareService=<Healthcare Service Id>&appointmentId=<appointment Id>

Supported _include params

  • Slot:schedule
  • Slot:schedule.practitioner

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:permittedPatientActions 0..* Coding Use to describe what a patient is permitted to do
URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.
Fixed Value: free
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Slot.statusrequiredFixed Value: free
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: 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()
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()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SlotCoreSe

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... serviceCategory 0..0
... serviceType 0..0
... specialty 0..0
... schedule 1..1 Reference(Schedule) {c} The schedule resource that this slot defines an interval of status information
... status 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Fixed Value: free
... overbooked 0..0
... comment 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:permittedPatientActions 0..* Coding Use to describe what a patient is permitted to do
URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... schedule Σ 1..1 Reference(Schedule) {c} The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.
Fixed Value: free
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Slot.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Slot.statusrequiredFixed Value: free
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: 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()
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()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SlotCoreSe

Summary

Fixed: 1 element
Prohibited: 6 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:permittedPatientActions 0..* Coding Use to describe what a patient is permitted to do
URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.
Fixed Value: free
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Slot.statusrequiredFixed Value: free
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: 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()
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()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from SlotCoreSe

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... serviceCategory 0..0
... serviceType 0..0
... specialty 0..0
... schedule 1..1 Reference(Schedule) {c} The schedule resource that this slot defines an interval of status information
... status 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Fixed Value: free
... overbooked 0..0
... comment 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Slot 0..* SlotCoreSe A slot of time on a schedule that may be available for booking appointments
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:permittedPatientActions 0..* Coding Use to describe what a patient is permitted to do
URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... schedule Σ 1..1 Reference(Schedule) {c} The schedule resource that this slot defines an interval of status information
... status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
Binding: SlotStatus (required): The free/busy status of the slot.
Fixed Value: free
... start Σ 1..1 instant Date/Time that the slot is to begin
... end Σ 1..1 instant Date/Time that the slot is to conclude

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Slot.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Slot.statusrequiredFixed Value: free
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: 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()
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()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SlotCoreSe

Summary

Fixed: 1 element
Prohibited: 6 elements

 

Other representations of profile: CSV, Excel, Schematron