Schedule Profile
This Schedule profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 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 table in athenaPractice. Specific detail can be found in the Mappings section in the profile detail page.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Schedule, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/Schedule/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Schedule resource to retrieve |
| [_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 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 slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 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. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 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. |
Search Operation
Search operations 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/Schedule?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/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(HealthcareService, Practitioner, Location, ...) to find a Schedule for |
| identifier (token ) | A Schedule Identifier |
| type (token ) | The type of appointments that can be booked into associated slot(s) |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 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. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/schedule-profile
A container for slot(s) of time that may be available for booking appointments
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Schedule | 0..* | Schedule | A container for slot(s) of time that may be available for booking appointments | ||
 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: IETF BCP-47  (required ) | ||
| text | I | 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 | |
| type | 0..* | CodeableConcept | The schedule type can be used for the categorization of healthcare services or other appointment types Binding: Practice Setting Code Value Set (preferred ) | ||
 actor | ∑ | 1..1 | Reference (Patient | Practitioner | 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, 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 | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| start | ∑ I | 0..1 | dateTime | Starting time with inclusive boundary | |
 end | ∑ I | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| comment | 0..1 | string | Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated | ||
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs.
athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are
the same. Use of this information is subject to the API Server
Terms and Conditions .
| Schedule Profile | ||
| Schedule | Schedule-Profile | FHIR_SCHEDULEVIEW |
| ├ id | MakeId(%SCHEDULEID%) | |
| ├ identifier | MakeIdentifier("U",getSiteSystem("ScheduleId"),%SCHEDULEID%) | |
| ├ type | MakeConcept(%TYPE%,null,%TYPE%) | |
| └ actor | MakeReference("PRACTITIONER",%PVID%,"Practitioner") | |
| ├ start | %STARTTIME% | |
| └ end | %STOPTIME% | |