JOjoincandidhealth
v1

Create

Changed on

Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual.

post/coverages/v1/

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/coverages/v1/
  • Auth
    HTTP bearer

Request body

status'ACTIVE' | 'CANCELLED' | 'DRAFT' | 'ENTERED_IN_ERROR' required

enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html

relationship'SELF' | 'SPOUSE' | 'CHILD' | 'COMMON_LAW_SPOUSE' | 'OTHER' required
patientstring required

The unique identifier for a Patient

verifiedboolean required

A boolean indicating if the coverage has been verified by a user.

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.

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.

previous_appointment_copaysobject

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.

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

versioninteger required

The version of the object. Any update to any property of an object object will create a new version.

updated_atstring date-time required
updating_user_idstring required

The unique identifier for a User in the database

status'ACTIVE' | 'CANCELLED' | 'DRAFT' | 'ENTERED_IN_ERROR' required

enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html

relationship'SELF' | 'SPOUSE' | 'CHILD' | 'COMMON_LAW_SPOUSE' | 'OTHER' required
patientstring required

The unique identifier for a Patient

verifiedboolean required

A boolean indicating if the coverage has been verified by a user.

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.

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.

previous_appointment_copaysobject

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.

idstring uuid required

The unique identifier for a Coverage in the database

Changes

  • d8b0a61873e2Revision changes
    • warning

      added the new ABA enum value to the /// response property for the response status

    • warning

      added the new CES enum value to the /// response property for the response status

    • warning

      added the new EEG enum value to the /// response property for the response status

    • warning

      added the new FWC enum value to the /// response property for the response status

    • warning

      added the new OT enum value to the /// response property for the response status

    • warning

      added the new PT enum value to the /// response property for the response status

    • warning

      added the new SLP enum value to the /// response property for the response status

    • info

      added the new ABA enum value to the request property ///

    • info

      added the new CES enum value to the request property ///

    • info

      added the new EEG enum value to the request property ///

    • info

      added the new FWC enum value to the request property ///

    • info

      added the new OT enum value to the request property ///

    • info

      added the new PT enum value to the request property ///

    • info

      added the new SLP enum value to the request property ///

  • 72fc5ca65ba5Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status