JOjoincandidhealth
v2

Create contract

Changed on

Creates a new contract within the user's current organization

post/api/contracts/v2

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/contracts/v2
  • Auth
    HTTP bearer

Request body

effective_datestring required

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

expiration_datestring

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

contract_status'pending' | 'effective' | 'cancelled'
contracting_provider_idstring uuid required
rendering_provider_idsContractsV2RenderingProviderid[] required

A rendering provider isn't contracted directly with the payer but can render services under the contract held by the contracting provider. Max items is 4000.

payer_uuidstring uuid required

The UUID of the insurance company under agreement to the contract

Response

Response with status 200

effective_datestring required

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

expiration_datestring

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

contract_status'pending' | 'effective' | 'cancelled'
contract_idstring uuid required
provider_countinteger required

The number of linked providers who can render medical services under this contract

rendering_provider_idsstring[] required

The providers who can render medical services under the contract

Changes

  • 97de8fddb088Revision changes
    • warning

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

  • 24b2d80d577aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to object

    • breaking

      the request property type changed from no type to string

    • breaking

      the request property type changed from no type to string, and format from no format to uuid

    • breaking

      the / request property type changed from no type to string, and format from no format to uuid

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added discriminator to request property

    • info

      added discriminator to request property

    • info

      added discriminator to request property

    • info

      added the new cancelled enum value to the request property

    • info

      added the new effective enum value to the request property

    • info

      added the new pending enum value to the request property

    • info

      added subschema #1 subschema #2 subschema #3 to the request property oneOf list

    • info

      added subschema #1 subschema #2 subschema #3 to the request property oneOf list

    • info

      added subschema #1 subschema #2 subschema #3 to the request property oneOf list

    • 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status