Update Referring Physician¶
Update an existing referring physician record. Send only the fields that need to change; omitted fields retain their current values.
Endpoint¶
Path Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Yes | The id of the referring physician to update |
Request Body¶
All fields are optional. Include only the ones you want to change.
| Parameter | Type | Description |
|---|---|---|
first_name |
string | Physician's first name |
last_name |
string | Physician's last name |
middle_name |
string | Physician's middle name |
npi |
string | National Provider Identifier (exactly 10 digits) |
title |
string | Title prefix (e.g. Dr.) |
degree |
string | Medical degree (e.g. MD, DO, NP, PA) |
speciality |
string | Medical speciality |
taxonomy_code |
string | Provider taxonomy code |
phone_number |
string | Phone number |
group_name |
string | Group practice name |
org_id |
integer | Organisation ID |
office_address |
array | List of office addresses (see Office Address Object) |
Office Address Object¶
| Parameter | Type | Description |
|---|---|---|
office_name |
string | Office or practice name |
address1 |
string | Street address line 1 |
address2 |
string | Street address line 2 |
city |
string | City |
state |
string | 2-letter state code (e.g. CA, TX) |
zip |
string | ZIP / postal code |
fax_number |
string | Fax number |
email |
string | Email address |
Request¶
curl --location '{base_url}/apis/v2/referring-physician/5012' \
--header 'Authorization: Bearer JWT_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"phone_number": "555 987 6543",
"office_address": [
{
"office_name": "Chicago Ortho Group",
"address1": "789 New Medical Blvd",
"city": "Evanston",
"state": "IL",
"zip": "60201",
"fax_number": "5559876543"
}
]
}'
Response¶
Success Response¶
Code: 200 OK
{
"code": 2000,
"data": {
"id": 5012,
"first_name": "Robert",
"last_name": "Chen",
"middle_name": "James",
"full_name": "Robert James Chen",
"npi": "1234567890",
"title": "Dr.",
"degree": "MD",
"speciality": "Orthopedics",
"taxonomy_code": "207X00000X",
"phone_number": "555 987 6543",
"group_name": null,
"org_id": 74,
"office_address": [
{
"office_id": 1001,
"npi": "1234567890",
"office_name": "Chicago Ortho Group",
"address1": "789 New Medical Blvd",
"address2": null,
"city": "Evanston",
"state": "IL",
"zip": "60201",
"fax_number": "5559876543",
"email": null
}
]
},
"message": "Success"
}
Response Fields¶
| Field | Type | Description |
|---|---|---|
id |
integer | Referring physician ID |
first_name |
string | Physician's first name |
last_name |
string | Physician's last name |
middle_name |
string | Physician's middle name |
full_name |
string | Concatenated full name |
npi |
string | National Provider Identifier |
title |
string | Title prefix |
degree |
string | Medical degree |
speciality |
string | Medical speciality |
taxonomy_code |
string | Provider taxonomy code |
phone_number |
string | Phone number |
group_name |
string | Group practice name |
org_id |
integer | Organisation ID |
office_address |
array | Updated list of office address objects |
Error Response¶
Code: 404 Not Found
Notes¶
- If
npiis provided, it must be exactly 10 digits. statemust be a valid 2-letter USPS abbreviation.