Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Schedule

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... identifier 1..1IdentifierExternal Ids for this item

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorScheduleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorScheduleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScheduleIf 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-4errorScheduleIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... active ?!Σ0..1booleanWhether this schedule is in active use
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe 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..1PeriodThe 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..1stringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Schedule.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Schedule.serviceCategoryexampleServiceCategory
Schedule.serviceTypeexampleServiceType
Schedule.specialtypreferredPractice Setting Code Value Set

This structure is derived from Schedule

Summary

Mandatory: 1 element

Differential View

This structure is derived from Schedule

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... identifier 1..1IdentifierExternal Ids for this item

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... 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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorScheduleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorScheduleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorScheduleIf 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-4errorScheduleIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..*ScheduleA container for slots of time that may be available for booking appointments
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierExternal Ids for this item
... active ?!Σ0..1booleanWhether this schedule is in active use
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe 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..1PeriodThe 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..1stringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Schedule.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Schedule.serviceCategoryexampleServiceCategory
Schedule.serviceTypeexampleServiceType
Schedule.specialtypreferredPractice Setting Code Value Set

This structure is derived from Schedule

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron