Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferenceOrganization ProvidersV3

PATCH
/api/organization-providers/v3/:organization_provider_id
PATCH
/api/organization-providers/v3/:organization_provider_id
1import uuid
2
3from candid import CandidApiClient
4from candid.resources.organization_providers.resources.v_3 import (
5 OrganizationProviderUpdateV2,
6)
7
8client = CandidApiClient(
9 client_id="YOUR_CLIENT_ID",
10 client_secret="YOUR_CLIENT_SECRET",
11)
12client.organization_providers.v_3.update(
13 organization_provider_id=uuid.UUID(
14 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15 ),
16 request=OrganizationProviderUpdateV2(),
17)
Try it
1{
2 "npi": "npi",
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": "provider_number",
15 "state": "AA"
16 },
17 "period": {
18 "start_date": "start_date",
19 "end_date": "end_date"
20 }
21 },
22 {
23 "identifier_code": "MCR",
24 "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
25 "identifier_value": {
26 "type": "medicare_provider_identifier",
27 "provider_number": "provider_number",
28 "state": "AA"
29 },
30 "period": {
31 "start_date": "start_date",
32 "end_date": "end_date"
33 }
34 }
35 ],
36 "first_name": "first_name",
37 "last_name": "last_name",
38 "organization_name": "organization_name",
39 "tax_id": "tax_id",
40 "taxonomy_code": "taxonomy_code",
41 "addresses": [
42 {
43 "address": {
44 "address1": "address1",
45 "city": "city",
46 "state": "AA",
47 "zip_code": "zip_code",
48 "zip_plus_four_code": "zip_plus_four_code",
49 "address2": "address2"
50 },
51 "address_type": "DEFAULT"
52 },
53 {
54 "address": {
55 "address1": "address1",
56 "city": "city",
57 "state": "AA",
58 "zip_code": "zip_code",
59 "zip_plus_four_code": "zip_plus_four_code",
60 "address2": "address2"
61 },
62 "address_type": "DEFAULT"
63 }
64 ],
65 "employment_start_date": "2023-01-15",
66 "employment_termination_date": "2023-01-15"
67}
Was this page helpful?
Previous

Get organization service facility

Next
Built with
Update organization provider

Path parameters

organization_provider_idUUIDRequired

Headers

AuthorizationstringRequired
OAuth authentication of the form `<token>`.

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_typeenumOptional
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values:
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_typeenum
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values:
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_namestring or null
The first name of the provider, if the provider is an individual.
last_namestring or null
The last name of the provider, if the provider is an individual.
organization_namestring or null
The name of the provider, if the provider is an organization.
tax_idstring or null
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_codestring or null
A code designating classification and specialization.
addresseslist of objects or null
The addresses associated with this provider.
employment_start_datedate or null
The employment start date for the provider.
employment_termination_datedate or null
The employment termination date for the provider.

Errors

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

Auto-generated ID set on creation.

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

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.

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.

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

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

OAuth authentication of the form <token>.

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

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