GET /api/Coverage
Coverages

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

Patient ID

Validations:

  • Must be number.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Coverage

Validations:

  • Must be String.
id
required

Validations:

  • Must be String.
identifier
required

Validations:

  • Must be Array.
type
required

Validations:

  • Must be Hash.
status
required

Validations:

  • Must be String.
subscriber
required

Validations:

  • Must be Hash.
beneficiary
required

Validations:

  • Must be Hash.
relationship
required

Validations:

  • Must be Hash.
subscriber_id
required

Validations:

  • Must be String.
period
required

Validations:

  • Must be Hash.
payor
required

Validations:

  • Must be Array.
Class
required

Validations:

  • Must be Array.