JOjoincandidhealth
v2

Update Supervising Provider

Changed on
patch/api/encounter-providers/v2/{encounter_id}/supervising-provider

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/encounter-providers/v2/{encounter_id}/supervising-provider
  • Auth
    HTTP bearer

Path parameters

encounter_idstring uuid required

Request body

first_namestring

If the provider is an individual, this should be set instead of organization name

last_namestring

If the provider is an individual, this should be set instead of organization name

organization_namestring

If the provider is an organization, this should be set instead of first + last name

npistring

A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States

taxonomy_codestring

Response

Response with status 200

first_namestring

If the provider is an individual, this should be set instead of organization name

last_namestring

If the provider is an individual, this should be set instead of organization name

organization_namestring

If the provider is an organization, this should be set instead of first + last name

provider_idstring uuid required
tax_idstring
npistring required
taxonomy_codestring
qualifier'DQ' | 'DN' | 'DK' | 'P3'
provider_commercial_license_type'0' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I'

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the request's body type changed from no type to object

    • 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 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

    • 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 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

  • 3a81ee81d4edRevision changes
    • info

      api operation id update_supervising_provider removed and replaced with v2_update_supervising_provider