Update Coverage

patch

https://au-api.halaxy.com/main/Coverage/{id}

Updates specific fields in existing patient claim details

🖊️
Note
This PATCH request currently only supports adding a new file attachment to existing patient claim details. This does not delete or replace any previous file attachments. This does not include editing other properties in the claim details.

Parameters

Path Params

string

required

Coverage identifier

Body Params

The updated Coverage resource

A Coverage. See https://hl7.org/fhir/R4/coverage.html

identifier

array of objects | null

Business Identifier for the coverage

identifier

status

string

enum

The status of the coverage

Allowed:

subscriber

FhirReference | null

The person receiving the treatment under the coverage

subscriberId

string | null

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

beneficiary

FhirReference | null

The person who receives the benefit for the coverage

dependent

string | null

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

period

FhirPeriodYearMonth | null

The time period when the coverage was valid

payor

array of objects

The issuer of the coverage policy - if Organization, this is the funder (FD) ID.

payor

attachments

array of objects

File attachments to the coverage

attachments

meta

FhirResourceMeta | null

Metadata about the resource

resourceType

string | null

Resource Type

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

400

Invalid input

403

Forbidden

404

Resource not found

422

Unprocessable entity

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

Note

Parameters

200Coverage resource updated