HAhalaxy
Coverage

Create Coverage

Changed on

Creates a new coverage record for a patient

post/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

Request body

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

containedFhirResourceInterfaceJsonfhir[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Response

Coverage resource created

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 request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/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/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/fhir+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/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/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/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 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/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/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/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 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)

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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