v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Practitioner

Update practitioner overview information

Updates practitioner overview information including basic details like name, NPI, and other core fields.

put/practitioners/{id}/overview

Path parameters

idstring required

Practitioner ID

Headers

tenant-idstring

Request body

firstNamestring

First name of the practitioner

lastNamestring

Last name of the practitioner

primaryEmailstring

Primary email address of the practitioner

middleNamestring

Middle name of the practitioner

prefixstring

Name prefix of the practitioner

suffixstring

Name suffix of the practitioner

npistring

National Provider Identifier

caqhProviderIdstring

CAQH Provider ID

caqhAttestationDatestring

CAQH attestation date

caqhPdqsobject

CAQH PDQS data object. Can be provided directly or via caqhAttestationDate field.

userDefinedFieldsobject

Custom user-defined fields. Replaces the entire userDefinedFields object (PUT semantics).

providerTypestring[]

Types of healthcare provider (e.g., MD, DO, NP)

practitionerTypestring[]

Types of healthcare practitioner (e.g., MD, DO, NP)

practitionerTypesToCredentialstring[]

Practitioner types to credential (e.g., MD, Physician)

medicareIdstring

Medicare PTAN

dateOfBirthstring

Date of birth

genderstring

Gender of the practitioner

ethnicitystring

Ethnicity of the practitioner

racestring

Race of the practitioner. Multiple selections stored as comma-separated values.

delegationStatus'Delegated' | 'Direct'

Delegation status of the practitioner

initialCredentialingDatestring nullable

Date when the practitioner was first credentialed

lastCredentialingDatestring nullable

Date of the most recent credentialing

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "primaryEmail": "john.doe@example.com",
  "middleName": "Clancy",
  "prefix": "Dr.",
  "suffix": "Jr.",
  "npi": "1483628392",
  "caqhProviderId": "23662864",
  "caqhAttestationDate": "2024-01-15",
  "providerType": [
    "MD",
    "DO"
  ],
  "practitionerType": [
    "MD",
    "DO"
  ],
  "practitionerTypesToCredential": [
    "MD",
    "Physician"
  ],
  "languages": [
    {
      "language": "English",
      "isPrimary": true
    },
    {
      "language": "Spanish"
    }
  ],
  "medicareId": "1EG4-TE5-MK73",
  "dateOfBirth": "1985-03-15",
  "gender": "Male",
  "ethnicity": "White",
  "race": "Asian, White",
  "delegationStatus": "Delegated",
  "initialCredentialingDate": "2020-01-15",
  "lastCredentialingDate": "2024-06-15"
}

Response

Practitioner overview updated successfully