Create organization provider

POST

/api/organization-providers/v3

POST

/api/organization-providers/v3

$ curl -X POST https://api.joincandidhealth.com/api/organization-providers/v3 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "npi": "npi",
>   "is_rendering": true,
>   "is_billing": true,
>   "provider_type": "INDIVIDUAL",
>   "license_type": "MD",
>   "qualifications": [
>     {
>       "identifier_code": "MCR",
>       "identifier_value": {
>         "type": "medicare_provider_identifier",
>         "provider_number": "provider_number",
>         "state": "AA"
>       }
>     },
>     {
>       "identifier_code": "MCR",
>       "identifier_value": {
>         "type": "medicare_provider_identifier",
>         "provider_number": "provider_number",
>         "state": "AA"
>       }
>     }
>   ]
> }'

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         "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17       },
18       "period": {
19         "start_date": "start_date",
20         "end_date": "end_date"
21       }
22     },
23     {
24       "identifier_code": "MCR",
25       "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26       "identifier_value": {
27         "type": "medicare_provider_identifier",
28         "provider_number": "provider_number",
29         "state": "AA",
30         "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
31       },
32       "period": {
33         "start_date": "start_date",
34         "end_date": "end_date"
35       }
36     }
37   ],
38   "first_name": "first_name",
39   "last_name": "last_name",
40   "organization_name": "organization_name",
41   "tax_id": "tax_id",
42   "taxonomy_code": "taxonomy_code",
43   "addresses": [
44     {
45       "address": {
46         "address1": "address1",
47         "city": "city",
48         "state": "AA",
49         "zip_code": "zip_code",
50         "zip_plus_four_code": "zip_plus_four_code",
51         "address2": "address2"
52       },
53       "address_type": "DEFAULT"
54     },
55     {
56       "address": {
57         "address1": "address1",
58         "city": "city",
59         "state": "AA",
60         "zip_code": "zip_code",
61         "zip_plus_four_code": "zip_plus_four_code",
62         "address2": "address2"
63       },
64       "address_type": "DEFAULT"
65     }
66   ],
67   "employment_start_date": "2023-01-15",
68   "employment_termination_date": "2023-01-15"
69 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

npistringRequired

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

is_renderingbooleanRequired

Whether the provider can be used to render services.

is_billingbooleanRequired

Whether the provider can be used to bill services.

provider_typeenumRequired

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

license_typeenumRequired

The type of license that the provider holds.

qualificationslist of objectsRequired

A provider's qualifications such as PTAN, Medicaid Provider Id, etc.

first_namestringOptional

The first name of the provider. Required when provider_type is INDIVIDUAL. Must not be set when provider_type is ORGANIZATION.

last_namestringOptional

The last name of the provider. Required when provider_type is INDIVIDUAL. Must not be set when provider_type is ORGANIZATION.

organization_namestringOptional

The name of the provider. Required when provider_type is ORGANIZATION. Must not be set when provider_type is INDIVIDUAL.

tax_idstringOptional

Required when is_billing is true. 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.

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.

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.