UKCoreSlot (Slot) | C | | Slot | There are no (further) constraints on this element Element idSlot Short descriptionA slot of time on a schedule that may be available for booking appointments DefinitionA slot of time on a schedule that may be available for booking appointments.
Data typeSlot Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If 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-4: 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() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() Mappings- rim: Entity. Role, or Act
- rim: n/a
- ical: (refer to the Availability resource for the header mapping details)
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSlot.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSlot.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSlot.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idSlot.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idSlot.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idSlot.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idSlot.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
deliveryChannel | C | 0..1 | Extension(CodeableConcept) | Element idSlot.extension:deliveryChannel Short descriptionAn extension to record the delivery channel of a scheduled Appointment Alternate namesextensions, user content DefinitionAn extension to record the delivery channel of a scheduled Appointment.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSlot.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSlot.identifier Short descriptionExternal Ids for this item DefinitionExternal Ids for this item.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
serviceCategory | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idSlot.serviceCategory Short descriptionA broad categorization of the service that is to be performed during this appointment DefinitionA broad categorization of the service that is to be performed during this appointment.
Data typeCodeableConcept BindingServiceCategory (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idSlot.serviceType Short descriptionThe 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 DefinitionThe 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.
Data typeCodeableConcept BindingServiceType (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
specialty | S Σ | 0..* | CodeableConceptBinding | Element idSlot.specialty Short descriptionThe specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Data typeCodeableConcept BindingAdditional details about where the content was created (e.g. clinical specialty).
UKCorePracticeSettingCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
appointmentType | S Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idSlot.appointmentType Short descriptionThe style of appointment or patient that may be booked in the slot (not service type) DefinitionThe style of appointment or patient that may be booked in the slot (not service type).
Data typeCodeableConcept Bindingv2.0276 (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
schedule | S Σ | 1..1 | Reference(Schedule) | There are no (further) constraints on this element Element idSlot.schedule Short descriptionThe schedule resource that this slot defines an interval of status information DefinitionThe schedule resource that this slot defines an interval of status information.
Data typeReference(Schedule) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
status | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idSlot.status Short descriptionbusy | free | busy-unavailable | busy-tentative | entered-in-error Definitionbusy | free | busy-unavailable | busy-tentative | entered-in-error.
Data typecode BindingThe free/busy status of the slot.
SlotStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- ical: FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
|
start | S Σ | 1..1 | instant | There are no (further) constraints on this element Element idSlot.start Short descriptionDate/Time that the slot is to begin DefinitionDate/Time that the slot is to begin.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.planned
- ical: FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
|
end | S Σ | 1..1 | instant | There are no (further) constraints on this element Element idSlot.end Short descriptionDate/Time that the slot is to conclude DefinitionDate/Time that the slot is to conclude.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.planned
- ical: FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)
|
overbooked | | 0..1 | boolean | There are no (further) constraints on this element Element idSlot.overbooked Short descriptionThis slot has already been overbooked, appointments are unlikely to be accepted for this time DefinitionThis slot has already been overbooked, appointments are unlikely to be accepted for this time.
Meaning when missingIf overbooked is missing, systems may assume that there are still appointments available
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|