Versions Compared

Old Version 2

changes.mady.by.user Pete Richardson

Saved on

compared with

New Version Current

changes.mady.by.user Pete Richardson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

This API will enable the API user to get a list of programs that the user is eligible for within a certain domain.

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.

...

Info

Scope Needed For This API

SouthEast Michigan Hub - semi-cie.hub/egibility

 

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 Community Information Exchange Hub Region URL

Environment

URL

Development

POST https://hub-dev.{cie-region}.org/v1/person/{personId}/eligibility/{domain}

UAT

POST https://hub-uat.{cie-region}.org/v1/person/{personId}/eligibility/{domain}

Production

POST https://hub.{cie-region}.org/v1/person/{personId}/eligibility/{domain}

Headers

The following will be headers that will need to be supplied

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

The following will be the request object that will be sent in the body of the post. The information in the request will represent the information that will be needed to create the person in the CIE Hub.

JSON Example of Request

 

Code Block
{
  "resourceType": "Enrollment",
}

...

Data Element

Description

Required

Query

personId

This will be the person Id that is being checked

Tip

X

domain

This will be the program that the person is enrolling.

The current domain that is supported is

  • transportation

Tip

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.

HTTP Status Code

Description

Response Example

200

Returns a list of programs, if none a egiblie then it will return an empty error. A enrollment ID will be generated and sent back.

 

Code Block
{
  "egilibilityId": "13899",
  "programs": [
    {
      "programId": 123,
      "programName": "Detroit Toolbox",
    },
    {
      "programId": 234,
      "programName": "Other Program"
    }
  ],
  "instance": "3abdf0d4-e934-5575513f6d5"
}

 

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.

 

 

Code Block
{
  "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.

 

Code Block
{
  "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

...