Skip to content

Create Referring Physician

Create a new referring physician record in the system.

Endpoint

POST /apis/v2/referring-physician

Request Body

Parameter Type Required Description
first_name string Yes Physician's first name
last_name string Yes Physician's last name
middle_name string No Physician's middle name
npi string No National Provider Identifier (exactly 10 digits)
title string No Title prefix (e.g. Dr.)
degree string No Medical degree (e.g. MD, DO, NP, PA)
speciality string No Medical speciality
taxonomy_code string No Provider taxonomy code
phone_number string No Phone number
group_name string No Group practice name
org_id integer Yes Organisation ID
office_address array No List of office addresses (see Office Address Object)

Office Address Object

Parameter Type Required Description
office_name string No Office or practice name
address1 string No Street address line 1
address2 string No Street address line 2
city string No City
state string No 2-letter state code (e.g. CA, TX)
zip string No ZIP / postal code
fax_number string No Fax number
email string No Email address

Request

curl --location '{base_url}/apis/v2/referring-physician' \
  --header 'Authorization: Bearer JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Robert",
    "last_name": "Chen",
    "middle_name": "James",
    "npi": "1234567890",
    "degree": "MD",
    "title": "Dr.",
    "speciality": "Orthopedics",
    "taxonomy_code": "207X00000X",
    "phone_number": "555 123 4567",
    "org_id": 74,
    "office_address": [
      {
        "office_name": "Chicago Ortho Group",
        "address1": "456 Medical Center Dr",
        "address2": "Suite 300",
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "fax_number": "5551234567",
        "email": "rchen@chicagoortho.example.com"
      }
    ]
  }'

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 123 4567",
    "group_name": null,
    "org_id": 74,
    "office_address": [
      {
        "office_id": 1001,
        "npi": "1234567890",
        "office_name": "Chicago Ortho Group",
        "address1": "456 Medical Center Dr",
        "address2": "Suite 300",
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "fax_number": "5551234567",
        "email": "rchen@chicagoortho.example.com"
      }
    ]
  },
  "message": "Success"
}

Response Fields

Field Type Description
id integer Unique ID of the created referring physician
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 (auto-generated)
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 List of office address objects
office_address[].office_id integer Unique ID of the office address record
office_address[].npi string NPI of the physician this address belongs to
office_address[].office_name string Office or practice name
office_address[].address1 string Street address line 1
office_address[].address2 string Street address line 2
office_address[].city string City
office_address[].state string State code
office_address[].zip string ZIP code
office_address[].fax_number string Fax number
office_address[].email string Email address

Error Response

Code: 400 Bad Request

{
  "code": 4000,
  "data": null,
  "message": "First Name must not be blank"
}

Notes

  • npi, if provided, must be exactly 10 digits.
  • state must be a valid 2-letter USPS abbreviation.
  • A physician can have multiple office addresses; each entry in office_address creates a separate address record.
  • If a fax number already exists for the same NPI and organisation, the office_address entry containing it will be ignored.