DSResource
The following resources are applicable:
- /direct-scheduling/booking-confirmation
- /direct-scheduling/cancel-confirmation
- /direct-scheduling/directscheduling-resource-directory
- /direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider
- /direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-all
- /direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-view
- /direct-scheduling/site/{site-code}/logout
- /direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/available-appointment-slots
- /direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/booked-appointments
- /direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-appointment
- /direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-reasons-list
/direct-scheduling/booking-confirmation
Mount Point: /rest/direct-scheduling/booking-confirmation
PUT
This REST service sends email confirmation after appointment is booked
Parameters
name | description | type | default |
---|---|---|---|
patient-id | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path |
Request Body
element: | bookAppointmentEmail |
media types: | */* application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | application/xml application/json |
Response
/direct-scheduling/cancel-confirmation
Mount Point: /rest/direct-scheduling/cancel-confirmation
PUT
This REST service sends email confirmation after appointment is cancelled
Request Body
element: | bookAppointmentEmail |
media types: | */* application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | application/xml application/json |
Response
/direct-scheduling/directscheduling-resource-directory
Mount Point: /rest/direct-scheduling/directscheduling-resource-directory
GET
This REST service is used to get resource directory for direct scheduling.
Parameters
name | description | type | default |
---|---|---|---|
siteCode | (no documentation provided) | query |
Response Body
element: | resource-directory |
media types: | application/xml application/json |
ResourceDirectory
/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider
Mount Point: /rest/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider
GET
This REST service is used to fetch PACT relationship with facilities, providers and clinics associated for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Response Body
element: | facilityProviders |
media types: | application/xml application/json |
DirectSchedulingFacilityProviders
/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-all
Mount Point: /rest/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-all
GET
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Response Body
element: | facilities |
media types: | application/xml application/json |
(no documentation provided)
/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-view
Mount Point: /rest/direct-scheduling/patient/{assigning-authority}/{patient-id}/facility-provider-view
GET
Parameters
name | description | type | default |
---|---|---|---|
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Response Body
element: | facilityProviders |
media types: | application/xml application/json |
(no documentation provided)
/direct-scheduling/site/{site-code}/logout
Mount Point: /rest/direct-scheduling/site/{site-code}/logout
GET
This REST service is used to logout MDWS session open for selected facility for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
patient-id | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | application/xml application/json |
Response
/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/available-appointment-slots
Mount Point: /rest/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/available-appointment-slots
GET
This REST service is used to fetch all the appointment slots for selected facility from vista via scheduling manager for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path | |
startDate | (no documentation provided) | query | |
endDate | (no documentation provided) | query | |
clinicIds | (no documentation provided) | query |
Response Body
element: | (custom) |
media types: | application/xml application/json |
Collection
/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/booked-appointments
Mount Point: /rest/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/booked-appointments
POST
This REST service is used to save appointment for selected facility in vista via scheduling manager for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Request Body
element: | bookAppointment |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | application/xml application/json |
Response
GET
This REST service is used to fetch all booked appointments for selected facility from vista via scheduling manager for logged in patient/veteran. Service returns collection with booked appointments by "PRIMART CARE" and "OTHER"
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
patient-id | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
startDate | (no documentation provided) | query | |
clinicIds | (no documentation provided) | query |
Response Body
element: | VARBookedAppointmentCollections |
media types: | application/xml application/json |
VARBookedAppointmentCollections
/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-appointment
Mount Point: /rest/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-appointment
PUT
This REST service is used to update the booked appointment status to cancel in selected facility in vista via scheduling manager for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Request Body
element: | cancelAppointment |
media types: | application/xml application/json |
(no documentation provided)
Response Body
element: | (custom) |
media types: | application/xml application/json |
Response
/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-reasons-list
Mount Point: /rest/direct-scheduling/site/{site-code}/patient/{assigning-authority}/{patient-id}/cancel-reasons-list
GET
This REST service is used to fetch cancel reason list for selected facility from vista via scheduling manager for logged in patient/veteran
Parameters
name | description | type | default |
---|---|---|---|
site-code | (no documentation provided) | path | |
assigning-authority | (no documentation provided) | path | |
patient-id | (no documentation provided) | path |
Response Body
element: | cancelReasons |
media types: | application/xml application/json |
CancelReasons