View and Edit a Provider

Overview

Description: Retrieve data on a specific doctor, as well as the ability to add, edit or delete data on that doctor.

Endpoint: /v1/custom/providers/{NPI}

Status: Live

Methods: GET, PUT, POST, DELETE

Example use-case: You might have an important field for doctors that we do not yet have, or that only pertains to your unique use case. You could add that field to any doctor, and merge your data so that it shows up in the /v1/custom/providers search.

Generally, we're very flexible as to how you can edit a given doctor's data. However, when it comes to insurances, specialties, and locations we have certain standards as to how those fields can be edited. (Further detail in the later sections.) We maintain these standards so that data can be consistently merged and resolved for these fields as our dataset updates.

Diving in

For the GET request, you can get the full set of data on that doctor by simply calling the NPI number through /v1/custom/doctors/{NPI}:

curl -X GET \
  'https://api.ribbonhealth.com/v1/custom/providers/1234567890' \
  -H 'authorization: Token your_token'

We can see an initial view of our doctor object:

{
    "npi": "1234567890",
    "first_name": "Jane",
    "middle_name": "J",
    "last_name": "Doe",
    "age": 38,
    "gender": "f",
    "ratings_count": 20,
    "ratings_avg": 9.18,
    "degrees": [
        "MD"
    ],
    "specialties": [
        {
            "uuid": "18d8ad26-7e5f-44ac-9afa-966efb375344",
            "taxonomy_code": "207Q00000X",
            "board_specialty": "Family Medicine",
            "board_sub_specialty": "None",
            "non_md_specialty": null,
            "non_md_sub_specialty": null,
            "provider_name": "Family Medicine Doctor",
            "colloquial": null,
            "taxonomy_1": "Allopathic & Osteopathic Physicians",
            "taxonomy_2": "Family Medicine",
            "taxonomy_3": null,
            "display": "Family Medicine",
            "provider_type": "Doctor",
            "is_primary": true
        }
    ],
    "languages": [
        "english"
    ],
    "educations": [
        {
            "education": {
                "name": "Stritch School of Medicine",
                "uuid": "0b26c31a-d74a-4327-9702-57753b82a126"
            },
            "type": null,
            "year": 2007
        }
    ],
    "insurances": [
        {
            "uuid": "d8addf29-1054-4ccb-b179-dda65f7fefdd",
            "carrier_association": "Aetna",
            "carrier_brand": "Aetna",
            "carrier_name": "Aetna",
            "state": "",
            "plan_name": "Aetna HealthFund Open Choice",
            "plan_type": "PPO",
            "metal_level": "",
            "display_name": "Aetna - HealthFund Open Choice - PPO",
            "network": "",
            "confidence": 4
        },
        {... 72 additional insurances ...}
        {
            "uuid": "d4357c57-76d9-4fda-94b6-16ca8869cd45",
            "carrier_association": "UnitedHealthcare",
            "carrier_brand": "UnitedHealthcare",
            "carrier_name": "UnitedHealthcare",
            "state": "",
            "plan_name": "Passport Connect Choice Plus",
            "plan_type": "",
            "metal_level": "",
            "display_name": "Unitedhealthcare - Passport Connect Choice Plus",
            "network": "",
            "confidence": 4
        }
    ],
    "provider_types": [
        "Doctor"
    ],
    "locations": [
        {
            "uuid": "f38b9fd5-1e28-4f6e-953c-1e1493b68e21",
            "name": null,
            "address": "185 Berry St # 130, San Francisco, CA 94107, US",
            "address_details": {
                "street": "185 Berry St # 130",
                "address_line_1": "185 Berry St",
                "address_line_2": "# 130",
                "city": "San Francisco",
                "state": "CA",
                "zip": "94107"
            },
            "latitude": 37.7765973,
            "longitude": -122.3919488,
            "google_maps_link": "https://www.google.com/maps/@37.7765973,-122.3919488?q=185%20Berry%20St%20%23%20130%2C%20SF%2C%20CA%2094107%2C%20US",
            "phone_numbers": [
                {
                    "phone": "4155146410",
                    "details": "primary"
                },
                {
                    "phone": "4155146420",
                    "details": "secondary"
                },
                {
                    "phone": "4155146200",
                    "details": "secondary"
                }
            ],
            "confidence": 2
        },
        {... 3 additional locations ...}
    ],
    "online_profiles": [
    ]
}

Now, what if we want to edit or change this data? Well you're in for a real treat! (See below)