Create a new provider

Creates a new provider that can be used to store information about this provider. Once a provider is created you can attach records, notes, documents and create other associations with this provider such as adding them to a Group or Payer.

Request
Request Body schema: application/json
firstName
string

The first (given) name of the provider.

lastName
string

The last (family) name of the provider.

dateOfBirth
string <date-time>

The date of birth of this provider.

ssn
string

The social security number of this provider.

npi
integer <int64>

The 10 digit National Provider Identifiers (NPI) of this provider

Array of objects (ProviderAliasRequestModel)

A list of aliases that this provider is also known by.

credentialingStatus
string

The name of credentialing status. The default value is 'Data Collection'.

Array of objects (ProviderEmailRequestModel)

A list with provider emails.

Array of objects (ProviderAddressRequestModel)

A list with provider addresses.

phone
string

Primary phone number associated with this provider

languages
Array of strings

A list of languages, other than English, this provider speaks.

credentialedDate
string <date-time>

Date this provider was originally credentialed

recredentialedDates
Array of strings <date-time>

A list of dates when this provider was re-credentialed.

nextCredentialingDate
string <date>

Date this provider should be credentialed next

providerTypeId
string <uuid>

Provider type id associated with this provider.

deactivated
boolean

If set to true, the provider will be deactivated. If set to false, the provider will be activated.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

post/providers
Request samples
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2000-08-24",
  • "ssn": "123456789"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "ssn": "string",
  • "credentialingStatus": "string",
  • "credentialedDate": "2019-08-24T14:15:22Z",
  • "nextCredentialingDate": "2019-08-24",
  • "npi": 0,
  • "deactivated": true,
  • "deactivatedAt": "2019-08-24T14:15:22Z",
  • "aliases": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "phone": "string",
  • "languages": [
    ],
  • "recredentialedDates": [
    ],
  • "providerType": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}