Provider

A provider is a user who is delivering care to the patient. They can host appointments with patients, order prescriptions, order labs, sign and lock notes, and more.

The provider model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the provider.

  • Name
    object
    Type
    string
    Description

    Always 'provider'.

  • Name
    first_name
    Type
    string
    Description

    Provider's first name.

  • Name
    middle_name
    Type
    string
    Description

    Provider's middle name.

  • Name
    last_name
    Type
    string
    Description

    Provider's last name.

  • Name
    preferred_name
    Type
    string
    Description

    Provider's preferred name.

  • Name
    admin
    Type
    string
    Description

    Whether the provider is a global admin, local admin, or not an admin.

    Possible values:
    global_admin
    local_admin
    not_admin
  • Name
    email
    Type
    string
    Description

    Provider's email address.

  • Name
    phone
    Type
    string
    Description

    Provider's phone number.

  • Name
    medical_centers
    Type
    array of strings
    Description

    Medical centers that the provider belongs to.

  • Name
    specialization
    Type
    string
    Description

    What specialization (e.g. PCP, Nurse, etc.) the provider belongs to. Must be one of the specializations set for providers in the specializations object.

  • Name
    credentials
    Type
    string
    Description

    Provider's credentials (e.g. MD, DO, PhD, etc.)

  • Name
    bio
    Type
    string
    Description

    Short bio for the provider. This bio is shown to patients when they are booking an appointment.

  • Name
    npi
    Type
    string
    Description

    Provider's NPI.

  • Name
    dea_number
    Type
    string
    Description

    Provider's DEA number.

  • Name
    license_type
    Type
    string
    Description

    Type of license the provider has (e.g. MD, DO, RN, etc.)

    Possible values:
    MD
    DO
    NP
    RN
    PA
    Pharm.D
    DO
    LVN
    HA
    SC
    MSW
    VOL
    NU
    BC
    SN
    QAPI
    BSW
    LCSW
    ST
    OT
    LSW
    HC
    LCAT
    LMSW
  • Name
    licensed_in
    Type
    array of strings
    Description

    List of states the provider is licensed in. Use the states' two-letter acronym (e.g. 'CA,' 'NY').

  • Name
    signature
    Type
    string
    Description

    Provider's signature.

  • Name
    timezone
    Type
    string
    Description

    Provider's timezone.

  • Name
    status_history
    Type
    array of objects
    Description
    Status history of the provider.
  • Name
    custom_data
    Type
    array of objects
    Description

    Custom field and values added to the provider object.

  • Name
    created_by
    Type
    string
    Description

    Creator of the provider.

  • Name
    created_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the provider was created.

  • Name
    last_updated_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the provider was last updated.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "provider",
    "first_name": "Sam",
    "middle_name": "",
    "last_name": "Wellins",
    "preferred_name": null,
    "admin": "not_admin",
    "email": "sam@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_PKbvBirnEb1Mli1OLwqnM",
    "credentials": "MD, PhD",
    "bio": "Sam Wellins is a world-renowned primacy care physician best known for behavioral treatment analysis.",
    "npi": "1123456712",
    "dea_number": "F91234563",
    "license_type": "MD",
    "licensed_in": [
        "CA",
        "NY"
    ],
    "timezone": "America/New_York",
    "status_history": [
        {
            "status": "active",
            "changed_by": "user_xeDpGyt67wTor93qKtS7",
            "changed_at": 1653798303000
        }
    ],
    "custom_data": [
        {
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
        }
    ],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"000
}


POST/v2/providers

Create a provider

Creates a new provider.

Required attributes

  • Name
    first_name
    Type
    string
    Description

    Provider's first name.

  • Name
    last_name
    Type
    string
    Description

    Provider's last name.

  • Name
    admin
    Type
    string
    Description

    Whether the provider is a global admin, local admin, or not an admin.

    Possible values:
    global_admin
    local_admin
    not_admin
  • Name
    email
    Type
    string
    Description

    Provider's email address.

  • Name
    specialization
    Type
    string
    Description

    What specialization (e.g. PCP, Nurse, etc.) the provider belongs to. Must be one of the specializations set for providers in the specializations object.

  • Name
    npi
    Type
    string
    Description

    Provider's NPI.

  • Name
    timezone
    Type
    string
    Description

    Provider's timezone.

  • Name
    status
    Type
    string
    Description

    Status of the provider.

    Possible values:
    active
    suspended
    archived
  • Name
    custom_data
    Type
    array of objects
    Description

    Custom field and values added to the provider object. Some fields may be required while others as optional.

Optional attributes

  • Name
    middle_name
    Type
    string
    Description

    Provider's middle name.

  • Name
    preferred_name
    Type
    string
    Description

    Provider's preferred name.

  • Name
    phone
    Type
    string
    Description

    Provider's phone number.

  • Name
    medical_centers
    Type
    array of strings
    Description

    Medical centers that the provider belongs to.

  • Name
    credentials
    Type
    string
    Description

    Provider's credentials (e.g. MD, DO, PhD, etc.)

  • Name
    bio
    Type
    string
    Description

    Short bio for the provider. This bio is shown to patients when they are booking an appointment.

  • Name
    dea_number
    Type
    string
    Description

    Provider's DEA number.

  • Name
    license_type
    Type
    string
    Description

    Type of license the provider has (e.g. MD, DO, RN, etc.)

    Possible values:
    MD
    DO
    NP
    RN
    PA
    Pharm.D
    DO
    LVN
    HA
    SC
    MSW
    VOL
    NU
    BC
    SN
    QAPI
    BSW
    LCSW
    ST
    OT
    LSW
    HC
    LCAT
    LMSW
  • Name
    licensed_in
    Type
    array of strings
    Description

    List of states the provider is licensed in. Use the states' two-letter acronym (e.g. 'CA,' 'NY').

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "provider",
    "first_name": "Sam",
    "middle_name": "",
    "last_name": "Wellins",
    "admin": "not_admin",
    "email": "sam@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "specialization": "spec_PKbvBirnEb1Mli1OLwqnM",
    "bio": "Sam Wellins is a world-renowned primacy care physician best known for behavioral treatment analysis.",
    "npi": "1123456712",
    "dea_number": "F91234563",
    "license_type": "MD",
    "licensed_in": [
        "CA",
        "NY"
    ],
    "timezone": "America/New_York",
    "status_history": [
        {
            "status": "active",
            "changed_by": "user_xeDpGyt67wTor93qKtS7",
            "changed_at": 1653798303000
        }
    ],
    "custom_data": [
        {
        "id": "cdta_ZR6ioEDFTnKLFn62okn",
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "value": "Routine Care"
        }
    ],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"000
}


GET/v2/providers/:id

Retrieve a provider

Retrieves the specified provider.

Response

{
   "id": "user_idjkvxZTqfJD734feQHa",
   "object": "provider",
   "first_name": "Sam",
   "middle_name": "",
   "last_name": "Wellins",
   "admin": "not_admin",
   "email": "sam@demo.com",
   "phone": "(860)409-4300",
   "medical_centers": [
       "mctr_XbvBirnEb1Mli1OLwqnM"
   ],
   "specialization": "spec_PKbvBirnEb1Mli1OLwqnM",
   "bio": "Sam Wellins is a world-renowned primacy care physician best known for behavioral treatment analysis.",
   "npi": "1123456712",
   "dea_number": "F91234563",
   "license_type": "MD",
   "licensed_in": [
       "CA",
       "NY"
   ],
   "timezone": "America/New_York",
   "status_history": [
       {
           "status": "active",
           "changed_by": "user_xeDpGyt67wTor93qKtS7",
           "changed_at": 1653798303000
       }
   ],
   "custom_data": [
       {
       "id": "cdta_ZR6ioEDFTnKLFn62okn",
       "key": "cfld_FZR6ioEDTkHKn62oknLF",
       "value": "Routine Care"
       }
   ],
   "created_by": "user_xeDpGyt67wTor93qKtS7",
   "created_at": "2024-04-10T13:20:21.724Z",
   "last_updated_at": "2024-04-10T13:20:21.724Z"000
}


POST/v2/providers/:id

Update a provider

Updates the specified provider object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

    Optional attributes

    • Name
      first_name
      Type
      string
      Description

      Provider's first name.

    • Name
      middle_name
      Type
      string
      Description

      Provider's middle name.

    • Name
      last_name
      Type
      string
      Description

      Provider's last name.

    • Name
      admin
      Type
      string
      Description

      Whether the provider is a global admin, local admin, or not an admin.

      Possible values:
      globalAdmin
      localAdmin
      not_admin
    • Name
      phone
      Type
      string
      Description

      Provider's phone number.

    • Name
      medical_centers
      Type
      array of strings
      Description

      Medical centers that the provider belongs to.

    • Name
      specialization
      Type
      string
      Description

      What specialization (e.g. PCP, Nurse, etc.) the provider belongs to. Must be one of the specializations set for providers in the specializations object.

    • Name
      bio
      Type
      string
      Description

      Short bio for the provider. This bio is shown to patients when they are booking an appointment.

    • Name
      npi
      Type
      string
      Description

      Provider's NPI.

    • Name
      dea_number
      Type
      string
      Description

      Provider's DEA number.

    • Name
      license_type
      Type
      string
      Description

      Type of license the provider has (e.g. MD, DO, RN, etc.)

      Possible values:
      MD
      DO
      NP
      RN
      PA
      Pharm.D
      DO
      LVN
      HA
      SC
      MSW
      VOL
      NU
      BC
      SN
      QAPI
      BSW
      LCSW
      ST
      OT
      LSW
      HC
      LCAT
      LMSW
    • Name
      licensed_in
      Type
      array of strings
      Description

      List of states the provider is licensed in. Use the states' two-letter acronym (e.g. 'CA,' 'NY').

    • Name
      timezone
      Type
      string
      Description

      Provider's timezone.

    • Name
      status
      Type
      string
      Description

      Status of the provider.

      Possible values:
      active
      suspended
      archived
    • Name
      custom_data
      Type
      array of objects
      Description

      Custom field and values added to the provider object.

    Response

    {
        "id": "user_idjkvxZTqfJD734feQHa",
        "object": "provider",
        "first_name": "Sam",
        "middle_name": "",
        "last_name": "Wellins",
        "admin": "not_admin",
        "email": "sam@demo.com",
        "phone": "(860)409-4300",
        "medical_centers": [
            "mctr_XbvBirnEb1Mli1OLwqnM"
        ],
        "specialization": "spec_PKbvBirnEb1Mli1OLwqnM",
        "bio": "Sam Wellins is a world-renowned primacy care physician best known for behavioral treatment analysis.",
        "npi": "1123456712",
        "dea_number": "F91234563",
        "license_type": "MD",
        "licensed_in": [
            "CA",
            "NY"
        ],
        "timezone": "America/New_York",
        "status_history": [
            {
                "status": "active",
                "changed_by": "user_xeDpGyt67wTor93qKtS7",
                "changed_at": 1653798303000
            }
        ],
        "custom_data": [
            {
            "id": "cdta_ZR6ioEDFTnKLFn62okn",
            "key": "cfld_FZR6ioEDTkHKn62oknLF",
            "value": "Routine Care"
            }
        ],
        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": "2024-04-10T13:20:21.724Z",
        "last_updated_at": "2024-04-10T13:20:21.724Z"000
    }
    

    GET/v2/providers

    List all providers

    Returns a list of all provider.

    Response

    {
      "object": "list",
      "data": [{
        "id": "user_idjkvxZTqfJD734feQHa",
        "object": "provider",
        "first_name": "Sam",
        "middle_name": "",
        "last_name": "Wellins",
        "admin": "not_admin",
        "email": "sam@demo.com",
        "phone": "(860)409-4300",
        "medical_centers": [
            "mctr_XbvBirnEb1Mli1OLwqnM"
        ],
        "specialization": "spec_PKbvBirnEb1Mli1OLwqnM",
        "bio": "Sam Wellins is a world-renowned primacy care physician best known for behavioral treatment analysis.",
        "npi": "1123456712",
        "dea_number": "F91234563",
        "license_type": "MD",
        "licensed_in": [
            "CA",
            "NY"
        ],
        "timezone": "America/New_York",
        "status_history": [
            {
                "status": "active",
                "changed_by": "user_xeDpGyt67wTor93qKtS7",
                "changed_at": 1653798303000
            }
        ],
        "custom_data": [
            {
            "id": "cdta_ZR6ioEDFTnKLFn62okn",
            "key": "cfld_FZR6ioEDTkHKn62oknLF",
            "value": "Routine Care"
            }
        ],
        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": "2024-04-10T13:20:21.724Z",
        "last_updated_at": "2024-04-10T13:20:21.724Z"000
    }]
    }