latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

Update a practitioner's Social Security Number

Updates the Social Security Number for the specified practitioner. This operation requires elevated permission (PRACTITIONER_UPDATE_SSN) beyond standard practitioner update access. Use this only when the SSN on record is incorrect or needs to be set for the first time; SSN is sensitive PII, so access is restricted and audited. {id} is the certifyPractitionerId. The SSN must be exactly 9 plain digits with no dashes or spaces. This operation always writes — there is no read-then-compare, so resubmitting the same value still performs a write.

put/practitioners/{id}/ssn

Path parameters

idstring required

Practitioner ID

Headers

tenant-idstring

Request body

ssnstring required

Social Security Number

Example request

{
  "ssn": "123456789"
}

Response

Confirmation message that the SSN was updated (no ssn field is returned; use GET /practitioners/{id}/ssn to retrieve the value).