API ReferencePre EncounterCoveragesV1

Update

Beta

Updates a Coverage. The path must contain the next version number to prevent race conditions. For example, if the current version of the coverage is n, you will need to send a request to this endpoint with /{id}/n+1 to update the coverage. Updating historic versions is not supported.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idUUIDRequired
The unique identifier for a Coverage in the database
versionstringRequired

Request

This endpoint expects an object.
statusenumRequired
The status indiciating if the coverage is active or not.
Allowed values:
subscriberobjectRequired

The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

relationshipenumRequired

The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html

Allowed values:
patientstringRequired
The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage
insurance_planobjectRequired
verifiedbooleanRequired
A boolean indicating if the coverage has been verified by a user.
eligibility_checkslist of objectsOptional
A list of eligibility check metadata that have been initiated on this coverage.
latest_eligibility_checkobjectOptional
The latest eligibility check metadata that has been initiated on this coverage.
benefitsobjectOptional
The eligibility of the patient for the coverage, manually verified by users.
orconbooleanOptional

ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false.

auto_update_enabledbooleanOptional
Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration.
previous_appointment_copaysmap from enums to integersOptional

A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly.

Allowed values:

Response

This endpoint returns an object.
deactivatedboolean
True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
idUUID
The unique identifier for a Coverage in the database
insurance_planobject
organization_idstring
The organization that owns this object.
patientstring
The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage
relationshipenum

The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html

Allowed values:
statusenum
The status indiciating if the coverage is active or not.
Allowed values:
subscriberobject

The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the object.
verifiedboolean
A boolean indicating if the coverage has been verified by a user.
versioninteger
The version of the object. Any update to any property of an object object will create a new version.
auto_update_enabledboolean
Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration.
benefitsobject
The eligibility of the patient for the coverage, manually verified by users.
eligibility_checkslist of objects
A list of eligibility check metadata that have been initiated on this coverage.
latest_eligibility_checkobject
The latest eligibility check metadata that has been initiated on this coverage.
orconboolean

ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false.

previous_appointment_copaysmap from enums to integers

A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly.

Allowed values:

Errors

404
Not Found Error
409
Version Conflict Error