NAV Navbar
Logo cerner
Ruby Shell

Provider API v1

The HealtheIntent Provider service enables managing the services in a health care system, the providers of those services, and the payers, plans, provider networks, and medical homes with which a health care system may contract or have a business relationship. In this context, a provider is considered a subset of the personnel and organizations defined in the HealtheIntent Personnel and Organization services.

Designating a HealtheIntent provider personnel or 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 can 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 can be assigned 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.

If you plan to use the health care services and network resources for the Provider service, Cerner recommends that you create those items first so that you can associate them with the providers you create. Health care services, categories, and types are especially useful for referral management, orders processing, and scheduling systems. You can define the health care service types that are available for your organizations and the hierarchy of service categories and subcategories to narrow these classifications as needed. Once you define service types and service categories, health care service instances can be defined to assign these entities to specific locations in the context of a providing organization. Optionally, a specialty also can be assigned to each health care service. The specialties available are those defined using the Specialty API.

Additionally, once a network and its attributes are defined, individual providers can be associated with the network using the provider operations. For example, a general practitioner could be associated with a network as a member of the primary care team for patients assigned to the medical home (and with a specific insurance plan), while a specialist could have a capitated contractual relationship with that same network but have an ancillary fee-for-service (FFS) contractual relationship with another network as well.

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

Health Care Services

Health care services are procedures that are performed by a health care practitioner on a person for the purpose of diagnosing or treating a disease, injury, or other illness.

Health care services reference either a type or category of health care services that are provided by an organization at one or more locations. Health care services can be defined for individual service types that are assigned in various combinations to providers or they can use a service category relationship to dynamically assign a set of service types based on the service types under that category.

A health care service can reference either a single service type or a single service category. For example, health care services can be defined for individual service types that are assigned in various combinations to providers or they can use a service category relationship to dynamically assign a set of service types based on the service types under that category.

Create a Health Care Service

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-1.healtheintent.com/provider/v1/healthcare-services', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/healthcare-services \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}

POST /healthcare-services

Creates a health care service.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 health care service.

Retrieve a List of Health Care Services

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-1.healtheintent.com/provider/v1/healthcare-services', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "Ped Cardiology Consult",
      "description": "Ped Cardiology Consult",
      "providedBy": {
        "id": "eb0f8626f21d11e7a3d646705f8c9e77",
        "name": "Premier Health Center"
      },
      "providedAt": [
        {
          "id": "d2874990f21d11e7a3d646705f8c9e77",
          "name": "Oakland Clinic Center"
        },
        {
          "id": "d2874990f21d11e7a3d646705f8c9e77",
          "name": "Bristol Towers"
        },
        {
          "id": "d2874990f21d11e7a3d646705f8c9e77",
          "name": "Oakland Memorial Medical Center"
        }
      ],
      "specialties": [
        {
          "id": "01d3197cf21e11e7a3d646705f8c9e77",
          "name": "Pediatric Cardiology"
        }
      ],
      "type": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "Ped Cardiology Consult",
        "status": "ACTIVE"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "6ccc2836f21e11e7a3d646705f8c9e77",
      "name": "MRI - Brain",
      "description": "MRI - Brain",
      "providedBy": {
        "id": "eb0f8626f21d11e7a3d646705f8c9e77",
        "name": "Premier Health Center"
      },
      "providedAt": [
        {
          "id": "d2874990f21d11e7a3d646705f8c9e77",
          "name": "Premiere Open MRI Services"
        }
      ],
      "specialties": [
        {
          "id": "c3bbb378f21e11e7a3d646705f8c9e77",
          "name": "Radiology"
        }
      ],
      "type": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "MRI - Brain",
        "status": "ACTIVE"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "3a42042af21f11e7a3d646705f8c9e77",
      "name": "MRI - Breast",
      "description": "MRI- Breast",
      "providedBy": {
        "id": "758bf0e0f21f11e7a3d646705f8c9e77",
        "name": "APMHS"
      },
      "providedAt": [
        {
          "id": "6ee914c0f21f11e7a3d646705f8c9e77",
          "name": "APMHS MRI Center"
        }
      ],
      "specialties": [
        {
          "id": "dd6e022af21f11e7a3d646705f8c9e77",
          "name": "Radiology"
        }
      ],
      "type": {
        "id": "964c3cb6f22111e7a3d646705f8c9e77",
        "name": "MRI-Breast",
        "status": "ACTIVE"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 3,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/healthcare-services?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/healthcare-services?offset=0&limit=20"
}

GET /healthcare-services

Retrieves a list of health care services.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The health care service IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name or partial name of the health care service. -
categoryId query string false N/A The service category ID for which the health care service details are defined. -
providedAt query string false N/A The location where the service can be provided. -
providedBy query string false N/A The organization that provides this service. -
specialtyId query string false N/A The unique ID of the specialty that is handled by the health care service. -
status query string false N/A The status of the health care service. ACTIVE, INACTIVE
typeId query string false N/A The service type ID for which the health care service details are defined. -
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 Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of Health Care Service objects HealthcareServices
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Health Care Service

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /healthcare-services/{serviceId}

Deletes a health care service.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceId path string 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

Update a Health Care Service

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-1.healtheintent.com/provider/v1/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}

PUT /healthcare-services/{serviceId}

Updates a health care service.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceId path string true N/A No description -
body body putHealthcareServices 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

Retrieve a Single Health Care Service

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-1.healtheintent.com/provider/v1/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Ped Cardiology Consult",
  "description": "Ped Cardiology Consult",
  "providedBy": {
    "id": "eb0f8626f21d11e7a3d646705f8c9e77",
    "name": "Premier Health Center"
  },
  "providedAt": [
    {
      "id": "d2874990f21d11e7a3d646705f8c9e77",
      "name": "Oakland Clinic Center"
    }
  ],
  "specialties": [
    {
      "id": "01d3197cf21e11e7a3d646705f8c9e77",
      "name": "Pediatric Cardiology"
    }
  ],
  "type": {
    "id": "2d33c102f21e11e7a3d646705f8c9e77",
    "name": "Ped Cardiology Consult",
    "status": "ACTIVE"
  },
  "category": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "Radiology",
    "status": "ACTIVE"
  },
  "status": "ACTIVE",
  "createdAt": "2018-07-10T15:48:32Z",
  "updatedAt": "2018-07-10T15:48:32Z"
}

GET /healthcare-services/{serviceId}

Retrieves a single health care service.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK The single health care service object. HealthcareService
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Medical Homes

Medical homes are the organization to which patients in an accountable care organization (ACO) or patient-centered medical home (PCMH) model health system can be assigned for their primary care. This could be a practice-level organization, a provider hospital organization (PHO), or any organizational unit in which patients are grouped for managed care. For example, an enterprise could define a network for the CIGNA HMO Gold plan that would consist of a collection of providers contracted to accept that plan. For another example, the enterprise could define a network more specifically for the CIGNA HMO Gold plan at the Premier Health Practice organization (where Premier Health Practice is a medical home). This second example defines the collection of providers contracted with a specific payer plan for patients assigned to that specific medical home. Individual provider networks can be defined for each payer plan with which Premier Health Practice contracts to support patient-provider matching at a more granular level.

Create a Medical Home

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-1.healtheintent.com/provider/v1/medical-homes', headers: headers, body: {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/medical-homes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}

POST /medical-homes

Creates a medical home.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 medical home.

Retrieve a List of Medical Homes

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-1.healtheintent.com/provider/v1/medical-homes', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "9d6c9e780ab811e89dc2587234aecbf1",
      "name": "General Downtown Practice Center",
      "representedBy": {
        "id": "451e764e52f011e89a8ea7eba4735242",
        "name": "General Medical Center"
      },
      "aliases": [
        {
          "system": "General Medical Center",
          "value": "GMC"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "9d6c9e780ab811e89dc2587234aecbf2",
      "name": "General Uptown Practice Center",
      "representedBy": {
        "id": "010c498a-ebed-4c9d-a824-787724448e0a",
        "name": "General Uptown Medical Center"
      },
      "aliases": [
        {
          "system": "General Uptown Medical Center",
          "value": "GUMC"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/medical-homes?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/medical-homes?offset=0&limit=20"
}

GET /medical-homes

Retrieves a list of medical homes.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The medical home IDs by which to filter results. A maximum of 100 IDs can be specified in a single request. -
name query string false N/A The name or partial name of the medical home. -
status query string false N/A The status of the medical home. ACTIVE, INACTIVE
aliasSystem query string false N/A The authority responsible for assigning the medical home ID. If aliasSystem is specified, aliasValue is required. -
aliasValue query string false N/A The value or ID of the medical home in the context of the assigning authority. If aliasValue is specified, aliasSystem 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 name A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Medical Home

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/provider/v1/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medical-homes/{medicalHomeId}

Deletes a medical home.

Parameters

Parameter In Type Required Default Description Accepted Values
medicalHomeId path string 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

Update a Medical Home

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-1.healtheintent.com/provider/v1/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}

PUT /medical-homes/{medicalHomeId}

Updates a medical home.

Parameters

Parameter In Type Required Default Description Accepted Values
medicalHomeId path string true N/A No description -
body body putMedicalHomes 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 Medical Home

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-1.healtheintent.com/provider/v1/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "General Uptown Practice Center",
  "representedBy": {
    "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
    "name": "Associates For Women's Healthcare"
  },
  "status": "ACTIVE",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "aliases": [
    {
      "system": "General Uptown Medical Center",
      "value": "GUMC"
    }
  ]
}

GET /medical-homes/{medicalHomeId}

Retrieves a single medical home.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A Medical Home object MedicalHomeEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Networks

A provider network is a list of the physicians, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members.

Create a 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-1.healtheintent.com/provider/v1/networks', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/networks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE"}

POST /networks

Creates a network.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 network.

Retrieve a List of 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-1.healtheintent.com/provider/v1/networks', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "Premier - UnitedHealthcare Choice",
      "description": "Premier - UnitedHealthcare Choice HMO",
      "plan": {
        "id": "3f7b6c740a9d11e89dc2587234aecbf0",
        "name": "UnitedHealthcare Choice"
      },
      "medicalHome": {
        "id": "451e764e45f011e89a8ea7eba4734242",
        "name": "Premier Medical Center"
      },
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "9d6c9f070ab811e89dc2587234aecbf0",
      "name": "General Medical Center - UnitedHealthcare HMO Gold",
      "description": "General Medical Center - UnitedHealthcare HMO Gold",
      "plan": {
        "id": "3f7b6c740a9d11e89dc2587234aecbf0",
        "name": "UnitedHealthcare HMO Gold"
      },
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/networks?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/networks?offset=0&limit=20"
}

GET /networks

Retrieves a list of networks.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The network IDs by which to filter. A maximum of 100 IDs can be specified in a single request. -
name query string false N/A The name or partial name of the network. -
medicalHomeId query string false N/A The ID of the medical home or site for which a network is defined. -
planId query string false N/A The ID of the plan for which a network is defined. -
status query string false N/A The status of the network. 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 name A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Network

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

DELETE /networks/{networkId}

Deletes a network.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a 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-1.healtheintent.com/provider/v1/networks/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/networks/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE"}

PUT /networks/{networkId}

Updates a network.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 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-1.healtheintent.com/provider/v1/networks/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "cc46c4c2deac11e7a3d646705f8c9e77",
  "name": "General Medical Center - UnitedHealthcare HMO Gold",
  "description": "General Medical Center - UnitedHealthcare HMO Gold",
  "medicalHome": {
    "id": "451e764e45f011e89a8ea7eba4734242",
    "name": "Premier Medical Center"
  },
  "plan": {
    "id": "3f7b6c740a9d11e89dc2587234aecbf0",
    "name": "UnitedHealthcare HMO Gold"
  },
  "status": "ACTIVE",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /networks/{networkId}

Retrieves a single network.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Success NetworkEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Payers

Payers are the health insurance entity that pays medical claims on behalf of the insured. Examples of third-party payers include government agencies, insurance companies, health maintenance organizations (HMOs), and employers.

Create a Payer

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-1.healtheintent.com/provider/v1/payers', headers: headers, body: {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payers \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}

POST /payers

Creates a payer.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 payer.

Retrieve a List of Payers

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-1.healtheintent.com/provider/v1/payers', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "9d6c9e780ab811e89dc2587234aecbf1",
      "name": "UnitedHealthcare",
      "description": "UnitedHealthcare",
      "aliases": [
        {
          "system": "NAIC",
          "value": "79413"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "9d6c9e780ab811e89dc2587234aecbf2",
      "name": "Cigna",
      "description": "Cigna",
      "aliases": [
        {
          "system": "NAIC",
          "value": "79415"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payers?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payers?offset=0&limit=20"
}

GET /payers

Retrieves a list of payers.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The payer IDs by which to filter. A maximum of 100 IDs can be specified in a single request. -
name query string false N/A The name or partial name of the payer. -
status query string false N/A The status of the payer. ACTIVE, INACTIVE
aliasSystem query string false N/A The authority responsible for assigning the payer ID. If aliasSystem is specified, aliasValue is required. -
aliasValue query string false N/A The value or ID of the payer in the context of the assigning authority. If aliasValue is specified, aliasSystem 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 name A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Payer

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payers/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /payers/{payerId}

Deletes a payer.

Parameters

Parameter In Type Required Default Description Accepted Values
payerId path string 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

Update a Payer

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-1.healtheintent.com/provider/v1/payers/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payers/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}

PUT /payers/{payerId}

Updates a payer.

Parameters

Parameter In Type Required Default Description Accepted Values
payerId path string true N/A No description -
body body putPayers 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 Payer

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-1.healtheintent.com/provider/v1/payers/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "UnitedHealthcare",
  "description": "UnitedHealthcare",
  "status": "ACTIVE",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "aliases": [
    {
      "system": "NAIC",
      "value": "79413"
    }
  ]
}

GET /payers/{payerId}

Retrieves a single payer.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A Payer object PayerEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Payment Sources

Payment sources are categories of payers as defined by a payment source typology. Responses may include payment sources provided by Cerner as a shared typology appropriate for the region, for example, the NAHDO typology in the U.S. Payment sources from shared typologies cannot be modified.

Create a Payment Source

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-1.healtheintent.com/provider/v1/payment-sources', headers: headers, body: {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payment-sources \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}

POST /payment-sources

Creates a payment source.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postPaymentSources 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
423 Locked Locked Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created payment source.

Retrieve a List of Payment Sources

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-1.healtheintent.com/provider/v1/payment-sources', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "ac33db5c7ae011eabc550242ac130003",
      "name": "Medicare (Non-Managed Care)",
      "description": "Payment source for Medicare (Non-Managed Care)",
      "typology": {
        "id": "133490e47ae111eabc550242ac130003"
      },
      "codings": [
        {
          "code": "12",
          "display": "Medicare (Non-Managed Care)",
          "system": "Source of Payment Typology (PHDSC)"
        }
      ],
      "children": [
        {
          "id": "34a7610a7b3311eabc550242ac130003"
        },
        {
          "id": "38d76aae7b3311eabc550242ac130003"
        },
        {
          "id": "3e02efc67b3311eabc550242ac130003"
        },
        {
          "id": "4140afb67b3311eabc550242ac130003"
        }
      ],
      "parent": {
        "id": "5396cef27b3311eabc550242ac130003"
      },
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "2d12cf1c7ae111eabc550242ac130003",
      "name": "Medicare (Managed Care)",
      "description": "Payment source for Medicare (Managed Care)",
      "typology": {
        "id": "133490e47ae111eabc550242ac130003"
      },
      "codings": [
        {
          "code": "11",
          "display": "Medicare (Managed Care)",
          "system": "Source of Payment Typology (PHDSC)"
        }
      ],
      "children": [
        {
          "id": "65436ac07b3311eabc550242ac130003"
        },
        {
          "id": "6a13ab6e7b3311eabc550242ac130003"
        },
        {
          "id": "6ff792347b3311eabc550242ac130003"
        },
        {
          "id": "76018e967b3311eabc550242ac130003"
        }
      ],
      "parent": {
        "id": "5396cef27b3311eabc550242ac130003"
      },
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payment-sources?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payment-sources?offset=0&limit=20"
}

GET /payment-sources

Retrieves a list of payment sources.

Parameters

Parameter In Type Required Default Description Accepted Values
typologyId query string false N/A Filters by the ID of the typology. -
name query string false N/A Filters by the name or partial name of the payment source. -
system query string false N/A Filters by the ID of the coding system of the payment source. If the system parameter is specified, the code parameter is required. -
code query string false N/A Filters by the unique ID of the code of the payment source. If the code parameter is specified, the system parameter is required. -
parentId query string false N/A Filters by the direct ancestor of the payment source. If a blank value is specified, the API returns only root-level entities. If a null value is specified, the API returns all entities. -
ids query array[string] false N/A Filters by payment source IDs. A maximum of 100 IDs can be specified in a single request. -
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 PaymentSourceEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Payment Source

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payment-sources/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payment-sources/11e8a0b6e3d9e4b7bae9bd3b7d82a964 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /payment-sources/{id}

Deletes a payment source.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source. -

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
423 Locked Locked Error

Update a Payment Source

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-1.healtheintent.com/provider/v1/payment-sources/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/payment-sources/11e8a0b6e3d9e4b7bae9bd3b7d82a964 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}

PUT /payment-sources/{id}

Updates a payment source.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source. -
body body putPaymentSources 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
423 Locked Locked Error

Retrieve a Single Payment Source

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-1.healtheintent.com/provider/v1/payment-sources/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "b00c69fd689643758de5577e2c588245",
  "name": "Medicare (Non-Managed Care)",
  "description": "Medicare (Non-Managed Care)",
  "typology": {},
  "codings": [
    {}
  ],
  "children": [
    {}
  ],
  "parent": {},
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /payment-sources/{id}

Retrieves a single payment source.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source. -

Response Statuses

Status Meaning Description Schema
200 OK A Payment Source object PaymentSourceEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Lineage of Payment Sources

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-1.healtheintent.com/provider/v1/payment-sources/8c95b90d1d1c4f56bc8a54e4fd30644c/lineage', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "depth": "1",
      "paymentSource": {
        "id": "cdc77f7a7b3111eabc550242ac130003",
        "name": "MEDICAID",
        "description": "",
        "typology": {
          "id": "cf7794f47ae111eabc550242ac130003"
        },
        "codings": [
          {
            "code": "1",
            "display": "MEDICAID",
            "system": "Source of Payment Typology (PHDSC)"
          }
        ],
        "children": [
          {
            "id": "e71d321c7ae111eabc550242ac130003"
          },
          {
            "id": "cf6bdd0c7b3211eabc550242ac130003"
          },
          {
            "id": "db0eb9907b3211eabc550242ac130003"
          },
          {
            "id": "e1e699727b3211eabc550242ac130003"
          },
          {
            "id": "e93873bc7b3211eabc550242ac130003"
          },
          {
            "id": "ef34b7f87b3211eabc550242ac130003"
          },
          {
            "id": "b8t382e207ae111eabc50242ac130003"
          }
        ],
        "createdAt": "2018-04-21T16:14:53Z",
        "updatedAt": "2018-04-21T16:14:53Z"
      }
    },
    {
      "depth": "2",
      "paymentSource": {
        "id": "b8t382e207ae111eabc50242ac130003",
        "name": "Medicaid (Managed Care)",
        "description": "Payment source for Medicare (Non-Managed Care)",
        "typology": {
          "id": "cf7794f47ae111eabc550242ac130003"
        },
        "codings": [
          {
            "code": "21",
            "display": "Medicaid (Managed Care)",
            "system": "Source of Payment Typology (PHDSC)"
          }
        ],
        "children": [
          {
            "id": "5e1808a67b3211eabc550242ac130003"
          },
          {
            "id": "008e29d07b3311eabc550242ac130003"
          },
          {
            "id": "0715e32e7b3311eabc550242ac130003"
          },
          {
            "id": "0c3a051a7b3311eabc550242ac130003"
          }
        ],
        "parent": {
          "id": "cdc77f7a7b3111eabc550242ac130003"
        },
        "createdAt": "2018-04-21T16:14:53Z",
        "updatedAt": "2018-04-21T16:14:53Z"
      }
    },
    {
      "depth": "3",
      "paymentSource": {
        "id": "5e1808a67b3211eabc550242ac130003",
        "name": "Medicaid HMO",
        "description": "Payment source for Medicaid HMO",
        "typology": {
          "id": "cf7794f47ae111eabc550242ac130003"
        },
        "codings": [
          {
            "code": "211",
            "display": "Medicaid HMO",
            "system": "Source of Payment Typology (PHDSC)"
          }
        ],
        "children": [],
        "parent": {
          "id": "b8t382e207ae111eabc50242ac130003"
        },
        "createdAt": "2018-04-21T16:14:53Z",
        "updatedAt": "2018-04-21T16:14:53Z"
      }
    }
  ],
  "totalResults": 3,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payment-sources/96f53b1e0a9911e89dc2587234aecbf1/lineage?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/payment-sources/96f53b1e0a9911e89dc2587234aecbf1/lineage?offset=0&limit=20"
}

GET /payment-sources/{id}/lineage

Retrieves a lineage of payment sources.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source. -
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. -

Response Statuses

Status Meaning Description Schema
200 OK Success PaymentSourceLineageEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Payment Source Typologies

A payment source typology is a standardized payer type classification system. The typology enables consistent reporting of payer data to state health data organizations and supports data comparisons by payer type across states, by various provider types, and to national benchmarks. Tenants can create and manage their own typologies or use shared typologies provided by Cerner. Shared typologies cannot be modified.

Create a Payment Source Typology

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-1.healtheintent.com/provider/v1/typologies', headers: headers, body: {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/typologies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}

POST /typologies

Creates a payment source typology.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postTypologies 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 payment source typology.

Retrieve a List of Payment Source Typologies

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-1.healtheintent.com/provider/v1/typologies', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "e0dc02fc7b3611eabc550242ac130003",
      "name": "NAHDO",
      "description": "The National Association of Health Data Organizations (NAHDO) typology",
      "ownership": "SHARED",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "d9483a607b3611eabc550242ac130003",
      "name": "UnnamedTypology",
      "description": "Unnamed Typology Duplicate",
      "ownership": "TENANT",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/typologies?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/typologies?offset=0&limit=20"
}

GET /typologies

Retrieves a list of payment source typologies.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters by typology IDs. A maximum of 100 can be specified in a single request. -
name query string false N/A Filters by the name or partial name of the typology. -
ownership query string false N/A Filters by whether the typologies are owned by a single tenant or shared. The value can be either TENANT or SHARED. -
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 PaymentSourceTypologyEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Payment Source Typology

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/typologies/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /typologies/{id}

Deletes a payment source typology.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source typology. -

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
423 Locked Locked Error

Update a Payment Source Typology

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-1.healtheintent.com/provider/v1/typologies/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/typologies/11e8a0b6e3d9e4b7bae9bd3b7d82a964 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}

PUT /typologies/{id}

Updates a payment source typology.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source typology. -
body body putTypologies 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
423 Locked Locked Error

Retrieve a Single Payment Source Typology

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-1.healtheintent.com/provider/v1/typologies/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "NAHDO",
  "description": "The National Association of Health Data Organizations (NAHDO) typology",
  "ownership": "SHARED",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /typologies/{id}

Retrieves a single payment source typology.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The unique ID of the payment source typology. -

Response Statuses

Status Meaning Description Schema
200 OK A Payment Source Typology object PaymentSourceTypologyEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Plans

Plans are the health insurance products offered by a given payer, for example, CIGNA HMO Gold. Systems can reference this single catalog of payers and plans for different use cases and workflows. For example, plan is an attribute common to both patients, who have certain benefits coverage, and providers, who have specific payer and plan contracts for services they offer. This supports the ability to perform a search for those providers considered in-network for the patient’s insurance plan. Similar use cases exist for referral management, scheduling, claims processing and other workflows.

Create a Plan

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-1.healtheintent.com/provider/v1/plans', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/plans \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}

POST /plans

Creates a plan.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Plan
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 plan.

Retrieve a List of Plans

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-1.healtheintent.com/provider/v1/plans', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "9d6c9e780ab811e89dc2587234aecbf0",
      "name": "Premier - UnitedHealthcare Choice",
      "description": "Premier - UnitedHealthcare Choice HMO",
      "aliases": [
        {
          "system": "X-REF",
          "value": "3444"
        },
        {
          "system": "UnitedHealthcare HMO",
          "value": "87726-1"
        }
      ],
      "payer": {
        "id": "96f53b1e0a9911e89dc2587234aecbf0",
        "name": "Humana"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "1234e780ab811e89dc2587234aecbf0",
      "name": "Premier - UnitedHealthcare Choice PPO",
      "description": "Premier - UnitedHealthcare Choice PPO",
      "aliases": [
        {
          "system": "X-REF",
          "value": "3445"
        },
        {
          "system": "UnitedHealthcare PPO",
          "value": "87726-2"
        }
      ],
      "payer": {
        "id": "96f53b1e0a9911e89dc2587234aecbf0",
        "name": "BCBS"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/plans?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v1/plans?offset=0&limit=20"
}

GET /plans

Retrieves a list of plans.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The plan IDs by which to filter. A maximum of 100 IDs can be specified in a single request. -
name query string false N/A The name or partial name of the plan. -
payerId query string false N/A The ID of the payer. -
status query string false N/A The status of the plan. ACTIVE, INACTIVE
aliasSystem query string false N/A The authority responsible for assigning the plan ID. If aliasSystem is specified, aliasValue is required. -
aliasValue query string false N/A The value or ID of the plan in the context of the assigning authority. If aliasValue is specified, aliasSystem 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 name A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Plan

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/plans/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /plans/{planId}

Deletes a Plan.

Parameters

Parameter In Type Required Default Description Accepted Values
planId path string 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

Update a Plan

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-1.healtheintent.com/provider/v1/plans/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/plans/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}

PUT /plans/{planId}

Updates a plan.

Parameters

Parameter In Type Required Default Description Accepted Values
planId path string true N/A No description -
body body putPlans 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 Plan

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-1.healtheintent.com/provider/v1/plans/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Premier - UnitedHealthcare Choice PPO",
  "description": "Premier - UnitedHealthcare Choice PPO",
  "payer": {
    "id": "f9ed82acf21c11e7a3d646705f8c9e77",
    "name": "UnitedHealthcare"
  },
  "status": "ACTIVE",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "aliases": [
    {
      "system": "X-REF",
      "value": "3445"
    },
    {
      "system": "UnitedHealthcare PPO",
      "value": "87726-2"
    }
  ]
}

GET /plans/{planId}

Retrieves a single plan.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A Plan object PlanEntity
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 are the 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-1.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-1.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-1.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-1.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-1.healtheintent.com/provider/v1/provider-network-relationship-types?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 Error
403 Forbidden Forbidden Error

Delete a Provider Network Relationship Type.

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

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

Deletes a 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
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

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-1.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-1.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-1.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-1.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-1.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-1.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-1.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-1.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

Delete a Provider Network

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider-networks/{providerNetworkId}

Deletes a 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
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

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-1.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-1.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-1.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-1.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",
    "rankOrder": "1",
    "updatedAt": "2018-04-21T16:14:53Z",
    "createdAt": "2018-04-21T16:14:53Z"
  },
  "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 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 in a given organization is managed using the Health Care Services resource.

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-1.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,"effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"},"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-1.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,"effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"},"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-1.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-1.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"
      },
      "effectivePeriod": {
        "start": "2020-01-01T19:45:00.000Z",
        "end": "2020-06-01T20:55:00.000Z"
      },
      "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. -
organizationIds query array[string] false N/A The IDs of the organizations for which these organization roles have been established. A maximum of 100 IDs can be specified in a single request. -
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. -
effectiveDate query string false N/A Filters by whether the role is effective on the date specified. If the date is on or between the effective start and end dates of the role, the role is included in the response. -
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

Delete a Provider Organization Role

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider-organization-roles/{organizationRoleId}

Deletes a provider organization role.

Parameters

Parameter In Type Required Default Description Accepted Values
organizationRoleId path string 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

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-1.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,"effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"},"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-1.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,"effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"},"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 Organization Search

The provider organization search enables retrieving 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 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-1.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-1.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

Provider Organization

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. 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-1.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-1.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-1.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-1.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 ProviderOrganizationSearchResults
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Provider Organization

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider-organization/{providerOrganizationId}

Deletes a 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
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

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-1.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-1.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-1.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-1.healtheintent.com/provider/v1/provider-organization/11e82f7f6590cad3ba52932424218c65 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
  "name": "Associates for Women's Healthcare",
  "aliases": [
    {}
  ]
}

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 ProviderOrganizationSearchResult
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Personnel Roles

Provider personnel roles are the different jobs a provider may perform while offering a variety of health care services in different locations or settings. A given HealtheIntent personnel can 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 organizations.

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-1.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","effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"}}

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-1.healtheintent.com/provider/v1/provider-personnel-roles', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon @ NorthEastPole Healthcare",
      "effectivePeriod": {
        "start": "2020-01-01T19:45:00.000Z",
        "end": "2020-06-01T20:55:00.000Z"
      },
      "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"
        }
      ],
      "proxyPersonnel": [
        {
          "id": "23f34rfrffdd11e7a3d646705f84ferf"
        },
        {
          "id": "67vdfa4dea23fdffs3d6467054r56jd3"
        }
      ],
      "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"
        }
      ],
      "proxyPersonnel": [
        {
          "id": "212cfba4dead11e7a3d646705f8c9e77"
        },
        {
          "id": "56t34ba4dea23fdffs3d646705ft76cd"
        }
      ],
      "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 can provide the defined services for the organization. -
providerPersonnelId query string false N/A The ID of the provider personnel that can 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 that 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. -
proxyPersonnelId query string false N/A The ID of the personnel who is a proxy for the provider personnel in the role. -
pcpIndicator query boolean false 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. -
effectiveDate query string false N/A Filters by whether the role is effective on the date specified. If the date is on or between the effective start and end dates of the role, the role is included in the response. -
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

Delete a Provider Personnel Role

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/provider-personnel-roles/11e8a5750246534cbae93fe1756e44cf', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /provider-personnel-roles/{personnelRoleId}

Deletes a provider personnel role.

Parameters

Parameter In Type Required Default Description Accepted Values
personnelRoleId path string 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

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-1.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","effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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","effectivePeriod":{"start":"2019-01-01T19:45:00.000Z","end":"2019-06-01T20:50:00.000Z"}}

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

Add a Proxy Personnel

Example Request:


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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/provider-personnel-roles/f89fa3dd-0000-494b-1111-4640ccc081e3/proxy-personnel/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/provider-personnel-roles/f89fa3dd-0000-494b-1111-4640ccc081e3/proxy-personnel/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /provider-personnel-roles/{personnelRoleId}/proxy-personnel/{proxyPersonnelId}

Adds a personnel as a proxy for a provider personnel role. This can be used to designate a personnel user as a proxy for a specific provider in the context of an organization. Proxy personnel are granted the same capabilities in and access to HealtheIntent applications as the provider personnel in the role for the organization.

Parameters

Parameter In Type Required Default Description Accepted Values
proxyPersonnelId path string true N/A The ID of the personnel to add or remove as a proxy for the personnel role. -
personnelRoleId path string true N/A The ID of the personnel role. -

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

Remove a Proxy Personnel

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/provider-personnel-roles/f89fa3dd-0000-494b-1111-4640ccc081e3/proxy-personnel/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/provider/v1/provider-personnel-roles/f89fa3dd-0000-494b-1111-4640ccc081e3/proxy-personnel/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /provider-personnel-roles/{personnelRoleId}/proxy-personnel/{proxyPersonnelId}

Removes a personnel from the list of proxy personnel for a provider personnel role.

Parameters

Parameter In Type Required Default Description Accepted Values
proxyPersonnelId path string true N/A The ID of the personnel to add or remove as a proxy for the personnel role. -
personnelRoleId path string true N/A The ID of the personnel role. -

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 Personnel Search

The provider personnel search enables retrieving 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 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-1.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-1.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 Personnel

Provider personnel are individual health care practitioners, such as physicians, clinicians, or specialists. 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-1.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-1.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-1.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-1.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

Delete a Provider Personnel

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider-personnel/{providerPersonnelId}

Deletes a 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
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

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-1.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-1.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-1.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-1.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",
      "kind": "PERSONNEL"
    }
  ],
  "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

Service Categories

Service categories classify groupings of service types that can be delivered or performed. See the following example of service category hierarchies:

Create a Service Category

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-1.healtheintent.com/provider/v1/service-categories', headers: headers, body: {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77"}

POST /service-categories

Creates a service category.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 service category.

Retrieve a List of Service Categories

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-1.healtheintent.com/provider/v1/service-categories', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "Radiology",
      "description": "A radiologist who utilizes x-ray, radionuclides, ultrasound, and electromagnetic radiation to diagnose and treat disease",
      "parentId": "0",
      "types": [
        {
          "id": "2f4df666deae11e7a3d646705f8c9e77",
          "name": "Chest x-ray 2 views",
          "status": "ACTIVE"
        }
      ],
      "childCategories": [
        {
          "id": "32654f3adead11e7a3d646705f8c9e77",
          "name": "Ultrasound",
          "status": "ACTIVE"
        },
        {
          "id": "4a3a2f3edeae11e7a3d646705f8c9e77",
          "name": "MRI",
          "status": "ACTIVE"
        }
      ],
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "533cfba4dead11e7a3d646705f8c9e77",
      "name": "CT Scan",
      "description": "Special x-ray equipment to help detect a variety of diseases and conditions. CT scanning is fast, painless, noninvasive, and accurate",
      "parentId": "32654f3adead11e7a3d646705f8c9e77",
      "types": [
        {
          "id": "4a3a4f2edeae11e7a3d646705f8c9e77",
          "name": "CT scan of the brain",
          "status": "ACTIVE"
        }
      ],
      "childCategories": [],
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "533cfba4dead11e7a3d646705f8c9e77",
      "name": "Neurology",
      "description": "A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.",
      "parentId": "0",
      "types": [
        {
          "id": "51b3ccdadeae11e7a3d646705f8c9e77",
          "name": "Neurology consult",
          "status": "ACTIVE"
        }
      ],
      "childCategories": [],
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 3,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-categories?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-categories?offset=0&limit=20"
}

GET /service-categories

Retrieves a list of service categories.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The service category IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name of the service category. Filtering by a partial match is allowed. -
parentId query string false N/A The parent category ID. If the value is zero, the response includes all service categories at the root level. Otherwise, the API retrieves all immediate child service categories for the specified parent ID (with one level of depth). If no value is provided, the API retrieves categories at all levels. -
status query string false N/A The status of the health care service category. 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 name Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of Service Category objects ServiceCategories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Service Category

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-categories/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /service-categories/{serviceCategoryId}

Deletes a service category.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceCategoryId path string 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

Update a Service Category

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-1.healtheintent.com/provider/v1/service-categories/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-categories/f9ed82acf21c11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77"}

PUT /service-categories/{serviceCategoryId}

Updates a service category.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceCategoryId path string true N/A No description -
body body putServiceCategories 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 Service Category

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-1.healtheintent.com/provider/v1/service-categories/964c3cb6f22111e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Radiology",
  "description": "A radiologist who utilizes x-ray, radionuclides, ultrasound, and electromagnetic radiation to diagnose and treat disease.",
  "parentId": "cc46c4c2deac11e7a3d646705f8c9e77",
  "types": [
    {
      "id": "2d33c102f21e11e7a3d646705f8c9e77",
      "name": "Ped Cardiology Consult",
      "status": "ACTIVE"
    }
  ],
  "childCategories": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "Radiology",
      "status": "ACTIVE"
    }
  ],
  "status": "ACTIVE",
  "createdAt": "2018-07-10T15:48:32Z",
  "updatedAt": "2018-07-10T15:48:32Z"
}

GET /service-categories/{serviceCategoryId}

Retrieve a single service category.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Single Service Category object ServiceCategory
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Service Types

Service types are the specific kinds of services that can be delivered or performed. Each service type must be part of a service category. See the following examples of types:

Create a Service 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-1.healtheintent.com/provider/v1/service-types', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}

POST /service-types

Creates a service type.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created 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 service type.

Retrieve a List of Service 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-1.healtheintent.com/provider/v1/service-types', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "2f4df666deae11e7a3d646705f8c9e77",
      "name": "Electrocardiograph (ECG/EKG)",
      "description": "Instrument for recording the electrical activity of the heart ECG",
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z",
      "category": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "Neurology"
      }
    },
    {
      "id": "4a3a4f2edeae11e7a3d646705f8c9e77",
      "name": "Electroencephalography (EEG)",
      "description": "Instrument for measuring and recording the electric activity of the brain.",
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z",
      "category": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "Neurology"
      }
    },
    {
      "id": "51b3ccdadeae11e7a3d646705f8c9e77",
      "name": "Neurology consult",
      "description": "Neurology consult",
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z",
      "category": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "Neurology"
      }
    }
  ],
  "totalResults": 3,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-types?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-types?offset=0&limit=20"
}

GET /service-types

Retrieves a list of service types.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The service type IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name of the service type. Filtering by a partial match is allowed. -
serviceCategoryId query string false N/A Filters by service type definitions associated with the specified service category ID. -
status query string false N/A The status of the service type. 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 name Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of Service Type objects ServiceTypes
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Service Type

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-types/2f4df666deae11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-types/2f4df666deae11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /service-types/{serviceTypeId}

Deletes a service type.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceTypeId path string 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

Update a Service 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-1.healtheintent.com/provider/v1/service-types/2f4df666deae11e7a3d646705f8c9e77', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v1/service-types/2f4df666deae11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}

PUT /service-types/{serviceTypeId}

Updates a service type.

Parameters

Parameter In Type Required Default Description Accepted Values
serviceTypeId path string true N/A No description -
body body putServiceTypes 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 Service 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-1.healtheintent.com/provider/v1/service-types/2f4df666deae11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "2f4df666deae11e7a3d646705f8c9e77",
  "name": "Electrocardiograph (ECG/EKG)",
  "description": "Instrument for recording the electrical activity of the heart ECG.",
  "status": "ACTIVE",
  "createdAt": "2018-07-10T15:48:32Z",
  "updatedAt": "2018-07-10T15:48:32Z",
  "category": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "Radiology",
    "status": "ACTIVE"
  }
}

GET /service-types/{serviceTypeId}

Retrieves a single service type.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Single Service Type object ServiceType
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

postHealthcareServices

Name Type Required Description Accepted Values
name string true The name of the health care service. -
description string false The description of the health care service. -
status string true The status of the health care service. ACTIVE, INACTIVE
type object false No description -
» id string true The unique ID of the health care service type. -
category object false No description -
» id string true The unique ID of the service category. -
providedBy object true No description -
» id string true The unique ID of the organization that provides the health care service. -
providedAt [object] false No description -
» id string true The unique ID of the location of the health care service. -
specialties [object] false No description -
» id string true The unique ID of specialty of the health care service. -

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. -

HealthcareServices

Name Type Required Description Accepted Values
items [HealthcareService] 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. -

HealthcareService

Name Type Required Description Accepted Values
id string false The unique ID of the health care service. -
name string false The name of the health care service. -
description string false The description of the health care service. -
providedBy Organization false The organization that provides the health care service. -
providedAt [HealthcareServiceLocation] false The locations where the health care service is provided. -
specialties [Specialty] false The specialty associated with the health care service. -
type Type false The service type of the health care service. -
category Category false The service category of the health care service. -
status string false The current state of the health care service. ACTIVE, INACTIVE
createdAt string false The date and time when the health care service was created. -
updatedAt string false The date and time when the health care service was updated. -

Organization

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

HealthcareServiceLocation

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

Specialty

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

Type

Name Type Required Description Accepted Values
id string false The unique ID of the service type -
name string false The name of the service type that can be delivered or performed. -
status string false The current status of the service type. ACTIVE, INACTIVE

Category

Name Type Required Description Accepted Values
id string false The unique ID of the category -
name string false The name of the category -
status string false The current state of the health care service category. ACTIVE, INACTIVE

putHealthcareServices

Name Type Required Description Accepted Values
name string true The name of the health care service. -
description string false The description of the health care service. -
status string true The status of the health care service. ACTIVE, INACTIVE
type object false No description -
» id string true The unique ID of the health care service type. -
category object false No description -
» id string true The unique ID of the service category. -
providedBy object true No description -
» id string true The unique ID of the organization that provides the health care service. -
providedAt [object] false No description -
» id string true The unique ID of the location of the health care service. -
specialties [object] false No description -
» id string true The unique ID of specialty of the health care service. -

postServiceCategories

Name Type Required Description Accepted Values
name string true The category name of the health care service being performed or delivered. -
description string false The description of the service category. -
status string true The status of the service category. ACTIVE, INACTIVE
parentId string false The unique ID of the parent category. -

ServiceCategories

Name Type Required Description Accepted Values
items [ServiceCategory] 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. -

ServiceCategory

Name Type Required Description Accepted Values
id string false The unique ID of the service category. -
name string false The formatted display text of the service category. -
description string false The description of the health care service category definition. -
parentId string false The parent category ID of the service category. -
types [Type] false The health care service types associated with the given service category definition. -
childCategories [Category] false A list of subcategories associated with the category definition. -
status string false The status of the service category. ACTIVE, INACTIVE
createdAt string false The date and time in International Organization for Standardization (ISO) 8601 format (YYYY-MM-DDThh:mm:ssZ) when the service category was created. -
updatedAt string false The date and time when the service category was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssh). -

putServiceCategories

Name Type Required Description Accepted Values
name string true The category name of the health care service being performed or delivered. -
description string false The description of the service category. -
status string true The status of the service category. ACTIVE, INACTIVE
parentId string false The unique ID of the parent category. -

postServiceTypes

Name Type Required Description Accepted Values
name string true The name of the service type. -
description string false The description of the service type. -
status string true The status of the service type. ACTIVE, INACTIVE
category object true No description -
» id string true The unique ID of the service category. -

ServiceTypes

Name Type Required Description Accepted Values
items [ServiceType] 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. -

ServiceType

Name Type Required Description Accepted Values
id string false The unique ID of the service type. -
name string false The name of the service type. -
description string false The description of the service type. -
status string false The status of the service type. ACTIVE, INACTIVE
createdAt string false The date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) when the service type was created. -
updatedAt string false The date and time when the service type was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
category Category false The service category of the service type. -

putServiceTypes

Name Type Required Description Accepted Values
name string true The name of the service type. -
description string false The description of the service type. -
status string true The status of the service type. ACTIVE, INACTIVE
category object true No description -
» id string true The unique ID of the service category. -

postMedicalHomes

Name Type Required Description Accepted Values
name string true The name of the medical home. -
representedBy object false The organization associated with the medical home. -
» id string true The ID of the referenced object. -
status string true The status of the medical home. ACTIVE, INACTIVE
aliases [object] false The list of medical home aliases. -
» 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. -

MedicalHomeEntities

Name Type Required Description Accepted Values
items [MedicalHomeEntity] 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. -

MedicalHomeEntity

Name Type Required Description Accepted Values
id string true The unique ID of the medical home. -
name string true The name of the medical home. -
representedBy Organization false The organization associated with the medical home. -
status string true The status of the medical home. ACTIVE, INACTIVE
createdAt string true The date and time when the medical home was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the medical home was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
aliases [Alias] false The list of medical home aliases. -

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. -

putMedicalHomes

Name Type Required Description Accepted Values
name string true The name of the medical home. -
representedBy object false The organization associated with the medical home. -
» id string true The ID of the referenced object. -
status string true The status of the medical home. ACTIVE, INACTIVE
aliases [object] false The list of medical home aliases. -
» 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. -

postNetworks

Name Type Required Description Accepted Values
name string true The name of the network. -
description string false Additional details that help describe the network. -
medicalHome object false The medical home of the network. -
» id string true The ID of the referenced object. -
plan object true The plan of the network. -
» id string true The ID of the referenced object. -
status string true The status of the network. ACTIVE, INACTIVE

NetworkEntities

Name Type Required Description Accepted Values
items [NetworkEntity] 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. -

NetworkEntity

Name Type Required Description Accepted Values
id string true The unique ID of the network. -
name string true The name of the network. -
description string false Additional details that help describe the network. -
medicalHome MedicalHome false The medical home of the network. -
plan Plan true The plan of the network. -
status string true The status of the network. ACTIVE, INACTIVE
createdAt string true The date and time when the network was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the network was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

MedicalHome

Name Type Required Description Accepted Values
id string true The ID of the medical home. -
name string true The name of the medical home. -

Plan

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

putNetworks

Name Type Required Description Accepted Values
name string true The name of the network. -
description string false Additional details that help describe the network. -
medicalHome object false The medical home of the network. -
» id string true The ID of the referenced object. -
plan object true The plan of the network. -
» id string true The ID of the referenced object. -
status string true The status of the network. ACTIVE, INACTIVE

postPayers

Name Type Required Description Accepted Values
name string true The name of the payer. -
description string false Additional details that help describe the payer. -
status string true The status of the payer. ACTIVE, INACTIVE
aliases [object] false The list of payer aliases. -
» 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. -

PayerEntities

Name Type Required Description Accepted Values
items [PayerEntity] 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. -

PayerEntity

Name Type Required Description Accepted Values
id string true The unique ID of the payer. -
name string true The name of the payer. -
description string false Additional details that help describe the payer. -
status string true The status of the payer. ACTIVE, INACTIVE
createdAt string true The date and time when the payer was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the payer was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
aliases [Alias] false The list of payer aliases. -

putPayers

Name Type Required Description Accepted Values
name string true The name of the payer. -
description string false Additional details that help describe the payer. -
status string true The status of the payer. ACTIVE, INACTIVE
aliases [object] false The list of payer aliases. -
» 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. -

postPaymentSources

Name Type Required Description Accepted Values
name string true The name of the payment source. -
description string false The description of the payment source. -
typology object true The typology under which to categorize the payment source. -
» id string true The ID of the referenced object. -
codings [object] false A list of codified values from a standard code system. -
» code string true The unique ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false A human-readable representation of the code. -
parent object false The parent of the payment source in the context of the same typology. Root-level payment sources have a null parent. -
» id string true The ID of the referenced object. -

PaymentSourceEntities

Name Type Required Description Accepted Values
items [PaymentSourceEntity] 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. -

PaymentSourceEntity

Name Type Required Description Accepted Values
id string true The unique ID of the payment source. -
name string true The name of the payment source. -
description string false The description of the payment source. -
typology IdModel true The typology that this payment source is categorized under. -
codings [Code] false A list of codified values from a standard code system. -
children [IdModel] false A list of children sources of payment. -
parent IdModel false The direct ancestor of the payment source. -
createdAt string true The date and time when the payment source was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the payment source was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

IdModel

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

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

putPaymentSources

Name Type Required Description Accepted Values
name string true The name of the payment source. -
description string false The description of the payment source. -
typology object true The typology under which to categorize the payment source. -
» id string true The ID of the referenced object. -
codings [object] false A list of codified values from a standard code system. -
» code string true The unique ID of the code. -
» system string true The ID of the coding system that gives meaning to the code. -
» display string false A human-readable representation of the code. -
parent object false The parent of the payment source in the context of the same typology. Root-level payment sources have a null parent. -
» id string true The ID of the referenced object. -

PaymentSourceLineageEntities

Name Type Required Description Accepted Values
items [PaymentSourceLineageEntity] 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. -

PaymentSourceLineageEntity

Name Type Required Description Accepted Values
depth integer(int32) false A numeric value that represents the calculated level of a payment source on a payment source hierarchy tree. This value starts at one for the highest-most level and gets larger with more child payment source entries. -
paymentSource PaymentSourceEntity false The ancestor payment source entity of the given depth. -

postTypologies

Name Type Required Description Accepted Values
name string true The name of the typology. -
description string false The description of the typology. -

PaymentSourceTypologyEntities

Name Type Required Description Accepted Values
items [PaymentSourceTypologyEntity] 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. -

PaymentSourceTypologyEntity

Name Type Required Description Accepted Values
id string true The unique ID of the typology. -
name string true The name of the typology. -
description string false The description of the typology. -
ownership string true The ownership of the typology. A value of TENANT indicates that the typology is owned and managed by a single tenant. A value of SHARED indicates that is is provided by Cerner and can be retrieved but not modified. SHARED, TENANT
createdAt string true The date and time when the payment source typology was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the payment source typology was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

putTypologies

Name Type Required Description Accepted Values
name string true The name of the typology. -
description string false The description of the typology. -

postPlans

Name Type Required Description Accepted Values
name string true The name of the plan. -
description string false Additional details that help describe the plan. -
payer object true The payer for the plan. -
» id string true The ID of the referenced object. -
status string true The status of the plan. ACTIVE, INACTIVE
aliases [object] false The list of plan aliases. -
» 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. -

PlanEntities

Name Type Required Description Accepted Values
items [PlanEntity] 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. -

PlanEntity

Name Type Required Description Accepted Values
id string true The unique ID of the plan. -
name string true The name of the plan. -
description string false Additional details that help describe the plan. -
payer Payer true The payer for the plan. -
status string true The status of the plan. ACTIVE, INACTIVE
createdAt string true The date and time when the plan was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the plan was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
aliases [Alias] false The list of plan aliases. -

Payer

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

putPlans

Name Type Required Description Accepted Values
name string true The name of the plan. -
description string false Additional details that help describe the plan. -
payer object true The payer for the plan. -
» id string true The ID of the referenced object. -
status string true The status of the plan. ACTIVE, INACTIVE
aliases [object] false The list of plan aliases. -
» 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. -

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 alternative 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. -
effectivePeriod object false The period during which the role is effective, including the start and end dates. -
» start string true The start date of the organization role. -
» end string false The end date of the organization role. -
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 A list of codified values from a standard code system. -
»» code string true The unique ID of the code. -
»» system string true The ID of the coding system that gives meaning to the code. -

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. -
effectivePeriod EffectivePeriod false The effective time period of the organization role. -
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. -

EffectivePeriod

Name Type Required Description Accepted Values
start string false The start date of the effective period of the role. -
end string false The end date of the effective period of the role. -

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. -

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. -

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 alternative 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. -
effectivePeriod object false The period during which the role is effective, including the start and end dates. -
» start string true The start date of the organization role. -
» end string false The end date of the organization role. -
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 A list of codified values from a standard code system. -
»» 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 can 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 alternative 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 time frame. -
» 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. -
effectivePeriod object false The period during which the role is effective, including the start and end dates. -
» start string true The start date of the personnel role. -
» end string false The end date of 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. -
effectivePeriod EffectivePeriod false The effective time period of the personnel role. -
providedAt [ProviderLocation] 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 [ProviderHealthcareService] 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 alternative 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 PCP in a specific time frame. -
proxyPersonnel [IdModel] false The list of personnel who are designated as proxies for the provider personnel in the role. -
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. -

ProviderLocation

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. -

ProviderHealthcareService

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 can 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 alternative 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 time frame. -
» 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. -
effectivePeriod object false The period during which the role is effective, including the start and end dates. -
» start string true The start date of the personnel role. -
» end string false The end date of the personnel role. -

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. -

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 NetworkRelationshipTypeEntity 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. -

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

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 [ProviderLocation] 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 [ProviderServiceType] 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. -

ProviderServiceType

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. -

ProviderOrganizationSearchResults

Name Type Required Description Accepted Values
items [ProviderOrganizationSearchResult] 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. -

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 [ProviderLocation] 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 [ProviderServiceType] false The list of service types offered by the provider personnel member. -
roles [RoleAndKind] 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. -

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 [RoleAndKind] 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. -