API Reference

List Coverage

get
https://au-api.halaxy.com/main/Coverage

Retrieves a collection of patient coverage records

Query Params
integer
Defaults to 1

The collection page number

integer
≥ 0
Defaults to 30

The number of items per page

boolean

Enable or disable pagination

string

ID of the coverage

string

The primary beneficiary of the policy.

string

Subscriber to the policy - can be the same as the policyholder, or different.

string

Payor is the funder for this coverage

string

The coverage organisation for this coverage

string

Subscriber identifier number.

string

Date the coverage was last updated.

string

Date the coverage was created.

string
enum

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.
Allowed:
Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

403

Forbidden

Updated 10 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json

Updated 10 months ago