NAV Navbar
Logo cerner
Ruby Shell

Provider API v1

The HealtheIntent Provider API enables you to create, update, and retrieve the providers of health care services in a health care system. In this context, a provider is considered a subset of personnel and organizations defined in Personnel Tool, the HealtheIntent configuration tool for personnel. Provider personnel are individual health care practitioners, such as doctors, clinicians, or specialists. Provider organizations are the organizations that offer or provide health care services, but when you visit or receive a referral to one of these organizations, you do not schedule an appointment with a specific practitioner. Examples of a provider organization include physical therapy facilities, radiology facilities, and laboratories.

Designating a HealtheIntent provider personnel or an organization as a provider involves assigning the entity a provider role. A provider role defines a specific job performed by the provider in the context of the role-assigning organization. This role includes but is not limited to references to the following attributes:

A given provider may be assigned multiple roles, depending on how many distinct combinations of the attributes above are required to describe services performed by the provider and where they are provided. Likewise, a provider may require separate roles if the provider is contracted to perform only a subset of specialized services under certain payer plans but not under others.

For example, one specialist who offers the same set of services at any of the three practice offices where she works may have a single provider personnel role that describes the relationship that defines her job. Another specialist in the same practice may offer only a subset of the same services in two of the practice offices on four days out of the week. This second specialist also provides a different set of services on Fridays when he works in the emergency department at the local hospital. He requires two roles to describe the two distinct sets of service and location relationships that define his jobs.

This API supports the main definitional endpoints for managing these provider personnel and organization roles. In addition, specific endpoints are provided for searching for provider personnel or organizations. These endpoints allow the consumer of this service to search for providers based on a variety of criteria, such as provider name, service type, specialty, and location name or other address attributes. The resulting response includes those providers and their locations that best match the specified criteria.

URL: https://cernerdemo.api.us.healtheintent.com/provider/v1

Provider Personnel Roles

Provider personnel roles represent the different jobs a provider may perform while offering a variety of health care services in different locations or settings. A given HealtheIntent personnel member may be assigned a single or multiple provider roles, depending on how many distinct combinations of specialties, health care services, and locations the provider supports across organizational contexts.

Create a Provider Personnel Role

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles', headers: headers, body: {"name":"Surgeon at NorthWest Healthcare","providerPersonnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2019-01-01","endDate":"2019-06-01"}],"status":"ACTIVE","paymentTaxId":"152684597EE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Surgeon at NorthWest Healthcare","providerPersonnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2019-01-01","endDate":"2019-06-01"}],"status":"ACTIVE","paymentTaxId":"152684597EE"}

POST /provider-personnel-roles

Creates a provider personnel role.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderPersonnelRoles true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created personnel role.

Retrieve a List of Provider Personnel Roles

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles',
  query: {
  'pcpIndicator' => 'boolean'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles?pcpIndicator=type,boolean \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon @ NorthEastPole Healthcare",
      "personnel": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Jay Bee"
      },
      "providerPersonnel": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0"
      },
      "assignedBy": {
        "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
        "name": "Associates For Women's Healthcare"
      },
      "providedAt": [
        {
          "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
          "name": "Pulmonary and Sleep Medicine SC"
        },
        {
          "id": "79739004-09db-11e8-9dc2-587234aecbf0",
          "name": "Rheumatology Specialists SC"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO GOLD"
        },
        {
          "id": "3002ad1133ce467f9acf8c347b4f0eeb",
          "name": "ECBS vs. FCBC"
        }
      ],
      "healthcareServices": [
        {
          "id": "11e87375edcdded880535db964285cae",
          "name": "rheumatoid arthritis"
        },
        {
          "id": "f9ed82acf21c11e7a3d646705f8c9e77",
          "name": "osteoarthritis consultation"
        }
      ],
      "specialties": [
        {
          "specialtyId": "2b6116d78e36438e804f758db09d9ed2",
          "taxonomyId": "123cfba4dead11e7a3d646705f8c9e77"
        },
        {
          "specialtyId": "765116d78e36438e804f758db09d9ed2",
          "taxonomyId": "109cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "primarySpecialties": [
        {
          "specialtyId": "1a5116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "aliases": [
        {
          "system": "personnel-profile-id",
          "value": "512cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "status": "ACTIVE",
      "paymentTaxId": "18364201AC",
      "acceptingPatients": true,
      "pcpStatuses": [
        {
          "pcpIndicator": true,
          "effectiveDate": "2018-01-01",
          "endDate": "2019-06-01"
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "1b87eee2-09de-11e8-9dc2-587234aecbf0",
      "name": "Surgeon at NorthWest Healthcare",
      "personnel": {
        "id": "1d1aaa88-09de-11e8-9dc2-587234aecbf0",
        "name": "Elizabeth Buck"
      },
      "providerPersonnel": {
        "id": "1d1aaa88-09de-11e8-9dc2-587234aecbf0"
      },
      "assignedBy": {
        "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
        "name": "Associates For Women's Healthcare"
      },
      "providedAt": [
        {
          "id": "4a1eea6c-09de-11e8-9dc2-587234aecbf0",
          "name": "Northwest Neurology Ltd",
          "addressText": "22285 N Pepper Rd #401, Lake Barrington, IL, 60010"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO GOLD"
        }
      ],
      "healthcareServices": [
        {
          "id": "3a42042af21f11e7a3d646705f8c9e77",
          "name": "Epilepsy consultation"
        },
        {
          "id": "11e875607a77c5ef840bddd8dc576c20",
          "name": "Stroke treatment"
        }
      ],
      "specialties": [
        {
          "specialtyId": "2b4116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        },
        {
          "specialtyId": "65t116d78e36438e804f758db09d9ed2",
          "taxonomyId": "123cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "primarySpecialties": [
        {
          "specialtyId": "0b66465424c111e9ab14d663bd873d93",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "aliases": [
        {
          "system": "personnel-profile-id",
          "value": "612cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "status": "ACTIVE",
      "paymentTaxId": "18364201AC",
      "acceptingPatients": false,
      "pcpStatuses": [
        {
          "pcpIndicator": true,
          "effectiveDate": "2017-01-01",
          "endDate": "2017-06-01"
        },
        {
          "pcpIndicator": true,
          "effectiveDate": "2018-01-01",
          "endDate": "2019-01-01"
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles?offset=0&limit=20"
}

GET /provider-personnel-roles

Retrieves a list of provider personnel roles.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The personnel role ID or IDs to filter by. -
name query string false N/A The name of the personnel role. Filtering by a partial match is allowed. -
assignedBy query string false N/A The ID of the organization for which the role is available or to which it may be assigned. -
personnelId query string false N/A The ID of the personnel that is able to provide the defined services for the organization. -
providerPersonnelId query string false N/A The ID of the provider personnel that is able to provide the defined services for the organization. -
providedAt query string false N/A The ID of a location where the provider represented by this role offers care. -
networkId query string false N/A The ID of a network which covers this personnel role. -
healthcareServiceId query string false N/A The ID of a health care service that this role provides. -
specialtyId query string false N/A The ID of a personnel role specialty. If this is specified, taxonomyId must also be specified. -
taxonomyId query string false N/A The taxonomy ID of a specialty of the personnel role. If this is specified, specialtyId must also be specified. -
primarySpecialtyId query string false N/A The ID of a personnel role primary specialty. If this is specified, primarySpecialtyTaxonomyId must also be specified. -
primarySpecialtyTaxonomyId query string false N/A The taxonomy ID of a primary specialty of the personnel role. If this is specified, primarySpecialtyId must also be specified. -
status query string false N/A The status of the personnel role. ACTIVE, INACTIVE
paymentTaxId query string false N/A The Taxpayer Identification Number (TIN) of a personnel that is applicable for services rendered by the personnel role. -
aliasSystem query string false N/A The authority responsible for assigning the alias value. Alias values are unique within the personnel role namespace but not across systems. If this is specified, aliasValue must also be specified. -
aliasValue query string false N/A The unique ID of the personnel role in the context of the system or assigning authority. If this is specified, aliasSystem must also be specified. -
acceptingPatients query boolean false N/A Indicates whether a provider in the role accepts new patients. -
pcpIndicator query boolean true N/A The primary care physician (PCP) status of the personnel role in a specific time frame. -
pcpEffectiveDate query string false N/A The begin date of a personnel role as a PCP. If this is specified, pcpIndicator must also be specified. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false personnelId,-updatedAt A comma-separated list of fields by which to sort. personnelId, -personnelId, name, -name, updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success PersonnelRoles
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Provider Personnel Role

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles/11e8a5750246534cbae93fe1756e44cf', headers: headers, body: {"name":"Surgeon at NorthWest Healthcare","providerPersonnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2019-01-01","endDate":"2019-06-01"}],"status":"ACTIVE","paymentTaxId":"152684597EE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles/11e8a5750246534cbae93fe1756e44cf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Surgeon at NorthWest Healthcare","providerPersonnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2019-01-01","endDate":"2019-06-01"}],"status":"ACTIVE","paymentTaxId":"152684597EE"}

PUT /provider-personnel-roles/{personnelRoleId}

Updates a provider personnel role.

Parameters

Parameter In Type Required Default Description Accepted Values
personnelRoleId path string true N/A No description -
body body putProviderPersonnelRoles true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error

Provider Organization Roles

Provider organization roles identify which subset of HealtheIntent organizations are designated as provider organizations when performing operations such as a provider search. The management of services offered across locations within a given organization is managed through the Healthcare Service API.

Create a Provider Organization Role

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles', headers: headers, body: {"providerOrganization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"organization-profile-id","value":"533cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"152684597EE","acceptingPatients":true,"roleType":{"text":"Sample text","codings":[{"code":"IPA","system":"CLIENT1:123456789"}]}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerOrganization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"organization-profile-id","value":"533cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"152684597EE","acceptingPatients":true,"roleType":{"text":"Sample text","codings":[{"code":"IPA","system":"CLIENT1:123456789"}]}}

POST /provider-organization-roles

Creates a provider organization role.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderOrganizationRoles true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created organization role.

Retrieve a List of Provider Organization Roles

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
      "organization": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Premier Quest Lab"
      },
      "providerOrganization": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0"
      },
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        },
        {
          "id": "9d6c9f070ab811e89dc2587234aecbf0",
          "name": "CIGNA PPO Platinum"
        }
      ],
      "specialties": [
        {
          "specialtyId": "1a5116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "primarySpecialties": [
        {
          "specialtyId": "1a5116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "aliases": [
        {
          "system": "organization-profile-id",
          "value": "212cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "status": "ACTIVE",
      "paymentTaxId": "18364201AC",
      "acceptingPatients": true,
      "roleType": {
        "text": "Sample 1234",
        "codings": [
          {
            "code": "IPA",
            "system": "testSystem"
          }
        ]
      },
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "11e8860ca0771b91be9009736596b9ba",
      "organization": {
        "id": "1d1aaa88-09de-11e8-9dc2-587234aecbf0",
        "name": "Christiana care lab services"
      },
      "providerOrganization": {
        "id": "1d1aaa88-09de-11e8-9dc2-587234aecbf0"
      },
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "specialties": [
        {
          "specialtyId": "1a5116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "primarySpecialties": [
        {
          "specialtyId": "1a5116d78e36438e804f758db09d9ed2",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "aliases": [
        {
          "system": "organization-profile-id",
          "value": "312cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "status": "ACTIVE",
      "paymentTaxId": "18364201AC",
      "acceptingPatients": false,
      "roleType": {
        "text": "Sample 5678"
      },
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles?offset=0&limit=20"
}

GET /provider-organization-roles

Retrieves a list of provider organization roles.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The organization role ID or IDs to filter by. -
organizationId query string false N/A The ID of the organization for which this organization role has been established. -
providerOrganizationId query string false N/A The ID of the provider organization for which this organization role has been established. -
networkId query string false N/A The ID of the network with which this organization role has a contractual relationship. -
specialtyId query string false N/A The ID of an organization role specialty. If this is specified, taxonomyId must also be specified. -
taxonomyId query string false N/A The taxonomy ID of a specialty of the organization role. If this is specified, specialtyId must also be specified. -
primarySpecialtyId query string false N/A The ID of an organization role primary specialty. If this is specified, primarySpecialtyTaxonomyId must also be specified. -
primarySpecialtyTaxonomyId query string false N/A The taxonomy ID of a primary specialty of the organization role. If this is specified, primarySpecialtyId must also be specified. -
status query string false N/A The status of the organization role. ACTIVE, INACTIVE
paymentTaxId query string false N/A The TIN of an organization that is applicable for services rendered by the organization role. -
aliasSystem query string false N/A The authority responsible for assigning the alias value. Alias values are unique within the organization role namespace but not across systems. If this is specified, aliasValue must also be specified. -
aliasValue query string false N/A The unique ID of the organization role in the context of the system or assigning authority. If this is specified, aliasSystem must also be specified. -
acceptingPatients query boolean false N/A The attribute that can be used outside attributions to indicate that an organization in a role accepts new patients. -
roleTypeText query string false N/A A human-readable, potentially personalized description of a role type. -
roleTypeCode query string false N/A The unique ID of the code. If valued, roleTypeCodeSystem is required. -
roleTypeCodeSystem query string false N/A The ID of the coding system that gives meaning to the code. If valued, roleTypeCode is required. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success OrganizationRoles
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Provider Organization Role

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"providerOrganization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"organization-profile-id","value":"533cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"152684597EE","acceptingPatients":true,"roleType":{"text":"Sample text","codings":[{"code":"IPA","system":"CLIENT1:123456789"}]}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles/11e8a0b6e3d9e4b7bae9bd3b7d82a964 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerOrganization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}],"aliases":[{"system":"organization-profile-id","value":"533cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"152684597EE","acceptingPatients":true,"roleType":{"text":"Sample text","codings":[{"code":"IPA","system":"CLIENT1:123456789"}]}}

PUT /provider-organization-roles/{organizationRoleId}

Updates a provider organization role.

Parameters

Parameter In Type Required Default Description Accepted Values
organizationRoleId path string true N/A No description -
body body putProviderOrganizationRoles true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Network Relationship Types

Provider network relationship types represent different contractual relationships providers may have to a given provider network. These definitions support an optional rank or preference order for provider search results.

Create a Provider Network Relationship Type.

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types', headers: headers, body: {"name":"CAPPED","rankOrder":"1"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CAPPED","rankOrder":"1"}

POST /provider-network-relationship-types

Creates a provider network relationship type.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderNetworkRelationshipTypes true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created provider network relationship type.

Retrieve a List of Provider Network Relationship Types

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "e1a9eacc427711e89a8ea7eba4735242",
      "name": "CAPPED",
      "rankOrder": "1",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types?offset=0&limit=20"
}

GET /provider-network-relationship-types

Retrieves a list of provider network relationship types.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A The name of the relationship type, for example, CAPPED, ANCILLARY, or TERTIARY. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success NetworkRelationshipTypeEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Access Error
403 Forbidden Access Forbidden Error

Update a Provider Network Relationship Type.

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types/e1a9eacc427711e89a8ea7eba4735242', headers: headers, body: {"name":"CAPPED","rankOrder":"1"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types/e1a9eacc427711e89a8ea7eba4735242 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CAPPED","rankOrder":"1"}

PUT /provider-network-relationship-types/{providerNetworkRelationshipTypeId}

Updates a provider network relationship type.

Parameters

Parameter In Type Required Default Description Accepted Values
providerNetworkRelationshipTypeId path string true N/A No description -
body body putProviderNetworkRelationshipTypes true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error

Retrieve a Single Provider Network Relationship Type

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types/e1a9eacc427711e89a8ea7eba4735242', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-network-relationship-types/e1a9eacc427711e89a8ea7eba4735242 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "e1a9eacc427711e89a8ea7eba4735242",
  "name": "CAPPED",
  "rankOrder": "1",
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

GET /provider-network-relationship-types/{providerNetworkRelationshipTypeId}

Retrieves a single provider network relationship type.

Parameters

Parameter In Type Required Default Description Accepted Values
providerNetworkRelationshipTypeId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A provider network relationship type object NetworkRelationshipTypeEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Networks

Provider networks describe the relationships between providers and payer- or plan-specific networks. They also capture the type and duration of these relationships as they change over time.

Create a Provider Network

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks', headers: headers, body: {"role":{"id":"11e8a5750246534cbae93fe1756e44cf","kind":"PERSONNEL"},"network":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"relationshipType":{"id":"e1a9eacc427711e89a8ea7eba4735242"},"effectiveStart":"2016-01-01","effectiveEnd":"2018-12-31","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":{"id":"11e8a5750246534cbae93fe1756e44cf","kind":"PERSONNEL"},"network":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"relationshipType":{"id":"e1a9eacc427711e89a8ea7eba4735242"},"effectiveStart":"2016-01-01","effectiveEnd":"2018-12-31","status":"ACTIVE"}

POST /provider-networks

Creates a provider network.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderNetworks true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created provider network.

Retrieve a List of Provider Networks

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "8c95b90d1d1c4f56bc8a54e4fd30644b",
      "role": {
        "id": "babbf210-5783-4c8e-a570-3c33a2c30485",
        "kind": "PERSONNEL"
      },
      "network": {
        "id": "cc46c4c2deac11e7a3d646705f8c9e77",
        "name": "HMO Gold"
      },
      "relationshipType": {
        "id": "e1a9eacc427711e89a8ea7eba4735242",
        "name": "CAPPED"
      },
      "effectiveStart": "2017-01-01",
      "effectiveEnd": "2018-12-31",
      "status": "ACTIVE",
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "db5b2aad251e44e581daae6463556a73",
      "role": {
        "id": "babbf210-5783-4c8e-a570-3c33a2c30485",
        "kind": "PERSONNEL"
      },
      "network": {
        "id": "9d6c9f070ab811e89dc2587234aecbf0",
        "name": "CIGNA PPO Platinum"
      },
      "relationshipType": {
        "id": "047cff08427811e89a8ea7eba4735242",
        "name": "ANCILLARY"
      },
      "effectiveStart": "2016-01-01",
      "effectiveEnd": "2018-12-31",
      "status": "ACTIVE",
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks?offset=0&limit=20"
}

GET /provider-networks

Retrieves a list of provider networks.

Parameters

Parameter In Type Required Default Description Accepted Values
networkId query string false N/A The ID of the network with which the provider personnel or organizations have contracted to provide services, as defined by their provider roles. -
personnelId query string false N/A The ID of the provider personnel member who has the relationship to the network or networks. Should be provided only if an organization ID is not -
organizationId query string false N/A The ID of the provider organization that has the relationship to the network or networks. Should be provided only if a personnel ID is not -
effectiveDate query string false N/A A date provided to filter provider network associations based on their effective start and end dates. For example, entering the current date would return only those provider network associations with an effective period that includes the current date (that is, currently effective). Value should be in YYYY-MM-DD format. -
status query string false N/A The status of the provider network relationship. ACTIVE, INACTIVE
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. roleId, -roleId, updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success ProviderNetworks
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Provider Network

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks/8c95b90d1d1c4f56bc8a54e4fd30644b', headers: headers, body: {"role":{"id":"11e8a5750246534cbae93fe1756e44cf","kind":"PERSONNEL"},"network":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"relationshipType":{"id":"e1a9eacc427711e89a8ea7eba4735242"},"effectiveStart":"2016-01-01","effectiveEnd":"2018-12-31","status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks/8c95b90d1d1c4f56bc8a54e4fd30644b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":{"id":"11e8a5750246534cbae93fe1756e44cf","kind":"PERSONNEL"},"network":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"relationshipType":{"id":"e1a9eacc427711e89a8ea7eba4735242"},"effectiveStart":"2016-01-01","effectiveEnd":"2018-12-31","status":"ACTIVE"}

PUT /provider-networks/{providerNetworkId}

Updates a provider network.

Parameters

Parameter In Type Required Default Description Accepted Values
providerNetworkId path string true N/A No description -
body body putProviderNetworks true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error

Retrieve a Single Provider Network

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks/8c95b90d1d1c4f56bc8a54e4fd30644b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-networks/8c95b90d1d1c4f56bc8a54e4fd30644b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "8c95b90d1d1c4f56bc8a54e4fd30644b",
  "network": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "HMO GOLD"
  },
  "role": {
    "id": "11e8a5750246534cbae93fe1756e44cf",
    "kind": "PERSONNEL"
  },
  "relationshipType": {
    "id": "e1a9eacc427711e89a8ea7eba4735242",
    "name": "CAPPED"
  },
  "effectiveStart": "2016-01-01",
  "effectiveEnd": "2018-12-31",
  "status": "ACTIVE",
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

GET /provider-networks/{providerNetworkId}

Retrieves a single provider network.

Parameters

Parameter In Type Required Default Description Accepted Values
providerNetworkId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A provider network object ProviderNetwork
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Personnel

Provider personnel identify which subset of HealtheIntent personnel are designated as provider personnel when performing operations such as a provider search.

Create a Provider Personnel

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel', headers: headers, body: {"personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}

POST /provider-personnel

Creates a provider personnel.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderPersonnel true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created provider personnel.

Retrieve a List of Provider Personnel

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e91f884c18d5d4805aeb96e2647bb8",
      "personnel": {
        "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
        "name": "Bonny M. Smith, M.D"
      },
      "primarySpecialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        },
        {
          "id": "39c5b7a0451141f4a4fe09f8e1da6342",
          "name": "Doctor"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "11e941e94b5d459da3a5192e48ec744c",
      "personnel": {
        "id": "1a344284-09e3-11e8-9dc2-587234aecbf0",
        "name": "Carlos F Smith, D.P.M."
      },
      "primarySpecialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=0&limit=20"
}

GET /provider-personnel

Retrieves a list of provider personnel.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The provider personnel member ID or IDs to filter by. -
personnelId query string false N/A The ID of the personnel member who is a provider. -
primarySpecialtyId query string false N/A The ID of a primary specialty of the provider personnel member. -
primarySpecialtyTaxonomyId query string false N/A The taxonomy ID of a primary specialty of the provider personnel member. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success ProviderPersonnels
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Provider Personnel

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8', headers: headers, body: {"personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}

PUT /provider-personnel/{providerPersonnelId}

Updates a provider personnel.

Parameters

Parameter In Type Required Default Description Accepted Values
providerPersonnelId path string true N/A No description -
body body putProviderPersonnel true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error

Retrieve a Single Provider Personnel

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e91f884c18d5d4805aeb96e2647bb8",
  "personnel": {
    "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
    "name": "Bonny M. Smith, M.D"
  },
  "primarySpecialties": [
    {
      "specialtyId": "11e8a5750246534cbae93fe1756e44cf",
      "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "roles": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon"
    }
  ],
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

GET /provider-personnel/{providerPersonnelId}

Retrieves a single provider personnel.

Parameters

Parameter In Type Required Default Description Accepted Values
providerPersonnelId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A provider personnel object ProviderPersonnel
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Organization

Provider organizations identify which subset of HealtheIntent organizations are designated as provider organizations when performing operations such as a provider search.

Create a Provider Organization

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization', headers: headers, body: {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}

POST /provider-organization

Creates a provider organization.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProviderOrganization true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created provider organization.

Retrieve a List of Provider Organizations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "11e82f7f6590cad3ba52932424218c65",
      "organization": {
        "id": "5d8aba58-09e9-11e8-9dc2-587234aecbf0",
        "name": "Memorial Hospital"
      },
      "primarySpecialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "roles": [
        {
          "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "11e941e94b5d459da3a5192e48ec744c",
      "organization": {
        "id": "128aba58-09e9-11e8-9dc2-587234dacbf0",
        "name": "General Therapy Hospital"
      },
      "primarySpecialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "roles": [
        {
          "id": "11e8860ca0771b91be9009736596b9ba"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=0&limit=20"
}

GET /provider-organization

Retrieves a list of provider organizations.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The provider organization ID or IDs to filter by. -
organizationId query string false N/A The ID of the organization that is a provider. -
primarySpecialtyId query string false N/A The ID of a primary specialty of the provider organization. -
primarySpecialtyTaxonomyId query string false N/A The taxonomy ID of a primary specialty of the provider organization. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK Success ProviderOrganizations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Provider Organization

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/11e82f7f6590cad3ba52932424218c65', headers: headers, body: {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/11e82f7f6590cad3ba52932424218c65 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"primarySpecialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77"}]}

PUT /provider-organization/{providerOrganizationId}

Updates a provider organization.

Parameters

Parameter In Type Required Default Description Accepted Values
providerOrganizationId path string true N/A No description -
body body putProviderOrganization true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Conflict Error

Retrieve a Single Provider Organization

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/11e82f7f6590cad3ba52932424218c65', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/11e82f7f6590cad3ba52932424218c65 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e82f7f6590cad3ba52932424218c65",
  "organization": {
    "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
    "name": "Associates For Women's Healthcare"
  },
  "primarySpecialties": [
    {
      "specialtyId": "11e8a5750246534cbae93fe1756e44cf",
      "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "roles": [
    {}
  ],
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

GET /provider-organization/{providerOrganizationId}

Retrieves a single provider organization.

Parameters

Parameter In Type Required Default Description Accepted Values
providerOrganizationId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A provider organization object ProviderOrganization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Personnel Search

The provider personnel search allows the consumer of this service to retrieve a list of provider personnel based on a variety of criteria, such as provider name, service type, specialty, and location name or other address attributes. The resulting response includes those providers and their locations that best match the specified criteria.

Retrieve a List of Provider Personnel

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "provider": {
        "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
        "name": "Bonny M. Smith, M.D",
        "gender": "FEMALE",
        "age": "49",
        "languages": [
          "en",
          "es",
          "fr"
        ],
        "qualifications": [
          {
            "code": "DPM",
            "issuer": "County Podiatric Surgical Residency",
            "start": "2005-08-21",
            "end": "2020-02-04"
          }
        ],
        "aliases": [
          {
            "system": "NPI",
            "value": "7777777777"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Chicago, IL, 60603",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-555-1212"
            }
          ]
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e77",
          "name": "Radiology"
        }
      ],
      "serviceTypes": [
        {
          "id": "2f4df666deae11e7a3d646705f8c9e77",
          "name": "X-Ray"
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        },
        {
          "id": "39c5b7a0451141f4a4fe09f8e1da6342",
          "name": "Doctor"
        }
      ]
    },
    {
      "provider": {
        "id": "1a344284-09e3-11e8-9dc2-587234aecbf0",
        "name": "Carlos F Smith, D.P.M.",
        "gender": "MALE",
        "age": "49",
        "languages": [
          "en",
          "es",
          "fr"
        ],
        "qualifications": [
          {
            "code": "DPM",
            "issuer": "County Podiatric Surgical Residency",
            "start": "2005-08-21",
            "end": "2020-02-04"
          }
        ],
        "aliases": [
          {
            "system": "NPI",
            "value": "6666666666"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Chicago, IL, 60603",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-555-1212"
            }
          ]
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e77",
          "name": "Radiology "
        }
      ],
      "serviceTypes": [
        {
          "id": "51b3ccdadeae11e7a3d646705f8c9e77",
          "name": "MRI of Brain"
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        }
      ]
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel/search?offset=0&limit=20"
}

GET /provider-personnel/search

Retrieves a list of provider personnel.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A The name of the provider. Filtering by a partial match is allowed. -
serviceTypeId query string false N/A The ID of a service type offered by the provider. -
specialtyId query array[string] false N/A The ID of a provider specialty. -
medicalHomeId query string false N/A The ID of the medical home of the provider. -
medicalHomeOnly query string false false Determines whether only results that match the specified medical home ID are retrieved. true, false
planId query string false N/A The ID of an insurance plan that belongs to a network covered by the provider. -
planOnly query string false false Determines whether only results that match the specified plan ID are retrieved. true, false
locationName query string false N/A The name of a location at which the provider offers care. -
city query string false N/A The city portion of the provider’s address, based on the defined locations where the provider offers care. -
postalCode query string false N/A The postal code portion of the provider’s address, based on the defined locations where the provider offers care. -
state query string false N/A The state portion of the provider’s address, based on the defined locations where the provider offers care. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -name A comma-separated list of fields by which to sort. name, -name
organizationId query array[string] false N/A Organization where the providers are available. -

Response Statuses

Status Meaning Description Schema
200 OK Success ProviderPersonnelSearchResultEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Provider Organization Search

The provider organization search allows the consumer of this service to retrieve a list of provider organizations based on a variety of criteria, such as provider name, service type, specialty, and location name or other address attributes. The resulting response includes those providers and their locations that best match the specified criteria.

Retrieve a List of Provider Organizations.

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/search', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/search \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "providerOrganization": {
        "id": "5d8aba58-09e9-11e8-9dc2-587234aecbf0",
        "name": "Memorial Hospital",
        "aliases": [
          {
            "system": "NPI",
            "value": "9999999999"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Chicago, IL, 60603",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-555-1212"
            }
          ]
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e77",
          "name": "Radiology"
        }
      ],
      "serviceTypes": [
        {
          "id": "2f4df666deae11e7a3d646705f8c9e77",
          "name": "X-Ray"
        }
      ],
      "roles": [
        {
          "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
        }
      ]
    },
    {
      "providerOrganization": {
        "id": "128aba58-09e9-11e8-9dc2-587234dacbf0",
        "name": "General Therapy Hospital",
        "aliases": [
          {
            "system": "NPI",
            "value": "8888888888"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Chicago, IL, 60603",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-555-1212"
            }
          ]
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e77",
          "name": "Radiology "
        }
      ],
      "serviceTypes": [
        {
          "id": "51b3ccdadeae11e7a3d646705f8c9e77",
          "name": "MRI of Brain"
        }
      ],
      "roles": [
        {
          "id": "11e8860ca0771b91be9009736596b9ba"
        }
      ]
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/search?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization/search?offset=0&limit=20"
}

GET /provider-organization/search

Retrieves a list of provider organizations.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A The name of the provider. Filtering by a partial match is allowed. -
serviceTypeId query string false N/A The ID of a service type offered by the provider. -
specialtyId query array[string] false N/A The ID of a provider specialty. -
medicalHomeId query string false N/A The ID of the medical home of the provider. -
medicalHomeOnly query string false false Determines whether only results that match the specified medical home ID are retrieved. true, false
planId query string false N/A The ID of an insurance plan that belongs to a network covered by the provider. -
planOnly query string false false Determines whether only results that match the specified plan ID are retrieved. true, false
locationName query string false N/A The name of a location at which the provider offers care. -
city query string false N/A The city portion of the provider’s address, based on the defined locations where the provider offers care. -
postalCode query string false N/A The postal code portion of the provider’s address, based on the defined locations where the provider offers care. -
state query string false N/A The state portion of the provider’s address, based on the defined locations where the provider offers care. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -name A comma-separated list of fields by which to sort. name, -name

Response Statuses

Status Meaning Description Schema
200 OK Success ProviderOrganizationSearchResultEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Schema Definitions

postProviderOrganizationRoles

Name Type Required Description Accepted Values
providerOrganization object true The provider organization for which this organization role has been established. -
» id string true The ID of the referenced object. -
specialties [object] false The list of organization role specialties. Specialties indicate the provider’s field of practice. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
primarySpecialties [object] false The organization role primary specialty. The primary specialty reflects the field for which the provider has been registered with the National Plan and Provider Enumeration System (NPPES). Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
aliases [object] false The list of organization role aliases. An alias contains a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
status string true The status of the organization role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of an organization that is applicable for services rendered by the organization role. -
acceptingPatients boolean false Indicates whether an organization in the role accepts new patients. -
roleType object false The codeable concept associated with the organization role. -
» text string false A human readable, potentially personalized description of a role type. -
» codings [object] false No description -
»» code string true The unique ID of the code. -
»» system string true The ID of the coding system that gives meaning to the code. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

OrganizationRoles

Name Type Required Description Accepted Values
items [OrganizationRole] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

OrganizationRole

Name Type Required Description Accepted Values
id string true The unique ID of the organization role. -
organization Organization true The organization for which this organization role has been established. -
providerOrganization IdModel true The provider organization for which this organization role has been established. -
networks [Network] false The list of networks with which this organization has a contractual relationship to provide services. -
specialties [SpecialtyTaxonomy] false The list of organization role specialties. Specialties indicate the provider’s field of practice. -
primarySpecialties [SpecialtyTaxonomy] false The primary specialty of the organization role. The primary specialty reflects the field for which the provider has been registered with the NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
status string true The status of the organization role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of an organization that is applicable for services rendered by the organization role. -
aliases [Alias] false The list of organization role aliases. An alias includes a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
acceptingPatients boolean false Indicates whether an organization in the role accepts new patients. -
roleType CodeableConcept false The codeable concept associated with the organization role. -
updatedAt string true The date and time when the organization role was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the organization role was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

Organization

Name Type Required Description Accepted Values
id string true The unique ID of the organization. -
name string false The name of the organization. -

IdModel

Name Type Required Description Accepted Values
id string false The ID of the referenced object. -

Network

Name Type Required Description Accepted Values
id string true The unique ID of the network. -
name string false The name of the network. -

SpecialtyTaxonomy

Name Type Required Description Accepted Values
specialtyId string true The unique ID of the provider specialty. -
taxonomyId string true The taxonomy ID of the provider specialty. -

Alias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -

CodeableConcept

Name Type Required Description Accepted Values
text string false A human readable, potentially personalized description of a role type. -
codings [Code] false A list of codified values from a standard code system. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
system string true The ID of the coding system that gives meaning to the code. -

putProviderOrganizationRoles

Name Type Required Description Accepted Values
providerOrganization object true The provider organization for which this organization role has been established. -
» id string true The ID of the referenced object. -
specialties [object] false The list of organization role specialties. Specialties indicate the provider’s field of practice. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
primarySpecialties [object] false The organization role primary specialty. The primary specialty reflects the field for which the provider has been registered with the National Plan and Provider Enumeration System (NPPES). Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
aliases [object] false The list of organization role aliases. An alias contains a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
status string true The status of the organization role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of an organization that is applicable for services rendered by the organization role. -
acceptingPatients boolean false Indicates whether an organization in the role accepts new patients. -
roleType object false The codeable concept associated with the organization role. -
» text string false A human readable, potentially personalized description of a role type. -
» codings [object] false No description -
»» code string true The unique ID of the code. -
»» system string true The ID of the coding system that gives meaning to the code. -

postProviderPersonnelRoles

Name Type Required Description Accepted Values
name string false The name of the personnel role. -
providerPersonnel object true The provider personnel member who is able to provide the defined services for the organization. -
» id string true The ID of the referenced object. -
assignedBy object true The organization for which the role is available or to which it may be assigned. -
» id string true The ID of the referenced object. -
providedAt [object] false The locations where the provider represented by this role offers care. -
» id string true The ID of the referenced object. -
healthcareServices [object] false The list of health care services that this role provides. -
» id string true The ID of the referenced object. -
specialties [object] false The list of personnel role specialties. Specialties indicate the provider’s field of practice. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
primarySpecialties [object] false The personnel role primary specialty. The primary specialty reflects the field for which the provider has been registered with the NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
aliases [object] false The list of personnel role aliases. An alias includes a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
acceptingPatients boolean false Indicates whether a provider in the role accepts new patients. -
pcpStatuses [object] false The status of the personnel role as a PCP, including effective start and end dates. -
» pcpIndicator boolean true The PCP indicator for the personnel role in a specific timeframe. -
» endDate string false The end date of the PCP status. -
» effectiveDate string false The effective start date of the PCP status. -
status string true The status of the personnel role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of a personnel that is applicable for services rendered by the personnel role. -

PersonnelRoles

Name Type Required Description Accepted Values
items [PersonnelRole] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

PersonnelRole

Name Type Required Description Accepted Values
id string true The unique ID of the personnel role. -
name string false The name of the personnel role. -
personnel Personnel true The personnel member who is able to provide the defined services for the organization. -
providerPersonnel IdModel true The provider personnel member who is able to provide the defined services for the organization. -
assignedBy Organization true The organization for which the roles are available or to which they may be assigned. -
providedAt [Location] false The locations where the provider represented by this role offers care. -
networks [Network] false The list of networks that cover this personnel role. -
healthcareServices [HealthcareService] false The list of health care services that this role provides. -
specialties [SpecialtyTaxonomy] false The list of personnel role specialties. Specialties indicate the provider’s field of practice. -
primarySpecialties [SpecialtyTaxonomy] false The primary specialty of the provider role. The primary specialty reflects the field for which the provider has been registered with the NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
status string true The status of the personnel role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of a personnel that is applicable for services rendered by the personnel role. -
aliases [Alias] false The list of personnel role aliases. An alias includes a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
acceptingPatients boolean false Indicates whether a provider in the role accepts new patients. -
pcpStatuses [PcpStatus] false Indicates whether the personnel role acted as a PCPin a specific time frame. -
updatedAt string true The date and time when the personnel role was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the personnel role was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

Personnel

Name Type Required Description Accepted Values
id string true The unique ID of the personnel member. -
name string false The name of the personnel member. -

Location

Name Type Required Description Accepted Values
id string true The unique ID of the location. -
name string false The name of the location. -
addressText string false The street address of the location. -
telecoms [Telecom] false The telecommunication information of the location. -

Telecom

Name Type Required Description Accepted Values
system string false The system of the telecom. PHONE, EMAIL, OTHER
value string false The value for a telecom. -

HealthcareService

Name Type Required Description Accepted Values
id string true The unique ID of the health care service. -
name string false The name of the health care service. -

PcpStatus

Name Type Required Description Accepted Values
pcpIndicator boolean true The primary care physician (PCP) status of the personnel role in a specific time frame. -
effectiveDate string false The effective start date of the PCP status. -
endDate string false The end date of the PCP status. -

putProviderPersonnelRoles

Name Type Required Description Accepted Values
name string false The name of the personnel role. -
providerPersonnel object true The provider personnel member who is able to provide the defined services for the organization. -
» id string true The ID of the referenced object. -
assignedBy object true The organization for which the role is available or to which it may be assigned. -
» id string true The ID of the referenced object. -
providedAt [object] false The locations where the provider represented by this role offers care. -
» id string true The ID of the referenced object. -
healthcareServices [object] false The list of health care services that this role provides. -
» id string true The ID of the referenced object. -
specialties [object] false The list of personnel role specialties. Specialties indicate the provider’s field of practice. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
primarySpecialties [object] false The personnel role primary specialty. The primary specialty reflects the field for which the provider has been registered with the NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -
aliases [object] false The list of personnel role aliases. An alias includes a system and a value and can be used to store alternate IDs such as a client-defined ID for a role. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
acceptingPatients boolean false Indicates whether a provider in the role accepts new patients. -
pcpStatuses [object] false The status of the personnel role as a PCP, including effective start and end dates. -
» pcpIndicator boolean true The PCP indicator for the personnel role in a specific timeframe. -
» endDate string false The end date of the PCP status. -
» effectiveDate string false The effective start date of the PCP status. -
status string true The status of the personnel role. ACTIVE, INACTIVE
paymentTaxId string false The TIN of a personnel that is applicable for services rendered by the personnel role. -

RoleAndKind

Name Type Required Description Accepted Values
id string true The unique ID of the role. -
kind string true Indicates the kind of entity to which the role belongs, either personnel or organization. PERSONNEL, ORGANIZATION

postProviderNetworks

Name Type Required Description Accepted Values
role RoleAndKind true The role of the provider for this provider network relationship. -
network object true The network of the provider. -
» id string true The ID of the referenced object. -
relationshipType object true The relationship type between the network and provider. -
» id string true The ID of the referenced object. -
effectiveStart string false The date after which the provider network is effective, in ISO 8601 YYYY-MM-DD format. -
effectiveEnd string false The date after which the provider network is no longer effective, in ISO 8601 YYYY-MM-DD format. -
status string true The status of the provider network. ACTIVE, INACTIVE

ProviderNetworks

Name Type Required Description Accepted Values
items [ProviderNetwork] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProviderNetwork

Name Type Required Description Accepted Values
id string true The unique ID of the provider network. -
network Network true The network of the provider. -
role RoleAndKind true The role of the provider for this provider network relationship. -
relationshipType NetworkRelationshipType true The relationship type between the network and provider. -
effectiveStart string false The date after which the provider network is effective, in ISO 8601 YYYY-MM-DD format. -
effectiveEnd string false The date after which the provider network is no longer effective, in ISO 8601 YYYY-MM-DD format. -
status string true The status of the provider network. ACTIVE, INACTIVE
updatedAt string true The date and time when the provider network was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the provider network was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

NetworkRelationshipType

Name Type Required Description Accepted Values
id string true The unique ID of the relationship type. -
name string true The name of the relationship type, for example, CAPPED, ANCILLARY, or TERTIARY. -

putProviderNetworks

Name Type Required Description Accepted Values
role RoleAndKind true The role of the provider for this provider network relationship. -
network object true The network of the provider. -
» id string true The ID of the referenced object. -
relationshipType object true The relationship type between the network and provider. -
» id string true The ID of the referenced object. -
effectiveStart string false The date after which the provider network is effective, in ISO 8601 YYYY-MM-DD format. -
effectiveEnd string false The date after which the provider network is no longer effective, in ISO 8601 YYYY-MM-DD format. -
status string true The status of the provider network. ACTIVE, INACTIVE

postProviderNetworkRelationshipTypes

Name Type Required Description Accepted Values
name string true The name of the relationship type. -
rankOrder integer(int32) true A positive integer representing assigned rank or preference order of a relationship type relative to other relationship types. -

NetworkRelationshipTypeEntities

Name Type Required Description Accepted Values
items [NetworkRelationshipTypeEntity] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

NetworkRelationshipTypeEntity

Name Type Required Description Accepted Values
id string true The unique ID of the relationship type. -
name string true The name of the relationship type, for example, CAPPED, ANCILLARY, or TERTIARY. -
rankOrder integer(int32) true A positive integer representing the assigned rank or preference order of a relationship type relative to other relationship types. -
updatedAt string true The date and time when the provider network relationship type was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the provider network relationship type was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

putProviderNetworkRelationshipTypes

Name Type Required Description Accepted Values
name string true The name of the relationship type. -
rankOrder integer(int32) true A positive integer representing assigned rank or preference order of a relationship type relative to other relationship types. -

ProviderOrganizationSearchResultEntities

Name Type Required Description Accepted Values
items [ProviderOrganizationSearchResultEntity] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProviderOrganizationSearchResultEntity

Name Type Required Description Accepted Values
providerOrganization ProviderOrganizationSearchResult true The provider information. -
locations [Location] false The list of locations where the provider organization offers care. -
networks [Network] false The list of networks with which this provider organization has contracted to provide services. -
specialties [Specialty] false The list of provider organization specialties. Specialties indicate the provider’s field of practice. -
serviceTypes [ServiceType] false The list of service types offered by the provider organization. -
roles [IdModel] false The list of roles of the provider organization. -

ProviderOrganizationSearchResult

Name Type Required Description Accepted Values
id string true The unique ID of the provider organization. -
name string true The name of the provider organization. -
aliases [Alias] false The list of provider organization aliases. -

Specialty

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string false The name of the specialty. -

ServiceType

Name Type Required Description Accepted Values
id string true The unique ID of the service type. -
name string false The name of the service type. -

postProviderOrganization

Name Type Required Description Accepted Values
organization object true The organization that is a provider. -
» id string true The ID of the referenced object. -
primarySpecialties [object] false The primary specialty of the provider organization. The primary specialty reflects the field for which the provider has been registered with NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -

ProviderOrganizations

Name Type Required Description Accepted Values
items [ProviderOrganization] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProviderOrganization

Name Type Required Description Accepted Values
id string true The unique ID of the provider organization. -
organization Organization true The organization that is a provider. -
primarySpecialties [SpecialtyTaxonomy] false The primary specialty of the provider organization. The primary specialty reflects the field for which the provider has been registered with NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
roles [IdModel] false The list of provider organization roles. -
updatedAt string true The date and time when the provider organization was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the provider organization was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

putProviderOrganization

Name Type Required Description Accepted Values
organization object true The organization that is a provider. -
» id string true The ID of the referenced object. -
primarySpecialties [object] false The primary specialty of the provider organization. The primary specialty reflects the field for which the provider has been registered with NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -

ProviderPersonnelSearchResultEntities

Name Type Required Description Accepted Values
items [ProviderPersonnelSearchResultEntity] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProviderPersonnelSearchResultEntity

Name Type Required Description Accepted Values
provider Provider true The provider information. -
locations [Location] false The list of locations where the provider personnel member offers care. -
networks [Network] false The list of networks with which this provider personnel member has contracted to provide services. -
specialties [Specialty] false The list of provider personnel member specialties. Specialties indicate the provider’s field of practice. -
serviceTypes [ServiceType] false The list of service types offered by the provider personnel member. -
roles [Role] false The list of roles of the provider personnel member. -

Provider

Name Type Required Description Accepted Values
id string true The unique ID of the provider personnel member. -
name string true The name of the provider personnel member. -
age string false The age of the provider personnel member. -
gender string false The gender of the provider personnel member. -
languages [string] false The languages spoken by the provider personnel member. -
qualifications [Qualification] false The qualifications of the provider personnel member. -
aliases [Alias] false The list of provider aliases. -

Qualification

Name Type Required Description Accepted Values
code string true A qualification code, for example, M.D. or PhD. -
issuer string false The institute that issued the qualification. -
start string false The first date when the qualification is valid. This field can have precision of YYYY-MM-DD. -
end string false The date when the qualification expires. This field can have precision of YYYY-MM-DD. -

Role

Name Type Required Description Accepted Values
id string true The unique ID of the personnel role. -
name string false The name of the personnel role. -

postProviderPersonnel

Name Type Required Description Accepted Values
personnel object true The personnel member who is a provider. -
» id string true The ID of the referenced object. -
primarySpecialties [object] false The primary specialty of the provider personnel member. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -

ProviderPersonnels

Name Type Required Description Accepted Values
items [ProviderPersonnel] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProviderPersonnel

Name Type Required Description Accepted Values
id string true The unique ID of the provider personnel member. -
personnel Personnel true The personnel member who is a provider. -
primarySpecialties [SpecialtyTaxonomy] false The primary specialty of the provider personnel member. The primary specialty reflects the field for which the provider has been registered with NPPES. Multiple representations of the primary specialty in different taxonomies can exist. -
roles [Role] false The list of roles of the provider personnel member. -
updatedAt string true The date and time when the provider personnel member was most recently updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -
createdAt string true The date and time when the provider personnel member was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format. -

putProviderPersonnel

Name Type Required Description Accepted Values
personnel object true The personnel member who is a provider. -
» id string true The ID of the referenced object. -
primarySpecialties [object] false The primary specialty of the provider personnel member. -
» specialtyId string true The unique ID of the provider specialty. -
» taxonomyId string true The taxonomy ID of the provider specialty. -