Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Resource Profile: CareConnectSchedule1
| Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Schedule-1 | Version: 0.1.0 | |||
| Draft as of 2018-09-27 | Computable Name: CareConnect-Schedule-1 | |||
Copyright/Legal: Copyright © 2018 NHS Digital |
||||
CareConnect Schedule profile.
NOT CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
Usage:
- Derived from this Resource Profile: InterweaveSchedule
- Refer to this Resource Profile: InterweaveSlot
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |
  identifier | 1..1 | Identifier | External Ids for this item | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 1..1 | Identifier | External Ids for this item |
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use |
 actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Schedule | 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 | Schedule | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time 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 | |||||
 extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | External Ids for this item | ||||
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||
| 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 specific service that is to be performed during this appointment 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) | ||||
| actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 | ||||
| planningHorizon | Σ | 0..1 | Period | 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 | ||||
| comment | 0..1 | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Schedule.language | extensible | Common Languages
| ||||
| Schedule.serviceCategory | example | ServiceCategory | ||||
| Schedule.serviceType | example | ServiceType | ||||
| Schedule.specialty | preferred | Practice Setting Code Value Set |
This structure is derived from Schedule
Differential View
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |
| identifier | 1..1 | Identifier | External Ids for this item | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..1 | Identifier | External Ids for this item |
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use |
| actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Schedule | 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 | Schedule | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time 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 | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | External Ids for this item | ||||
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||
| 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 specific service that is to be performed during this appointment 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) | ||||
| actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 | ||||
| planningHorizon | Σ | 0..1 | Period | 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 | ||||
| comment | 0..1 | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Schedule.language | extensible | Common Languages
| ||||
| Schedule.serviceCategory | example | ServiceCategory | ||||
| Schedule.serviceType | example | ServiceType | ||||
| Schedule.specialty | preferred | Practice Setting Code Value Set |
This structure is derived from Schedule
Other representations of profile: CSV, Excel, Schematron