latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

Update practitioner overview and core identity fields

Updates the practitioner's overview information, including core identity fields such as name and NPI. Use this when basic practitioner identity or profile attributes need to be changed; for updating the full practitioner record, use PUT /practitioners/{id} instead. {id} is the certifyPractitionerId, and a 409 is returned if an initial credentialing workflow conflict is detected. Unlike PUT /practitioners/{id}, this endpoint is a true partial update: the service fetches the existing core record and merges only the explicitly-provided fields on top of it, distinguishing an omitted field from one explicitly set to null.

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

externalIdstring

External identifier for 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' | 'CredNotRequired'

Delegation status of the practitioner

initialCredentialingDatestring nullable

Date when the practitioner was first credentialed

lastCredentialingDatestring nullable

Date of the most recent credentialing

nextCredentialingDatestring nullable

Date the next credentialing is due

culturalCompetencyboolean nullable

Whether cultural competency training has been completed. Stored on the matching complianceTrainings entry.

Example request

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

Response

Practitioner overview updated successfully