WOFConnect, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions
Resource Profile: Wof Connect Schedule
| Official URL: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-schedule | Version: 0.1.0 | |||
| Active as of 2025-11-27 | Computable Name: WofConnectSchedule | |||
Schedule for bookable service availability as exposed by WOF Connect integrations.
Usages:
- Use this Profile: WOF Connect GetScheduleContext Operation Response
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments | |||||||
  meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||
   profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||||
 Slices for serviceType |
SΣ | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system Binding: ServiceType (example) | ||||||
  serviceType:service-type-id |
SΣ | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code Binding: ServiceType (example) | ||||||
  Slices for coding |
Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
 coding:st-id |
SOΣ | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
  system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
 code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| coding:ep-id |
SOΣ | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| Slices for actor |
SΣ | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
 actor:healthcareService |
SOΣ | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SOΣ | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
 actor:practitionerRole |
SOΣ | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
 planningHorizon |
SΣC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| start |
SOΣC | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SOΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| Documentation for this format | ||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Schedule.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType:service-type-id | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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 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 | 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()
|
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Schedule | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Schedule |
Schedule | |||||||||
 meta |
1..1 | Meta | Metadata about the resource | |||||||
| profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||
| Slices for serviceType |
S | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system | ||||||
| serviceType:service-type-id |
S | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code | ||||||
| Slices for coding |
2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||
| coding:st-id |
SO | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| code |
S | 1..1 | code | Symbol in syntax defined by the system | ||||||
| coding:ep-id |
SO | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| code |
S | 1..1 | code | Symbol in syntax defined by the system | ||||||
| Slices for actor |
S | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
| actor:healthcareService |
SO | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SO | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
| actor:practitionerRole |
SO | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
| planningHorizon |
SC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| start |
SO | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SO | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| Documentation for this format | ||||||||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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 |
Σ | 1..1 | Meta | Metadata about the resource | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||||
| serviceCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||||
| Slices for serviceType |
SΣ | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system Binding: ServiceType (example) | ||||||
| serviceType:service-type-id |
SΣ | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code Binding: ServiceType (example) | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
 Slices for coding |
Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
 coding:st-id |
SOΣ | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| coding:ep-id |
SOΣ | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
| specialty |
Σ | 0..* | CodeableConcept | Type of specialty needed Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty). | ||||||
| Slices for actor |
SΣ | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
| actor:healthcareService |
SOΣ | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SOΣ | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
| actor:practitionerRole |
SOΣ | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
| planningHorizon |
SΣC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| start |
SOΣC | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SOΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| comment |
0..1 | string | Comments on availability | |||||||
| Documentation for this format | ||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Schedule.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Schedule.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Schedule.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Schedule.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType:service-type-id | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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 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 | 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()
|
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Schedule | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
This structure is derived from Schedule
Summary
Mandatory: 14 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
- Wof Connect HealthcareService (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice)
- Wof Connect Practitioner (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner)
- Wof Connect PractitionerRole (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitionerrole)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Schedule.serviceType
- The element 1 is sliced based on the value of Schedule.serviceType.coding
- The element 1 is sliced based on the value of Schedule.actor
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Schedule |
0..* | Schedule | A container for slots of time that may be available for booking appointments | |||||||
| meta |
Σ | 1..1 | Meta | Metadata about the resource | ||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||||
| Slices for serviceType |
SΣ | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system Binding: ServiceType (example) | ||||||
| serviceType:service-type-id |
SΣ | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code Binding: ServiceType (example) | ||||||
| Slices for coding |
Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
| coding:st-id |
SOΣ | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| coding:ep-id |
SOΣ | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| Slices for actor |
SΣ | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
| actor:healthcareService |
SOΣ | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SOΣ | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
| actor:practitionerRole |
SOΣ | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
| planningHorizon |
SΣC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| start |
SOΣC | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SOΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| Documentation for this format | ||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Schedule.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType:service-type-id | Base | example | Service type | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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 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 | 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()
|
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Schedule | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
Differential View
This structure is derived from Schedule
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Schedule |
Schedule | |||||||||
| meta |
1..1 | Meta | Metadata about the resource | |||||||
| profile |
1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||
| Slices for serviceType |
S | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system | ||||||
| serviceType:service-type-id |
S | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code | ||||||
| Slices for coding |
2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||
| coding:st-id |
SO | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| code |
S | 1..1 | code | Symbol in syntax defined by the system | ||||||
| coding:ep-id |
SO | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| code |
S | 1..1 | code | Symbol in syntax defined by the system | ||||||
| Slices for actor |
S | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
| actor:healthcareService |
SO | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SO | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
| actor:practitionerRole |
SO | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
| planningHorizon |
SC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| start |
SO | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SO | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| Documentation for this format | ||||||||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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 |
Σ | 1..1 | Meta | Metadata about the resource | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||||
| active |
?!Σ | 0..1 | boolean | Whether this schedule is in active use | ||||||
| serviceCategory |
Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||||
| Slices for serviceType |
SΣ | 1..* | CodeableConcept | Kind of treatment/service Slice: Unordered, Open by value:coding.system Binding: ServiceType (example) | ||||||
| serviceType:service-type-id |
SΣ | 1..1 | CodeableConcept | Service Type Identifier Code and Endpoint Id Code Binding: ServiceType (example) | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| Slices for coding |
Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
| coding:st-id |
SOΣ | 1..1 | Coding | Service Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| coding:ep-id |
SOΣ | 1..1 | Coding | Endpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id | ||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
| specialty |
Σ | 0..* | CodeableConcept | Type of specialty needed Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty). | ||||||
| Slices for actor |
SΣ | 1..* | Reference(Wof Connect HealthcareService | Wof Connect Practitioner | Wof Connect PractitionerRole) | Clinic and provider actors in scope for this schedule Slice: Unordered, Open by type:$this | ||||||
| actor:healthcareService |
SOΣ | 0..* | Reference(Wof Connect HealthcareService) | The HealthcareService that hosts the schedule if applicable
| ||||||
| actor:practitioner |
SOΣ | 0..* | Reference(Wof Connect Practitioner) | The practitioner who performs the service
| ||||||
| actor:practitionerRole |
SOΣ | 1..1 | Reference(Wof Connect PractitionerRole) | The practionerRole who performs the service
| ||||||
| planningHorizon |
SΣC | 1..1 | Period | Interval for which this schedule is valid Constraints: inv-schedule-planning | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| start |
SOΣC | 1..1 | dateTime | Starting time with inclusive boundary
| ||||||
| end |
SOΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing
| ||||||
| comment |
0..1 | string | Comments on availability | |||||||
| Documentation for this format | ||||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Schedule.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Schedule.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Schedule.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Schedule.serviceCategory | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.serviceType:service-type-id | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Schedule.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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 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 | 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()
|
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Schedule | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-schedule-planning | error | Schedule.planningHorizon | planningHorizon.start must be on or before planningHorizon.end |
start <= end
|
This structure is derived from Schedule
Summary
Mandatory: 14 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
- Wof Connect HealthcareService (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice)
- Wof Connect Practitioner (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner)
- Wof Connect PractitionerRole (http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitionerrole)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Schedule.serviceType
- The element 1 is sliced based on the value of Schedule.serviceType.coding
- The element 1 is sliced based on the value of Schedule.actor
Other representations of profile: CSV, Excel, Schematron