AppointmentRequestResource

The following resources are applicable:

/appointment-service/feedback

Mount Point: /rest/appointment-service/feedback

POST

This REST service is used to save feedback from the user

Request Body

element: feedback
media types: application/xml
application/json

(no documentation provided)

Response Body

element: feedback
media types: */*
application/xml
application/json

UserFeedback

/appointment-service/metadata

Mount Point: /rest/appointment-service/metadata

GET

This REST service is used to fetch detail codes from SED database

Response Body

element: appointments-metadata
media types: application/xml
application/json

VARAppointmentsMetadata

/appointment-service/metrics/no-dfn-cancel-request

Mount Point: /rest/appointment-service/metrics/no-dfn-cancel-request

POST

This REST service is used to capture/save the metric if a patient is not registered to any facility

Response Body

element: appointmentMetric
media types: application/xml
application/json

(no documentation provided)

/appointment-service/metrics/no-icn-or-dfn

Mount Point: /rest/appointment-service/metrics/no-icn-or-dfn

POST

This REST service is used to capture/save the metric if icn or dfn for a patient is not found

Response Body

element: appointmentMetric
media types: application/xml
application/json

VARAppointmentMetric

/appointment-service/patient/{assigning-authority}/{patient-id}/appointment-requests/system/{system-id}/id/{appointment-request-id}/messages

Mount Point: /rest/appointment-service/patient/{assigning-authority}/{patient-id}/appointment-requests/system/{system-id}/id/{appointment-request-id}/messages

GET

A resource that returns all VARAppointmentRequestMessages that have been created by this user.

Parameters

name description type default
assigning-authority (no documentation provided) path
patient-id (no documentation provided) path
system-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Response Body

element: appointmentRequestMessages
media types: application/xml
application/json

Returns VARAppointmentRequestMessages associated with the user calling the request

POST

This REST service is used to save a message for select appointment request

Parameters

name description type default
assigning-authority (no documentation provided) path
patient-id (no documentation provided) path
appointment-request-id (no documentation provided) path
system-id (no documentation provided) path

Request Body

element: appointmentRequestMessage
media types: application/xml
application/json

(no documentation provided)

Response Body

element: appointmentRequestMessage
media types: application/xml
application/json

VARAppointmentRequestMessage

/appointment-service/patient/{assigning-authority}/{patient-id}/appointment-requests/system/{system-id}/id/{appointment-request-id}/messages/read

Mount Point: /rest/appointment-service/patient/{assigning-authority}/{patient-id}/appointment-requests/system/{system-id}/id/{appointment-request-id}/messages/read

POST

This REST service is used to save/update the flag that message from provider is been read by veteran

Parameters

name description type default
assigning-authority (no documentation provided) path
patient-id (no documentation provided) path
system-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

Response

/appointment-service/patient/{assigning-authority}/{patient-id}/appointments

Mount Point: /rest/appointment-service/patient/{assigning-authority}/{patient-id}/appointments

GET

A resource that returns all VARAppointmentRequests that have been created by this user.

Parameters

name description type default
assigning-authority (no documentation provided) path
patient-id (no documentation provided) path

Response Body

element: appointmentRequests
media types: application/xml
application/json

Returns VARAppointmentRequests associated with the user calling the request

POST

A resource that allows a client to save an VARAppointmentRequest. See AppointmentRequestValidator for val idation logic.

Parameters

name description type default
assigning-authority (no documentation provided) path
patient-id (no documentation provided) path

Request Body

element: appointmentRequest
media types: application/xml
application/json

(no documentation provided)

Response Body

element: appointmentRequest
media types: application/xml
application/json

The VARAppointmentRequest that was saved.

/appointment-service/patient/{assigning-authority}/{patient-id}/appointments/system/{system-id}/id/{appointment-request-id}

Mount Point: /rest/appointment-service/patient/{assigning-authority}/{patient-id}/appointments/system/{system-id}/id/{appointment-request-id}

GET

A resource that returns a single VARAppointmentRequest by user and id

Parameters

name description type default
assigning-authority (no documentation provided) path
system-id (no documentation provided) path
patient-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Response Body

element: appointmentRequest
media types: application/xml
application/json

Returns VARAppointmentRequest associated with the id and user calling the request

PUT

A resource that saves a single VARAppointmentRequest by user and id

Parameters

name description type default
assigning-authority (no documentation provided) path
system-id (no documentation provided) path
patient-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Request Body

element: appointmentRequest
media types: application/xml
application/json

(no documentation provided)

Response Body

element: appointmentRequest
media types: application/xml
application/json

Returns VARAppointmentRequest associated with the id and user calling the request

/appointment-service/patient/{assigning-authority}/{patient-id}/appointments/system/{system-id}/id/{appointment-request-id}/inprocess

Mount Point: /rest/appointment-service/patient/{assigning-authority}/{patient-id}/appointments/system/{system-id}/id/{appointment-request-id}/inprocess

POST

This REST service is used to save the state of appointment request thats under process of being booked by a provider so that other provider cannot update the appointment request

Parameters

name description type default
patient-id (no documentation provided) path
system-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

The VARAppointmentRequestInProcess that was saved.

DELETE

This REST service is to used to delete the state of the appointment requests thats processed/booked by a provider

Parameters

name description type default
system-id (no documentation provided) path
appointment-request-id (no documentation provided) path

Response Body

element: (custom)
media types: application/xml
application/json

The VARAppointmentRequestInProcess that was saved.

/appointment-service/var-patient-resource-directory

Mount Point: /rest/appointment-service/var-patient-resource-directory

GET

This REST service provides resource directory to front-end

Parameters

name description type default
patientId (no documentation provided) query
assigningAuthority (no documentation provided) query

Response Body

element: resource-directory
media types: application/xml
application/json

ResourceDirectory