Network Open API v1
The Network API allows you to create, update, and retrieve the definitions of the payers, plans, provider networks, and medical homes with which a health care system may contract or have a business relationship.
A provider network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members.
Plans represent the health insurance products offered by a payer, for example, CIGNA HMO Gold. Consumers of this service can reference this single catalog of payers and plans for various 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 the services they offer. This allows systems to search for providers who are considered in-network for the patient’s insurance plan. Similar use cases exist for referral management, scheduling, claims processing, and other workflows.
Medical homes represent 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.
Once a network and its attributes are defined, individual providers can be associated with the network using the Provider API. 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/network/v1
Payers
Payers represent 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/network/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/network/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 | 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 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/network/v1/payers', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/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-1.healtheintent.com/network/v1/payers?offset=0&limit=20",
"lastLink": "http://cernerdemo.api.us-1.healtheintent.com/network/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 | Payer IDs to filter results. Maximum of 100 IDs. | - |
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 identifier. If valued, then aliasValue is required. | - |
aliasValue | query | string | false | N/A | The value or identifier of the payer within the context of the assigning authority. If valued, then aliasSystem is required. | - |
offset | query | integer(int32) | false | N/A | Indicates the starting index of the paginated collection. | - |
limit | query | integer(int32) | false | 20 | Indicates the number of results returned in a single page. The value set must be between 1 and 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 |
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/network/v1/payers/{payerId}', 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/network/v1/payers/{payerId} \
-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/network/v1/payers/{payerId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/v1/payers/{payerId} \
-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 |
Plans
Plans represent the health insurance products offered by a given Payer (example: CIGNA HMO Gold). Consumers of this service may reference this single catalog of payers and plans for different use cases and workflows. For example, plan is an attribute common to both patients, having certain benefits coverage, and providers, having 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. There are similar use cases 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/network/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/network/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 | 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 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/network/v1/plans', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/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-1.healtheintent.com/network/v1/plans?offset=0&limit=20",
"lastLink": "http://cernerdemo.api.us-1.healtheintent.com/network/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 | Plan IDs to filter results. Maximum of 100 IDs. | - |
name | query | string | false | N/A | The name or partial name of the plan. | - |
payerId | query | string | false | N/A | 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 identifier. If valued, then aliasValue is required. | - |
aliasValue | query | string | false | N/A | The value or identifier of the plan within the context of the assigning authority. If valued, then aliasSystem is required. | - |
offset | query | integer(int32) | false | N/A | Indicates the starting index of the paginated collection. | - |
limit | query | integer(int32) | false | 20 | Indicates the number of results returned in a single page. The value set must be between 1 and 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 |
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/network/v1/plans/{planId}', 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/network/v1/plans/{planId} \
-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/network/v1/plans/{planId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/v1/plans/{planId} \
-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 |
Medical Homes
Medical homes represent 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.
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/network/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/network/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 | 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 medical home. |
Retrieves 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/network/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/network/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-1.healtheintent.com/network/v1/medical-homes?offset=0&limit=20",
"lastLink": "http://cernerdemo.api.us-1.healtheintent.com/network/v1/medical-homes?offset=0&limit=20"
}
GET /medical-homes
Retrieve a list of medical homes.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
ids | query | array[string] | false | N/A | Medical home IDs to filter results. Maximum of 100 IDs. | - |
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 identifier. If valued, then aliasValue is required. | - |
aliasValue | query | string | false | N/A | The value or identifier of the medical home within the context of the assigning authority. If valued, then aliasSystem is required. | - |
offset | query | integer(int32) | false | N/A | Indicates the starting index of the paginated collection. | - |
limit | query | integer(int32) | false | 20 | Indicates the number of results returned in a single page. The value set must be between 1 and 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 |
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/network/v1/medical-homes/{medicalHomeId}', 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/network/v1/medical-homes/{medicalHomeId} \
-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/network/v1/medical-homes/{medicalHomeId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/v1/medical-homes/{medicalHomeId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "f9ed82acf21c11e7a3d646705f8c9e77",
"name": "General Uptown Practice Center",
"representedBy": {
"id": "010c498a-ebed-4c9d-a824-787724448e0a",
"name": "General Uptown Medical Center"
},
"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 doctors, 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/network/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/network/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 | 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 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/network/v1/networks', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/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-1.healtheintent.com/network/v1/networks?offset=0&limit=20",
"lastLink": "http://cernerdemo.api.us-1.healtheintent.com/network/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 | Network IDs to filter by. Maximum of 100 IDs. | - |
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 | N/A | Indicates the starting index of the paginated collection. | - |
limit | query | integer(int32) | false | 20 | Indicates the number of results returned in a single page. The value set must be between 1 and 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 |
Update an 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/network/v1/networks/{networkId}', 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/network/v1/networks/{networkId} \
-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 | 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 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/network/v1/networks/{networkId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/network/v1/networks/{networkId} \
-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 |
Schema Definitions
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 | List of payer aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the assigning authority. | - |
Error
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
code | integer(int32) | true | Http response status code representing the error. | - |
message | string | true | Human readable description of the error. | - |
errorDetails | [ErrorDetail] | false | 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 | Codified value representing the specific error resulting in the current error status. | - |
message | string | false | Human readable description of an error. | - |
locationType | string | false | Location or type of the field that caused an error. | query, header, path, formData, body |
location | string | false | Name of the field that caused an error. | - |
PayerEntities
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [PayerEntity] | true | No description | - |
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. | - |
Alias
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
system | string | false | Authority responsible for assigning the identifier. | - |
value | string | false | The value or identifier within the context of the assigning authority. | - |
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 | List of payer aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the assigning authority. | - |
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 referencing object. | - |
status | string | true | The status of the plan. | ACTIVE, INACTIVE |
aliases | [object] | false | List of plan aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the assigning authority. | - |
PlanEntities
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [PlanEntity] | true | No description | - |
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 | No description | - |
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 referencing object. | - |
status | string | true | The status of the plan. | ACTIVE, INACTIVE |
aliases | [object] | false | List of plan aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the assigning authority. | - |
postMedicalHomes
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the medical home. | - |
representedBy | object | false | Organization associated with the medical home. | - |
» id | string | true | The ID of referencing object. | - |
status | string | true | The status of the medical home. | ACTIVE, INACTIVE |
aliases | [object] | false | List of medical home aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the assigning authority. | - |
MedicalHomeEntities
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [MedicalHomeEntity] | true | No description | - |
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 | No description | - |
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. | - |
Organization
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the organization. | - |
name | string | false | The name of the organization. | - |
putMedicalHomes
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the medical home. | - |
representedBy | object | false | Organization associated with the medical home. | - |
» id | string | true | The ID of referencing object. | - |
status | string | true | The status of the medical home. | ACTIVE, INACTIVE |
aliases | [object] | false | List of medical home aliases. | - |
» system | string | true | Authority responsible for assigning the identifier. | - |
» value | string | true | The value or identifier within the context of the 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 referencing object. | - |
plan | object | true | The plan of the network. | - |
» id | string | true | The ID of referencing object. | - |
status | string | true | The status of the network. | ACTIVE, INACTIVE |
NetworkEntities
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [NetworkEntity] | true | No description | - |
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 | No description | - |
plan | Plan | true | No description | - |
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 referencing object. | - |
plan | object | true | The plan of the network. | - |
» id | string | true | The ID of referencing object. | - |
status | string | true | The status of the network. | ACTIVE, INACTIVE |
IdModel
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The ID of referencing object. | - |