Organization ProvidersV3

Create organization provider

POST
https://api.joincandidhealth.com/api/organization-providers/v3

Request

This endpoint expects an object.
npi
string
The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.
is_rendering
boolean
Whether the provider can be used to render services.
is_billing
boolean
Whether the provider can be used to bill services.
provider_type
enum
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values: INDIVIDUALORGANIZATION
license_type
enum
The type of license that the provider holds.
qualifications
list of objects
A provider's qualifications such as PTAN, Medicaid Provider Id, etc.
first_name
optional string
The first name of the provider, if the provider is an individual.
last_name
optional string
The last name of the provider, if the provider is an individual.
organization_name
optional string
The name of the provider, if the provider is an organization.
tax_id
optional string
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_code
optional string
A code designating classification and specialization.
addresses
optional list of objects
The addresses associated with this provider.
employment_start_date
optional date
The employment start date for the provider.
employment_termination_date
optional date
The employment termination date for the provider.

Response

This endpoint return an object.
npi
string
The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long.
is_rendering
boolean
Whether the provider can be used to render services.
is_billing
boolean
Whether the provider can be used to bill services.
provider_type
enum
Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider.
Allowed values: INDIVIDUALORGANIZATION
license_type
enum
The type of license that the provider holds.
organization_provider_id
UUID
Auto-generated ID set on creation.
qualifications
list of objects
Qualification given to a provider (PTAN, Medicaid Provider Id etc.).
first_name
optional string
The first name of the provider, if the provider is an individual.
last_name
optional string
The last name of the provider, if the provider is an individual.
organization_name
optional string
The name of the provider, if the provider is an organization.
tax_id
optional string
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_code
optional string
A code designating classification and specialization.
addresses
optional list of objects
The addresses associated with this provider.
employment_start_date
optional date
The employment start date for the provider.
employment_termination_date
optional date
The employment termination date for the provider.

Errors

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": "string",
"is_rendering": true,
"is_billing": true,
"provider_type": "INDIVIDUAL",
"license_type": "MD",
"qualifications": [
{
"identifier_code": "MCR",
"identifier_value": {
"type": "medicare_provider_identifier",
"provider_number": "string",
"state": "AA"
}
}
]
}'
Response
{
"npi": "string",
"is_rendering": true,
"is_billing": true,
"provider_type": "INDIVIDUAL",
"license_type": "MD",
"organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"qualifications": [
{
"identifier_code": "MCR",
"identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"identifier_value": {
"type": "medicare_provider_identifier",
"provider_number": "string",
"state": "AA"
},
"period": {
"start_date": "string",
"end_date": "string"
}
}
],
"first_name": "string",
"last_name": "string",
"organization_name": "string",
"tax_id": "string",
"taxonomy_code": "string",
"addresses": [
{
"address": {
"address1": "string",
"city": "string",
"state": "AA",
"zip_code": "string",
"zip_plus_four_code": "string",
"address2": "string"
},
"address_type": "DEFAULT"
}
],
"employment_start_date": "2023-01-01",
"employment_termination_date": "2023-01-01"
}