Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Schedule

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaSchedule

Athena Schedule Profile

This Schedule profile is part of the set of resource profiles supported by the API Server used with the athenaPractice product. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource provides a container for slots of time that may be available for booking appointments.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Schedule resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Schedule resource is derived from the Schedule and ScheduleResource tables in athenaPractice. Specific detail can be found in the Mappings tab in the profile detail page.

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..* Schedule A container for slots of time that may be available for booking appointments
... id 1..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
... identifier 0..* Identifier External Ids for this item
... serviceType 0..* CodeableConcept Specific service
... actor 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier External Ids for this item
... active ?!Σ 0..1 boolean Whether this schedule is in active use
... serviceType Σ 0..* CodeableConcept Specific service
Binding: ServiceType (example)
... actor Σ 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Schedule.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 1..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
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
.... 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
... 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 Σ 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)
... serviceType Σ 0..* CodeableConcept Specific service
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept Type of specialty needed
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).


... actor Σ 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Schedule.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Schedule.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Schedule.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Schedule.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Schedule.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Schedule.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

This structure is derived from Schedule

Summary

Mandatory: 5 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Schedule.meta.profile

Differential View

This structure is derived from Schedule

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id 1..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
... identifier 0..* Identifier External Ids for this item
... serviceType 0..* CodeableConcept Specific service
... actor 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 1..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier External Ids for this item
... active ?!Σ 0..1 boolean Whether this schedule is in active use
... serviceType Σ 0..* CodeableConcept Specific service
Binding: ServiceType (example)
... actor Σ 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Schedule.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id Σ 1..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
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-schedule-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-schedule-profile
.... 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
... 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 Σ 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)
... serviceType Σ 0..* CodeableConcept Specific service
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept Type of specialty needed
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).


... actor Σ 1..1 Reference(Practitioner) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Schedule.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Schedule.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Schedule.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Schedule.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Schedule.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Schedule.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

This structure is derived from Schedule

Summary

Mandatory: 5 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Schedule.meta.profile

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Schedule resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Schedule?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Schedule resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
actor (reference) The individual(Practitioner) to find a Schedule for
identifier (token) A Schedule Identifier
service-type (token) The type of appointments that can be booked into associated slot(s)
active (token) Is the schedule in active use
date (date) Search for Schedule resources that have a period that contains this date specified
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.