NAV Navbar
Logo cerner
Ruby Shell

Provider Open API v1

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

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

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

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

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

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

Provider Organization Roles

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

Create an Organization Role

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles', headers: headers, body: {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




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

POST /provider-organization-roles

Creates an 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 Organization Roles

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
      "organization": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Premier Quest Lab"
      },
      "healthcareServices": [
        {
          "id": "11e8733529b9bfce8ddd1bedf2633ac3",
          "name": "Blood glucose"
        },
        {
          "id": "6ccc2836f21e11e7a3d646705f8c9e77",
          "name": "Electrolytes"
        },
        {
          "id": "11e87366c78aca1c8a263b07d172512e",
          "name": "Urinalysis"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        },
        {
          "id": "9d6c9f070ab811e89dc2587234aecbf0",
          "name": "CIGNA PPO Platinum"
        }
      ],
      "status": "ACTIVE",
      "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"
      },
      "healthcareServices": [
        {
          "id": "11e8736bfbd40090a03e3f103ed32c45",
          "name": "Blood Panel"
        },
        {
          "id": "11e8736d269505e88151fb45df51819a",
          "name": "Trichomonas"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        }
      ],
      "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-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 organization roles.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The organization role ID(s) to filter by. -
networkId query string false N/A The ID of the network with which this organization role has a contractual relationship. -
organizationId query string false N/A The ID of the organization for which this organization role has been established. -
status query string false N/A The status of the organization role. Allowable values are ACTIVE and INACTIVE. ACTIVE, INACTIVE
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

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

Update an Organization Role

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-organization-roles/11e8a0b6e3d9e4b7bae9bd3b7d82a964 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"organization":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"status":"ACTIVE"}

PUT /provider-organization-roles/{organizationRoleId}

Updates an 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 Personnel Roles

Provider personnel roles represent the different jobs a practitioner may perform as they offer a variety of healthcare services in different locations or settings. A given HealtheIntent personnel may be assigned a single or multiple provider roles, depending on how many distinct combinations of specialties, healthcare services and locations they support across organizational contexts.

Create a Personnel Role

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles', headers: headers, body: {"name":"Surgeon @ NorthWest Healthcare","personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Surgeon @ NorthWest Healthcare","personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"status":"ACTIVE"}

POST /provider-personnel-roles

Creates a 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 Personnel Roles

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon @ NorthEastPole Healthcare",
      "personnel": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Jay Bee"
      },
      "assignedBy": {
        "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
        "name": "NorthEastPole Associates For Women's Healthcare"
      },
      "providedAt": [
        {
          "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
          "name": "NorthEastPole Pulmonary and Sleep Medicine SC"
        },
        {
          "id": "79739004-09db-11e8-9dc2-587234aecbf0",
          "name": "NorthEastPole Rheumatology Specialists SC"
        }
      ],
      "specialties": [
        {
          "id": "1a5116d78e36438e804f758db09d9ed2",
          "name": "Rheumatology"
        },
        {
          "id": "170e55574d2e444693b2e29d6bcbfa60",
          "name": "sleep medicine and pulmonary care"
        }
      ],
      "healthcareServices": [
        {
          "id": "11e87375edcdded880535db964285cae",
          "name": "rheumatoid arthritis"
        },
        {
          "id": "f9ed82acf21c11e7a3d646705f8c9e77",
          "name": "osteoarthritis consultation"
        },
        {
          "id": "11e87484e368a100872e15b3e0d71d65",
          "name": "pulmonary or sleep medicine consultation"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO GOLD"
        },
        {
          "id": "3002ad1133ce467f9acf8c347b4f0eeb",
          "name": "ECBS vs. FCBC"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "1b87eee2-09de-11e8-9dc2-587234aecbf0",
      "name": "Surgeon @ NorthWest Healthcare",
      "personnel": {
        "id": "1d1aaa88-09de-11e8-9dc2-587234aecbf0",
        "name": "Elizabeth Buck"
      },
      "assignedBy": {
        "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
        "name": "Northwest 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"
        }
      ],
      "specialties": [
        {
          "id": "0324b676b87e4f1bb5acb58727bd6805",
          "name": "Neurology"
        }
      ],
      "healthcareServices": [
        {
          "id": "3a42042af21f11e7a3d646705f8c9e77",
          "name": "Epilepsy consultation"
        },
        {
          "id": "11e875607a77c5ef840bddd8dc576c20",
          "name": "Stroke treatment"
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO GOLD"
        }
      ],
      "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-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 personnel roles.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The personnel role ID(s) to filter by. -
name query string false N/A The name (or partial name) of the personnel role. -
assignedBy query string false N/A The ID of the organization for which the role is available or to which it may be assigned. -
healthcareServiceId query string false N/A The ID of a healthcare service that this role provides. -
personnelId query string false N/A The ID of the personnel that is able to provide the defined services for the organization. -
providedAt query string false N/A The ID of a location at which this personnel role provides care. -
networkId query string false N/A The ID of a network which covers this personnel role. -
specialtyId query string false N/A The ID of a personnel role specialty. -
status query string false N/A the status of the personnel role. ACTIVE, INACTIVE
offset query integer(int32) false N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false personnelId,-updatedAt A comma-separated list of fields by which to sort. personnelId, -personnelId, name, -name, updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

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

Update a Personnel Role

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles/11e8a5750246534cbae93fe1756e44cf', headers: headers, body: {"name":"Surgeon @ NorthWest Healthcare","personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"status":"ACTIVE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/provider/v1/provider-personnel-roles/11e8a5750246534cbae93fe1756e44cf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Surgeon @ NorthWest Healthcare","personnel":{"id":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0"},"providedAt":[{"id":"12628e5e-09e2-11e8-9dc2-587234aecbf0"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77"}],"healthcareServices":[{"id":"f9ed82acf21c11e7a3d646705f8c9e77"}],"status":"ACTIVE"}

PUT /provider-personnel-roles/{personnelRoleId}

Updates a personnel role.

Parameters

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

Response Statuses

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

Provider Networks

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

Create a Provider Network

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

POST /provider-networks

Creates a provider networks.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Provider Networks

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /provider-networks

Retrieves a list of provider networks.

Parameters

Parameter In Type Required Default Description Accepted Values
networkId query string false N/A The ID of the network with which the provider personnel or organizations have contracted to provide services, as defined by their provider roles. -
personnelId query string false N/A The ID of the provider personnel that has the relationship to the network(s). 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(s).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 current date would return only those provider network associations with an effective period that includes the current date (i.e. 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 N/A The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. roleId, -roleId, updatedAt, -updatedAt, createdAt, -createdAt

Response Statuses

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

Update a Provider Network

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

PUT /provider-networks/{providerNetworkId}

Updates a provider network.

Parameters

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

Response Statuses

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

Retrieve a Single Provider Network

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /provider-networks/{providerNetworkId}

Retrieves a single provider network.

Parameters

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

Response Statuses

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

Provider Network Relationship Types

Provider network relationship types represent different contractual relationships providers may have to a given provider network. These definitions support an optional rank order of precedence that can be used to influence provider search result order.

Create a Provider Network Relationship Type.

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

POST /provider-network-relationship-types

Creates a provider network relationship type.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Provider Network Relationship Types

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /provider-network-relationship-types

Retrieves a list of provider network relationship types.

Parameters

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

Response Statuses

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

Update a Provider Network Relationship Type.

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

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

Updates a provider network relationship type.

Parameters

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

Response Statuses

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

Retrieve a Single Provider Network Relationship Type

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

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

Retrieves a single provider network relationship type.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A Provider Network Relationship Type object NetworkRelationshipTypeEntity
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Provider Organization Search

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

Retrieve a List of Provider Organizations.

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "providerOrganization": {
        "id": "5d8aba58-09e9-11e8-9dc2-587234aecbf0",
        "name": "Advocate Good Samaritan Hospital",
        "aliases": [
          {
            "system": "NPI",
            "value": "98765543"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Fairbury, IL, 61739",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-692-2305"
            }
          ]
        }
      ],
      "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": "9223265543"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Fairbury, IL, 61739",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-692-2305"
            }
          ]
        }
      ],
      "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 or partial name of the provider. -
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 which 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 N/A 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 ProviderOrganizationEntities
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Provider Personnel Search

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

Retrieve a List of Provider Personnel

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "provider": {
        "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
        "name": "Bonny M. Smith, M.D",
        "gender": "FEMALE",
        "age": "49",
        "languages": [
          "en",
          "es",
          "fr"
        ],
        "qualifications": [
          {
            "code": "DPM",
            "issuer": "Harris County Podiatric Surgical Residency/Gtef",
            "start": "2005-08-21",
            "end": "2020-02-04"
          }
        ],
        "aliases": [
          {
            "system": "NPI",
            "value": "01234567"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Fairbury, IL, 61739",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-692-2305"
            }
          ]
        }
      ],
      "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": "Harris County Podiatric Surgical Residency/Gtef",
            "start": "2005-08-21",
            "end": "2020-02-04"
          }
        ],
        "aliases": [
          {
            "system": "NPI",
            "value": "01234567"
          }
        ]
      },
      "locations": [
        {
          "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
          "name": "Americana Medi Group",
          "addressText": "115 East Walnut St, Fairbury, IL, 61739",
          "telecoms": [
            {
              "system": "PHONE",
              "value": "815-692-2305"
            }
          ]
        }
      ],
      "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 or partial name of the provider. -
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 which 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 N/A 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. -
organizations query string false N/A No description -

Response Statuses

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

Schema Definitions

postProviderOrganizationRoles

Name Type Required Description Accepted Values
organization object true The organization for which this organization role has been established. -
» id string true The ID of the referenced object. -
status string true The status of the organization role. ACTIVE, INACTIVE

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

OrganizationRoles

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

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. -
networks [Network] false The list of networks with which this organization has a contractual relationship to provide services. -
status string true The status of the organization role. Allowable values are ACTIVE and INACTIVE. ACTIVE, INACTIVE
updatedAt string true The date and time when the organization role was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdAt string true The date and time when the organization role was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

Organization

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

Network

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

putProviderOrganizationRoles

Name Type Required Description Accepted Values
organization object true The organization for which this organization role has been established. -
» id string true The ID of the referenced object. -
status string true The status of the organization role. ACTIVE, INACTIVE

postProviderPersonnelRoles

Name Type Required Description Accepted Values
name string false The name of the personnel role. -
personnel object true The personnel member who is able to provide the defined services for the organization. -
» id string true The ID of the referenced object. -
assignedBy object true The organization for which the role is available or to which it may be assigned. -
» id string true The ID of the referenced object. -
providedAt [object] false The location(s) at which this personnel role provides care. -
» id string true The ID of the referenced object. -
specialties [object] false The list of personnel role specialties. -
» id string true The ID of the referenced object. -
healthcareServices [object] false The list of healthcare services that this role provides. -
» id string true The ID of the referenced object. -
status string true The status of the personnel role. ACTIVE, INACTIVE

PersonnelRoles

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

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. -
assignedBy Organization true The organization for which the roles are available or to which they may be assigned. -
providedAt [Location] false The location(s) at which this personnel role provides care. -
specialties [Specialty] false The list of personnel role specialties. -
healthcareServices [HealthcareService] false The list of healthcare services that this role provides. -
networks [Network] false The list of networks which cover this personnel role. -
status string true The status of the personnel role. Allowable values are ACTIVE and INACTIVE. ACTIVE, INACTIVE
updatedAt string true The date and time when the personnel role was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdAt string true The date and time when the personnel role was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

Personnel

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

Location

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

Telecom

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

Specialty

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

HealthcareService

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

putProviderPersonnelRoles

Name Type Required Description Accepted Values
name string false The name of the personnel role. -
personnel object true The personnel member who is able to provide the defined services for the organization. -
» id string true The ID of the referenced object. -
assignedBy object true The organization for which the role is available or to which it may be assigned. -
» id string true The ID of the referenced object. -
providedAt [object] false The location(s) at which this personnel role provides care. -
» id string true The ID of the referenced object. -
specialties [object] false The list of personnel role specialties. -
» id string true The ID of the referenced object. -
healthcareServices [object] false The list of healthcare services that this role provides. -
» id string true The ID of the referenced object. -
status string true The status of the personnel role. ACTIVE, INACTIVE

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 International Organization for Standardization (ISO) 8601 YYYY-MM-DD format. -
effectiveEnd string false The date after which the provider network is no longer effective, in International Organization for Standardization (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 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. -

ProviderNetwork

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

NetworkRelationshipType

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

putProviderNetworks

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

postProviderNetworkRelationshipTypes

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

NetworkRelationshipTypeEntities

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

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. Example: CAPPED, ANCILLARY, 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 format (YYYY-MM-DDThh:mm:ssZ). -
createdAt string true The date and time when the provider network relationship type was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

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

ProviderOrganizationEntities

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

ProviderOrganizationEntity

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

ProviderOrganization

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

ServiceType

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

IdModel

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

ProviderPersonnels

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

ProviderPersonnel

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

Provider

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

Qualification

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

Role

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