Profile: GPConnect-Slot-1
GPConnect-Slot-1 (Slot) | C | Slot | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
deliveryChannel | S C | 0..1 | Extension(code) |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..0 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..0 | Period |
assigner | Σ | 0..0 | Reference(Organization) |
serviceCategory | Σ | 0..0 | CodeableConcept |
serviceType | Σ | 0..* | CodeableConcept |
specialty | Σ | 0..1 | CodeableConceptBinding |
appointmentType | Σ | 0..0 | CodeableConceptBinding |
schedule | Σ | 1..1 | Reference(GPConnect-Schedule-1) |
id | 0..1 | string | |
extension | 0..* | Extension | |
reference | Σ C | 1..1 | string |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
status | Σ | 1..1 | codeBinding |
start | Σ | 1..1 | instant |
end | Σ | 1..1 | instant |
overbooked | 0..1 | boolean | |
comment | 0..1 | string |
Slot | |||
Short | A slot of time on a schedule that may be available for booking appointments | ||
Definition | A slot of time on a schedule that may be available for booking appointments. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
Slot.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
Slot.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Slot.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
Slot.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
Comments | Language 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). | ||
Slot.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained 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 in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
Slot.contained | |||
Short | Contained, inline Resources | ||
Definition | These 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. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This 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. | ||
Mappings |
| ||
Slot.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There 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. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
Slot.extension:deliveryChannel | |||
Short | An extension to record the delivery channel of a scheduled Appointment | ||
Definition | An extension to record the delivery channel of a scheduled Appointment. | ||
Cardinality | 0..1 | ||
Type | Extension(code) | ||
Must Support | True | ||
Alias | extensions, user content | ||
Comments | There 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Slot.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May 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. Usually modifier elements provide negation or qualification. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Comments | There 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. | ||
Mappings |
| ||
Slot.identifier | |||
Short | External Ids for this item | ||
Definition | External Ids for this item. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Mappings |
| ||
Slot.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Slot.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Slot.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..0 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
Slot.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
Slot.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Slot.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||
Examples | General123456 | ||
Mappings |
| ||
Slot.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..0 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Slot.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..0 | ||
Type | Reference(Organization) | ||
Summary | True | ||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
Mappings |
| ||
Slot.serviceCategory | |||
Short | A broad categorisation of the service that is to be performed during this appointment | ||
Definition | A broad categorisation of the service that is to be performed during this appointment. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Mappings |
| ||
Slot.serviceType | |||
Short | 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 | ||
Definition | 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. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Mappings |
| ||
Slot.specialty | |||
Short | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Additional details about where the content was created (e.g. clinical specialty). | ||
Summary | True | ||
Mappings |
| ||
Slot.appointmentType | |||
Short | The style of appointment or patient that may be booked in the slot (not service type) | ||
Definition | The style of appointment or patient that may be booked in the slot (not service type). | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Mappings |
| ||
Slot.schedule | |||
Short | The schedule resource that this slot defines an interval of status information | ||
Definition | The schedule resource that this slot defines an interval of status information. | ||
Cardinality | 1..1 | ||
Type | Reference(GPConnect-Schedule-1) | ||
Summary | True | ||
Slot.schedule.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Slot.schedule.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
Slot.schedule.reference | |||
Short | Literal reference, Relative, internal or absolute URL | ||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ref-1 | ||
Examples | GeneralSchedule/b57e1f37-e88e-43ad-a9e9-79eeed7531dd | ||
Mappings |
| ||
Slot.schedule.identifier | |||
Short | Logical reference, when literal reference is not known | ||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||
Mappings |
| ||
Slot.schedule.display | |||
Short | Text alternative for the resource | ||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
Examples | GeneralAppointment Schedule - Out of Hours GP Clinic | ||
Mappings |
| ||
Slot.status | |||
Short | busy | free | busy-unavailable | busy-tentative | entered-in-error | ||
Definition | busy | free | busy-unavailable | busy-tentative | entered-in-error. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The free/busy status of the slot. | ||
Summary | True | ||
Examples | Generalfree | ||
Mappings |
| ||
Slot.start | |||
Short | Date/Time that the slot is to begin | ||
Definition | Date/Time that the slot is to begin. | ||
Cardinality | 1..1 | ||
Type | instant | ||
Summary | True | ||
Mappings |
| ||
Slot.end | |||
Short | Date/Time that the slot is to conclude | ||
Definition | Date/Time that the slot is to conclude. | ||
Cardinality | 1..1 | ||
Type | instant | ||
Summary | True | ||
Mappings |
| ||
Slot.overbooked | |||
Short | This slot has already been overbooked, appointments are unlikely to be accepted for this time | ||
Definition | This slot has already been overbooked, appointments are unlikely to be accepted for this time. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Meaning when missing | If overbooked is missing, systems may assume that there are still appointments available | ||
Slot.comment | |||
Short | Comments on the slot to describe any extended information. Such as custom constraints on the slot | ||
Definition | Comments on the slot to describe any extended information. Such as custom constraints on the slot. | ||
Cardinality | 0..1 | ||
Type | string | ||
Examples | GeneralThis slot is only to be used for Out of Hours GP Clinic appointments. |
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
id | |||
meta.versionId | |||
meta.lastUpdated | |||
meta.profile | |||
meta.security | |||
meta.tag | |||
extension(deliveryChannel) | |||
identifier | |||
serviceType | |||
specialty | |||
schedule | |||
status | |||
start | |||
end | |||
overbooked | |||
comment |
id
Usage
Mandatory
Guidance
The id
is the logical identifier for the GPConnect-Slot-1
profile.
Example
<id value="148" />
meta.VersionId
Usage
Optional
Guidance
The population of the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.
Example
<meta> <versionId value="1503310820000" /> </meta>
meta.lastUpdated
Usage
Optional
Guidance
The meta.lastUpdated
element could be useful alongside the meta.versionId
element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.
Example
<meta> <lastUpdated value="2022-10-28T08:06:00+00:00" /> </meta>
meta.profile
Usage
Mandatory
Guidance
The meta.profile
contains a fixed value of the URL for the GPConnect-Slot-1
profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Slot-1" /> </meta>
meta.security
Usage
Optional
Guidance
The security label(s) applicable to the resource.
See Resources not to be disclosed to a patient for more details on how to populate the element.
Example
<meta> <security> <system value="http://hl7.org/fhir/v3/ActCode"/> <code value="NOPAT"/> <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/> </security> </meta>
meta.tag
Usage
Optional
Guidance
A use-case for the meta.tag
element within GP Connect has not been defined.
Example
<meta> <tag> <coding> <system value="http://hl7.org/fhir/common-tags" /> <code value="actionable" /> <display value="Actionable" /> </coding> </tag> </meta>
extension(deliveryChannel)
Usage
Required
Guidance
An extension to record the delivery channel of a scheduled Appointment.
Example
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-GPConnect-DeliveryChannel-2"> <deliveryChannel> <code value="In-Person" /> <display value="In-Person" /> </deliveryChannel> </extension>
identifier
Usage
Mandatory
Guidance
All relevant external identifier details for the slot where available.
Example
</text> <identifier> <system value="http://example.org/identifiers/slots"/> <value value="123132"/> </identifier>
serviceType
Usage
Optional
Guidance
Populated with the practice defined slot type description.
Example
<serviceType> <text value="General GP Appointment"/> </serviceType>
specialty
Usage
Optional
Guidance
The speciality of the practitioner that would be required to perform the service requested in this appointment.
Example
<specialty> <coding> <system value="http://example.org/specialty"/> <code value="gp"/> <display value="General Practice"/> </coding> </specialty>
schedule
Usage
Mandatory
Guidance
The schedule resource that this slot defines an interval of status information.
Example
<Schedule> <reference value="Schedule/example"/> </Schedule>
status
Usage
Mandatory
Guidance
The availability status of the slot.
Example
<status value="Free" />
start
Usage
Mandatory
Guidance
The time the slot is to begin, in UK local time in the format yyyy-mm-ddThh:mm:ss+hh:mm
with the timezone offset +00:00
for UTC and +01:00
for BST.
Example
<start value="2023-11-24T10:05:00+00:00" />
end
Usage
Mandatory
Guidance
The time the slot is to conclude, in UK local time in the format yyyy-mm-ddThh:mm:ss+hh:mm
with the timezone offset +00:00
for UTC and +01:00
for BST.
Example
<start value="2023-11-24T10:20:00+00:00" />
overbooked
Usage
Optional
Guidance
To indicate if the slot has been overbooked.
Example
<overbooked value="true"/>
comment
Usage
Optional
Guidance
Additional comments about the slot.
Example
<comment value="This slot is only to be used for blood test appointments." />