Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Slot
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryChannel | 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. | |
identifier | 1..1 | Identifier | External Ids for this item | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Slot | 0..* | Slot | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryChannel | 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 |
schedule | Σ | 1..1 | Reference(Schedule) | 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. |
start | Σ | 1..1 | instant | Date/Time that the slot is to begin |
end | Σ | 1..1 | instant | Date/Time that the slot is to conclude |
Documentation for this format |
Path | Conformance | ValueSet |
Slot.status | required | SlotStatus |
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..* | Slot | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
deliveryChannel | 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: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | 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: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The 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..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: v2 Appointment reason codes (preferred) | ||||
schedule | Σ | 1..1 | Reference(Schedule) | 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. | ||||
start | Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
end | Σ | 1..1 | instant | Date/Time that the slot is to conclude | ||||
overbooked | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | |||||
comment | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Slot.language | extensible | Common Languages
| ||||
Slot.serviceCategory | example | ServiceCategory | ||||
Slot.serviceType | example | ServiceType | ||||
Slot.specialty | preferred | Practice Setting Code Value Set | ||||
Slot.appointmentType | preferred | v2 Appointment reason codes | ||||
Slot.status | required | SlotStatus |
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 Slot
Differential View
This structure is derived from Slot
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryChannel | 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. | |
identifier | 1..1 | Identifier | External Ids for this item | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Slot | 0..* | Slot | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryChannel | 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 |
schedule | Σ | 1..1 | Reference(Schedule) | 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. |
start | Σ | 1..1 | instant | Date/Time that the slot is to begin |
end | Σ | 1..1 | instant | Date/Time that the slot is to conclude |
Documentation for this format |
Path | Conformance | ValueSet |
Slot.status | required | SlotStatus |
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..* | Slot | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
deliveryChannel | 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: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | 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: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The 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..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: v2 Appointment reason codes (preferred) | ||||
schedule | Σ | 1..1 | Reference(Schedule) | 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. | ||||
start | Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
end | Σ | 1..1 | instant | Date/Time that the slot is to conclude | ||||
overbooked | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | |||||
comment | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Slot.language | extensible | Common Languages
| ||||
Slot.serviceCategory | example | ServiceCategory | ||||
Slot.serviceType | example | ServiceType | ||||
Slot.specialty | preferred | Practice Setting Code Value Set | ||||
Slot.appointmentType | preferred | v2 Appointment reason codes | ||||
Slot.status | required | SlotStatus |
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 Slot
Other representations of profile: CSV, Excel, Schematron