Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
v2/provider

Create Provider

Add a provider to the organization

post/v2/provider

Headers

organization-idstring

Request body

first_namestring required

First name of the Provider

middle_namestring

Middle name of the Provider

last_namestring required

Last name of the Provider

degree'AA' | 'ABA' | 'ACU' | 'ADC' | 'APN' | 'AT' | 'ATR' | 'AUD' | 'BCaBA' | 'BCBA' | 'BSW' | 'BT' | 'CBHT' | 'CMHC' | 'CNS' | 'CP' | 'CphT' | 'CPsyD' | 'CRNA' | 'CSP' | 'CSW' | 'CTRS' | 'DC' | 'DD' | 'DDS' | 'DMD' | 'DO' | 'DOU' | 'DPM' | 'DT' | 'EMT' | 'GC' | 'HOS' | 'IBCLC' | 'LactCon' | 'LBHC' | 'LCSW' | 'LMHC' | 'LN' | 'LP' | 'LPC' | 'LPN' | 'LPT' | 'MA' | 'MD' | 'MFT' | 'MT' | 'MW' | 'ND' | 'NEU' | 'NMW' | 'NP' | 'OA' | 'OD' | 'OPT' | 'OT' | 'OTA' | 'PA' | 'PC' | 'PDH' | 'PHA' | 'PHD' | 'PSW' | 'PT' | 'PTA' | 'PTNL' | 'RD' | 'RDH' | 'RDN' | 'RN' | 'RNFA' | 'Rph' | 'RPSGT' | 'RT' | 'SA' | 'SLP' | 'SW' required

Type of provider

npistring

NPI of the Provider

statesstring required

States in which Provider will provide care to patients/enrollees

caqh_provider_idstring

CAQH ID of the Provider

last_credentialed_datestring date-time

Date Provider was last credentialed

next_credentialing_datestring date-time

Date by which Provider needs to be recredentialed

initial_credentialing_datestring date-time

Date by which Provider was initially credentialed.

external_idstring

Client’s ID for the provider

primary_emailstring

Provider’s email address

gender'M' | 'F' | 'U'

Provider Gender

dobstring date-time

Provider’s date of birth

group_namestring

Name of the group

group_npistring

Group National Provider Identifier (NPI)

group_tinstring

Group Tax Identification Number (TIN)

location_namestring

Name of group location

external_group_idstring

Client’s ID for the group

is_pcpboolean

Indicates whether the provider is a Primary Care Provider (PCP).

is_specialistboolean

Indicates whether the provider is a specialist.

accepts_new_patientsboolean

Indicates whether the provider is currently accepting new patients.

accepts_new_medicare_patientsboolean

Indicates whether the provider accepts new Medicare patients.

Example request

{
  "primary_email": "string@string.com",
  "group_npi": "2345678901",
  "group_tin": "123456789"
}

Response

The record has been successfully created.

provider_idstring
is_createdboolean

Example response

{
  "provider_id": "sfas12345"
}