Profile: GPConnect-Schedule-1
GPConnect-Schedule-1 (Schedule) | C | Schedule | |
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 | |
practitionerRole | S C | 0..* | Extension(CodeableConcept) |
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) |
active | Σ ?! | 0..0 | boolean |
serviceCategory | Σ | 0..1 | CodeableConcept |
serviceType | Σ | 0..0 | CodeableConcept |
specialty | Σ | 0..1 | CodeableConceptBinding |
actor | Σ | 1..* | Reference(CareConnect-GPC-Location-1 | CareConnect-GPC-Practitioner-1) |
planningHorizon | Σ | 0..1 | Period |
id | 0..1 | string | |
extension | 0..* | Extension | |
start | Σ C | 1..1 | dateTime |
end | Σ C | 0..1 | dateTime |
comment | 0..1 | string |
Schedule | |||
Short | A container for slots of time that may be available for booking appointments | ||
Definition | A container for slots of time that may be available for booking appointments. | ||
Cardinality | 0..* | ||
Alias | Availability | ||
Constraints |
| ||
Mappings |
| ||
Schedule.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. | ||
Schedule.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 | ||
Schedule.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. | ||
Schedule.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). | ||
Schedule.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 |
| ||
Schedule.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 |
| ||
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 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 |
| ||
Schedule.extension:practitionerRole | |||
Short | An extension to record the role of the Practitioner of a scheduled Appointment | ||
Definition | An extension to record the role of the Practitioner of a scheduled Appointment. | ||
Cardinality | 0..* | ||
Type | Extension(CodeableConcept) | ||
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 |
| ||
Schedule.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 |
| ||
Schedule.identifier | |||
Short | External Ids for this item | ||
Definition | External Ids for this item. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Mappings |
| ||
Schedule.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 |
| ||
Schedule.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 |
| ||
Schedule.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 |
| ||
Schedule.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 |
| ||
Schedule.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/patientGeneral https://fhir.nhs.uk/Id/gpconnect-schedule-identifier | ||
Mappings |
| ||
Schedule.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 |
| ||
Schedule.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 |
| ||
Schedule.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 |
| ||
Schedule.active | |||
Short | Whether this schedule is in active use | ||
Definition | Whether this schedule record is in active use, or should not be used (such as was entered in error). | ||
Cardinality | 0..0 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||
Default value | true | ||
Mappings |
| ||
Schedule.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..1 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Mappings |
| ||
Schedule.serviceType | |||
Short | The specific service that is to be performed during this appointment | ||
Definition | The specific service that is to be performed during this appointment. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Mappings |
| ||
Schedule.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 |
| ||
Schedule.actor | |||
Short | The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson | ||
Definition | The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson. | ||
Cardinality | 1..* | ||
Type | Reference(CareConnect-GPC-Location-1 | CareConnect-GPC-Practitioner-1) | ||
Summary | True | ||
Comments | The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a pracitioner and a room(location) are always required by a system. | ||
Mappings |
| ||
Schedule.planningHorizon | |||
Short | The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates | ||
Definition | The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
Schedule.planningHorizon.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 |
| ||
Schedule.planningHorizon.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 |
| ||
Schedule.planningHorizon.start | |||
Short | Starting time with inclusive boundary | ||
Definition | The start of the period. The boundary is inclusive. | ||
Cardinality | 1..1 | ||
Type | dateTime | ||
Summary | True | ||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Mappings |
| ||
Schedule.planningHorizon.end | |||
Short | End time with inclusive boundary, if not ongoing | ||
Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Mappings |
| ||
Schedule.comment | |||
Short | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated | ||
Definition | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
|
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
id | |||
meta.versionId | |||
meta.lastUpdated | |||
meta.profile | |||
meta.security | |||
meta.tag | |||
extension(practitionerRole) | |||
identifier | |||
serviceCategory | |||
specialty | |||
actor | |||
planningHorizon | |||
comment | |||
id
Usage
Mandatory
Guidance
The id
is the logical identifier for the GPConnect-Schedule-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-Schedule-1
profile.
Example
<meta> <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Schedule-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(practitionerRole)
Usage
Required
Guidance
The role of the Practitioner assigned to the schedule.
Example
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-GPConnect-PractitionerRole-1"> <valueCodeableConcept> <system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1" /> <coding value="R0260"> <display value="General Medical Practitioner" /> </valueCodeableConcept> </extension>
identifier
Usage
Mandatory
Guidance
All relevant business identifier details for the schedule, where available.
Example
<identifier> <system value="https://fhir.nhs.uk/Id/nhs-number" /> <value value="9476719931" /> </identifier>
serviceCategory
Usage
Optional
Guidance
A broad categorisation of the service that is to be performed during this schedule
Example
<serviceCategory> <coding> <system value="http://terminology.hl7.org/CodeSystem/service-category" /> <code value="17" /> <display value="General Practice" /> </coding> </serviceCategory>
specialty
Usage
Optional
Guidance
The specialty of a practitioner that would be required to perform the service requested in this schedule
Example
<specialty> <coding> <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode" /> <code value="600" /> <display value="General Medical Practice" /> </coding>
actor
Usage
Mandatory
Guidance
The resource this Schedule is providing availability information for. These are expected to usually be one of Location or Practitioner for example
Example
<actor> <reference value="Location/UKCore-Location-GeneralPracticeNurseClinic-Example" /> <display value="White Rose GP Practice Nurse Clinic" /> </actor>
planningHorizon
Usage
Optional
Guidance
The period of time that the slots that are attached to this Schedule resource cover
Example
<planningHorizon> <start value="2024-10-13T11:20:00+00:00" /> <end value="2024-10-13T11:50:00+00:00" /> </planningHorizon>
comment
Usage
Optional
Guidance
Additional comments about the schedule.
Example
<comment value="The slots attached to this schedule should be specialized to cover immunizations within the clinic." />