GET /appointments/tax

Introduction

This API will enable the API user to get a list of appointment per a type of appointment.

Authorization

The authorization will contain an API key and also will use an OAuth2 access token. An API key will be provided to each client that intends to consume this API. A development key and also a separate production key will be provided. If this key is not included then an authorization error will be returned.

The process for getting an OAuth2 token can be found here https://brightstreetgroup.atlassian.net/wiki/spaces/CIEP/pages/1309802703

Scope Needed For This API

SouthEast Michigan Hub - semi-cie.hub/app_tax_read

Rest URL

The following are the URLs for this API. Please note that base url for the region you are looking for can be found here https://brightstreetgroup.atlassian.net/wiki/spaces/CIEP/pages/1310195720

Environment	URL

Environment	URL
Development	GET https://hub-dev.{cie-region}.org/v1/appointments/tax
UAT	GET https://hub-uat.{cie-region}.org/v1/appointments/tax
Production	GET https://hub.{cie-region}.org/v1/appointments/tax

Headers

The following will be headers that will need to be supplied

Header	Description

Header	Description
x-api-key	This will be a key that will provided by a community information exchange administrator.
ContentType	application/json
Authorization	This will be the access token that was retrieved using your client id and secret

Request

Note that the person ID passed as a parameter in the URL as documented in the REST URL section.

Data Element	Description	Required

Data Element	Description	Required
Query String
`startDate`	This will be the start date of the query	X
`endDate`	This will be the end date of the query	X

Response

The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. https://tools.ietf.org/html/rfc7807 . Please note that all responses will also include a instance value which will uniquely identify the specific request that was made. This ensures uniqueness even if the patient was referred to the CIE multiple times.

Data Element	Description	Required

Data Element	Description	Required
Body
`appointments[].type`	The type of appointment.
`appointments[].organizationName`	The name of the organization for the appointment
`appointments[].organizationId`	The id of the organization from the social services directory
`appointments[].address` `appointments[].city` `appointments[].state` `appointments[].zip`	The address of the organization that the appointment
`appointments[].timeslots[].availableDateTime`	The date and time that the appointment will be available
`appointments[].timeslots[].availableDate`	The date that the appointment will be available
`appointments[].timeslots[].availableTime`	The time that the appointment will be available
`appointments[].timeslots[].availableRange.start`	This is the start time for the appointment
`appointments[].timeslots[].availableRange.end`	This is the end time for the appointment
`appointments[].timeslots[].availableRange.startUTC`
`appointments[].timeslots[].availableRange.endUTC`

HTTP Status Code	Description	Response Example

HTTP Status Code

Description

Response Example

200

Successful retrieval of a person record.

{
  "appointments" : [{
    "type": ""
    "organizationName": "Detroit Metro",
    "organizationId": 12344,
    "address": "111 Main Street",
    "city": "Gothem",
    "state": "MI",
    "zip": "49456"
    "timeSlots": [
      {
        "availableDateTime": "",
        "availableDate": "",
        "availableTime": "",
        "availableRange": {"start": "", "end":"", "startUTC": "", "endUTC": "", "numberSlots": 5}
      }
    ]
    },
  ]
  instance: "347984t9"
}

403

Request is unauthorized and will not be processed. This will happen if the authorization header does not contain a valid client id and secret.

{
  "type": "cie/unauthorized",
  "title": "Request is not authorized 
            to perform this operation",
  "detail": "The x-api-key header may be 
             missing or is invalid",          
  "instance":"4abdf0d4-e934-5575513f6d5"
}

400

Request is malformed and will not be processed.

{
  "type": "cie/validation-error",
  "title": "Your request parameters 
            didn't validate.",
  "instance":"4abdf0d4-e934-5575513f6d5"
}

Example CURL for this API Call

The following is an example CURL for calling this api. Also note that there are sample Referral Id’s that are in the CIE Hub development environment that can be used for testing purposes