HAhalaxy
Coverage

List Coverage

Changed on

Retrieves a collection of patient coverage records

get/main/Coverage

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Coverage
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

ID of the coverage

beneficiarystring

The primary beneficiary of the policy.

subscriberstring

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

payorstring

Payor is the funder for this coverage

coverageOrganizationstring

The coverage organisation for this coverage

subscriberIdstring

Subscriber identifier number.

_lastUpdatedstring datetime

Date the coverage was last updated.

createdstring datetime

Date the coverage was created.

_include'Coverage:beneficiary' | 'Coverage:subscriber' | 'Coverage:payor'

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.
_sort'_lastUpdated' | 'created' | '-_lastUpdated' | '-created'

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Response

Coverage collection

status'active' | 'cancelled'

The status of the coverage

subscriberIdstring nullable

The patient's claim details (e.g. membership number, card number, reference number)

dependentstring nullable

An individual reference number (IRN) on the membership card, typically a single digit number before the cardholder's name

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new image/gif enum value to the ////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new image/gif enum value to the /// response property for the response status (media type: application/json)