Update organization provider

PATCH

/api/organization-providers/v3/:organization_provider_id

Path parameters

organization_provider_idUUIDRequired

Request

This endpoint expects an object.

npistringOptional

The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.

is_renderingbooleanOptional

Whether the provider can be used to render services.

is_billingbooleanOptional

Whether the provider can be used to bill services.

first_namestringOptional

The first name of the provider, if the provider is an individual.

last_namestringOptional

The last name of the provider, if the provider is an individual.

organization_namestringOptional

The name of the provider, if the provider is an organization.

provider_type"INDIVIDUAL" or "ORGANIZATION"Optional

Allowed values: INDIVIDUALORGANIZATION

Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.

tax_idstringOptional

If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting.

taxonomy_codestringOptional

A code designating classification and specialization.

license_typeenumOptional

The type of license that the provider holds.

addresseslist of objectsOptional

The addresses associated with this provider.

employment_start_datestringOptional

The employment start date for the provider.

employment_termination_datestringOptional

The employment termination date for the provider.

qualificationslist of objectsOptional

Provider’s qualifications (medicare provider number, medicaid provider number, etc.)

Response

This endpoint returns an object.

npistring

The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.

is_renderingboolean

Whether the provider can be used to render services.

is_billingboolean

Whether the provider can be used to bill services.

provider_type"INDIVIDUAL" or "ORGANIZATION"

Allowed values: INDIVIDUALORGANIZATION

Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.

license_typeenum

The type of license that the provider holds.

organization_provider_idUUID

Auto-generated ID set on creation.

qualificationslist of objects

Qualification given to a provider (PTAN, Medicaid Provider Id etc.).

first_namestringOptional

The first name of the provider, if the provider is an individual.

last_namestringOptional

The last name of the provider, if the provider is an individual.

organization_namestringOptional

The name of the provider, if the provider is an organization.

tax_idstringOptional

If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting.

taxonomy_codestringOptional

A code designating classification and specialization.

addresseslist of objectsOptional

The addresses associated with this provider.

employment_start_datedateOptional

The employment start date for the provider.

employment_termination_datedateOptional

The employment termination date for the provider.

Errors

PATCH

1 curl -X PATCH https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "npi": "string",
3   "is_rendering": true,
4   "is_billing": true,
5   "provider_type": "INDIVIDUAL",
6   "license_type": "MD",
7   "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8   "qualifications": [
9     {
10       "identifier_code": "MCR",
11       "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12       "identifier_value": {
13         "type": "medicare_provider_identifier",
14         "provider_number": "string",
15         "state": "AA"
16       },
17       "period": {
18         "start_date": "string",
19         "end_date": "string"
20       }
21     }
22   ],
23   "first_name": "string",
24   "last_name": "string",
25   "organization_name": "string",
26   "tax_id": "string",
27   "taxonomy_code": "string",
28   "addresses": [
29     {
30       "address": {
31         "address1": "string",
32         "city": "string",
33         "state": "AA",
34         "zip_code": "string",
35         "zip_plus_four_code": "string",
36         "address2": "string"
37       },
38       "address_type": "DEFAULT"
39     }
40   ],
41   "employment_start_date": "2023-01-01",
42   "employment_termination_date": "2023-01-01"
43 }