Patch an existing provider

Allows you to change a provider's name or other data properties.

Request

path Parameters

providerId

required

string <uuid>

Identifier of the provider to patch.

Request Body schema: application/json

firstName	string If set, the provider's `firstName` will be updated with this value.
lastName	string If set, the provider's `lastName` will be updated with this value.
dateOfBirth	string <date-time> If set, the provider's `dateOfBirth` will be updated with this value.
ssn	string If set, the provider's `ssn` will be updated with this value.
npi	integer <int64> The 10 digit National Provider Identifiers (NPI) of this provider
	Array of objects (ProviderAliasRequestModel) If set, the provider's `aliases` will be updated with this value. To remove the aliases pass an empty array.
credentialingStatus	string If set, the provider's `credentialingStatus` will be updated with this value.
	Array of objects (ProviderEmailRequestModel) If set, the provider's `emails` will be updated with this value. To remove the emails pass an empty array.
	Array of objects (ProviderAddressRequestModel) If set, the provider's `addresses` will be updated with this value. To remove the addresses pass an empty array.
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
nextCredentialingDate	string <date> Date this provider should be credentialed next
recredentialedDates	Array of strings <date-time> A list of dates when this provider was re-credentialed.
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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/providers/{providerId}

Request samples

Payload

application/json

{"firstName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"npi": 0,
"aliases": [{"firstName": "string",
"lastName": "string"
}
],
"credentialingStatus": "string",
"emails": [{"email": "string",
"type": "Unspecified"
}
],
"addresses": [{"state": "AL",
"zipCode": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"type": "Unspecified"
}
],
"phone": "string",
"languages": ["string"
],
"credentialedDate": "2019-08-24T14:15:22Z",
"nextCredentialingDate": "2019-08-24",
"recredentialedDates": ["2019-08-24T14:15:22Z"
],
"providerTypeId": "7c48fbd8-5cbf-42dd-a198-1f0ad04354f0",
"deactivated": true
}

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": [{"firstName": "string",
"lastName": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"addresses": [{"state": "AL",
"zipCode": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"type": "Unspecified",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"emails": [{"email": "string",
"type": "Unspecified",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"phone": "string",
"languages": ["string"
],
"recredentialedDates": ["2019-08-24T14:15:22Z"
],
"providerType": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"createdAt": "2019-08-24T14:15:22Z"
}