Appointment Availability Sprint
This wiki page tracks the status of the Argonaut Scheduling Appointment Availability Sprint participants. Steps are listed for both Client and EHR platforms to prepare their systems. Once a system is ready, clients may test with a partner using the following Test Script and update the testing matrix.
(What is a "Sprint")
Remember this Sprint is based on FHIR STU3 (Version 3.0.1)
Every server shares in the Google spreadsheet
- Organization name and contact
- FHIR endpoint URL - assuming open endpoints for this first sprint
Every client shares in the Google spreadsheet
- Organization name and contact
- Public demo URL if available
This spreadsheet contains sample schedules for providers, specialties, locations to use as a simple baseline unit test for availability search. This data can be modified to increase the complexity of the operation or alternative data can be used as well.
We'll focus on the basics, beginning with 3 scenarios using the example data and the FHIR Appointment Availability Operation that every participating server should expose. Participating clients may invoke any of the one scenario depending on their use case.
Retrieve a set of proposed appointments based on the input parameters using:
-
GET [base]/Appointment/$find&[parameters]
or POST [base]/Appointment/$find
For full details, and examples see The Argonaut Scheduling IG OperationDefinition Appointment Availability. For detailed description on FHIR operations refer to the FHIR Specification.
-
Patient Portal Scenario 1a provider based appointment availability search for an existing patient Scenario 1.
All the input parameters must be supported (definition of "Must Support"):
- available period
- appt-type
- requested provider
- location
- max_number
-
Patient Portal Scenario 1a service or specialty based appointment availability search for an existing patient Scenario 1.
- available period
- appt-type
- specialty
- service
- location
- max_number
-
Prefetch Scenario 2a and 2b based appointment availability for new or existing patient using open scheduling approach. Scenario 2
The following parameters must be supported at a minimum:
- available period
- appt-type
- specialty
- service
- location
- patient
- max_number
Questions for discussion:
- should we add
- Reason/Indication
- Comments to the operation?
-
A client developer has published client details (see above) to the spreadsheet.
-
A client developer has viewed the spreadsheet to obtain configuration details for all servers.
- A client has connected to a server and fetched available appointments via
POST [base]/Appointment/$availability
.
-
A server developer has published server details (see above) to the spreadsheet.
-
A server has exposed an Appointment search endpoint via the appointment availability operation, supporting at least the operation parameters listed above for each of the scenarios.
-
A server has returned valid set of proposed FHIR Appointment resources in response to the appointment availability operation. These resources should be valid according to the Argonaut Profile appt-output
This matrix tracks the steps a client must complete prior prior to testing the Appointment Availability operation with an EHR:
Steps/ Client |
Published client details to spreadsheet | Implement the Appointment$find operation | step | step | step | step |
---|---|---|---|---|---|---|
Health eData Inc | X | |||||
This matrix tracks the steps an EHR platform must complete prior to testing the Appointment Availability operation with a client:
Steps/ EHR platform |
step | Implement the Appointment$find operation | step | Validate output | exposed an Appointment search endpoint | Published endpoint details to spreadsheet |
---|---|---|---|---|---|---|
MEDITECH | ||||||
AthenaHealth | ||||||
Cerner | ||||||
Epic |
This matrix tracks which systems have tested the Appointment$find operation:
Scheduling Client | ||||
---|---|---|---|---|
MEDITECH | ||||
AthenaHealth | ||||
Cerner | ||||
Epic | ||||
EHR 4 |
- Add yourself to the list of participants
- Chat with us on Zulip
- Have a discussion in the Argonaut-Scheduling Google Group
- Contribute or log an issue to the Argonaut Scheduling on Github
- Phase 1
- Phase 2
- Future