Provider API v2

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

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

Specialties practiced by the provider
Healthcare services offered by the provider
Locations (physical facilities) where the provider offers the specified services
Payer plan networks with which the provider contracts (related to insurance plans accepted)

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

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

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

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

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

Healthcare Services

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

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

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

Create a Healthcare Service




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/healthcare-services', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":[{"id":"6ee914c0f21f11e7a3d646705f8c9e77","name":"APMHS MRI Center"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77","taxonomy":{"id":"0205CF25-7F14-484B-A598-471BCA84A9BE"}},{"id":"964c3cb6f22111e7a3d646705f8c9e77"}],"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/healthcare-services \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":[{"id":"6ee914c0f21f11e7a3d646705f8c9e77","name":"APMHS MRI Center"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77","taxonomy":{"id":"0205CF25-7F14-484B-A598-471BCA84A9BE"}},{"id":"964c3cb6f22111e7a3d646705f8c9e77"}],"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}

POST /provider/v2/healthcare-services

Creates a healthcare service.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The URL of the created healthcare service.

Retrieve a List of Healthcare Services


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/healthcare-services

Retrieves a list of healthcare services.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	The healthcare service IDs to filter by. If you specify the IDs parameter, the other query parameters are ignored.	-
name	query	string	false	N/A	The name or partial name of the healthcare service.	-
categoryId	query	string	false	N/A	The service category ID for which the healthcare service details are defined.	-
providedAt	query	string	false	N/A	The location where the service can be provided.	-
providedBy	query	string	false	N/A	The organization that provides this service.	-
specialtyId	query	string	false	N/A	The unique ID of the specialty that is handled by the healthcare service.	-
status	query	string	false	N/A	The status of the healthcare service.	ACTIVE, INACTIVE
typeId	query	string	false	N/A	The service type ID for which the healthcare service details are defined.	-
aliasSystem	query	string	false	N/A	The system of the alias. Must be valued if aliasValue is valued.	-
aliasValue	query	string	false	N/A	The value of the alias. Must be valued if aliasSystem is valued.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-).	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Healthcare Service


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/healthcare-services/{serviceId}

Deletes a healthcare service.

Parameters

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

Response Statuses

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

Update a Healthcare Service




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":[{"id":"6ee914c0f21f11e7a3d646705f8c9e77","name":"APMHS MRI Center"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77","taxonomy":{"id":"0205CF25-7F14-484B-A598-471BCA84A9BE"}},{"id":"964c3cb6f22111e7a3d646705f8c9e77"}],"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":[{"id":"6ee914c0f21f11e7a3d646705f8c9e77","name":"APMHS MRI Center"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e77","taxonomy":{"id":"0205CF25-7F14-484B-A598-471BCA84A9BE"}},{"id":"964c3cb6f22111e7a3d646705f8c9e77"}],"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}

PUT /provider/v2/healthcare-services/{serviceId}

Updates a healthcare service.

Parameters

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

Response Statuses

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

Retrieve a Single Healthcare Service


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Ped Cardiology Consult",
  "description": "Ped Cardiology Consult",
  "providedBy": {
    "id": "eb0f8626f21d11e7a3d646705f8c9e77",
    "name": "Premier Health Center"
  },
  "providedAt": [
    {
      "id": "d2874990f21d11e7a3d646705f8c9e77",
      "name": "Oakland Clinic Center"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e77",
      "taxonomy": {
        "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
      }
    }
  ],
  "type": {
    "id": "2d33c102f21e11e7a3d646705f8c9e77",
    "name": "Ped Cardiology Consult",
    "status": "ACTIVE"
  },
  "category": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "Radiology",
    "status": "ACTIVE"
  },
  "status": "ACTIVE",
  "aliases": [
    {
      "system": "CERNER",
      "value": "HCS001"
    },
    {
      "system": "CERNER2",
      "value": "HCS111"
    }
  ],
  "createdAt": "2018-07-10T15:48:32Z",
  "updatedAt": "2018-07-10T15:48:32Z"
}

GET /provider/v2/healthcare-services/{serviceId}

Retrieves a single healthcare service.

Parameters

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

Response Statuses

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

Service Categories

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

Service Category: Cardiology

Service Types:
- Cardiac Catheterization
- Peripheral Vascular Evaluation
- Stress Test

Service Category: Radiology

Service Subcategory: Diagnostic

Service Types:

Abdomen 2 Views
Abdomen 3+ Views
Chest X-Ray 1 View

Service Subcategory: CT Scan

Service Types:

CT Scan Abdominal/Pelvis w/ Contrast
CT Scan Abdominal/Pelvis w/o Contrast

Create a Service Category




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-categories', headers: headers, body: {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77","aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




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

POST /provider/v2/service-categories

Creates a service category.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The web address of the created service category.

Retrieve a List of Service Categories


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/service-categories

Retrieves a list of service categories.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
IDs	query	array[string]	false	N/A	The service category IDs to filter by. If you specify the IDs parameter, the other query parameters are ignored.	-
name	query	string	false	N/A	The name of the service category. Filtering by a partial match is allowed.	-
parentID	query	string	false	N/A	The parent category ID. If the value is zero, the response includes all service categories at the root level. Otherwise, the API retrieves all immediate child service categories for the specified parent ID (with one level of depth). If no value is provided, the API retrieves categories at all levels.	-
status	query	string	false	N/A	The status of the health care service category.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The system of the alias. Must be valued if aliasValue is valued.	-
aliasValue	query	string	false	N/A	The value of the alias. Must be valued if aliasSystem is valued.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-).	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Service Category


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/service-categories/{serviceCategoryId}

Deletes a service category.

Parameters

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

Response Statuses

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

Update a Service Category




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-categories/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Neurology","description":"A neurologist specializes in the diagnosis and treatment of diseases or impaired function of the brain, spinal cord, peripheral nerves, muscles, autonomic nervous system, and blood vessels that relate to these structures.","status":"ACTIVE","parentId":"533cfba4-dead-11e7-a3d6-46705f8c9e77","aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/service-categories/{serviceCategoryId}

Updates a service category.

Parameters

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

Response Statuses

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

Retrieve a Single Service Category


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-categories/964c3cb6f22111e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/service-categories/{serviceCategoryId}

Retrieve a single service category.

Parameters

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

Response Statuses

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

Service Types

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

Cardiology Consult
MRI Head With Contrast
Physical Therapy - Initial Evaluation

Create a Service Type




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-types', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




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

POST /provider/v2/service-types

Creates a service type.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The web address of the created service type.

Retrieve a List of Service Types


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-types', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/service-types

Retrieves a list of service types.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
IDs	query	array[string]	false	N/A	The service type IDs to filter by. If you specify the IDs parameter, the other query parameters are ignored.	-
name	query	string	false	N/A	The name of the service type. Filtering by a partial match is allowed.	-
serviceCategoryId	query	string	false	N/A	Filters by service type definitions associated with the specified service category ID.	-
status	query	string	false	N/A	The status of the service type.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The system of the alias. Must be valued if aliasValue is valued.	-
aliasValue	query	string	false	N/A	The value of the alias. Must be valued if aliasSystem is valued.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-).	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Service Type


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/service-types/{serviceTypeId}

Deletes a service type.

Parameters

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

Response Statuses

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

Update a Service Type




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/service-types/2f4df666deae11e7a3d646705f8c9e77', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"aliases":[{"system":"CERNER","value":"HCS001"},{"system":"CERNER2","value":"HCS111"}]}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/service-types/{serviceTypeId}

Updates a service type.

Parameters

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

Response Statuses

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

Retrieve a Single Service Type


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/service-types/{serviceTypeId}

Retrieves a single service type.

Parameters

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

Response Statuses

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

Medical Homes

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

Create a Medical Home




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/medical-homes', headers: headers, body: {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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 /provider/v2/medical-homes

Creates a medical home.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The web address of the created medical home.

Retrieve a List of Medical Homes


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/medical-homes', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/medical-homes

Retrieves a list of medical homes.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
IDs	query	array[string]	false	N/A	The medical home IDs by which to filter results. A maximum of 100 IDs can be specified in a single request.	-
name	query	string	false	N/A	The name or partial name of the medical home.	-
status	query	string	false	N/A	The status of the medical home.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The authority responsible for assigning the medical home ID. If aliasSystem is specified, aliasValue is required.	-
aliasValue	query	string	false	N/A	The value or ID of the medical home in the context of the assigning authority. If aliasValue is specified, aliasSystem is required.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Medical Home


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/medical-homes/{medicalHomeId}

Deletes a medical home.

Parameters

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

Response Statuses

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

Update a Medical Home




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/medical-homes/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"General Uptown Practice Center","representedBy":{"id":"010c498a-ebed-4c9d-a824-787724448e0a"},"status":"ACTIVE","aliases":[{"system":"General Uptown Medical Center","value":"GUMC"}]}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/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	putProviderV2MedicalHomes	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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/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	ProviderPublicApi_Entities_Common_Networks_MedicalHomeEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Networks

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

Create a Network




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/networks', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE","type":{"codings":[{"code":"PAYER_PLAN_NETWORK","system":"CERNER","display":"Payer Plan Network"}],"text":"Payer Plan Network"},"tags":[{"key":"INCLUDEINREPORT","value":"true"}],"aliases":[{"system":"EXTERNAL_SYSTEM","value":"IN_NETWORK"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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","type":{"codings":[{"code":"PAYER_PLAN_NETWORK","system":"CERNER","display":"Payer Plan Network"}],"text":"Payer Plan Network"},"tags":[{"key":"INCLUDEINREPORT","value":"true"}],"aliases":[{"system":"EXTERNAL_SYSTEM","value":"IN_NETWORK"}]}

POST /provider/v2/networks

Creates a network.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The web address of the created network.

Retrieve a List of Networks


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "Premier - UnitedHealthcare Choice",
      "description": "Premier - UnitedHealthcare Choice HMO",
      "type": {
        "codings": [
          {
            "code": "UHC_HMO_NTWK",
            "system": "CERNER",
            "display": "United Healthcare HMO Network"
          }
        ],
        "text": "United Healthcare HMO Network"
      },
      "aliases": [
        {
          "system": "Premier_Medical_Center",
          "value": "PMC_UHC_HMO"
        }
      ],
      "plan": {
        "id": "3f7b6c740a9d11e89dc2587234aecbf0",
        "name": "UnitedHealthcare Choice"
      },
      "medicalHome": {
        "id": "451e764e45f011e89a8ea7eba4734242",
        "name": "Premier Medical Center"
      },
      "tags": [
        {
          "key": "INNETWORK",
          "value": "true"
        }
      ],
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "9d6c9f070ab811e89dc2587234aecbf0",
      "name": "General Medical Center - UnitedHealthcare HMO Gold",
      "description": "General Medical Center - UnitedHealthcare HMO Gold",
      "plan": {
        "id": "3f7b6c740a9d11e89dc2587234aecbf0",
        "name": "UnitedHealthcare HMO Gold"
      },
      "status": "ACTIVE",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/networks?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/networks?offset=0&limit=20"
}

GET /provider/v2/networks

Retrieves a list of networks.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
IDs	query	array[string]	false	N/A	The network IDs by which to filter. A maximum of 100 IDs can be specified in a single request.	-
name	query	string	false	N/A	The name or partial name of the network.	-
medicalHomeID	query	string	false	N/A	The ID of the medical home or site for which a network is defined.	-
planId	query	string	false	N/A	The ID of the plan for which a network is defined.	-
status	query	string	false	N/A	The status of the network.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The system or authority responsible for assigning the network alias. If `aliasSystem` is specified, `aliasValue` is required.	-
aliasValue	query	string	false	N/A	The value or ID of the network in the context of the `aliasSystem`. If `aliasValue` is specified, `aliasSystem` is required.	-
tag	query	array[string]	false	N/A	An array of colon-delimited combinations of the key and value of a tag associated with the resource.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Network


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/networks/{networkId}

Deletes a network.

Parameters

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

Response Statuses

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

Update a Network




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/networks/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE","type":{"codings":[{"code":"PAYER_PLAN_NETWORK","system":"CERNER","display":"Payer Plan Network"}],"text":"Payer Plan Network"},"tags":[{"key":"INCLUDEINREPORT","value":"true"}],"aliases":[{"system":"EXTERNAL_SYSTEM","value":"IN_NETWORK"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/networks/8c95b90d1d1c4f56bc8a54e4fd30644c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Premier - UnitedHealthcare Choice","description":"Premier - UnitedHealthcare Choice HMO","medicalHome":{"id":"9d6c9f050ab811e89dc2587234aecbf0"},"plan":{"id":"3f7b6c740a9d11e89dc2587234aecbf0"},"status":"ACTIVE","type":{"codings":[{"code":"PAYER_PLAN_NETWORK","system":"CERNER","display":"Payer Plan Network"}],"text":"Payer Plan Network"},"tags":[{"key":"INCLUDEINREPORT","value":"true"}],"aliases":[{"system":"EXTERNAL_SYSTEM","value":"IN_NETWORK"}]}

PUT /provider/v2/networks/{networkId}

Updates a network.

Parameters

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

Response Statuses

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

Retrieve a Single Network


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "cc46c4c2deac11e7a3d646705f8c9e77",
  "name": "General Medical Center - UnitedHealthcare HMO Gold",
  "description": "General Medical Center - UnitedHealthcare HMO Gold",
  "type": {
    "codings": [
      {
        "code": "PAYER_PLAN_NETWORK",
        "system": "CERNER",
        "display": "Payer Plan Network"
      }
    ],
    "text": "Payer Plan Network"
  },
  "medicalHome": {
    "id": "451e764e45f011e89a8ea7eba4734242",
    "name": "Premier Medical Center"
  },
  "plan": {
    "id": "3f7b6c740a9d11e89dc2587234aecbf0",
    "name": "UnitedHealthcare HMO Gold"
  },
  "status": "ACTIVE",
  "tags": [
    {
      "key": "INCLUDEINREPORT",
      "value": "true"
    }
  ],
  "aliases": [
    {
      "system": "EXTERNAL_SYSTEM",
      "value": "IN_NETWORK"
    }
  ],
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /provider/v2/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	ProviderPublicApi_Entities_Common_Networks_NetworkEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Payers

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

Create a Payer




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payers', headers: headers, body: {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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 /provider/v2/payers

Creates a payer.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Payers


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/payers

Retrieves a list of payers.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	The payer IDs by which to filter. A maximum of 100 IDs can be specified in a single request.	-
name	query	string	false	N/A	The name or partial name of the payer.	-
status	query	string	false	N/A	The status of the payer.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The authority responsible for assigning the payer ID. If aliasSystem is specified, aliasValue is required.	-
aliasValue	query	string	false	N/A	The value or ID of the payer in the context of the assigning authority. If aliasValue is specified, aliasSystem is required.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Payer


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/payers/{payerId}

Deletes a payer.

Parameters

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

Response Statuses

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

Update a Payer




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payers/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"UnitedHealthcare","description":"UnitedHealthcare","status":"ACTIVE","aliases":[{"system":"NAIC","value":"79413"}]}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/payers/{payerId}

Updates a payer.

Parameters

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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 /provider/v2/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	ProviderPublicApi_Entities_Common_Networks_PayerEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Payment Sources

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

Create a Payment Source




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payment-sources', headers: headers, body: {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}.to_json )

print JSON.pretty_generate(result)




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

POST /provider/v2/payment-sources

Creates a payment source.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Payment Sources


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payment-sources', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/payment-sources

Retrieves a list of payment sources.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
typologyId	query	string	false	N/A	Filters by the ID of the typology.	-
name	query	string	false	N/A	Filters by the name or partial name of the payment source.	-
system	query	string	false	N/A	Filters by the ID of the coding system of the payment source. If the system parameter is specified, the code parameter is required.	-
code	query	string	false	N/A	Filters by the unique ID of the code of the payment source. If the code parameter is specified, the system parameter is required.	-
parentId	query	string	false	N/A	Filters by the direct ancestor of the payment source. If a blank value is specified, the API returns only root-level entities. If a null value is specified, the API returns all entities.	-
ids	query	array[string]	false	N/A	Filters by payment source IDs. A maximum of 100 IDs can be specified in a single request.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name

Response Statuses

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

Delete a Payment Source


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/payment-sources/{id}

Deletes a payment source.

Parameters

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

Response Statuses

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

Update a Payment Source




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payment-sources/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"name":"Medicare (Managed Care)","description":"Payment source for Medicare (Managed Care)","typology":{"id":"133490e47ae111eabc550242ac130003"},"codings":[{"code":"12","display":"Medicare (Non-Managed Care)","system":"Source of Payment Typology (PHDSC)"},{"code":"11","display":"Medicare (Managed Care)","system":"Source of Payment Typology (PHDSC)"}],"parent":{"id":"ac33db5c7ae011eabc550242ac130003"}}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/payment-sources/{id}

Updates a payment source.

Parameters

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

Response Statuses

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

Retrieve a Single Payment Source


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payment-sources/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/payment-sources/{id}

Retrieves a single payment source.

Parameters

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

Response Statuses

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

Retrieve a Lineage of Payment Sources


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/payment-sources/8c95b90d1d1c4f56bc8a54e4fd30644c/lineage', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/payment-sources/{id}/lineage

Retrieves a lineage of payment sources.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the payment source.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Payment Source Typologies

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

Create a Payment Source Typology




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/typologies', headers: headers, body: {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}.to_json )

print JSON.pretty_generate(result)




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

POST /provider/v2/typologies

Creates a payment source typology.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Payment Source Typologies


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/typologies

Retrieves a list of payment source typologies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	Filters by typology IDs. A maximum of 100 can be specified in a single request.	-
name	query	string	false	N/A	Filters by the name or partial name of the typology.	-
ownership	query	string	false	N/A	Filters by whether the typologies are owned by a single tenant or shared. The value can be either `TENANT` or `SHARED`.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name

Response Statuses

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

Delete a Payment Source Typology


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/typologies/{id}

Deletes a payment source typology.

Parameters

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

Response Statuses

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

Update a Payment Source Typology




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/typologies/11e8a0b6e3d9e4b7bae9bd3b7d82a964', headers: headers, body: {"name":"NAHDO","description":"The National Association of Health Data Organizations (NAHDO) typology"}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/typologies/{id}

Updates a payment source typology.

Parameters

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

Response Statuses

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

Retrieve a Single Payment Source Typology


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/typologies/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers)

print JSON.pretty_generate(result)


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

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

GET /provider/v2/typologies/{id}

Retrieves a single payment source typology.

Parameters

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

Response Statuses

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

Plans

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

Create a Plan




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/plans', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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 /provider/v2/plans

Creates a plan.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Plans


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/plans

Retrieves a list of plans.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	The plan IDs by which to filter. A maximum of 100 IDs can be specified in a single request.	-
name	query	string	false	N/A	The name or partial name of the plan.	-
payerId	query	string	false	N/A	The ID of the payer.	-
status	query	string	false	N/A	The status of the plan.	ACTIVE, INACTIVE
aliasSystem	query	string	false	N/A	The authority responsible for assigning the plan ID. If aliasSystem is specified, aliasValue is required.	-
aliasValue	query	string	false	N/A	The value or ID of the plan in the context of the assigning authority. If aliasValue is specified, aliasSystem is required.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Delete a Plan


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/plans/{planId}

Deletes a Plan.

Parameters

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

Response Statuses

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

Update a Plan




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/plans/8c95b90d1d1c4f56bc8a54e4fd30644c', headers: headers, body: {"name":"Premier - UnitedHealthcare Choice PPO","description":"Premier - UnitedHealthcare Choice PPO","payer":{"id":"f9ed82acf21c11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"X-REF","value":"3445"},{"system":"UnitedHealthcare PPO","value":"87726-2"}]}.to_json )

print JSON.pretty_generate(result)




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

PUT /provider/v2/plans/{planId}

Updates a plan.

Parameters

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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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 /provider/v2/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	ProviderPublicApi_Entities_Common_Networks_PlanEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Locations

Provider Locations represent the physical facilities where providers offer services, for example practice offices, imaging facilities, laboratory facilities, and hospitals including departments within hospitals.

getProviderV2ProviderLocations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": {
    "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
    "name": "premier_health_berwyn_s",
    "description": "Premier Health Berwyn Location - South Near NH95 Interstate.",
    "address": {
      "use": "BILLING",
      "text": "123 Broadway Ave, Philadelphia, PA 19020",
      "lines": [
        "123 Broadway Ave"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "US",
      "postalCode": "19020"
    },
    "telecoms": [
      {
        "system": "EMAIL",
        "value": "test.name@testdomain.com",
        "use": "WORK",
        "rank": 1
      }
    ],
    "status": "ACTIVE",
    "link": {
      "target": {
        "id": "c12b044b-c32e-47ae-b4c1-4debb77177fa",
        "display": "Ministry - Premier Health Berwyn Location"
      }
    },
    "locationType": [
      {
        "id": "74331be5-ea75-47af-9689-256c75f6a50e",
        "display": "Ambulatory Location"
      }
    ],
    "managingOrganization": {
      "id": "9d6c9e780ab811e89dc2587234aecbf1"
    },
    "tags": [
      {
        "key": "INCLUDEINREPORT",
        "value": "true"
      }
    ],
    "sourceIdentifiers": [
      {
        "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
        "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
      }
    ],
    "aliases": [
      {
        "system": "http://hl7.org/fhir/v2/0203",
        "type": "TAX",
        "value": "453232001"
      }
    ],
    "createdBy": {
      "id": "9d6c9e780ab811e89dc2587234aecbf1"
    },
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedBy": {
      "id": "9d6c9e780ab811e89dc2587234aecbf1"
    },
    "updatedAt": "2020-01-01T00:00:00.000Z"
  },
  "totalResults": 21,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-locations?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-locations?offset=20&limit=20",
  "prevLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-locations?offset=0&limit=20",
  "nextLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-locations?offset=20&limit=20"
}

GET /provider/v2/provider-locations

Retrieve a List of Provider Locations

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	An array of IDs for the location.	-
name	query	string	false	N/A	The name of the location.	-
status	query	string	false	N/A	The status of the location.	ACTIVE, SUSPENDED, INACTIVE
locationType	query	array[string]	false	N/A	An array of IDs for selected location types.	-
linkTargetId	query	string	false	N/A	The ID of the link target associated with the location.	-
aliasSystem	query	string	false	N/A	The authority responsible for assigning the provider location alias value. If `aliasSystem` is specified, `aliasValue` is required.	-
aliasValue	query	string	false	N/A	The unique ID of the provider location alias in the context of the system or assigning authority. If `aliasValue` is specified, either `aliasSystem` or `aliasType` is required.	-
aliasType	query	string	false	N/A	The type of the provider location alias. If `aliasType` is specified, `aliasValue` is required.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
tag	query	array[string]	false	N/A	An array of colon-delimited combinations of the key and value of a tag associated with the resource.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	-updatedAt	A comma-separated list of fields by which to sort.	status, -status, name, -name, updatedAt, -updatedAt

Response Statuses

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

postProviderV2ProviderLocations




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-locations', headers: headers, body: {"name":"premier_health_berwyn_s","description":"Premier Health Berwyn Location - South Near NH95 Interstate","address":{"use":"BILLING","text":"123 Broadway Ave, Philadelphia, PA 19020","lines":["123 Broadway Ave"],"city":"Philadelphia","state":"PA","country":"US","postalCode":"19020"},"telecoms":[{"system":"EMAIL","value":"jane.smith@example.com","use":"WORK","rank":1}],"status":"ACTIVE","link":{"target":{"id":"c12b044b-c32e-47ae-b4c1-4debb77177fa"}},"locationType":[{"id":"04c5ad05-f74a-4f46-91bb-998705ec3f87"},{"id":"6cf4ca26-077d-11eb-adc1-0242ac120002"}],"managingOrganization":{"id":"9d6c9e780ab811e89dc2587234aecbf1"},"aliases":[{"system":"http://hl7.org/fhir/v2/0203","type":"TAX","value":"453232001"}],"createdBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"premier_health_berwyn_s","description":"Premier Health Berwyn Location - South Near NH95 Interstate","address":{"use":"BILLING","text":"123 Broadway Ave, Philadelphia, PA 19020","lines":["123 Broadway Ave"],"city":"Philadelphia","state":"PA","country":"US","postalCode":"19020"},"telecoms":[{"system":"EMAIL","value":"jane.smith@example.com","use":"WORK","rank":1}],"status":"ACTIVE","link":{"target":{"id":"c12b044b-c32e-47ae-b4c1-4debb77177fa"}},"locationType":[{"id":"04c5ad05-f74a-4f46-91bb-998705ec3f87"},{"id":"6cf4ca26-077d-11eb-adc1-0242ac120002"}],"managingOrganization":{"id":"9d6c9e780ab811e89dc2587234aecbf1"},"aliases":[{"system":"http://hl7.org/fhir/v2/0203","type":"TAX","value":"453232001"}],"createdBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}

{
  "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
  "name": "premier_health_berwyn_s",
  "description": "Premier Health Berwyn Location - South Near NH95 Interstate.",
  "address": {
    "use": "BILLING",
    "text": "123 Broadway Ave, Philadelphia, PA 19020",
    "lines": [
      "123 Broadway Ave"
    ],
    "city": "Philadelphia",
    "state": "PA",
    "country": "US",
    "postalCode": "19020"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "test.name@testdomain.com",
      "use": "WORK",
      "rank": 1
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "c12b044b-c32e-47ae-b4c1-4debb77177fa",
      "display": "Ministry - Premier Health Berwyn Location"
    }
  },
  "locationType": [
    {
      "id": "74331be5-ea75-47af-9689-256c75f6a50e",
      "display": "Ambulatory Location"
    }
  ],
  "managingOrganization": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "tags": [
    {
      "key": "INCLUDEINREPORT",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
    }
  ],
  "aliases": [
    {
      "system": "http://hl7.org/fhir/v2/0203",
      "type": "TAX",
      "value": "453232001"
    }
  ],
  "createdBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

POST /provider/v2/provider-locations

Create a Provider Location

Parameters

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

Response Statuses

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

deleteProviderV2ProviderLocationsProviderlocationid


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-locations/{providerLocationId}

Delete a Provider Location

Parameters

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

Response Statuses

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

putProviderV2ProviderLocationsProviderlocationid




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-locations/8c95b90d1d1c4f56bc8a54e4fd30644b', headers: headers, body: {"name":"premier_health_berwyn_s","description":"Premier Health Berwyn Location - South Near NH95 Interstate","address":{"use":"BILLING","text":"123 Broadway Ave, Philadelphia, PA 19020","lines":["123 Broadway Ave"],"city":"Philadelphia","state":"PA","country":"US","postalCode":"19020"},"telecoms":[{"system":"EMAIL","value":"jane.smith@example.com","use":"WORK","rank":1}],"status":"ACTIVE","link":{"target":{"id":"c12b044b-c32e-47ae-b4c1-4debb77177fa"}},"locationType":[{"id":"04c5ad05-f74a-4f46-91bb-998705ec3f87"},{"id":"6cf4ca26-077d-11eb-adc1-0242ac120002"}],"managingOrganization":{"id":"9d6c9e780ab811e89dc2587234aecbf1"},"aliases":[{"system":"http://hl7.org/fhir/v2/0203","type":"TAX","value":"453232001"}],"updatedBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-locations/8c95b90d1d1c4f56bc8a54e4fd30644b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"premier_health_berwyn_s","description":"Premier Health Berwyn Location - South Near NH95 Interstate","address":{"use":"BILLING","text":"123 Broadway Ave, Philadelphia, PA 19020","lines":["123 Broadway Ave"],"city":"Philadelphia","state":"PA","country":"US","postalCode":"19020"},"telecoms":[{"system":"EMAIL","value":"jane.smith@example.com","use":"WORK","rank":1}],"status":"ACTIVE","link":{"target":{"id":"c12b044b-c32e-47ae-b4c1-4debb77177fa"}},"locationType":[{"id":"04c5ad05-f74a-4f46-91bb-998705ec3f87"},{"id":"6cf4ca26-077d-11eb-adc1-0242ac120002"}],"managingOrganization":{"id":"9d6c9e780ab811e89dc2587234aecbf1"},"aliases":[{"system":"http://hl7.org/fhir/v2/0203","type":"TAX","value":"453232001"}],"updatedBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}

{
  "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
  "name": "premier_health_berwyn_s",
  "description": "Premier Health Berwyn Location - South Near NH95 Interstate.",
  "address": {
    "use": "BILLING",
    "text": "123 Broadway Ave, Philadelphia, PA 19020",
    "lines": [
      "123 Broadway Ave"
    ],
    "city": "Philadelphia",
    "state": "PA",
    "country": "US",
    "postalCode": "19020"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "test.name@testdomain.com",
      "use": "WORK",
      "rank": 1
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "c12b044b-c32e-47ae-b4c1-4debb77177fa",
      "display": "Ministry - Premier Health Berwyn Location"
    }
  },
  "locationType": [
    {
      "id": "74331be5-ea75-47af-9689-256c75f6a50e",
      "display": "Ambulatory Location"
    }
  ],
  "managingOrganization": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "tags": [
    {
      "key": "INCLUDEINREPORT",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
    }
  ],
  "aliases": [
    {
      "system": "http://hl7.org/fhir/v2/0203",
      "type": "TAX",
      "value": "453232001"
    }
  ],
  "createdBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

PUT /provider/v2/provider-locations/{providerLocationId}

Update a Provider Location

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Provider Location object	ProviderLocation
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

getProviderV2ProviderLocationsProviderlocationid


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "12628e5e-09e2-11e8-9dc2-587234aecbf0",
  "name": "premier_health_berwyn_s",
  "description": "Premier Health Berwyn Location - South Near NH95 Interstate.",
  "address": {
    "use": "BILLING",
    "text": "123 Broadway Ave, Philadelphia, PA 19020",
    "lines": [
      "123 Broadway Ave"
    ],
    "city": "Philadelphia",
    "state": "PA",
    "country": "US",
    "postalCode": "19020"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "test.name@testdomain.com",
      "use": "WORK",
      "rank": 1
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "c12b044b-c32e-47ae-b4c1-4debb77177fa",
      "display": "Ministry - Premier Health Berwyn Location"
    }
  },
  "locationType": [
    {
      "id": "74331be5-ea75-47af-9689-256c75f6a50e",
      "display": "Ambulatory Location"
    }
  ],
  "managingOrganization": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "tags": [
    {
      "key": "INCLUDEINREPORT",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
    }
  ],
  "aliases": [
    {
      "system": "http://hl7.org/fhir/v2/0203",
      "type": "TAX",
      "value": "453232001"
    }
  ],
  "createdBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

GET /provider/v2/provider-locations/{providerLocationId}

Retrieve a Single Provider Location

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single provider location object	ProviderLocation
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Location Types

Provider Location Types represent the types of physical facilities where providers offer services including the associations of provider location types to codeable concepts.

getProviderV2ProviderLocationTypes


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "99dabeb98a8945e08848433100a2da8b",
      "name": "all_locations",
      "title": "All Locations",
      "description": "All locations across the enterprises.",
      "code": {
        "text": "Facility",
        "codings": [
          {
            "code": "all_locations",
            "system": "2.16.840.1.113883.4.642.3.329",
            "display": "All Locations"
          }
        ]
      },
      "createdBy": {
        "id": "49d0677b-28e6-4648-9159-1e114eb7b829"
      },
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedBy": {
        "id": "49d0677b-28e6-4648-9159-1e114eb7b829"
      },
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }
  ],
  "totalResults": 21,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-location-types?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-location-types?offset=20&limit=20",
  "prevLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-location-types?offset=0&limit=20",
  "nextLink": "http://cernerdemo.api.us.healtheintent.com/provider/v2/provider-location-types?offset=20&limit=20"
}

GET /provider/v2/provider-location-types

Retrieve a List of Provider Location Types

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	An array of IDs for the location type.	-
name	query	string	false	N/A	The name of the location type.	-
title	query	string	false	N/A	The title of the location type.	-
codeSystem	query	string	false	N/A	The code system of the location type.	-
codeValue	query	string	false	N/A	The code value of the location type.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	-updatedAt	A comma-separated list of fields by which to sort.	name, -name, title, -title, updatedAt, -updatedAt

Response Statuses

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

postProviderV2ProviderLocationTypes




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types', headers: headers, body: {"name":"all_locations","title":"All locations","description":"All locations across the enterprises.","code":{"text":"Test text","codings":[{"code":"all_locations","system":"2.16.840.1.113883.4.642.3.329","display":"All Locations"},{"code":"imaging_centers","system":"2.16.840.1.113883.4.642.3.329","display":"Imaging Centers"}]},"createdBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"all_locations","title":"All locations","description":"All locations across the enterprises.","code":{"text":"Test text","codings":[{"code":"all_locations","system":"2.16.840.1.113883.4.642.3.329","display":"All Locations"},{"code":"imaging_centers","system":"2.16.840.1.113883.4.642.3.329","display":"Imaging Centers"}]},"createdBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}

POST /provider/v2/provider-location-types

Create a Provider Location Type

Parameters

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

Response Statuses

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

deleteProviderV2ProviderLocationTypesProviderlocationtypeid


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-location-types/{providerLocationTypeId}

Delete a Provider Location Type

Parameters

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

Response Statuses

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

putProviderV2ProviderLocationTypesProviderlocationtypeid




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types/8c95b90d1d1c4f56bc8a54e4fd30644b', headers: headers, body: {"name":"all_locations","title":"All locations","description":"All locations across the enterprises.","code":{"text":"Test text","codings":[{"code":"all_locations","system":"2.16.840.1.113883.4.642.3.329","display":"All Locations"},{"code":"imaging_centers","system":"2.16.840.1.113883.4.642.3.329","display":"Imaging Centers"}]},"updatedBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types/8c95b90d1d1c4f56bc8a54e4fd30644b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"all_locations","title":"All locations","description":"All locations across the enterprises.","code":{"text":"Test text","codings":[{"code":"all_locations","system":"2.16.840.1.113883.4.642.3.329","display":"All Locations"},{"code":"imaging_centers","system":"2.16.840.1.113883.4.642.3.329","display":"Imaging Centers"}]},"updatedBy":{"id":"9d6c9e780ab811e89dc2587234aecbf1"}}

PUT /provider/v2/provider-location-types/{providerLocationTypeId}

Update a Provider Location Type

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Provider Location Type object	ProviderLocationType
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

getProviderV2ProviderLocationTypesProviderlocationtypeid


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-location-types/8c95b90d1d1c4f56bc8a54e4fd30644b', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "99dabeb98a8945e08848433100a2da8b",
  "name": "all_locations",
  "title": "All Locations",
  "description": "All locations across the enterprises.",
  "code": {
    "text": "Facility",
    "codings": [
      {
        "code": "all_locations",
        "system": "2.16.840.1.113883.4.642.3.329",
        "display": "All Locations"
      }
    ]
  },
  "createdBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedBy": {
    "id": "9d6c9e780ab811e89dc2587234aecbf1"
  },
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

GET /provider/v2/provider-location-types/{providerLocationTypeId}

Retrieve a Single Provider Location Type

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single provider location type object	ProviderLocationType
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Network Relationship Types

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

Create a Provider Network Relationship Type.




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

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

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

print JSON.pretty_generate(result)




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

POST /provider/v2/provider-network-relationship-types

Creates a provider network relationship type.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postProviderV2ProviderNetworkRelationshipTypes	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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/provider-network-relationship-types

Retrieves a list of provider network relationship types.

Parameters

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

Response Statuses

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

Delete a Provider Network Relationship Type.


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

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

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

print JSON.pretty_generate(result)


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

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

Deletes a provider network relationship type.

Parameters

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

Response Statuses

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

Update a Provider Network Relationship Type.




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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/v2/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	putProviderV2ProviderNetworkRelationshipTypes	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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/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	ProviderPublicApi_Entities_Common_Providers_NetworkRelationshipTypeEntity
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Networks

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

Create a Provider Network




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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/v2/provider-networks

Creates a provider network.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postProviderV2ProviderNetworks	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


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

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

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

print JSON.pretty_generate(result)


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

{
  "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/v2/provider-networks?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v2/provider-networks?offset=0&limit=20"
}

GET /provider/v2/provider-networks

Retrieves a list of provider networks.

Parameters

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

Response Statuses

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

Delete a Provider Network


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-networks/{providerNetworkId}

Deletes a provider network.

Parameters

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

Response Statuses

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

Update a Provider Network




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

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

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

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/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/v2/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	putProviderV2ProviderNetworks	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


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

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

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

print JSON.pretty_generate(result)


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

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

GET /provider/v2/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	ProviderPublicApi_Entities_Common_Providers_ProviderNetwork
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Organizations

Provider organizations are the organizations that offer or provide health care services, but when you visit or receive a referral to one of these organizations, you do not schedule an appointment with a specific practitioner. Examples of a provider organization include physical therapy facilities, radiology facilities, and laboratories. Provider organizations identify which subset of Health Data Intelligence organizations are designated as provider organizations when performing operations such as a provider search.

Retrieve a List of Provider Organizations


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e82f7f6590cad3ba52932424218c68",
      "name": "Memorial Health System 7",
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e777",
          "name": "Cardiology",
          "taxonomy": {
            "id": "533cfba4dead11e7a3d646705f8c9e77",
            "name": "NUCC Taxonomy V20.3"
          },
          "isPrimary": true
        }
      ],
      "roles": [
        {
          "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
        }
      ],
      "telecoms": [
        {
          "system": "PHONE",
          "value": "123-456-7890",
          "use": "work",
          "rank": 1
        },
        {
          "system": "URL",
          "value": "http://memorialhealth.org"
        }
      ],
      "addresses": [
        {
          "text": "123 Broadway ave,23 Street, Philadelphia, PA, 19020",
          "use": "WORK",
          "lines": [
            "123 Broadway ave",
            "23 Street"
          ],
          "city": "Philadelphia",
          "state": "PA",
          "country": "USA",
          "postalCode": "19020"
        }
      ],
      "isManual": true,
      "aliases": [
        {
          "system": "2.16.840.1.113883.4.6",
          "type": "NPI",
          "value": "453232001"
        },
        {
          "system": "http://cerner.codes.com",
          "type": "EXTERNAL",
          "value": "PO001"
        }
      ],
      "status": "ACTIVE",
      "link": {
        "target": {
          "id": "5d8aba55-09e9-11e8-9dc2-697234aecbf8",
          "display": "Memorial Hospital"
        }
      },
      "tags": [
        {
          "key": "IncludeInReport",
          "value": true
        },
        {
          "key": "type",
          "value": "ManagedCare"
        }
      ],
      "sourceIdentifiers": [
        {
          "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
          "id": "12345"
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "updatedBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      },
      "createdAt": "2018-03-02T20:39:35Z",
      "createdBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organizations?offset=200&limit=20",
  "prevLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organizations?offset=40&limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organizations?offset=20&limit=20"
}

GET /provider/v2/provider-organizations

Retrieve a List of Provider Organizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	The provider organization IDs to filter by. The maximum number of IDs are limited to 30.	-
name	query	string	false	N/A	The name or partial name of the provider organization.	-
specialtyId	query	string	false	N/A	The ID of the specialty that is handled by the provider organization. If specialtyId is specified, taxonomyId is required.	-
taxonomyId	query	string	false	N/A	The ID of the taxonomy that is handled by the provider organization. If taxonomyId is specified, specialtyId is required.	-
aliasSystem	query	string	false	N/A	The authority responsible for assigning the provider organization ID. If aliasSystem is specified, aliasValue is required.	-
aliasValue	query	string	false	N/A	The value or ID of the provider organization in the context of the assigning authority.If aliasValue is specified, aliasSystem is required.	-
linkOrganizationId	query	array[string]	false	N/A	The ID of the link target associated with the provider organization. The maximum number of IDs are limited to 20.	-
tag	query	array[string]	false	N/A	Array parameter, The colon-delimited combination of the key and value of a tag (for example, Use:Production).	-
status	query	string	false	N/A	The status of the provider organization. Accepted values: ACTIVE, INACTIVE. SUSPENDED is not a valid status.	ACTIVE, INACTIVE
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Create a Provider Organization




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations', headers: headers, body: {"name":"Memorial Health System 7","specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e777","name":"Cardiology","taxonomy":{"id":"533cfba4dead11e7a3d646705f8c9e77","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"telecoms":[{"system":"PHONE","value":"123-456-7890","use":"work","rank":1},{"system":"URL","value":"http://memorialhealth.org"}],"addresses":[{"text":"123 Broadway ave,23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"NPI","value":"453232001"},{"system":"http://cerner.codes.com","type":"EXTERNAL","value":"PO001"}],"status":"ACTIVE","link":{"target":{"id":"5d8aba55-09e9-11e8-9dc2-697234aecbf8","display":"Memorial Hospital"}},"tags":[{"key":"IncludeInReport","value":true},{"key":"type","value":"ManagedCare"}],"createdBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Memorial Health System 7","specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e777","name":"Cardiology","taxonomy":{"id":"533cfba4dead11e7a3d646705f8c9e77","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"telecoms":[{"system":"PHONE","value":"123-456-7890","use":"work","rank":1},{"system":"URL","value":"http://memorialhealth.org"}],"addresses":[{"text":"123 Broadway ave,23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"NPI","value":"453232001"},{"system":"http://cerner.codes.com","type":"EXTERNAL","value":"PO001"}],"status":"ACTIVE","link":{"target":{"id":"5d8aba55-09e9-11e8-9dc2-697234aecbf8","display":"Memorial Hospital"}},"tags":[{"key":"IncludeInReport","value":true},{"key":"type","value":"ManagedCare"}],"createdBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}

{
  "id": "11e82f7f6590cad3ba52932424218c68",
  "name": "Memorial Health System 7",
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e777",
      "name": "Cardiology",
      "taxonomy": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
    }
  ],
  "telecoms": [
    {
      "system": "PHONE",
      "value": "123-456-7890",
      "use": "work",
      "rank": 1
    },
    {
      "system": "URL",
      "value": "http://memorialhealth.org"
    }
  ],
  "addresses": [
    {
      "text": "123 Broadway ave,23 Street, Philadelphia, PA, 19020",
      "use": "WORK",
      "lines": [
        "123 Broadway ave",
        "23 Street"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "USA",
      "postalCode": "19020"
    }
  ],
  "isManual": true,
  "aliases": [
    {
      "system": "2.16.840.1.113883.4.6",
      "type": "NPI",
      "value": "453232001"
    },
    {
      "system": "http://cerner.codes.com",
      "type": "EXTERNAL",
      "value": "PO001"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "5d8aba55-09e9-11e8-9dc2-697234aecbf8",
      "display": "Memorial Hospital"
    }
  },
  "tags": [
    {
      "key": "IncludeInReport",
      "value": true
    },
    {
      "key": "type",
      "value": "ManagedCare"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "12345"
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

POST /provider/v2/provider-organizations

Creates a provider organization.

Parameters

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

Response Statuses

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

Response Headers

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

Update a Provider Organization




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations/{id}', headers: headers, body: {"name":"Memorial Health System 7","specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e777","name":"Cardiology","taxonomy":{"id":"533cfba4dead11e7a3d646705f8c9e77","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"telecoms":[{"system":"PHONE","value":"123-456-7890","use":"work","rank":1},{"system":"URL","value":"http://memorialhealth.org"}],"addresses":[{"text":"123 Broadway ave,23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"NPI","value":"453232001"},{"system":"http://cerner.codes.com","type":"EXTERNAL","value":"PO001"}],"status":"ACTIVE","link":{"target":{"id":"5d8aba55-09e9-11e8-9dc2-697234aecbf8","display":"Memorial Hospital"}},"tags":[{"key":"IncludeInReport","value":true},{"key":"type","value":"ManagedCare"}],"updatedBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations/{id} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Memorial Health System 7","specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e777","name":"Cardiology","taxonomy":{"id":"533cfba4dead11e7a3d646705f8c9e77","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"telecoms":[{"system":"PHONE","value":"123-456-7890","use":"work","rank":1},{"system":"URL","value":"http://memorialhealth.org"}],"addresses":[{"text":"123 Broadway ave,23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"NPI","value":"453232001"},{"system":"http://cerner.codes.com","type":"EXTERNAL","value":"PO001"}],"status":"ACTIVE","link":{"target":{"id":"5d8aba55-09e9-11e8-9dc2-697234aecbf8","display":"Memorial Hospital"}},"tags":[{"key":"IncludeInReport","value":true},{"key":"type","value":"ManagedCare"}],"updatedBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}

{
  "id": "11e82f7f6590cad3ba52932424218c68",
  "name": "Memorial Health System 7",
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e777",
      "name": "Cardiology",
      "taxonomy": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
    }
  ],
  "telecoms": [
    {
      "system": "PHONE",
      "value": "123-456-7890",
      "use": "work",
      "rank": 1
    },
    {
      "system": "URL",
      "value": "http://memorialhealth.org"
    }
  ],
  "addresses": [
    {
      "text": "123 Broadway ave,23 Street, Philadelphia, PA, 19020",
      "use": "WORK",
      "lines": [
        "123 Broadway ave",
        "23 Street"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "USA",
      "postalCode": "19020"
    }
  ],
  "isManual": true,
  "aliases": [
    {
      "system": "2.16.840.1.113883.4.6",
      "type": "NPI",
      "value": "453232001"
    },
    {
      "system": "http://cerner.codes.com",
      "type": "EXTERNAL",
      "value": "PO001"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "5d8aba55-09e9-11e8-9dc2-697234aecbf8",
      "display": "Memorial Hospital"
    }
  },
  "tags": [
    {
      "key": "IncludeInReport",
      "value": true
    },
    {
      "key": "type",
      "value": "ManagedCare"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "12345"
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

PUT /provider/v2/provider-organizations/{id}

Updates a provider organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the provider organization.	-
body	body	putProviderV2ProviderOrganizations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Provider Organization	ProviderPublicApi_Entities_V2_Providers_ProviderOrganization
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Delete Provider Organization


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations/{id}', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-organizations/{id}

Delete Provider Organization.

Parameters

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

Response Statuses

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

Retrieve a Single Provider Organization


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organizations/{id}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e82f7f6590cad3ba52932424218c68",
  "name": "Memorial Health System 7",
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e777",
      "name": "Cardiology",
      "taxonomy": {
        "id": "533cfba4dead11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964"
    }
  ],
  "telecoms": [
    {
      "system": "PHONE",
      "value": "123-456-7890",
      "use": "work",
      "rank": 1
    },
    {
      "system": "URL",
      "value": "http://memorialhealth.org"
    }
  ],
  "addresses": [
    {
      "text": "123 Broadway ave,23 Street, Philadelphia, PA, 19020",
      "use": "WORK",
      "lines": [
        "123 Broadway ave",
        "23 Street"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "USA",
      "postalCode": "19020"
    }
  ],
  "isManual": true,
  "aliases": [
    {
      "system": "2.16.840.1.113883.4.6",
      "type": "NPI",
      "value": "453232001"
    },
    {
      "system": "http://cerner.codes.com",
      "type": "EXTERNAL",
      "value": "PO001"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "5d8aba55-09e9-11e8-9dc2-697234aecbf8",
      "display": "Memorial Hospital"
    }
  },
  "tags": [
    {
      "key": "IncludeInReport",
      "value": true
    },
    {
      "key": "type",
      "value": "ManagedCare"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "12345"
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

GET /provider/v2/provider-organizations/{id}

A single provider organization object.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Provider Organization	ProviderPublicApi_Entities_V2_Providers_ProviderOrganization
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Organization Roles

Provider organization roles identify which subset of Health Data Intelligence organizations are designated as provider organizations when performing operations such as a provider search. The management of services offered across locations in a given organization is managed using the Health Care Services resource.

Retrieve a List of Provider Organization Roles


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
      "assignedBy": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Premier Quest Lab",
        "link": {
          "target": {
            "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
            "display": "Ministry - Premier Quest Lab"
          }
        }
      },
      "providerLocations": [
        {
          "id": "e49e1c86-973a-4efa-83af-d35b252d0323"
        }
      ],
      "period": {
        "start": "2020-01-01T19:45:00.001Z",
        "end": "2020-06-01T20:55:00.001Z"
      },
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO Gold"
        },
        {
          "id": "9d6c9f070ab811e89dc2587234aecbf0",
          "name": "CIGNA PPO Platinum"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e522",
          "name": "Cardiology",
          "taxonomy": {
            "id": "9ed82acf21c11e7a3d646705f8c9e533",
            "name": "NUCC Taxonomy V20.3"
          },
          "isPrimary": true
        }
      ],
      "healthcareServices": [
        {
          "id": "11e87375edcdded880535db964285cae",
          "name": "rheumatoid arthritis"
        },
        {
          "id": "f9ed82acf21c11e7a3d646705f8c9e77",
          "name": "osteoarthritis consultation"
        }
      ],
      "tags": [
        {
          "key": "IncludeInReport",
          "value": "true"
        }
      ],
      "sourceIdentifiers": [
        {
          "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
          "id": "3edf856e"
        }
      ],
      "aliases": [
        {
          "system": "organization-profile-id",
          "value": "212cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "status": "ACTIVE",
      "isManual": true,
      "paymentTaxId": "18364201AC",
      "acceptingPatients": true,
      "roleType": {
        "text": "Sample 1234",
        "codings": [
          {
            "code": "IPA",
            "system": "testSystem",
            "display": "Independent Physician Association"
          }
        ]
      },
      "updatedAt": "2018-03-02T20:39:35Z",
      "updatedBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      },
      "createdAt": "2018-03-02T20:39:35Z",
      "createdBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organization-roles?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organization-roles?offset=200&limit=20",
  "prevLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organization-roles?offset=40&limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/provider-service/v2/provider-organization-roles?offset=20&limit=20"
}

GET /provider/v2/provider-organization-roles

Retrieve a List of Provider Organization Roles.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	Array parameter, the maximum number of ids are limited to 20. When provided, the response should contain the list of the provider organization roles that are matched to the input ids list.	-
organizationId	query	string	false	N/A	When provided, the response should contain the list of provider organization roles that are having matching assigning organization id.	-
paymentTaxId	query	string	false	N/A	The Taxpayer Identification Number (TIN) of a provider organization that is applicable for services rendered by the provider organization role. When provided, the response should include the list of matching provider organization roles that are matched to a given input parameter.	-
linkOrganizationId	query	array[string]	false	N/A	Array parameter, the maximum number of link location ids are limited to 20. When provided the response should contain the provider organization roles that matches the linked organization of personnel ministry.	-
networkId	query	string	false	N/A	When provided, the response should contain all the matching provider organization roles that are associated to the given network id.	-
specialtyId	query	string	false	N/A	When provided the taxonomyId must be provided as well. The response should contain all the matching provider organization roles that are associated to the given specialty id.	-
taxonomyId	query	string	false	N/A	When provided and if specialtyId is provided, then the response should contain all the matching provider organization roles that are associated to the given specialty id for this taxonomy id.	-
isPrimarySpecialty	query	boolean	false	N/A	When provided, then the response should contain all the matching provider organization roles that are associated to the given input parameter.	-
aliasSystem	query	string	false	N/A	When provided, the aliasValue parameter must be provided otherwise this parameter will be ignored. The response should contain a single provider organization role that matches the given aliasSystem and aliasValue.	-
aliasValue	query	string	false	N/A	When provided, the aliasSystem parameter must be provided otherwise this parameter will be ignored. The response should contain a single provider provider organization role that matches the given aliasSystem and aliasValue.	-
acceptingPatients	query	boolean	false	N/A	When provided, the response should include the list of matching provider organization roles that are matched to a given input parameter.	-
roleTypeText	query	string	false	N/A	When provided, the response should include the list of matching provider organization roles that are matched to a given input parameter.	-
roleTypeCode	query	string	false	N/A	When provided, the roleTypeCodeSystem must be present. The response should include the list of matching provider organization roles that are matched to a given roleTypeCode and roleTypeCodeSystem.	-
roleTypeCodeSystem	query	string	false	N/A	When provided, the roleTypeCode must be present. The response should include the list of matching provider organization roles that are matched to a given roleTypeCode and roleTypeCodeSystem.	-
effectiveDate	query	string	false	N/A	When provided, the response should include the list that is effective on the date specified. If the date is on or between the effective start and end dates of the role, the role is included in the response.	-
tag	query	array[string]	false	N/A	Array parameter, The colon-delimited combination of the key and value of a tag (for example, Use:Production). The maximum number of tags are limited to 20.	-
status	query	string	false	N/A	Allowable values: ACTIVE, INACTIVE. When provided, the response should contain the list of provider organization roles that are matching status for the given input parameter value.	ACTIVE, INACTIVE
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	-updatedAt	A comma-separated list of fields by which to sort.	createdAt, -createdAt, updatedAt, -updatedAt

Response Statuses

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

Create a Provider Organization Role




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles', headers: headers, body: {"assignedBy":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Premier Quest Lab","link":{"target":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","display":"Ministry - Premier Quest Lab"}}},"providerLocations":[{"id":"e49e1c86-973a-4efa-83af-d35b252d0323"}],"period":{"start":"2020-01-01T19:45:00.001Z","end":"2020-06-01T20:55:00.001Z"},"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e522","name":"Cardiology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e533","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"tags":[{"key":"IncludeInReport","value":"true"}],"aliases":[{"system":"organization-profile-id","value":"212cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"18364201AC","acceptingPatients":true,"roleType":{"text":"Sample 1234","codings":[{"code":"IPA","system":"testSystem","display":"Independent Physician Association"}]},"createdBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"assignedBy":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Premier Quest Lab","link":{"target":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","display":"Ministry - Premier Quest Lab"}}},"providerLocations":[{"id":"e49e1c86-973a-4efa-83af-d35b252d0323"}],"period":{"start":"2020-01-01T19:45:00.001Z","end":"2020-06-01T20:55:00.001Z"},"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e522","name":"Cardiology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e533","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"tags":[{"key":"IncludeInReport","value":"true"}],"aliases":[{"system":"organization-profile-id","value":"212cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"18364201AC","acceptingPatients":true,"roleType":{"text":"Sample 1234","codings":[{"code":"IPA","system":"testSystem","display":"Independent Physician Association"}]},"createdBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}

{
  "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
  "assignedBy": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Premier Quest Lab",
    "link": {
      "target": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "display": "Ministry - Premier Quest Lab"
      }
    }
  },
  "providerLocations": [
    {
      "id": "e49e1c86-973a-4efa-83af-d35b252d0323"
    }
  ],
  "period": {
    "start": "2020-01-01T19:45:00.001Z",
    "end": "2020-06-01T20:55:00.001Z"
  },
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO Gold"
    },
    {
      "id": "9d6c9f070ab811e89dc2587234aecbf0",
      "name": "CIGNA PPO Platinum"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e522",
      "name": "Cardiology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e533",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "tags": [
    {
      "key": "IncludeInReport",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "3edf856e"
    }
  ],
  "aliases": [
    {
      "system": "organization-profile-id",
      "value": "212cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "roleType": {
    "text": "Sample 1234",
    "codings": [
      {
        "code": "IPA",
        "system": "testSystem",
        "display": "Independent Physician Association"
      }
    ]
  },
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

POST /provider/v2/provider-organization-roles

Creates a provider organization role.

Parameters

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

Response Statuses

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

Response Headers

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

Delete Provider Organization Role


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles/{id}', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-organization-roles/{id}

Delete Provider Organization Role.

Parameters

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

Response Statuses

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

Update a Provider Organization Role




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles/{id}', headers: headers, body: {"assignedBy":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Premier Quest Lab","link":{"target":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","display":"Ministry - Premier Quest Lab"}}},"providerLocations":[{"id":"e49e1c86-973a-4efa-83af-d35b252d0323"}],"period":{"start":"2020-01-01T19:45:00.001Z","end":"2020-06-01T20:55:00.001Z"},"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e522","name":"Cardiology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e533","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"tags":[{"key":"IncludeInReport","value":"true"}],"aliases":[{"system":"organization-profile-id","value":"212cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"18364201AC","acceptingPatients":true,"roleType":{"text":"Sample 1234","codings":[{"code":"IPA","system":"testSystem","display":"Independent Physician Association"}]},"updatedBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles/{id} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"assignedBy":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Premier Quest Lab","link":{"target":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","display":"Ministry - Premier Quest Lab"}}},"providerLocations":[{"id":"e49e1c86-973a-4efa-83af-d35b252d0323"}],"period":{"start":"2020-01-01T19:45:00.001Z","end":"2020-06-01T20:55:00.001Z"},"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e522","name":"Cardiology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e533","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"tags":[{"key":"IncludeInReport","value":"true"}],"aliases":[{"system":"organization-profile-id","value":"212cfba4dead11e7a3d646705f8c9e77"}],"status":"ACTIVE","paymentTaxId":"18364201AC","acceptingPatients":true,"roleType":{"text":"Sample 1234","codings":[{"code":"IPA","system":"testSystem","display":"Independent Physician Association"}]},"updatedBy":{"id":"cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"}}

{
  "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
  "assignedBy": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Premier Quest Lab",
    "link": {
      "target": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "display": "Ministry - Premier Quest Lab"
      }
    }
  },
  "providerLocations": [
    {
      "id": "e49e1c86-973a-4efa-83af-d35b252d0323"
    }
  ],
  "period": {
    "start": "2020-01-01T19:45:00.001Z",
    "end": "2020-06-01T20:55:00.001Z"
  },
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO Gold"
    },
    {
      "id": "9d6c9f070ab811e89dc2587234aecbf0",
      "name": "CIGNA PPO Platinum"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e522",
      "name": "Cardiology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e533",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "tags": [
    {
      "key": "IncludeInReport",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "3edf856e"
    }
  ],
  "aliases": [
    {
      "system": "organization-profile-id",
      "value": "212cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "roleType": {
    "text": "Sample 1234",
    "codings": [
      {
        "code": "IPA",
        "system": "testSystem",
        "display": "Independent Physician Association"
      }
    ]
  },
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

PUT /provider/v2/provider-organization-roles/{id}

Updates a provider organization role.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the provider organization.	-
body	body	putProviderV2ProviderOrganizationRoles	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Update a Provider Organization Role	ProviderPublicApi_Entities_V2_Providers_ProviderOrganizationRole
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a Single Provider Organization Role


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-organization-roles/{id}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
  "assignedBy": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Premier Quest Lab",
    "link": {
      "target": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "display": "Ministry - Premier Quest Lab"
      }
    }
  },
  "providerLocations": [
    {
      "id": "e49e1c86-973a-4efa-83af-d35b252d0323"
    }
  ],
  "period": {
    "start": "2020-01-01T19:45:00.001Z",
    "end": "2020-06-01T20:55:00.001Z"
  },
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO Gold"
    },
    {
      "id": "9d6c9f070ab811e89dc2587234aecbf0",
      "name": "CIGNA PPO Platinum"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e522",
      "name": "Cardiology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e533",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "tags": [
    {
      "key": "IncludeInReport",
      "value": "true"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "3edf856e"
    }
  ],
  "aliases": [
    {
      "system": "organization-profile-id",
      "value": "212cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "roleType": {
    "text": "Sample 1234",
    "codings": [
      {
        "code": "IPA",
        "system": "testSystem",
        "display": "Independent Physician Association"
      }
    ]
  },
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

GET /provider/v2/provider-organization-roles/{id}

A single provider organization role object.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Provider Organization Role	ProviderPublicApi_Entities_V2_Providers_ProviderOrganizationRole
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Provider Personnel

Provider personnel are individual health care practitioners, such as physicians, clinicians, or specialists. Provider personnel identify which subset of Health Data Intelligence personnel are designated as provider personnel when performing operations such as a provider search.

Retrieve a List of Provider Personnel


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e91f884c18d5d4805aeb96e2647bb8",
      "name": {
        "text": "Dr. Firstname Lastname M.D.",
        "family": "Lastname",
        "given": [
          "Firstname"
        ],
        "prefix": [
          "Dr"
        ],
        "suffix": [
          "MD"
        ]
      },
      "gender": {
        "code": "male",
        "system": "http://hl7.org/fhir/administrative-gender",
        "display": "Male"
      },
      "birthDate": "1978-09-30",
      "communications": [
        {
          "code": {
            "codings": [
              {
                "code": "eng",
                "system": "ISO 639-2",
                "display": "English (United States)"
              }
            ],
            "text": "English"
          }
        },
        {
          "code": {
            "codings": [
              {
                "code": "zho",
                "system": "ISO 639-2",
                "display": "Chinese (China)"
              }
            ],
            "text": "Chinese"
          }
        }
      ],
      "photo": {
        "contentType": "IMAGE/JPG",
        "url": "../images/123.jpg",
        "title": "Image-Name"
      },
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "Name@organization.com",
          "use": "WORK",
          "rank": "2"
        },
        {
          "system": "PHONE",
          "value": "123-456-7890",
          "use": "WORK",
          "rank": "1"
        }
      ],
      "addresses": [
        {
          "text": "123 Broadway ave, Suite 12, Philadelphia, PA, 19020",
          "use": "WORK",
          "lines": [
            "123 Broadway ave",
            "Suite 12"
          ],
          "city": "Philadelphia",
          "state": "PA",
          "country": "USA",
          "postalCode": "19020"
        }
      ],
      "qualifications": [
        {
          "identifier": "ID0001",
          "text": "Doctor Of Medicine",
          "type": {
            "code": "Degree",
            "system": "Cerner",
            "display": "Degree"
          },
          "code": {
            "codings": [
              {
                "code": "MD",
                "system": "http://hl7.org/fhir/v2/0360/2.7",
                "display": "Doctor Of Medicine"
              }
            ],
            "text": "MD"
          },
          "period": {
            "start": "1991"
          },
          "issuer": {
            "name": "University Of Pennsylvania"
          }
        },
        {
          "identifier": "ID002",
          "text": "Vascular Surgery",
          "type": {
            "code": "CERTIFICATION",
            "system": "Cerner",
            "display": "Certification"
          },
          "code": {
            "codings": [
              {
                "code": "VASSURG",
                "system": "Cerner",
                "display": "Board Certification in Vascular Surgery"
              }
            ],
            "text": "Board Certification in Vascular Surgery"
          },
          "period": {
            "start": "1991-04",
            "end": "1993"
          },
          "reverificationDate": "1993",
          "issuer": {
            "name": "The American Board of Surgery"
          }
        }
      ],
      "aliases": [
        {
          "system": "DEA_SYSTEM",
          "type": "DEA",
          "value": "232334343"
        },
        {
          "system": "USER_SYSTEM",
          "type": "USER",
          "value": "342232"
        }
      ],
      "status": "ACTIVE",
      "link": {
        "target": {
          "id": "ecea26a9-8869-491d-8876-7cad7188c8ee",
          "display": "Dr. Firstname Lastname M.D."
        }
      },
      "specialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77",
          "isPrimary": true
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        },
        {
          "id": "39c5b7a0451141f4a4fe09f8e1da6342",
          "name": "Doctor"
        }
      ],
      "sourceIdentifiers": [
        {
          "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
          "id": "5a55a533523d"
        }
      ],
      "createdBy": {
        "id": "11e8a5750246534cbae93fe1756e44cf"
      },
      "updatedBy": {
        "id": "11e8a5750246534cbae93fe1756e44cf"
      },
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "11e941e94b5d459da3a5192e48ec744c",
      "link": {
        "target": {
          "id": "1a344284-09e3-11e8-9dc2-587234aecbf0",
          "display": "Carlos F Smith, D.P.M."
        }
      },
      "specialties": [
        {
          "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
          "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77",
          "isPrimary": true
        }
      ],
      "roles": [
        {
          "id": "11e8a5750246534cbae93fe1756e44cf",
          "name": "Surgeon"
        }
      ],
      "sourceIdentifiers": [
        {
          "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
          "id": "5a55a533523d"
        }
      ],
      "createdBy": {
        "id": "11e8a5750246534cbae93fe1756e44cf"
      },
      "updatedBy": {
        "id": "11e8a5750246534cbae93fe1756e44cf"
      },
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v2/provider-personnel/search?offset=20&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v2/provider-personnel/search?offset=0&limit=20"
}

GET /provider/v2/provider-personnel

Retrieves a list of provider personnel.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ids	query	array[string]	false	N/A	The provider personnel member ID or IDs to filter by.	-
status	query	string	false	N/A	The status of the provider personnel record.	-
aliasSystem	query	string	false	N/A	The system or authority responsible for assigning the provider alias. If aliasSystem is specified, aliasValue is required.	-
aliasValue	query	string	false	N/A	The value or ID of the provider personnel in the context of the aliasSystem. If aliasValue is specified, aliasSystem is required.	-
name	query	string	false	N/A	The name or partial name of the provider personnel.	-
linkTargetId	query	string	false	N/A	The ID of the linked personnel member who is a provider.	-
primarySpecialtyId	query	string	false	N/A	The ID of a primary specialty of the provider personnel.	-
primarySpecialtyTaxonomyId	query	string	false	N/A	The taxonomy ID of a primary specialty of the provider personnel.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	-updatedAt	A comma-separated list of fields by which to sort.	updatedAt, -updatedAt, createdAt, -createdAt, name, -name, status, -status

Response Statuses

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

Create a Provider Personnel




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel', headers: headers, body: {"name":{"text":"Dr. Firstname Lastname M.D.","family":"Lastname","given":["Firstname"],"prefix":["Dr"],"suffix":["MD"]},"gender":{"code":"male","system":"http://hl7.org/fhir/administrative-gender","display":"Male"},"birthDate":"1978-09-07","communications":[{"code":{"codings":[{"code":"eng","system":"ISO 639-2","display":"English (United States)"}],"text":"English"}},{"code":{"codings":[{"code":"zho","system":"ISO 639-2","display":"Chinese (China)"}],"text":"Chinese"}}],"photo":{"contentType":"IMAGE/JPG","url":"../images/123.jpg","title":"Image-Name"},"telecoms":[{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"},{"system":"PHONE","value":"123-456-7890","use":"WORK","rank":"1"}],"addresses":[{"text":"123 Broadway ave, 23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"qualifications":[{"identifier":"ID0001","text":"Doctor Of Medicine","type":{"code":"Degree","system":"Cerner","display":"Degree"},"code":{"codings":[{"code":"MD","system":"http://hl7.org/fhir/v2/0360/2.7","display":"Doctor Of Medicine"}],"text":"MD"},"period":{"start":"1991"},"issuer":{"name":"University Of Pennsylvania"}},{"identifier":"ID002","text":"Vascular Surgery","type":{"code":"CERTIFICATION","system":"Cerner","display":"Certification"},"code":{"codings":[{"code":"VASSURG","system":"Cerner","display":"Board Certification in Vascular Surgery"}],"text":"Board Certification in Vascular Surgery"},"period":{"start":"1991-04","end":"1993"},"reverificationDate":"1993","issuer":{"name":"The American Board of Surgery"}}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"SPI","value":"1669405973"},{"system":"DEA_SYSTEM","type":"DEA","value":"232334343"},{"system":"USER_SYSTEM","type":"USER","value":"342232"}],"status":"ACTIVE","link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77","isPrimary":true}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":{"text":"Dr. Firstname Lastname M.D.","family":"Lastname","given":["Firstname"],"prefix":["Dr"],"suffix":["MD"]},"gender":{"code":"male","system":"http://hl7.org/fhir/administrative-gender","display":"Male"},"birthDate":"1978-09-07","communications":[{"code":{"codings":[{"code":"eng","system":"ISO 639-2","display":"English (United States)"}],"text":"English"}},{"code":{"codings":[{"code":"zho","system":"ISO 639-2","display":"Chinese (China)"}],"text":"Chinese"}}],"photo":{"contentType":"IMAGE/JPG","url":"../images/123.jpg","title":"Image-Name"},"telecoms":[{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"},{"system":"PHONE","value":"123-456-7890","use":"WORK","rank":"1"}],"addresses":[{"text":"123 Broadway ave, 23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"qualifications":[{"identifier":"ID0001","text":"Doctor Of Medicine","type":{"code":"Degree","system":"Cerner","display":"Degree"},"code":{"codings":[{"code":"MD","system":"http://hl7.org/fhir/v2/0360/2.7","display":"Doctor Of Medicine"}],"text":"MD"},"period":{"start":"1991"},"issuer":{"name":"University Of Pennsylvania"}},{"identifier":"ID002","text":"Vascular Surgery","type":{"code":"CERTIFICATION","system":"Cerner","display":"Certification"},"code":{"codings":[{"code":"VASSURG","system":"Cerner","display":"Board Certification in Vascular Surgery"}],"text":"Board Certification in Vascular Surgery"},"period":{"start":"1991-04","end":"1993"},"reverificationDate":"1993","issuer":{"name":"The American Board of Surgery"}}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"SPI","value":"1669405973"},{"system":"DEA_SYSTEM","type":"DEA","value":"232334343"},{"system":"USER_SYSTEM","type":"USER","value":"342232"}],"status":"ACTIVE","link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77","isPrimary":true}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

{
  "id": "11e91f884c18d5d4805aeb96e2647bb8",
  "name": {
    "text": "Dr. Firstname Lastname M.D.",
    "family": "Lastname",
    "given": [
      "Firstname"
    ],
    "prefix": [
      "Dr"
    ],
    "suffix": [
      "MD"
    ]
  },
  "gender": {
    "code": "male",
    "system": "http://hl7.org/fhir/administrative-gender",
    "display": "Male"
  },
  "birthDate": "1978-09-08",
  "communications": [
    {
      "code": {
        "codings": [
          {
            "code": "eng",
            "system": "ISO 639-2",
            "display": "English (United States)"
          }
        ],
        "text": "English"
      }
    },
    {
      "code": {
        "codings": [
          {
            "code": "zho",
            "system": "ISO 639-2",
            "display": "Chinese (China)"
          }
        ],
        "text": "Chinese"
      }
    }
  ],
  "photo": {
    "contentType": "IMAGE/JPG",
    "url": "../images/123.jpg",
    "title": "Image-Name"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "Name@organization.com",
      "use": "WORK",
      "rank": "2"
    },
    {
      "system": "PHONE",
      "value": "123-456-7890",
      "use": "WORK",
      "rank": "1"
    }
  ],
  "addresses": [
    {
      "text": "123 Broadway ave, Suite 12, Philadelphia, PA, 19020",
      "use": "WORK",
      "lines": [
        "123 Broadway ave",
        "Suite 12"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "USA",
      "postalCode": "19020"
    }
  ],
  "qualifications": [
    {
      "identifier": "ID0001",
      "text": "Doctor Of Medicine",
      "type": {
        "code": "Degree",
        "system": "Cerner",
        "display": "Degree"
      },
      "code": {
        "codings": [
          {
            "code": "MD",
            "system": "http://hl7.org/fhir/v2/0360/2.7",
            "display": "Doctor Of Medicine"
          }
        ],
        "text": "MD"
      },
      "period": {
        "start": "1991"
      },
      "issuer": {
        "name": "University Of Pennsylvania"
      }
    },
    {
      "identifier": "ID002",
      "text": "Vascular Surgery",
      "type": {
        "code": "CERTIFICATION",
        "system": "Cerner",
        "display": "Certification"
      },
      "code": {
        "codings": [
          {
            "code": "VASSURG",
            "system": "Cerner",
            "display": "Board Certification in Vascular Surgery"
          }
        ],
        "text": "Board Certification in Vascular Surgery"
      },
      "period": {
        "start": "1991-04",
        "end": "1993"
      },
      "reverificationDate": "1993",
      "issuer": {
        "name": "The American Board of Surgery"
      }
    }
  ],
  "aliases": [
    {
      "system": "2.16.840.1.113883.4.6",
      "type": "SPI",
      "value": "1669405973"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "ecea26a9-8869-491d-8876-7cad7188c8ee",
      "display": "Carlos E Smith, D.P.M."
    }
  },
  "specialties": [
    {
      "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
      "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77",
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon"
    },
    {
      "id": "39c5b7a0451141f4a4fe09f8e1da6342",
      "name": "Doctor"
    }
  ],
  "createdBy": {
    "id": "11e8a5750246534cbae93fe1756e44cf"
  },
  "updatedBy": {
    "id": "11e8a5750246534cbae93fe1756e44cf"
  },
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

POST /provider/v2/provider-personnel

Creates a provider personnel.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	A personnel object	ProviderPublicApi_Entities_V2_Providers_ProviderPersonnel
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
409	Conflict	Conflict	Error

Response Headers

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

Delete a Provider Personnel


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-personnel/{providerPersonnelId}

Deletes a provider personnel.

Parameters

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

Response Statuses

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

Update a Provider Personnel




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8', headers: headers, body: {"name":{"text":"Dr. Firstname Lastname M.D.","family":"Lastname","given":["Firstname"],"prefix":["Dr"],"suffix":["MD"]},"gender":{"code":"male","system":"http://hl7.org/fhir/administrative-gender","display":"Male"},"birthDate":"1978-09-07","communications":[{"code":{"codings":[{"code":"eng","system":"ISO 639-2","display":"English (United States)"}],"text":"English"}},{"code":{"codings":[{"code":"zho","system":"ISO 639-2","display":"Chinese (China)"}],"text":"Chinese"}}],"photo":{"contentType":"IMAGE/JPG","url":"../images/123.jpg","title":"Image-Name"},"telecoms":[{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"},{"system":"PHONE","value":"123-456-7890","use":"WORK","rank":"1"}],"addresses":[{"text":"123 Broadway ave, 23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"qualifications":[{"identifier":"ID0001","text":"Doctor Of Medicine","type":{"code":"Degree","system":"Cerner","display":"Degree"},"code":{"codings":[{"code":"MD","system":"http://hl7.org/fhir/v2/0360/2.7","display":"Doctor Of Medicine"}],"text":"MD"},"period":{"start":"1991"},"issuer":{"name":"University Of Pennsylvania"}},{"identifier":"ID002","text":"Vascular Surgery","type":{"code":"CERTIFICATION","system":"Cerner","display":"Certification"},"code":{"codings":[{"code":"VASSURG","system":"Cerner","display":"Board Certification in Vascular Surgery"}],"text":"Board Certification in Vascular Surgery"},"period":{"start":"1991-04","end":"1993"},"reverificationDate":"1993","issuer":{"name":"The American Board of Surgery"}}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"SPI","value":"1669405973"},{"system":"DEA_SYSTEM","type":"DEA","value":"232334343"},{"system":"USER_SYSTEM","type":"USER","value":"342232"}],"status":"ACTIVE","link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77","isPrimary":true}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel/11e91f884c18d5d4805aeb96e2647bb8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":{"text":"Dr. Firstname Lastname M.D.","family":"Lastname","given":["Firstname"],"prefix":["Dr"],"suffix":["MD"]},"gender":{"code":"male","system":"http://hl7.org/fhir/administrative-gender","display":"Male"},"birthDate":"1978-09-07","communications":[{"code":{"codings":[{"code":"eng","system":"ISO 639-2","display":"English (United States)"}],"text":"English"}},{"code":{"codings":[{"code":"zho","system":"ISO 639-2","display":"Chinese (China)"}],"text":"Chinese"}}],"photo":{"contentType":"IMAGE/JPG","url":"../images/123.jpg","title":"Image-Name"},"telecoms":[{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"},{"system":"PHONE","value":"123-456-7890","use":"WORK","rank":"1"}],"addresses":[{"text":"123 Broadway ave, 23 Street, Philadelphia, PA, 19020","use":"WORK","lines":["123 Broadway ave","23 Street"],"city":"Philadelphia","state":"PA","country":"USA","postalCode":"19020"}],"qualifications":[{"identifier":"ID0001","text":"Doctor Of Medicine","type":{"code":"Degree","system":"Cerner","display":"Degree"},"code":{"codings":[{"code":"MD","system":"http://hl7.org/fhir/v2/0360/2.7","display":"Doctor Of Medicine"}],"text":"MD"},"period":{"start":"1991"},"issuer":{"name":"University Of Pennsylvania"}},{"identifier":"ID002","text":"Vascular Surgery","type":{"code":"CERTIFICATION","system":"Cerner","display":"Certification"},"code":{"codings":[{"code":"VASSURG","system":"Cerner","display":"Board Certification in Vascular Surgery"}],"text":"Board Certification in Vascular Surgery"},"period":{"start":"1991-04","end":"1993"},"reverificationDate":"1993","issuer":{"name":"The American Board of Surgery"}}],"aliases":[{"system":"2.16.840.1.113883.4.6","type":"SPI","value":"1669405973"},{"system":"DEA_SYSTEM","type":"DEA","value":"232334343"},{"system":"USER_SYSTEM","type":"USER","value":"342232"}],"status":"ACTIVE","link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"specialties":[{"specialtyId":"9ed82acf21c11e7a3d646705f8c9e77","taxonomyId":"533cfba4dead11e7a3d646705f8c9e77","isPrimary":true}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

{
  "id": "11e91f884c18d5d4805aeb96e2647bb8",
  "name": {
    "text": "Dr. Firstname Lastname M.D.",
    "family": "Lastname",
    "given": [
      "Firstname"
    ],
    "prefix": [
      "Dr"
    ],
    "suffix": [
      "MD"
    ]
  },
  "gender": {
    "code": "male",
    "system": "http://hl7.org/fhir/administrative-gender",
    "display": "Male"
  },
  "birthDate": "1978-09-08",
  "communications": [
    {
      "code": {
        "codings": [
          {
            "code": "eng",
            "system": "ISO 639-2",
            "display": "English (United States)"
          }
        ],
        "text": "English"
      }
    },
    {
      "code": {
        "codings": [
          {
            "code": "zho",
            "system": "ISO 639-2",
            "display": "Chinese (China)"
          }
        ],
        "text": "Chinese"
      }
    }
  ],
  "photo": {
    "contentType": "IMAGE/JPG",
    "url": "../images/123.jpg",
    "title": "Image-Name"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "Name@organization.com",
      "use": "WORK",
      "rank": "2"
    },
    {
      "system": "PHONE",
      "value": "123-456-7890",
      "use": "WORK",
      "rank": "1"
    }
  ],
  "addresses": [
    {
      "text": "123 Broadway ave, Suite 12, Philadelphia, PA, 19020",
      "use": "WORK",
      "lines": [
        "123 Broadway ave",
        "Suite 12"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "country": "USA",
      "postalCode": "19020"
    }
  ],
  "qualifications": [
    {
      "identifier": "ID0001",
      "text": "Doctor Of Medicine",
      "type": {
        "code": "Degree",
        "system": "Cerner",
        "display": "Degree"
      },
      "code": {
        "codings": [
          {
            "code": "MD",
            "system": "http://hl7.org/fhir/v2/0360/2.7",
            "display": "Doctor Of Medicine"
          }
        ],
        "text": "MD"
      },
      "period": {
        "start": "1991"
      },
      "issuer": {
        "name": "University Of Pennsylvania"
      }
    },
    {
      "identifier": "ID002",
      "text": "Vascular Surgery",
      "type": {
        "code": "CERTIFICATION",
        "system": "Cerner",
        "display": "Certification"
      },
      "code": {
        "codings": [
          {
            "code": "VASSURG",
            "system": "Cerner",
            "display": "Board Certification in Vascular Surgery"
          }
        ],
        "text": "Board Certification in Vascular Surgery"
      },
      "period": {
        "start": "1991-04",
        "end": "1993"
      },
      "reverificationDate": "1993",
      "issuer": {
        "name": "The American Board of Surgery"
      }
    }
  ],
  "aliases": [
    {
      "system": "2.16.840.1.113883.4.6",
      "type": "SPI",
      "value": "1669405973"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "ecea26a9-8869-491d-8876-7cad7188c8ee",
      "display": "Carlos E Smith, D.P.M."
    }
  },
  "specialties": [
    {
      "specialtyId": "9ed82acf21c11e7a3d646705f8c9e77",
      "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77",
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Surgeon"
    },
    {
      "id": "39c5b7a0451141f4a4fe09f8e1da6342",
      "name": "Doctor"
    }
  ],
  "createdBy": {
    "id": "11e8a5750246534cbae93fe1756e44cf"
  },
  "updatedBy": {
    "id": "11e8a5750246534cbae93fe1756e44cf"
  },
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdAt": "2018-04-21T16:14:53Z"
}

PUT /provider/v2/provider-personnel/{providerPersonnelId}

Updates a provider personnel.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	A personnel object	ProviderPublicApi_Entities_V2_Providers_ProviderPersonnel
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a Single Provider Personnel


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "11e91f884c18d5d4805aeb96e2647bb8",
  "name": {
    "text": "Dr. Rick Tague M.D.",
    "family": "Tague",
    "given": [
      "Rick"
    ],
    "prefix": [
      "Dr"
    ],
    "suffix": [
      "MD"
    ]
  },
  "gender": {
    "code": "male",
    "system": "http://hl7.org/fhir/administrative-gender",
    "display": "Male"
  },
  "birthDate": "1978-09-30",
  "communications": [
    {
      "code": {
        "codings": [
          {
            "code": "eng",
            "system": "ISO 639-2",
            "display": "English (United States)"
          }
        ],
        "text": "English"
      }
    },
    {
      "code": {
        "codings": [
          {
            "code": "zho",
            "system": "ISO 639-2",
            "display": "Chinese (China)"
          }
        ],
        "text": "Chinese"
      }
    }
  ],
  "photo": {
    "contentType": "IMAGE/JPG",
    "url": "../images/123.jpg",
    "title": "Image-Name"
  },
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "jane.smith@example.com",
      "use": "WORK",
      "rank": "1"
    }
  ],
  "addresses": [
    {
      "use": "HOME",
      "text": "123 Main Street, City, ST 12345",
      "lines": [
        "10236 Marion Park Dr"
      ],
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "64137",
      "country": "USA"
    }
  ],
  "qualifications": [
    {
      "identifier": "ID0001",
      "text": "Doctor Of Medicine",
      "type": {
        "code": "Degree",
        "system": "Cerner",
        "display": "Degree"
      },
      "code": {
        "codings": [
          {
            "code": "MD",
            "system": "http://hl7.org/fhir/v2/0360/2.7",
            "display": "Doctor Of Medicine"
          }
        ],
        "text": "MD"
      },
      "period": {
        "start": "1991"
      },
      "issuer": {
        "name": "University Of Pennsylvania"
      }
    },
    {
      "identifier": "ID002",
      "text": "Vascular Surgery",
      "type": {
        "code": "CERTIFICATION",
        "system": "Cerner",
        "display": "Certification"
      },
      "code": {
        "codings": [
          {
            "code": "VASSURG",
            "system": "Cerner",
            "display": "Board Certification in Vascular Surgery"
          }
        ],
        "text": "Board Certification in Vascular Surgery"
      },
      "period": {
        "start": "1991-04",
        "end": "1993"
      },
      "reverificationDate": "1993",
      "issuer": {
        "name": "The American Board of Surgery"
      }
    }
  ],
  "aliases": [
    {
      "system": "DEA_SYSTEM",
      "type": "DEA",
      "value": "232334343"
    },
    {
      "system": "USER_SYSTEM",
      "type": "USER",
      "value": "342232"
    }
  ],
  "status": "ACTIVE",
  "link": {
    "target": {
      "id": "ecea26a9-8869-491d-8876-7cad7188c8ee",
      "display": "Dr. Firstname Lastname M.D."
    }
  },
  "specialties": [
    {
      "specialtyId": "11e8a5750246534cbae93fe1756e44cf",
      "taxonomyId": "533cfba4dead11e7a3d646705f8c9e77",
      "isPrimary": true
    }
  ],
  "roles": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "kind": "PERSONNEL"
    }
  ],
  "sourceIdentifiers": [
    {
      "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
      "id": "12345"
    }
  ],
  "createdBy": {
    "id": "49d0677b-28e6-4648-9159-1e114eb7b829"
  },
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedBy": {
    "id": "49d0677b-28e6-4648-9159-1e114eb7b829"
  },
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

GET /provider/v2/provider-personnel/{providerPersonnelId}

Retrieves a single provider personnel.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A provider personnel object	ProviderPublicApi_Entities_V2_Providers_ProviderPersonnel
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 Role is a job that a practitioner may perform in the combination of locations/specialties/networks/services at an organization for a period of time.

Retrieve a List of Provider Personnel Roles


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

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

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

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "11e8a5750246534cbae93fe1756e44cf",
      "name": "Internist at NorthEast Healthcare",
      "period": {
        "start": "2020-01-01T19:45:00.000Z",
        "end": "2020-06-01T20:55:00.000Z"
      },
      "providerPersonnel": {
        "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
        "name": "Dr Firstname Lastname M.D.",
        "link": {
          "target": {
            "id": "0ee84b32-b720-4a8f-89fc-8c1fe4940f4c",
            "display": "Firstname Lastname"
          }
        }
      },
      "codes": [
        {
          "codings": [
            {
              "code": "66862007",
              "system": "http://snomed.info/sct",
              "display": "Radiologist"
            }
          ],
          "text": "Radiologist"
        }
      ],
      "assignedBy": {
        "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
        "name": "Associates For Women's Healthcare",
        "link": {
          "target": {
            "id": "49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8",
            "display": "Associates For Women's Healthcare"
          }
        }
      },
      "providedAt": [
        {
          "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
          "name": "Main Street Health Associates",
          "telecoms": [
            {
              "system": "DIRECT",
              "value": "Name@direct.organization.com",
              "use": "WORK",
              "rank": "1"
            },
            {
              "system": "EMAIL",
              "value": "Name@organization.com",
              "use": "WORK",
              "rank": "2"
            }
          ],
          "link": {
            "target": {
              "id": "e5b4e473-fd29-4ca1-90c0-b8dd112629f3",
              "display": "Main Street Health Associates"
            }
          }
        }
      ],
      "networks": [
        {
          "id": "cc46c4c2deac11e7a3d646705f8c9e77",
          "name": "HMO GOLD"
        },
        {
          "id": "3002ad1133ce467f9acf8c347b4f0eeb",
          "name": "National HMO"
        }
      ],
      "healthcareServices": [
        {
          "id": "11e87375edcdded880535db964285cae",
          "name": "rheumatoid arthritis consultation"
        },
        {
          "id": "f9ed82acf21c11e7a3d646705f8c9e77",
          "name": "osteoarthritis consultation"
        }
      ],
      "specialties": [
        {
          "id": "9ed82acf21c11e7a3d646705f8c9e52",
          "name": "Internal Medicine Rheumatology",
          "taxonomy": {
            "id": "9ed82acf21c11e7a3d646705f8c9e53",
            "name": "NUCC Taxonomy V20.3"
          },
          "isPrimary": true
        }
      ],
      "aliases": [
        {
          "system": "personnel-profile-id",
          "value": "512cfba4dead11e7a3d646705f8c9e77"
        }
      ],
      "tags": [
        {
          "key": "INCLUDE_IN_REPORT",
          "value": true
        }
      ],
      "sourceIdentifier": {
        "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
        "id": "43221"
      },
      "status": "ACTIVE",
      "isManual": true,
      "paymentTaxId": "18364201AC",
      "acceptingPatients": true,
      "pcpStatuses": [
        {
          "pcpIndicator": true,
          "effectiveDate": "2018-01-01",
          "endDate": "2019-06-01"
        }
      ],
      "proxyPersonnel": [
        {
          "id": "cd47a537-a762-42b7-b616-736379a79fb8",
          "name": "Dr Firstname Lastname M.D.",
          "link": {
            "target": {
              "id": "9f9edf2c-a563-470f-9a03-11de3ee30ea7",
              "display": "Firstname Lastname"
            }
          }
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "updatedBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      },
      "createdAt": "2018-03-02T20:39:35Z",
      "createdBy": {
        "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/provider/v2/provider-personnel-roles/search?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/provider/v2/provider-personnel-roles/search?offset=0&limit=20"
}

GET /provider/v2/provider-personnel-roles

Retrieves a list of provider personnel roles.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	query	array[string]	false	N/A	The provider personnel role ID or IDs to filter by.	-
name	query	string	false	N/A	The partial or full name of a provider personnel.	-
assignedBy	query	string	false	N/A	The ID of the assigning organization.	-
linkAssignedBy	query	string	false	N/A	The linked assigning organization ID from Personnel Ministry. Personnel Ministry is a management system for personnel entities, personnel groups, and organizations.	-
providerPersonnelId	query	string	false	N/A	The ID of a provider personnel.	-
linkPersonnelId	query	string	false	N/A	The ID of the linked personnel from Personnel Ministry. Personnel Ministry is a management system for personnel entities, personnel groups, and organizations.	-
providedAt	query	string	false	N/A	The provider location ID to filter by.	-
linkProvidedAt	query	string	false	N/A	Filters by the linked provider location from Personnel Ministry. Personnel Ministry is a management system for personnel entities, personnel groups, and organizations.	-
networkId	query	string	false	N/A	The ID of a provider network.	-
specialtyId	query	string	false	N/A	The ID of a specialty. When a specialty ID is provided, a taxonomy ID must also be provided.	-
taxonomyId	query	string	false	N/A	The ID of a taxonomy. If a specialty ID is also provided, the service filters by the specialty IDs linked to this taxonomy ID.	-
isPrimarySpecialty	query	boolean	false	N/A	Indicates whether a personnel role is a primary specialty.	-
aliasSystem	query	string	false	N/A	The system or authority responsible for assigning the provider alias. If `aliasSystem` is provided, `aliasValue` is required.	-
aliasValue	query	string	false	N/A	The value or ID of the provider personnel role in the context of the `aliasSystem`. If `aliasValue` is provided, `aliasSystem` is required.	-
acceptingPatients	query	boolean	false	N/A	Indicates whether patients are currently accepted.	-
proxyPersonnelId	query	string	false	N/A	The personnel ID of the user who is serving as a proxy for a specific personnel from Personnel Ministry. Personnel Ministry is a management system for personnel entities, personnel groups, and organizations.	-
linkProxyPersonnelId	query	string	false	N/A	The link personnel role ID proxy.	-
pcpIndicator	query	boolean	false	N/A	The PCP indicator.	-
pcpEffectiveDate	query	string	false	N/A	The date when the PCP is effective. When this is provided, `pcpIndicator` must also be provided.	-
effectiveDate	query	string	false	N/A	The range of dates for which a personnel role is in effect.	-
status	query	string	false	N/A	Indicates whether the provider personnel role is active.	ACTIVE, INACTIVE
tag	query	array[string]	false	N/A	The colon-delimited combination of the key and value of a tag, for example, Use:Production.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	-updatedAt	A comma-separated list of fields by which to sort.	name, -name, updatedAt, -updatedAt

Response Statuses

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

Create a Provider Personnel Role




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel-roles', headers: headers, body: {"name":"Internist at NorthEast Healthcare","period":{"start":"2020-01-01T19:45:00.000Z","end":"2020-06-01T20:55:00.000Z"},"providerPersonnel":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"0ee84b32-b720-4a8f-89fc-8c1fe4940f4c","display":"Firstname Lastname"}}},"codes":{"codings":[{"code":"66862007","system":"http://snomed.info/sct","display":"Radiologist"}],"text":"Radiologist"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0","name":"Associates For Women's Healthcare","link":{"target":{"id":"49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8","display":"Associates For Women's Healthcare"}}},"providedAt":[{"id":"77ce9776-09db-11e8-9dc2-587234aecbf0","name":"Main Street Health Associates","telecoms":[{"system":"DIRECT","value":"Name@direct.organization.com","use":"WORK","rank":"1"},{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"}],"link":{"target":{"id":"e5b4e473-fd29-4ca1-90c0-b8dd112629f3","display":"Main Street Health Associates"}}}],"link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis consultation"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e52","name":"Internal Medicine Rheumatology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e53","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"tags":[{"key":"INCLUDE_IN_REPORT","value":true}],"status":"ACTIVE","paymentTaxId":"957142094","acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2018-01-01","endDate":"2019-06-01"}],"proxyPersonnel":[{"id":"cd47a537-a762-42b7-b616-736379a79fb8","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"9f9edf2c-a563-470f-9a03-11de3ee30ea7","display":"Firstname Lastname"}}}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Internist at NorthEast Healthcare","period":{"start":"2020-01-01T19:45:00.000Z","end":"2020-06-01T20:55:00.000Z"},"providerPersonnel":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"0ee84b32-b720-4a8f-89fc-8c1fe4940f4c","display":"Firstname Lastname"}}},"codes":{"codings":[{"code":"66862007","system":"http://snomed.info/sct","display":"Radiologist"}],"text":"Radiologist"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0","name":"Associates For Women's Healthcare","link":{"target":{"id":"49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8","display":"Associates For Women's Healthcare"}}},"providedAt":[{"id":"77ce9776-09db-11e8-9dc2-587234aecbf0","name":"Main Street Health Associates","telecoms":[{"system":"DIRECT","value":"Name@direct.organization.com","use":"WORK","rank":"1"},{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"}],"link":{"target":{"id":"e5b4e473-fd29-4ca1-90c0-b8dd112629f3","display":"Main Street Health Associates"}}}],"link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis consultation"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e52","name":"Internal Medicine Rheumatology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e53","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"tags":[{"key":"INCLUDE_IN_REPORT","value":true}],"status":"ACTIVE","paymentTaxId":"957142094","acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2018-01-01","endDate":"2019-06-01"}],"proxyPersonnel":[{"id":"cd47a537-a762-42b7-b616-736379a79fb8","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"9f9edf2c-a563-470f-9a03-11de3ee30ea7","display":"Firstname Lastname"}}}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

{
  "id": "11e8a5750246534cbae93fe1756e44cf",
  "name": "Internist at NorthEast Healthcare",
  "period": {
    "start": "2020-01-01T19:45:00.000Z",
    "end": "2020-06-01T20:55:00.000Z"
  },
  "providerPersonnel": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Dr Firstname Lastname M.D.",
    "link": {
      "target": {
        "id": "0ee84b32-b720-4a8f-89fc-8c1fe4940f4c",
        "display": "Firstname Lastname"
      }
    }
  },
  "codes": [
    {
      "codings": [
        {
          "code": "66862007",
          "system": "http://snomed.info/sct",
          "display": "Radiologist"
        }
      ],
      "text": "Radiologist"
    }
  ],
  "assignedBy": {
    "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
    "name": "Associates For Women's Healthcare",
    "link": {
      "target": {
        "id": "49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8",
        "display": "Associates For Women's Healthcare"
      }
    }
  },
  "providedAt": [
    {
      "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
      "name": "Main Street Health Associates",
      "telecoms": [
        {
          "system": "DIRECT",
          "value": "Name@direct.organization.com",
          "use": "WORK",
          "rank": "1"
        },
        {
          "system": "EMAIL",
          "value": "Name@organization.com",
          "use": "WORK",
          "rank": "2"
        }
      ],
      "link": {
        "target": {
          "id": "e5b4e473-fd29-4ca1-90c0-b8dd112629f3",
          "display": "Main Street Health Associates"
        }
      }
    }
  ],
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO GOLD"
    },
    {
      "id": "3002ad1133ce467f9acf8c347b4f0eeb",
      "name": "National HMO"
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis consultation"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e52",
      "name": "Internal Medicine Rheumatology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e53",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "aliases": [
    {
      "system": "personnel-profile-id",
      "value": "512cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "tags": [
    {
      "key": "INCLUDE_IN_REPORT",
      "value": true
    }
  ],
  "sourceIdentifier": {
    "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
    "id": "43221"
  },
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "pcpStatuses": [
    {
      "pcpIndicator": true,
      "effectiveDate": "2018-01-01",
      "endDate": "2019-06-01"
    }
  ],
  "proxyPersonnel": [
    {
      "id": "cd47a537-a762-42b7-b616-736379a79fb8",
      "name": "Dr Firstname Lastname M.D.",
      "link": {
        "target": {
          "id": "9f9edf2c-a563-470f-9a03-11de3ee30ea7",
          "display": "Firstname Lastname"
        }
      }
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

POST /provider/v2/provider-personnel-roles

Creates a provider personnel role.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	A personnel object	ProviderPublicApi_Entities_V2_Providers_PersonnelRole
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Response Headers

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

Delete a Provider Personnel Role


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

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

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

print JSON.pretty_generate(result)


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

DELETE /provider/v2/provider-personnel-roles/{personnelRoleId}

Deletes a provider personnel role.

Parameters

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

Response Statuses

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

Update a Provider Personnel Role




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel-roles/11e91f884c18d5d4805aeb96e2647bb8', headers: headers, body: {"name":"Internist at NorthEast Healthcare","period":{"start":"2020-01-01T19:45:00.000Z","end":"2020-06-01T20:55:00.000Z"},"providerPersonnel":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"0ee84b32-b720-4a8f-89fc-8c1fe4940f4c","display":"Firstname Lastname"}}},"codes":{"codings":[{"code":"66862007","system":"http://snomed.info/sct","display":"Radiologist"}],"text":"Radiologist"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0","name":"Associates For Women's Healthcare","link":{"target":{"id":"49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8","display":"Associates For Women's Healthcare"}}},"providedAt":[{"id":"77ce9776-09db-11e8-9dc2-587234aecbf0","name":"Main Street Health Associates","telecoms":[{"system":"DIRECT","value":"Name@direct.organization.com","use":"WORK","rank":"1"},{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"}],"link":{"target":{"id":"e5b4e473-fd29-4ca1-90c0-b8dd112629f3","display":"Main Street Health Associates"}}}],"link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis consultation"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e52","name":"Internal Medicine Rheumatology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e53","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"tags":[{"key":"INCLUDE_IN_REPORT","value":true}],"status":"ACTIVE","paymentTaxId":"957142094","acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2018-01-01","endDate":"2019-06-01"}],"proxyPersonnel":[{"id":"cd47a537-a762-42b7-b616-736379a79fb8","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"9f9edf2c-a563-470f-9a03-11de3ee30ea7","display":"Firstname Lastname"}}}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/provider/v2/provider-personnel-roles/11e91f884c18d5d4805aeb96e2647bb8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Internist at NorthEast Healthcare","period":{"start":"2020-01-01T19:45:00.000Z","end":"2020-06-01T20:55:00.000Z"},"providerPersonnel":{"id":"a6bd37ee-09d2-11e8-9dc2-587234aecbf0","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"0ee84b32-b720-4a8f-89fc-8c1fe4940f4c","display":"Firstname Lastname"}}},"codes":{"codings":[{"code":"66862007","system":"http://snomed.info/sct","display":"Radiologist"}],"text":"Radiologist"},"assignedBy":{"id":"0ed4a350-09db-11e8-9dc2-587234aecbf0","name":"Associates For Women's Healthcare","link":{"target":{"id":"49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8","display":"Associates For Women's Healthcare"}}},"providedAt":[{"id":"77ce9776-09db-11e8-9dc2-587234aecbf0","name":"Main Street Health Associates","telecoms":[{"system":"DIRECT","value":"Name@direct.organization.com","use":"WORK","rank":"1"},{"system":"EMAIL","value":"Name@organization.com","use":"WORK","rank":"2"}],"link":{"target":{"id":"e5b4e473-fd29-4ca1-90c0-b8dd112629f3","display":"Main Street Health Associates"}}}],"link":{"target":{"id":"ecea26a9-8869-491d-8876-7cad7188c8ee"}},"healthcareServices":[{"id":"11e87375edcdded880535db964285cae","name":"rheumatoid arthritis consultation"},{"id":"f9ed82acf21c11e7a3d646705f8c9e77","name":"osteoarthritis consultation"}],"specialties":[{"id":"9ed82acf21c11e7a3d646705f8c9e52","name":"Internal Medicine Rheumatology","taxonomy":{"id":"9ed82acf21c11e7a3d646705f8c9e53","name":"NUCC Taxonomy V20.3"},"isPrimary":true}],"aliases":[{"system":"personnel-profile-id","value":"512cfba4dead11e7a3d646705f8c9e77"}],"tags":[{"key":"INCLUDE_IN_REPORT","value":true}],"status":"ACTIVE","paymentTaxId":"957142094","acceptingPatients":true,"pcpStatuses":[{"pcpIndicator":true,"effectiveDate":"2018-01-01","endDate":"2019-06-01"}],"proxyPersonnel":[{"id":"cd47a537-a762-42b7-b616-736379a79fb8","name":"Dr Firstname Lastname M.D.","link":{"target":{"id":"9f9edf2c-a563-470f-9a03-11de3ee30ea7","display":"Firstname Lastname"}}}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

{
  "id": "11e8a5750246534cbae93fe1756e44cf",
  "name": "Internist at NorthEast Healthcare",
  "period": {
    "start": "2020-01-01T19:45:00.000Z",
    "end": "2020-06-01T20:55:00.000Z"
  },
  "providerPersonnel": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Dr Firstname Lastname M.D.",
    "link": {
      "target": {
        "id": "0ee84b32-b720-4a8f-89fc-8c1fe4940f4c",
        "display": "Firstname Lastname"
      }
    }
  },
  "codes": [
    {
      "codings": [
        {
          "code": "66862007",
          "system": "http://snomed.info/sct",
          "display": "Radiologist"
        }
      ],
      "text": "Radiologist"
    }
  ],
  "assignedBy": {
    "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
    "name": "Associates For Women's Healthcare",
    "link": {
      "target": {
        "id": "49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8",
        "display": "Associates For Women's Healthcare"
      }
    }
  },
  "providedAt": [
    {
      "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
      "name": "Main Street Health Associates",
      "telecoms": [
        {
          "system": "DIRECT",
          "value": "Name@direct.organization.com",
          "use": "WORK",
          "rank": "1"
        },
        {
          "system": "EMAIL",
          "value": "Name@organization.com",
          "use": "WORK",
          "rank": "2"
        }
      ],
      "link": {
        "target": {
          "id": "e5b4e473-fd29-4ca1-90c0-b8dd112629f3",
          "display": "Main Street Health Associates"
        }
      }
    }
  ],
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO GOLD"
    },
    {
      "id": "3002ad1133ce467f9acf8c347b4f0eeb",
      "name": "National HMO"
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis consultation"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e52",
      "name": "Internal Medicine Rheumatology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e53",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "aliases": [
    {
      "system": "personnel-profile-id",
      "value": "512cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "tags": [
    {
      "key": "INCLUDE_IN_REPORT",
      "value": true
    }
  ],
  "sourceIdentifier": {
    "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
    "id": "43221"
  },
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "pcpStatuses": [
    {
      "pcpIndicator": true,
      "effectiveDate": "2018-01-01",
      "endDate": "2019-06-01"
    }
  ],
  "proxyPersonnel": [
    {
      "id": "cd47a537-a762-42b7-b616-736379a79fb8",
      "name": "Dr Firstname Lastname M.D.",
      "link": {
        "target": {
          "id": "9f9edf2c-a563-470f-9a03-11de3ee30ea7",
          "display": "Firstname Lastname"
        }
      }
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

PUT /provider/v2/provider-personnel-roles/{personnelRoleId}

Updates a provider personnel role.

Parameters

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

Response Statuses

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

Retrieve a Single Provider Personnel Role


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

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

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

print JSON.pretty_generate(result)


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

{
  "id": "11e8a5750246534cbae93fe1756e44cf",
  "name": "Internist at NorthEast Healthcare",
  "period": {
    "start": "2020-01-01T19:45:00.000Z",
    "end": "2020-06-01T20:55:00.000Z"
  },
  "providerPersonnel": {
    "id": "a6bd37ee-09d2-11e8-9dc2-587234aecbf0",
    "name": "Dr Firstname Lastname M.D.",
    "link": {
      "target": {
        "id": "0ee84b32-b720-4a8f-89fc-8c1fe4940f4c",
        "display": "Firstname Lastname"
      }
    }
  },
  "codes": [
    {
      "codings": [
        {
          "code": "66862007",
          "system": "http://snomed.info/sct",
          "display": "Radiologist"
        }
      ],
      "text": "Radiologist"
    }
  ],
  "assignedBy": {
    "id": "0ed4a350-09db-11e8-9dc2-587234aecbf0",
    "name": "Associates For Women's Healthcare",
    "link": {
      "target": {
        "id": "49d81cd8-8e14-4ea9-85c7-a2f73fb7f1d8",
        "display": "Associates For Women's Healthcare"
      }
    }
  },
  "providedAt": [
    {
      "id": "77ce9776-09db-11e8-9dc2-587234aecbf0",
      "name": "Main Street Health Associates",
      "telecoms": [
        {
          "system": "DIRECT",
          "value": "Name@direct.organization.com",
          "use": "WORK",
          "rank": "1"
        },
        {
          "system": "EMAIL",
          "value": "Name@organization.com",
          "use": "WORK",
          "rank": "2"
        }
      ],
      "link": {
        "target": {
          "id": "e5b4e473-fd29-4ca1-90c0-b8dd112629f3",
          "display": "Main Street Health Associates"
        }
      }
    }
  ],
  "networks": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "HMO GOLD"
    },
    {
      "id": "3002ad1133ce467f9acf8c347b4f0eeb",
      "name": "National HMO"
    }
  ],
  "healthcareServices": [
    {
      "id": "11e87375edcdded880535db964285cae",
      "name": "rheumatoid arthritis consultation"
    },
    {
      "id": "f9ed82acf21c11e7a3d646705f8c9e77",
      "name": "osteoarthritis consultation"
    }
  ],
  "specialties": [
    {
      "id": "9ed82acf21c11e7a3d646705f8c9e52",
      "name": "Internal Medicine Rheumatology",
      "taxonomy": {
        "id": "9ed82acf21c11e7a3d646705f8c9e53",
        "name": "NUCC Taxonomy V20.3"
      },
      "isPrimary": true
    }
  ],
  "aliases": [
    {
      "system": "personnel-profile-id",
      "value": "512cfba4dead11e7a3d646705f8c9e77"
    }
  ],
  "tags": [
    {
      "key": "INCLUDE_IN_REPORT",
      "value": true
    }
  ],
  "sourceIdentifier": {
    "dataPartitionId": "3edf856e-08ba-4da1-9550-5a55a533523d",
    "id": "43221"
  },
  "status": "ACTIVE",
  "isManual": true,
  "paymentTaxId": "18364201AC",
  "acceptingPatients": true,
  "pcpStatuses": [
    {
      "pcpIndicator": true,
      "effectiveDate": "2018-01-01",
      "endDate": "2019-06-01"
    }
  ],
  "proxyPersonnel": [
    {
      "id": "cd47a537-a762-42b7-b616-736379a79fb8",
      "name": "Dr Firstname Lastname M.D.",
      "link": {
        "target": {
          "id": "9f9edf2c-a563-470f-9a03-11de3ee30ea7",
          "display": "Firstname Lastname"
        }
      }
    }
  ],
  "updatedAt": "2018-03-02T20:39:35Z",
  "updatedBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  },
  "createdAt": "2018-03-02T20:39:35Z",
  "createdBy": {
    "id": "cae6b9b8-0688-4951-9c7d-79d2cfd2ec09"
  }
}

GET /provider/v2/provider-personnel-roles/{personnelRoleId}

Retrieves a single provider personnel role.

Parameters

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

Response Statuses

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

Schema Definitions

postProviderV2HealthcareServices

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

Error

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

ErrorDetail

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

HealthcareServices

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

ProviderPublicApi_Entities_Common_HealthcareServices_HealthcareService

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

ProviderPublicApi_Entities_Common_Organization

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

ProviderPublicApi_Entities_Common_HealthcareServices_HealthcareServiceLocation

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

ProviderPublicApi_Entities_Common_HealthcareServices_Specialty

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

ProviderPublicApi_Entities_Common_HealthcareServices_Reference

Name	Type	Required	Description	Accepted Values
id	string	true	No description	-

ProviderPublicApi_Entities_Common_HealthcareServices_Type

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

ProviderPublicApi_Entities_Common_HealthcareServices_Category

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

ProviderPublicApi_Entities_Common_HealthcareServices_Alias

Name	Type	Required	Description	Accepted Values
system	string	true	The system of the alias.	-
value	string	true	The value of the alias.	-

putProviderV2HealthcareServices

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

postProviderV2ServiceCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The category name of the health care service being performed or delivered.	-
description	string	false	The description of the service category.	-
status	string	true	The status of the service category.	ACTIVE, INACTIVE
parentId	string	false	The unique ID of the parent category.	-
aliases	[object]	false	No description	-
» system	string	true	The system of the alias.	-
» value	string	true	The value of the alias.	-

ServiceCategories

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

ProviderPublicApi_Entities_Common_HealthcareServices_ServiceCategory

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

putProviderV2ServiceCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The category name of the health care service being performed or delivered.	-
description	string	false	The description of the service category.	-
status	string	true	The status of the service category.	ACTIVE, INACTIVE
parentId	string	false	The unique ID of the parent category.	-
aliases	[object]	false	No description	-
» system	string	true	The system of the alias.	-
» value	string	true	The value of the alias.	-

postProviderV2ServiceTypes

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

ServiceTypes

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

ProviderPublicApi_Entities_Common_HealthcareServices_ServiceType

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

putProviderV2ServiceTypes

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

postProviderV2MedicalHomes

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the medical home.	-
representedBy	object	false	The organization associated with the medical home.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the medical home.	ACTIVE, INACTIVE
aliases	[object]	false	The list of medical home aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

MedicalHomeEntities

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

ProviderPublicApi_Entities_Common_Networks_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	ProviderPublicApi_Entities_Common_Organization	false	The organization associated with the medical home.	-
status	string	true	The status of the medical home.	ACTIVE, INACTIVE
createdAt	string	true	The date and time when the medical home was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	-
updatedAt	string	true	The date and time when the medical home was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	-
aliases	[Alias]	false	The list of medical home aliases.	-

Alias

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

putProviderV2MedicalHomes

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the medical home.	-
representedBy	object	false	The organization associated with the medical home.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the medical home.	ACTIVE, INACTIVE
aliases	[object]	false	The list of medical home aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

postProviderV2Networks

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the network.	-
description	string	false	Additional details that help describe the network.	-
medicalHome	object	false	The medical home of the network.	-
» id	string	true	The ID of the referenced object.	-
plan	object	false	The plan of the network.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the network.	ACTIVE, INACTIVE
type	object	false	The type of the network. If `type` is specified, either `codings` or `text` is required.	-
» codings	[object]	true	A list of codified values from a standard code system.	-
»» code	string	true	The unique ID of the code.	-
»» display	string	false	The human-readable representation of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
» text	string	false	The human-readable, potentially personalized, description of a network type.	-
tags	[object]	false	The tags associated with this entity.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
aliases	[object]	false	The aliases of the network.	-
» system	string	true	The authority responsible for assigning the ID.	-
» value	string	true	The value or ID within the context of the assigning authority.	-

NetworkEntities

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

ProviderPublicApi_Entities_Common_Networks_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.	-
type	ProviderPublicApi_Entities_Common_Networks_NetworkType	false	The type of provider network.	-
medicalHome	ProviderPublicApi_Entities_Common_Networks_MedicalHome	false	The medical home of the network.	-
plan	ProviderPublicApi_Entities_Common_Networks_Plan	false	The plan of the network.	-
status	string	true	The status of the network.	ACTIVE, INACTIVE
tags	[ProviderPublicApi_Entities_Common_Tag]	false	The tags associated with the network.	-
aliases	[Alias]	false	The aliases of the network.	-
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).	-

ProviderPublicApi_Entities_Common_Networks_NetworkType

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

Code

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

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

ProviderPublicApi_Entities_Common_Networks_Plan

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

ProviderPublicApi_Entities_Common_Tag

Name	Type	Required	Description	Accepted Values
key	string	true	The key associated with the tag.	-
value	string	false	The value associated with the key of a specific tag.	-

putProviderV2Networks

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the network.	-
description	string	false	Additional details that help describe the network.	-
medicalHome	object	false	The medical home of the network.	-
» id	string	true	The ID of the referenced object.	-
plan	object	false	The plan of the network.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the network.	ACTIVE, INACTIVE
type	object	false	The type of the network. If `type` is specified, either `codings` or `text` is required.	-
» codings	[object]	true	A list of codified values from a standard code system.	-
»» code	string	true	The unique ID of the code.	-
»» display	string	false	The human-readable representation of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
» text	string	false	The human-readable, potentially personalized, description of a network type.	-
tags	[object]	false	The tags associated with this entity.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
aliases	[object]	false	The aliases of the network.	-
» system	string	true	The authority responsible for assigning the ID.	-
» value	string	true	The value or ID within the context of the assigning authority.	-

postProviderV2Payers

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the payer.	-
description	string	false	Additional details that help describe the payer.	-
status	string	true	The status of the payer.	ACTIVE, INACTIVE
aliases	[object]	false	The list of payer aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

PayerEntities

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

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

putProviderV2Payers

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the payer.	-
description	string	false	Additional details that help describe the payer.	-
status	string	true	The status of the payer.	ACTIVE, INACTIVE
aliases	[object]	false	The list of payer aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

postProviderV2PaymentSources

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

PaymentSourceEntities

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

ProviderPublicApi_Entities_Common_Networks_PaymentSourceEntity

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

ProviderPublicApi_Entities_Common_IdModel

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

putProviderV2PaymentSources

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

PaymentSourceLineageEntities

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

ProviderPublicApi_Entities_Common_Networks_PaymentSourceLineageEntity

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

postProviderV2Typologies

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

PaymentSourceTypologyEntities

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

ProviderPublicApi_Entities_Common_Networks_PaymentSourceTypologyEntity

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

putProviderV2Typologies

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

postProviderV2Plans

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the plan.	-
description	string	false	Additional details that help describe the plan.	-
payer	object	true	The payer for the plan.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the plan.	ACTIVE, INACTIVE
aliases	[object]	false	The list of plan aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

PlanEntities

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

ProviderPublicApi_Entities_Common_Networks_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	ProviderPublicApi_Entities_Common_Networks_Payer	true	The payer for the plan.	-
status	string	true	The status of the plan.	ACTIVE, INACTIVE
createdAt	string	true	The date and time when the plan was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	-
updatedAt	string	true	The date and time when the plan was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	-
aliases	[Alias]	false	The list of plan aliases.	-

ProviderPublicApi_Entities_Common_Networks_Payer

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

putProviderV2Plans

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the plan.	-
description	string	false	Additional details that help describe the plan.	-
payer	object	true	The payer for the plan.	-
» id	string	true	The ID of the referenced object.	-
status	string	true	The status of the plan.	ACTIVE, INACTIVE
aliases	[object]	false	The list of plan aliases.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

ProviderLocations

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

ProviderLocation

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the location.	-
name	string	true	The name of the location.	-
description	string	false	A description of the location.	-
address	Address	false	The street address of the location.	-
telecoms	[ProviderTelecom]	false	The telecommunication information of the location.	-
status	string	false	The current status of the location. The default status is ACTIVE.	ACTIVE, SUSPENDED, INACTIVE
link	Link	false	An optional reference to a base location defined as part of the Health Data Intelligence Organization API.	-
locationType	[ProviderLocationTypeReference]	false	The types of provider locations that are dedicated to providing certain healthcare services, such as Imaging Centers, Outpatient Centers, and Ambulatory Centers.	-
managingOrganization	Reference	false	The ID of the organization responsible for the provisioning and upkeep of the location.	-
tags	[ProviderPublicApi_Entities_Common_Tag]	false	The tags associated with the provider location.	-
sourceIdentifiers	[SourceIdentifier]	false	The array of location IDs that uniquely identify a provider location record in its source system.	-
aliases	[ProviderAlias]	false	The aliases of the provider location.	-
createdBy	Reference	false	The personnel who created the location type.	-
createdAt	string	true	The date and time at which the location was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedBy	Reference	false	The personnel who updated the location.	-
updatedAt	string	true	The date and time at which the location was updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

Address

Name	Type	Required	Description	Accepted Values
use	string	false	Use of address.	BILLING, WORK, TEMP, OLD
text	string	false	A single-line representation of the address.	-
lines	[string]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
city	string	false	The city associated with the address.	-
state	string	false	The state associated with the address.	-
country	string	false	The country associated with the address.	-
postalCode	string	false	The postal code associated with the address.	-

ProviderTelecom

Name	Type	Required	Description	Accepted Values
system	string	true	The system of the telecom.	PHONE, FAX, EMAIL, DIRECT, URL, SMS, OTHER
value	string	true	The value of the telecom.	-
use	string	false	The purpose of the telecom.	HOME, WORK, TEMP, OLD, MOBILE
rank	integer(int32)	false	The ranking of the preferred order of use for the telecom. The default value is 1, which is the highest rank.	-

Link

Name	Type	Required	Description	Accepted Values
target	Target	true	The target of the link to the location.	-

Target

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

ProviderLocationTypeReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider location type.	-
display	string	false	The display of the provider location type.	-

Reference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the referenced entity.	-

SourceIdentifier

Name	Type	Required	Description	Accepted Values
dataPartitionId	string	true	The ID of the data partition.	-
id	string	true	The ID of the location in the source system.	-

ProviderAlias

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

postProviderV2ProviderLocations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the location.	-
description	string	false	A description of the location.	-
address	object	false	The street address of the location.	-
» use	string	false	The use of the address.	BILLING, WORK, TEMP, OLD
» text	string	false	A single-line representation of the address.	-
» lines	[string]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
» city	string	false	The city of the address.	-
» state	string	false	The state of the address.	-
» country	string	false	The country of the address.	-
» postalCode	string	false	The postal code of the address.	-
telecoms	[object]	false	The telecommunication information of the location.	-
» system	string	true	The system value of the telecom.	PHONE, FAX, EMAIL, DIRECT, URL, SMS, OTHER
» value	string	true	The value of the telecom.	-
» use	string	false	The purpose of the telecom.	HOME, WORK, TEMP, OLD, MOBILE
» rank	integer(int32)	false	The ranking of the preferred order of use for the telecom. The default value is 1, which is the highest rank.	-
status	string	false	The current status of the location. The default status is ACTIVE.	ACTIVE, SUSPENDED, INACTIVE
link	object	false	An optional reference to a base location defined as part of the Health Data Intelligence Organization API.	-
» target	object	true	The target location.	-
»» id	string	true	The unique ID of the target location.	-
locationType	[object]	false	A reference to the location types associated with the location.	-
» id	string	true	The ID of the location type.	-
managingOrganization	object	false	A reference to the managing organization.	-
» id	string	true	The ID of the managing organization being referenced.	-
aliases	[object]	false	The aliases of the provider location.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» type	string	false	The type of alias.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
tags	[object]	false	The tags associated with this entity.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
createdBy	object	false	The individual who entered the location into the system.	-
» id	string	true	The ID of the individual who entered the location into the system.	-

putProviderV2ProviderLocations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the location.	-
description	string	false	A description of the location.	-
address	object	false	The street address of the location.	-
» use	string	false	The use of the address.	BILLING, WORK, TEMP, OLD
» text	string	false	A single-line representation of the address.	-
» lines	[string]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
» city	string	false	The city of the address.	-
» state	string	false	The state of the address.	-
» country	string	false	The country of the address.	-
» postalCode	string	false	The postal code of the address.	-
telecoms	[object]	false	The telecommunication information of the location.	-
» system	string	true	The system value of the telecom.	PHONE, FAX, EMAIL, DIRECT, URL, SMS, OTHER
» value	string	true	The value of the telecom.	-
» use	string	false	The purpose of the telecom.	HOME, WORK, TEMP, OLD, MOBILE
» rank	integer(int32)	false	The ranking of the preferred order of use for the telecom. The default value is 1, which is the highest rank.	-
status	string	false	The current status of the location. The default status is ACTIVE.	ACTIVE, SUSPENDED, INACTIVE
link	object	false	An optional reference to a base location defined as part of the Health Data Intelligence Organization API.	-
» target	object	true	The target location.	-
»» id	string	true	The unique ID of the target location.	-
locationType	[object]	false	A reference to the location types associated with the location.	-
» id	string	true	The ID of the location type.	-
managingOrganization	object	false	A reference to the managing organization.	-
» id	string	true	The ID of the managing organization being referenced.	-
aliases	[object]	false	The aliases of the provider location.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» type	string	false	The type of alias.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
tags	[object]	false	The tags associated with this entity.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
updatedBy	object	false	The individual who updated the location in the system.	-
» id	string	true	The ID of the individual who updated the location in the system.	-

ProviderLocationTypes

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

ProviderLocationType

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the location type.	-
name	string	false	The name of the location type.	-
title	string	true	The user-friendly display name of the provider location type.	-
description	string	false	A description of the location type.	-
code	ProviderCode	true	The codeable concept associated with the location type.	-
createdBy	Reference	false	The personnel who created the location type.	-
createdAt	string	true	The date and time at which the location type was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedBy	Reference	false	The personnel who updated the location type.	-
updatedAt	string	true	The date and time at which the location type was updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

ProviderCode

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

ProviderCoding

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

postProviderV2ProviderLocationTypes

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the location type.	-
title	string	true	The user-friendly display name of the provider location type.	-
description	string	false	A description of the location type.	-
code	object	true	The codeable concept associated with the location type.	-
» text	string	false	The descriptive text for the code.	-
» codings	[object]	true	The codings associated with the location type.	-
»» code	string	true	The code associated with the code.	-
»» system	string	true	The system associated with the code.	-
»» display	string	false	The display of the code.	-
createdBy	object	false	The individual who entered the location type into the system.	-
» id	string	true	The ID of the individual who entered the location type into the system.	-

putProviderV2ProviderLocationTypes

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the location type.	-
title	string	true	The user-friendly display name of the provider location type.	-
description	string	false	A description of the location type.	-
code	object	true	The codeable concept associated with the location type.	-
» text	string	false	The descriptive text for the code.	-
» codings	[object]	true	The codings associated with the location type.	-
»» code	string	true	The code associated with the code.	-
»» system	string	true	The system associated with the code.	-
»» display	string	false	The display of the code.	-
updatedBy	object	false	The individual who updated the location type in the system.	-
» id	string	true	The ID of the individual who updated the location type in the system.	-

postProviderV2ProviderNetworkRelationshipTypes

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	[ProviderPublicApi_Entities_Common_Providers_NetworkRelationshipTypeEntity]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

ProviderPublicApi_Entities_Common_Providers_NetworkRelationshipTypeEntity

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

putProviderV2ProviderNetworkRelationshipTypes

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

postProviderV2ProviderNetworks

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

ProviderNetworks

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

ProviderPublicApi_Entities_Common_Providers_ProviderNetwork

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

ProviderPublicApi_Entities_Common_Providers_Network

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

ProviderPublicApi_Entities_Common_Providers_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

putProviderV2ProviderNetworks

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

ProviderOrganizations

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

ProviderPublicApi_Entities_V2_Providers_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.	-
specialties	[ProviderPublicApi_Entities_V2_Providers_Common_Specialty]	false	The specialty of the provider organization.	-
telecoms	[ProviderPublicApi_Entities_V2_Providers_Common_Telecom]	false	Contact details that are specific the provider organization.	-
addresses	[ProviderPublicApi_Entities_V2_Providers_Common_Address]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
isManual	boolean	false	Indicates whether this resource is created internally. NEW - Only available at Internal Component service.	-
aliases	[ProviderPublicApi_Entities_V2_Providers_Common_Alias]	false	The aliases of the provider organization.	-
status	string	true	The operational status of the provider organization. Allowable values: ACTIVE, INACTIVE, SUSPENDED.	ACTIVE, INACTIVE, SUSPENDED
link	ProviderPublicApi_Entities_V2_Providers_Common_Link	false	An optional reference to a base organization defined as part of the Health Data Intelligence Organization API.	-
tags	[ProviderPublicApi_Entities_V2_Providers_Common_Tag]	false	The tags are labels associated to the provider organization. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organizations in different ways, for example, by purpose, owner, or business.	-
roles	[ProviderPublicApi_Entities_V2_Providers_Common_Role]	false	The list of roles of the provider organization.	-
sourceIdentifiers	[ProviderPublicApi_Entities_V2_Providers_Common_SourceIdentifier]	false	The unique identifier of the provider organization in its source system. NEW - OPTIONAL and not part of the POST/PUT end-point. Value is derived from the ingestion workflow.	-
createdAt	string	true	The date and time at which the provider organization was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
createdBy	Reference	false	The individual who created the provider organization in the system.	-
updatedAt	string	true	The date and time at which the provider organization was updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedBy	Reference	false	The individual who updated the provider organization in the system.	-

ProviderPublicApi_Entities_V2_Providers_Common_Specialty

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider specialty.	-
name	string	false	Name of the provider specialty.	-
taxonomy	ProviderPublicApi_Entities_V2_Providers_Common_Taxonomy	false	Provider Taxonomy is a hierarchy of specialties. Only these specialties are used to map provider organization with specialties.	-
isPrimary	boolean	false	Indicates whether the specialty is primary or not. Include allowable values= TRUE and FALSE in the description.	-

ProviderPublicApi_Entities_V2_Providers_Common_Taxonomy

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the taxonomy. Allows 32 symbols only.	-
name	string	false	The name of the taxonomy.	-

ProviderPublicApi_Entities_V2_Providers_Common_Telecom

Name	Type	Required	Description	Accepted Values
system	string	true	The type of the system. The following values are available: PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
value	string	true	The actual contact point details.	-
use	string	false	The purpose of this contact point.	-
rank	integer(int32)	false	The rank of telecom relative to the other telecom items in the list.	-

ProviderPublicApi_Entities_V2_Providers_Common_Address

Name	Type	Required	Description	Accepted Values
text	string	false	The fully-formatted address.	-
use	string	false	The purpose of the address. The following values are available: ‘WORK’, ‘HOME’, ‘TEMP’, ‘OLD’, ‘BILLING’.	WORK, HOME, TEMP, OLD, BILLING
lines	[string]	false	Address splitted per line. An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
city	string	false	The name of the city, town, or village.	-
state	string	false	The state or other subunit of a country.	-
country	string	false	The nation specified for this address.	-
postalCode	string	true	The region defined by the postal service for this address.	-

ProviderPublicApi_Entities_V2_Providers_Common_Alias

Name	Type	Required	Description	Accepted Values
system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
type	string	false	The type of the alias. The allowable values: NPI, TAX, EXTERNAL, OTHER, UNKNOWN	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-

ProviderPublicApi_Entities_V2_Providers_Common_Link

Name	Type	Required	Description	Accepted Values
target	ProviderPublicApi_Entities_V2_Providers_Common_LinkTarget	true	The target of the link to the location.	-

ProviderPublicApi_Entities_V2_Providers_Common_LinkTarget

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

ProviderPublicApi_Entities_V2_Providers_Common_Tag

Name	Type	Required	Description	Accepted Values
key	string	true	The key associated with the tag.	-
value	string	false	The value associated with the key of a specific tag.	-

ProviderPublicApi_Entities_V2_Providers_Common_Role

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

ProviderPublicApi_Entities_V2_Providers_Common_SourceIdentifier

Name	Type	Required	Description	Accepted Values
dataPartitionId	string	true	The ID of the data partition.	-
id	string	true	The ID of the provider organization in the source system.	-

postProviderV2ProviderOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the provider organization.	-
specialties	[object]	false	The specialty of the provider organization.	-
» id	string	true	The unique ID of the provider specialty.	-
» name	string	false	Name of the provider specialty.	-
» taxonomy	object	true	Provider Taxonomy is a hierarchy of specialties. Only these specialties are used to map provider organization with specialties.	-
»» id	string	true	The unique ID of the taxonomy. Allows 32 symbols only.	-
»» name	string	false	The name of the taxonomy.	-
» isPrimary	boolean	false	Indicates whether the specialty is primary or not. Include allowable values= TRUE and FALSE in the description.	-
telecoms	[object]	false	Contact details that are specific the provider organization.	-
» system	string	true	The type of the system. The following values are available: PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
» value	string	true	The actual contact point details.	-
» use	string	false	The purpose of this contact point.	-
» rank	integer(int32)	false	The rank of telecom relative to the other telecom items in the list.	-
addresses	[object]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
» text	string	false	The fully-formatted address.	-
» use	string	false	The purpose of the address, for example, HOME or WORK. The following values are available: ‘WORK’, ‘HOME’, ‘TEMP’, ‘OLD’, ‘BILLING’.	WORK, HOME, TEMP, OLD, BILLING
» lines	[string]	false	Address splitted per line. An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
» city	string	false	The name of the city, town, or village.	-
» state	string	false	The state or other subunit of a country.	-
» country	string	false	The nation specified for this address.	-
» postalCode	string	true	The region defined by the postal service for this address.	-
aliases	[object]	false	The aliases of the provider organization.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» type	string	false	The type of the alias. The allowable values: ‘NPI’, ‘TAX’, ‘EXTERNAL’, ‘OTHER’, ‘UNKNOWN’	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
status	string	false	The operational status of the provider organization. Allowable values: ACTIVE, INACTIVE, SUSPENDED.	ACTIVE, INACTIVE, SUSPENDED
link	object	false	An optional reference to a base organization defined as part of the Health Data Intelligence Organization API.	-
» target	object	true	The target of the link to the location.	-
»» id	string	true	The unique ID of the target.	-
»» display	string	false	The display name of the target.	-
tags	[object]	false	The tags are labels associated to the provider organization. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organizations in different ways, for example, by purpose, owner, or business.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
createdBy	object	false	This has to be the individual who created the provider organization in the system.	-
» id	string	true	The ID of the individual who entered the record into the system.	-

putProviderV2ProviderOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the provider organization.	-
specialties	[object]	false	The specialty of the provider organization.	-
» id	string	true	The unique ID of the provider specialty.	-
» name	string	false	Name of the provider specialty.	-
» taxonomy	object	true	Provider Taxonomy is a hierarchy of specialties. Only these specialties are used to map provider organization with specialties.	-
»» id	string	true	The unique ID of the taxonomy. Allows 32 symbols only.	-
»» name	string	false	The name of the taxonomy.	-
» isPrimary	boolean	false	Indicates whether the specialty is primary or not. Include allowable values= TRUE and FALSE in the description.	-
telecoms	[object]	false	Contact details that are specific the provider organization.	-
» system	string	true	The type of the system. The following values are available: PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
» value	string	true	The actual contact point details.	-
» use	string	false	The purpose of this contact point.	-
» rank	integer(int32)	false	The rank of telecom relative to the other telecom items in the list.	-
addresses	[object]	false	An ordered list of address lines indicating the street name, number, direction, P.O. Box, and other similar address information, in the order in which the lines are displayed on an address label.	-
» text	string	false	The fully-formatted address.	-
» use	string	false	The purpose of the address, for example, HOME or WORK. The following values are available: ‘WORK’, ‘HOME’, ‘TEMP’, ‘OLD’, ‘BILLING’.	WORK, HOME, TEMP, OLD, BILLING
» lines	[string]	false	Address splitted per line. An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
» city	string	false	The name of the city, town, or village.	-
» state	string	false	The state or other subunit of a country.	-
» country	string	false	The nation specified for this address.	-
» postalCode	string	true	The region defined by the postal service for this address.	-
aliases	[object]	false	The aliases of the provider organization.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» type	string	false	The type of the alias. The allowable values: ‘NPI’, ‘TAX’, ‘EXTERNAL’, ‘OTHER’, ‘UNKNOWN’	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
status	string	false	The operational status of the provider organization. Allowable values: ACTIVE, INACTIVE, SUSPENDED.	ACTIVE, INACTIVE, SUSPENDED
link	object	false	An optional reference to a base organization defined as part of the Health Data Intelligence Organization API.	-
» target	object	true	The target of the link to the location.	-
»» id	string	true	The unique ID of the target.	-
»» display	string	false	The display name of the target.	-
tags	[object]	false	The tags are labels associated to the provider organization. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organizations in different ways, for example, by purpose, owner, or business.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
updatedBy	object	false	The individual who updated the provider organization.	-
» id	string	true	The ID of the individual who updated the record into the system.	-

ProviderOrganizationRoles

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

ProviderPublicApi_Entities_V2_Providers_ProviderOrganizationRole

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider organization role.	-
assignedBy	[ProviderPublicApi_Entities_V2_Providers_Common_AssignedBy]	false	The organization for which the role is available or to which it may be assigned.	-
providerLocations	[ProviderPublicApi_Entities_V2_Providers_Common_ProviderLocation]	false	The list of locations where the organization represented by this role offers care.	-
period	[ProviderPublicApi_Entities_V2_Providers_Common_Period]	false	The period during which the role is effective, including the start and end dates.	-
networks	[ProviderPublicApi_Entities_V2_Providers_Common_Network]	false	The list of networks that this role covers.	-
specialties	[ProviderPublicApi_Entities_V2_Providers_Common_Specialty]	false	The list of provider organization role specialties. Specialties indicate the provider organization’s field of practice.	-
healthcareServices	[ProviderPublicApi_Entities_V2_Providers_Common_HealthcareService]	false	The list of health care services that this role provides.	-
tags	[ProviderPublicApi_Entities_V2_Providers_Common_Tag]	false	The tags are labels associated to the provider organization role. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organization roles in different ways, for example, by purpose, owner, or business.	-
sourceIdentifiers	[ProviderPublicApi_Entities_V2_Providers_Common_SourceIdentifier]	false	The unique identifier of the provider organization role in its source system.	-
aliases	[ProviderPublicApi_Entities_V2_Providers_Common_AliasRole]	false	The list of provider organization role aliases. An alias contains a system and a value and can be used to store alternative IDs such as a client-defined ID for a role.	-
status	string	true	The status of the provider organization role.	ACTIVE, INACTIVE
isManual	boolean	false	Indicates whether this resource is created internally. NEW - Only available at Internal Component service	-
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a provider organization that is applicable for services rendered by the provider organization role.	-
acceptingPatients	boolean	false	Indicates whether an organization in the role accepts new patients.	-
roleType	[ProviderPublicApi_Entities_V2_Providers_Common_RoleType]	false	The codeable concept associated with the provider organization role.	-
createdAt	string	true	The date and time at which the provider organization role was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
createdBy	Reference	false	The individual who created the provider organization role in the system.	-
updatedAt	string	true	The date and time at which the provider organization role was updated, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedBy	Reference	false	The individual who updated the provider organization role in the system.	-

ProviderPublicApi_Entities_V2_Providers_Common_AssignedBy

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider organization.	-
name	string	false	The name of the provider organization.	-
link	ProviderPublicApi_Entities_V2_Providers_Common_Link	false	An optional reference to a base location defined as part of the Health Data Intelligence Organization API.	-

ProviderPublicApi_Entities_V2_Providers_Common_ProviderLocation

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider location	-

ProviderPublicApi_Entities_V2_Providers_Common_Period

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

ProviderPublicApi_Entities_V2_Providers_Common_Network

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

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

ProviderPublicApi_Entities_V2_Providers_Common_AliasRole

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

ProviderPublicApi_Entities_V2_Providers_Common_RoleType

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

ProviderPublicApi_Entities_V2_Providers_Common_Coding

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

postProviderV2ProviderOrganizationRoles

Name	Type	Required	Description	Accepted Values
assignedBy	object	true	The organization for which the role is available or to which it may be assigned.	-
» id	string	true	The unique ID of the provider organization.	-
providerLocations	[object]	false	The list of locations where the organization represented by this role offers care.	-
» id	string	true	The unique ID of the provider location.	-
period	object	false	The period during which the role is effective, including the start and end dates.	-
» start	string	true	The effective start date of the provider organization role.	-
» end	string	false	The effective end date of the provider organization role.	-
specialties	[object]	false	The list of provider organization role specialties. Specialties indicate the provider organization’s field of practice.	-
» id	string	true	The unique ID of the provider specialty.	-
» name	string	false	The name of the provider specialty.	-
» taxonomy	object	true	Provider Taxonomy is a hierarchy of specialties. Only these specialties are used to map provider organization roles with specialties.	-
»» id	string	true	The unique ID of the taxonomy. Allows 32 symbols only.	-
»» name	string	false	The name of the taxonomy.	-
» isPrimary	boolean	false	Indicates whether the specialty is primary or not. Include allowable values= TRUE and FALSE in the description.	-
healthcareServices	[object]	false	The list of health care services that this role provides.	-
» id	string	true	The unique ID of the healthcare service.	-
» name	string	false	The name of the healthcare service.	-
tags	[object]	false	The tags are labels associated to the provider organization role. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organization roles in different ways, for example, by purpose, owner, or business.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
aliases	[object]	false	The list of provider organization role aliases. An alias contains a system and a value and can be used to store alternative IDs such as a client-defined ID for a role.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
status	string	false	The status of the provider organization role. Allowable Values: ACTIVE, INACTIVE	ACTIVE, INACTIVE
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a provider organization that is applicable for services rendered by the provider organization role.	-
acceptingPatients	boolean	false	Indicates whether an organization in the role accepts new patients.	-
roleType	object	false	The codeable concept associated with the provider organization role.	-
» text	string	false	A human readable, potentially personalized description of a role type.	-
» codings	[object]	false	A list of codified values from a standard code system.	-
»» code	string	false	The unique ID of the code.	-
»» system	string	false	The ID of the coding system that gives meaning to the code.	-
»» display	string	false	A human-readable representation of the code.	-
createdBy	object	false	The individual who created the provider organization role in the system.	-
» id	string	true	The ID of the individual who entered the record into the system.	-

putProviderV2ProviderOrganizationRoles

Name	Type	Required	Description	Accepted Values
assignedBy	object	true	The organization for which the role is available or to which it may be assigned.	-
» id	string	true	The unique ID of the provider organization.	-
providerLocations	[object]	false	The list of locations where the organization represented by this role offers care.	-
» id	string	true	The unique ID of the provider location.	-
period	object	false	The period during which the role is effective, including the start and end dates.	-
» start	string	true	The effective start date of the provider organization role.	-
» end	string	false	The effective end date of the provider organization role.	-
specialties	[object]	false	The list of provider organization role specialties. Specialties indicate the provider organization’s field of practice.	-
» id	string	true	The unique ID of the provider specialty.	-
» name	string	false	The name of the provider specialty.	-
» taxonomy	object	true	Provider Taxonomy is a hierarchy of specialties. Only these specialties are used to map provider organization roles with specialties.	-
»» id	string	true	The unique ID of the taxonomy. Allows 32 symbols only.	-
»» name	string	false	The name of the taxonomy.	-
» isPrimary	boolean	false	Indicates whether the specialty is primary or not. Include allowable values= TRUE and FALSE in the description.	-
healthcareServices	[object]	false	The list of health care services that this role provides.	-
» id	string	true	The unique ID of the healthcare service.	-
» name	string	false	The name of the healthcare service.	-
tags	[object]	false	The tags are labels associated to the provider organization role. Each tag consists of a key and an optional value, both of which can be defined. It enable to categorize provider organization roles in different ways, for example, by purpose, owner, or business.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
aliases	[object]	false	The list of provider organization role aliases. An alias contains a system and a value and can be used to store alternative IDs such as a client-defined ID for a role.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
status	string	false	The status of the provider organization role. Allowable Values: ACTIVE, INACTIVE	ACTIVE, INACTIVE
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a provider organization that is applicable for services rendered by the provider organization role.	-
acceptingPatients	boolean	false	Indicates whether an organization in the role accepts new patients.	-
roleType	object	false	The codeable concept associated with the provider organization role.	-
» text	string	false	A human readable, potentially personalized description of a role type.	-
» codings	[object]	false	A list of codified values from a standard code system.	-
»» code	string	false	The unique ID of the code.	-
»» system	string	false	The ID of the coding system that gives meaning to the code.	-
»» display	string	false	A human-readable representation of the code.	-
updatedBy	object	false	The individual who updated the provider organization role in the system.	-
» id	string	true	The ID of the individual who updated the record into the system.	-

PersonnelRoles

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

ProviderPublicApi_Entities_V2_Providers_PersonnelRole

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the personnel role.	-
name	string	false	The name of the personnel role.	-
period	ProviderPublicApi_Entities_V2_Common_Period	false	The effective range of dates of the personnel role.	-
providerPersonnel	ProviderPublicApi_Entities_V2_Providers_ProviderPersonnelLite	true	The provider personnel member who provides the defined services for the personnel role.	-
codes	[CodeableConcept]	false	A list of codes that are associated with the provider personnel.	-
assignedBy	ProviderPublicApi_Entities_V2_Providers_Common_AssignedBy	true	The ID of the assigning organization or authority.	-
providedAt	[ProvidedAt]	false	The ID of the location where a service is provided.	-
networks	[ProviderPublicApi_Entities_V2_Providers_Common_Network]	false	A list of networks associated with the personnel role.	-
healthcareServices	[ProviderPublicApi_Entities_V2_Providers_Common_HealthcareService]	false	A list of healthcare services associated with the personnel role.	-
specialties	[ProviderPublicApi_Entities_V2_Providers_Common_Specialty]	false	A list of specialties associated with the personnel role.	-
aliases	[Alias]	false	A list of aliases associated with the personnel role.	-
tags	[ProviderPublicApi_Entities_V2_Common_Tag]	false	A list of tags associated with the personnel role.	-
sourceIdentifiers	[ProviderPublicApi_Entities_V2_Providers_Common_SourceIdentifier]	false	Indicates the source from which the data originated.	-
status	string	true	The current state of the personnel role.	ACTIVE, INACTIVE
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a personnel that is applicable for services rendered by the personnel role.	-
acceptingPatients	boolean	false	Indicates whether the provider specified in the personnel role is accepting patients.	-
pcpStatuses	[ProviderPublicApi_Entities_V2_Providers_PcpStatus]	false	Indicates whether the provider specified in the personnel role acted as a PCP in a specific time frame.	-
proxyPersonnel	[ProxyPersonnel]	false	The list of personnel who are designated as proxies for the provider personnel in the role.	-
createdAt	string	true	The date and time when the personnel role was created, in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ.	-
createdBy	Reference	false	The ID of the individual who created the record.	-
updatedAt	string	true	The date and time when the personnel role was most recently updated, in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ.	-
updatedBy	Reference	false	The ID of the individual who last updated the record.	-

ProviderPublicApi_Entities_V2_Common_Period

Name	Type	Required	Description	Accepted Values
start	string	false	The end date of the effective period of the role, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
end	string	false	The start date of the effective period of the role, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-

ProviderPublicApi_Entities_V2_Providers_ProviderPersonnelLite

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider personnel member.	-
name	string	false	A name associated with the provider personnel.	-
link	ProviderPublicApi_Entities_V2_Common_Link	false	A reference to another personnel resource.	-

ProviderPublicApi_Entities_V2_Common_Link

Name	Type	Required	Description	Accepted Values
target	ProviderPublicApi_Entities_V2_Common_Target	true	The link to a Health Data Intelligence Organization resource that has been identified as representing the same real-world entity, but is defined for the purpose of managing identity and access control within the platform.	-

ProviderPublicApi_Entities_V2_Common_Target

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the referenced target resource.	-
display	string	false	A human-readable representation of the target.	-

CodeableConcept

Name	Type	Required	Description	Accepted Values
codings	[Code]	true	A list of codified values from standard code systems recognized by Health Data Intelligence.	-
sourceCodings	[Code]	true	The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by Health Data Intelligence.	-
concepts	[Concept]	false	The list of ontological concepts derived from the codified values from standard code systems recognized by Health Data Intelligence.	-
text	string	false	This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list.	-

Concept

Name	Type	Required	Description	Accepted Values
alias	string	true	The unique ID of the concept in a context.	-
contextId	string	true	The unique ID of the context. IDs are in all caps and do not include dashes.	-

ProvidedAt

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of a location where a service is offered.	-
name	string	true	The name of the location providing the service.	-
telecoms	[ProvidedAtTelecom]	false	The communication information for a particular location.	-
link	ProviderPublicApi_Entities_V2_Common_Link	false	The personnel link attribute.	-

ProvidedAtTelecom

Name	Type	Required	Description	Accepted Values
system	string	true	The system or type of the telecom.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
value	string	true	The value of the telecom.	-
use	string	false	The use of the telecom.	HOME, WORK, MOBILE, TEMP, OLD
rank	integer(int32)	false	The rank or precedence of the telecom.	-

ProviderPublicApi_Entities_V2_Common_Tag

Name	Type	Required	Description	Accepted Values
key	string	true	The key associated with the tag.	-
value	string	true	The value of the tag.	-

ProviderPublicApi_Entities_V2_Providers_PcpStatus

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

ProxyPersonnel

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the proxy personnel.	-
name	string	false	The name of the proxy personnel.	-
link	ProviderPublicApi_Entities_V2_Common_Link	false	The link of the proxy personnel.	-

postProviderV2ProviderPersonnelRoles

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the personnel role.	-
period	object	false	The period during which the role is effective, including the start and end dates.	-
» start	string	false	The start date of the personnel role.	-
» end	string	false	The end date of the personnel role.	-
providerPersonnel	object	true	The provider personnel member who can provide the defined services for the organization.	-
» id	string	true	The unique ID of the provider personnel.	-
» link	object	false	The link of the provider personnel.	-
»» target	object	true	No description	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display of the target.	-
codes	[object]	false	The list of provider personnel role codes.	-
» text	string	false	Either the localized or annotated description of the element provided by a source system or the display text associated with a code.	-
» codings	[object]	false	A list of codified values from standard code systems recognized by Health Data Intelligence.	-
»» code	string	true	The unique ID of the code.	-
»» display	string	false	A human-readable representation of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
assignedBy	object	true	The organization for which the role is available or to which it can be assigned.	-
» id	string	true	The ID of the assigner.	-
» link	object	false	No description	-
»» target	object	true	No description	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display of the target.	-
providedAt	[object]	false	The locations where the provider represented by this role offers care.	-
» id	string	true	The ID of the provider location.	-
» telecoms	[object]	false	No description	-
»» system	string	true	The type of communication for the personnel.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
»» value	string	true	The value of the communication type for the personnel.	-
»» use	string	false	The purpose of the communication.	HOME, WORK, MOBILE, TEMP, OLD
»» rank	string	false	The priority or rank order of the communication type.	-
» link	object	false	A reference to another personnel resource.	-
»» target	object	true	The personnel resource that the link refers to.	-
»»» id	string	false	The ID of the target.	-
»»» display	string	false	The display name of the target in plain text.	-
healthcareServices	[object]	false	The list of health care services that this role provides.	-
» id	string	true	The ID of the qualification.	-
specialties	[object]	false	The list of personnel role specialties. Specialties indicate the provider’s field of practice.	-
» id	string	true	The ID of the specialty.	-
» taxonomy	object	true	The taxonomy associated with a personnel role specialty.	-
»» id	string	true	The taxonomy ID of the personnel role specialty.	-
» isPrimary	boolean	false	Indicates whether the specialty is a primary specialty.	-
aliases	[object]	false	The list of personnel role aliases. An alias includes a system and a value and can be used to store alternative IDs such as a client-defined ID for a role.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
tags	[object]	false	The tags of the provider personnel role.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
status	string	false	The status of the personnel role.	ACTIVE, INACTIVE
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a personnel that is applicable for services rendered by the personnel role.	-
acceptingPatients	boolean	false	Indicates whether a provider in the role accepts new patients.	-
pcpStatuses	[object]	false	The status of the personnel role as a PCP, including effective start and end dates.	-
» pcpIndicator	boolean	true	Boolean value that indicates the pcp.	-
» effectiveDate	string	false	The start date of the PCP status, in ISO 8601 YYYY-MM-DD format.	-
» endDate	string	false	The end date of the PCP status, in ISO 8601 YYYY-MM-DD format.	-
proxyPersonnel	[object]	false	Identifies the proxy personnel.	-
» id	string	false	The ID of the proxy personnel.	-
» link	object	false	The link of the proxy personnel.	-
»» target	object	true	The personnel resource that the link refers to.	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display name of the target in plain text.	-
createdBy	object	false	The individual who created the provider personnel role.	-
» id	string	true	The ID of the individual who created the provider personnel role.	-

putProviderV2ProviderPersonnelRoles

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the personnel role.	-
period	object	false	The period during which the role is effective, including the start and end dates.	-
» start	string	false	The start date of the personnel role.	-
» end	string	false	The end date of the personnel role.	-
providerPersonnel	object	true	The provider personnel member who can provide the defined services for the organization.	-
» id	string	true	The unique ID of the provider personnel.	-
» link	object	false	The link of the provider personnel.	-
»» target	object	true	No description	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display of the target.	-
codes	[object]	false	The list of provider personnel role codes.	-
» text	string	false	Either the localized or annotated description of the element provided by a source system or the display text associated with a code.	-
» codings	[object]	false	A list of codified values from standard code systems recognized by Health Data Intelligence.	-
»» code	string	true	The unique ID of the code.	-
»» display	string	false	A human-readable representation of the code.	-
»» system	string	true	The ID of the coding system that gives meaning to the code.	-
assignedBy	object	true	The organization for which the role is available or to which it can be assigned.	-
» id	string	true	The ID of the assigner.	-
» link	object	false	No description	-
»» target	object	true	No description	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display of the target.	-
providedAt	[object]	false	The locations where the provider represented by this role offers care.	-
» id	string	true	The ID of the provider location.	-
» telecoms	[object]	false	No description	-
»» system	string	true	The type of communication for the personnel.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
»» value	string	true	The value of the communication type for the personnel.	-
»» use	string	false	The purpose of the communication.	HOME, WORK, MOBILE, TEMP, OLD
»» rank	string	false	The priority or rank order of the communication type.	-
» link	object	false	A reference to another personnel resource.	-
»» target	object	true	The personnel resource that the link refers to.	-
»»» id	string	false	The ID of the target.	-
»»» display	string	false	The display name of the target in plain text.	-
healthcareServices	[object]	false	The list of health care services that this role provides.	-
» id	string	true	The ID of the qualification.	-
specialties	[object]	false	The list of personnel role specialties. Specialties indicate the provider’s field of practice.	-
» id	string	true	The ID of the specialty.	-
» taxonomy	object	true	The taxonomy associated with a personnel role specialty.	-
»» id	string	true	The taxonomy ID of the personnel role specialty.	-
» isPrimary	boolean	false	Indicates whether the specialty is a primary specialty.	-
aliases	[object]	false	The list of personnel role aliases. An alias includes a system and a value and can be used to store alternative IDs such as a client-defined ID for a role.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the provider in the context of the system or assigning authority.	-
tags	[object]	false	The tags of the provider personnel role.	-
» key	string	true	The key associated with the tag.	-
» value	string	false	The value associated with the key of a specific tag.	-
status	string	false	The status of the personnel role.	ACTIVE, INACTIVE
paymentTaxId	string	false	The Taxpayer Identification Number (TIN) of a personnel that is applicable for services rendered by the personnel role.	-
acceptingPatients	boolean	false	Indicates whether a provider in the role accepts new patients.	-
pcpStatuses	[object]	false	The status of the personnel role as a PCP, including effective start and end dates.	-
» pcpIndicator	boolean	true	Boolean value that indicates the pcp.	-
» effectiveDate	string	false	The start date of the PCP status, in ISO 8601 YYYY-MM-DD format.	-
» endDate	string	false	The end date of the PCP status, in ISO 8601 YYYY-MM-DD format.	-
proxyPersonnel	[object]	false	Identifies the proxy personnel.	-
» id	string	false	The ID of the proxy personnel.	-
» link	object	false	The link of the proxy personnel.	-
»» target	object	true	The personnel resource that the link refers to.	-
»»» id	string	true	The ID of the target.	-
»»» display	string	false	The display name of the target in plain text.	-
updatedBy	object	false	The individual who updated the provider personnel role.	-
» id	string	true	The ID of the individual who updated the provider personnel role.	-

ProviderPersonnels

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

ProviderPublicApi_Entities_V2_Providers_ProviderPersonnel

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the provider personnel member.	-
name	ProviderPublicApi_Entities_V2_Common_Name	false	A name associated with the provider personnel.	-
gender	Code	false	Gender of the provider personnel	-
birthDate	string	false	The date on which the provider personnel was born, in ISO 8601 format YYYY-MM-DD	-
communications	[ProviderPublicApi_Entities_V2_Providers_Communication]	false	Language(s) the provider personnel can use in patient communication.	-
photo	ProviderPublicApi_Entities_V2_Providers_Photo	false	The image associated with the provider personnel.	-
telecoms	[ProviderPublicApi_Entities_V2_Providers_PersonnelDemographicTelecom]	false	Contact details for the provider personnel that apply to all roles.	-
addresses	[ProviderPublicApi_Entities_V2_Common_Address]	false	Address(es) of the provider personnel that are not role specific (typically home address)	-
qualifications	[ProviderPublicApi_Entities_V2_Providers_Qualification]	false	Certification, licenses, or training pertaining to the provision of care that are associated with the provider personnel.	-
aliases	[ProviderPublicApi_Entities_V2_Common_Alias]	false	Aliases of the provider personnel.	-
status	string	false	Indicates whether this provider personnel’s record is in active use.	ACTIVE, INACTIVE
link	ProviderPublicApi_Entities_V2_Common_Link	false	The link to a separate Health Data Intelligence resource that has been identified as representing the same real-world entity as this Health Data Intelligence Provider Service resource.	-
specialties	[ProviderPublicApi_Entities_V2_Providers_PersonnelSpecialtyTaxonomy]	false	The specialties of the provider personnel member. The primary specialty reflects the field for which the provider has been registered with NPPES. Multiple representations of the primary specialty in different taxonomies can exist.	-
roles	[ProviderPublicApi_Entities_Common_Providers_RoleAndKind]	false	The list of roles of the provider personnel member.	-
sourceIdentifiers	[ProviderPublicApi_Entities_V2_Providers_Common_SourceIdentifier]	false	The list of provider personnel IDs that uniquely identifies a personnel record in the source system.	-
createdBy	Reference	false	The individual who created the provider personnel in the system.	-
createdAt	string	true	The date and time when the provider personnel member was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedBy	Reference	false	The individual who updated the provider personnel in the system.	-
updatedAt	string	true	The date and time when the provider personnel member was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

ProviderPublicApi_Entities_V2_Common_Name

Name	Type	Required	Description	Accepted Values
text	string	false	The text representation of the name.	-
family	string	true	The family name of the full name.	-
given	[string]	false	The given names of the full name.	-
prefix	[string]	false	The Prefix of the full name.	-
suffix	[string]	false	The suffix of the full name.	-

ProviderPublicApi_Entities_V2_Providers_Communication

Name	Type	Required	Description	Accepted Values
code	ProviderPublicApi_Entities_V2_Common_CodeableConcept	true	Coded representation of the communication.	-

ProviderPublicApi_Entities_V2_Common_CodeableConcept

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

ProviderPublicApi_Entities_V2_Providers_Photo

Name	Type	Required	Description	Accepted Values
contentType	string	true	Content Type of the Photo.	IMAGE/JPG, IMAGE/JPEG, IMAGE/GIF, IMAGE/PNG
url	string	true	Reference of the Photo.	-
title	string	false	Name of the image.	-

ProviderPublicApi_Entities_V2_Providers_PersonnelDemographicTelecom

Name	Type	Required	Description	Accepted Values
system	string	true	The communication system that is required to use the contact details.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
value	string	true	The contact point details.	-
use	string	false	The purpose of this contact point.	HOME, MOBILE, OLD, TEMP, WORK
rank	integer(int32)	false	Ranking based on other provided telecoms. Must be a positive nonzero numeric value. Telecoms without a rank are considered equal to other un-ranked telecoms. Ranked telecoms fall in order above un-ranked telecoms.	-

ProviderPublicApi_Entities_V2_Common_Address

Name	Type	Required	Description	Accepted Values
use	string	false	The purpose of the address, for example, HOME or WORK.	BILLING, HOME, OLD, TEMP, WORK
text	string	false	The formatted display text of the address.	-
lines	[string]	false	An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
city	string	false	The name of the city, town, or village.	-
state	string	false	The state or other subunit of a country.	-
postalCode	string	false	The region defined by the postal service for this address.	-
country	string	false	The nation specified for this address.	-

ProviderPublicApi_Entities_V2_Providers_Qualification

Name	Type	Required	Description	Accepted Values
identifier	string	false	An identifier for this qualification for the provider personnel.	-
text	string	true	Text representation of the qualification.	-
type	Code	false	Indicates whether this qualification is belonging to a degree, training, certification, or license.	-
code	ProviderPublicApi_Entities_V2_Common_CodeableConcept	false	Coded representation of the qualification.	-
period	ProviderPublicApi_Entities_V2_Common_Period	false	Period during which the qualification is valid.	-
reverificationDate	string	false	Date qualification needs to be reverified by, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
issuer	ProviderPublicApi_Entities_V2_Providers_Issuer	false	An organization that regulates and issues the qualification. Either name or reference should be valued.	-

ProviderPublicApi_Entities_V2_Providers_Issuer

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the issuer.	-
reference	string	false	The reference associated with the issuer.	-

ProviderPublicApi_Entities_V2_Common_Alias

Name	Type	Required	Description	Accepted Values
value	string	true	The unique ID of the alias in the context of the system or assigning authority.	-
system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
type	string	false	The type of alias. A `value` is required and used in combination with the specified `type`.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN

ProviderPublicApi_Entities_V2_Providers_PersonnelSpecialtyTaxonomy

Name	Type	Required	Description	Accepted Values
specialtyId	string	true	The unique ID of the provider specialty.	-
taxonomyId	string	true	The taxonomy ID of the provider specialty.	-
isPrimary	boolean	true	Indicates whether a specialty is the primary specialty.	-

postProviderV2ProviderPersonnel

Name	Type	Required	Description	Accepted Values
name	object	false	Name of personnel. This field is required if link is not supplied.	-
» text	string	false	Text representation of the full name.	-
» family	string	true	Family name. This field is required if link is not supplied.	-
» given	[string]	false	Given names (not always first). Includes middle names.	-
» prefix	[string]	false	The prefix of the name. Parts that come before the name.	-
» suffix	[string]	false	The suffix of the name. Parts that come after the name.	-
gender	object	false	Gender of the provider personnel.	-
» code	string	true	Code associated with the code.	-
» system	string	true	System associated with the code.	-
» display	string	false	Display of the code.	-
birthDate	string	false	The date on which the provider personnel was born, in ISO 8601 YYYY-MM-DD format.	-
communications	[object]	false	Language(s) the provider personnel can use in patient communication.	-
» code	object	true	Coded representation of the communication.	-
»» text	string	false	Text associated with the communication.	-
»» codings	[object]	false	Codings associated with the communication.	-
»»» code	string	true	Code associated with the code.	-
»»» system	string	true	System associated with the code.	-
»»» display	string	false	Display of the code.	-
photo	object	false	The image associated with the provider personnel.	-
» contentType	string	true	Content Type of the Photo.	IMAGE/JPG, IMAGE/JPEG, IMAGE/GIF, IMAGE/PNG
» url	string	true	Reference of the Photo.	-
» title	string	false	Name of the image.	-
telecoms	[object]	false	Contact details for the provider personnel that apply to all roles.	-
» system	string	true	System value of telecom.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
» value	string	true	Value of telecom.	-
» use	string	false	Use of telecom.	HOME, MOBILE, OLD, TEMP, WORK
» rank	integer(int32)	false	Ranking based on other provided telecoms. Must be a positive nonzero numeric value. Telecoms without a rank are considered equal to other un-ranked telecoms. Ranked telecoms fall in order above un-ranked telecoms.	-
addresses	[object]	false	Address(es) associated with the provider personnel that are not related to a Provider Role.	-
» use	string	false	The purpose of the address, for example, HOME or WORK.	BILLING, HOME, OLD, TEMP, WORK
» text	string	false	The fully-formatted address.	-
» lines	[string]	false	An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
» city	string	false	The name of the city, town, or village.	-
» state	string	false	The state or other subunit of a country.	-
» postalCode	string	false	The region defined by the postal service for this address.	-
» country	string	false	The nation specified for this address.	-
qualifications	[object]	false	Certification, licenses, or training pertaining to the provision of care that are associated with the provider personnel.	-
» identifier	string	false	Identifier of qualification.	-
» type	object	false	Type of qualification.	-
»» code	string	true	Code associated with the code.	-
»» system	string	true	System associated with the code.	-
»» display	string	false	Display of the code.	-
» text	string	true	Text associated with the qualification.	-
» code	object	false	Code associated with the qualification.	-
»» text	string	false	Text associated with the qualification code.	-
»» codings	[object]	false	Codings associated with the qualification code.	-
»»» code	string	true	Code associated with the code.	-
»»» system	string	true	System associated with the code.	-
»»» display	string	false	Display of the code.	-
» period	object	false	Period during which the qualification is valid.	-
»» start	string	false	Start date of period, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
»» end	string	false	End date of period, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
» reverificationDate	string	false	Date qualification needs to be reverified by, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
» issuer	object	false	Issuer of qualification.	-
»» name	string	false	Name of issuer.	-
»» reference	string	false	Reference associated with the issuer.	-
aliases	[object]	false	Aliases of the provider personnel.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the alias in the context of the system or assigning authority.	-
» type	string	true	The type of alias.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
status	string	false	Indicates whether this provider personnel’s record is in active use.	ACTIVE, INACTIVE
link	object	false	The link to a separate Health Data Intelligence resource that has been identified as representing the same real-world entity as this Health Data Intelligence Provider Service resource.	-
» target	object	true	The link to a targeted personnel resource that must be used instead of the personnel resource that contains the link. See the personnel section on the Personnel API v1 page for more information.	-
»» id	string	true	The unique ID of the referenced target resource.	-
specialties	[object]	false	The specialties of the provider personnel member.	-
» specialtyId	string	true	The unique ID of the provider specialty.	-
» taxonomyId	string	true	The taxonomy ID of the provider specialty.	-
» isPrimary	boolean	true	Indicates whether a specialty is the primary specialty.	-
createdBy	object	false	The individual who created the provider personnel in the system	-
» id	string	true	The ID of the referenced entity.	-

putProviderV2ProviderPersonnel

Name	Type	Required	Description	Accepted Values
name	object	false	Name of personnel. This field is required if link is not supplied.	-
» text	string	false	Text representation of the full name.	-
» family	string	true	Family name. This field is required if link is not supplied.	-
» given	[string]	false	Given names (not always first). Includes middle names.	-
» prefix	[string]	false	The prefix of the name. Parts that come before the name.	-
» suffix	[string]	false	The suffix of the name. Parts that come after the name.	-
gender	object	false	Gender of the provider personnel.	-
» code	string	true	Code associated with the code.	-
» system	string	true	System associated with the code.	-
» display	string	false	Display of the code.	-
birthDate	string	false	The date on which the provider personnel was born, in ISO 8601 YYYY-MM-DD format.	-
communications	[object]	false	Language(s) the provider personnel can use in patient communication.	-
» code	object	true	Coded representation of the communication.	-
»» text	string	false	Text associated with the communication.	-
»» codings	[object]	false	Codings associated with the communication.	-
»»» code	string	true	Code associated with the code.	-
»»» system	string	true	System associated with the code.	-
»»» display	string	false	Display of the code.	-
photo	object	false	The image associated with the provider personnel.	-
» contentType	string	true	Content Type of the Photo.	IMAGE/JPG, IMAGE/JPEG, IMAGE/GIF, IMAGE/PNG
» url	string	true	Reference of the Photo.	-
» title	string	false	Name of the image.	-
telecoms	[object]	false	Contact details for the provider personnel that apply to all roles.	-
» system	string	true	System value of telecom.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
» value	string	true	Value of telecom.	-
» use	string	false	Use of telecom.	HOME, MOBILE, OLD, TEMP, WORK
» rank	integer(int32)	false	Ranking based on other provided telecoms. Must be a positive nonzero numeric value. Telecoms without a rank are considered equal to other un-ranked telecoms. Ranked telecoms fall in order above un-ranked telecoms.	-
addresses	[object]	false	Address(es) associated with the provider personnel that are not related to a Provider Role.	-
» use	string	false	The purpose of the address, for example, HOME or WORK.	BILLING, HOME, OLD, TEMP, WORK
» text	string	false	The fully-formatted address.	-
» lines	[string]	false	An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
» city	string	false	The name of the city, town, or village.	-
» state	string	false	The state or other subunit of a country.	-
» postalCode	string	false	The region defined by the postal service for this address.	-
» country	string	false	The nation specified for this address.	-
qualifications	[object]	false	Certification, licenses, or training pertaining to the provision of care that are associated with the provider personnel.	-
» identifier	string	false	Identifier of qualification.	-
» type	object	false	Type of qualification.	-
»» code	string	true	Code associated with the code.	-
»» system	string	true	System associated with the code.	-
»» display	string	false	Display of the code.	-
» text	string	true	Text associated with the qualification.	-
» code	object	false	Code associated with the qualification.	-
»» text	string	false	Text associated with the qualification code.	-
»» codings	[object]	false	Codings associated with the qualification code.	-
»»» code	string	true	Code associated with the code.	-
»»» system	string	true	System associated with the code.	-
»»» display	string	false	Display of the code.	-
» period	object	false	Period during which the qualification is valid.	-
»» start	string	false	Start date of period, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
»» end	string	false	End date of period, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
» reverificationDate	string	false	Date qualification needs to be reverified by, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DD.	-
» issuer	object	false	Issuer of qualification.	-
»» name	string	false	Name of issuer.	-
»» reference	string	false	Reference associated with the issuer.	-
aliases	[object]	false	Aliases of the provider personnel.	-
» system	string	true	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
» value	string	true	The unique ID of the alias in the context of the system or assigning authority.	-
» type	string	true	The type of alias.	NPI, TAX, EXTERNAL, OTHER, UNKNOWN
status	string	false	Indicates whether this provider personnel’s record is in active use.	ACTIVE, INACTIVE
link	object	false	The link to a separate Health Data Intelligence resource that has been identified as representing the same real-world entity as this Health Data Intelligence Provider Service resource.	-
» target	object	true	The link to a targeted personnel resource that must be used instead of the personnel resource that contains the link. See the personnel section on the Personnel API v1 page for more information.	-
»» id	string	true	The unique ID of the referenced target resource.	-
specialties	[object]	false	The specialties of the provider personnel member.	-
» specialtyId	string	true	The unique ID of the provider specialty.	-
» taxonomyId	string	true	The taxonomy ID of the provider specialty.	-
» isPrimary	boolean	true	Indicates whether a specialty is the primary specialty.	-
updatedBy	object	false	The individual who updated the provider personnel in the system	-
» id	string	true	The ID of the referenced entity.	-

ProviderPublicApi_Entities_V2_Providers_OrganizationDemographicTelecom

Name	Type	Required	Description	Accepted Values
system	string	true	The communication system that is required to use the contact details.	PHONE, EMAIL, FAX, SMS, URL, DIRECT, OTHER
value	string	true	The contact point details.	-
use	string	false	The purpose of this contact point.	-

ProviderPublicApi_Entities_V2_Providers_OrganizationSpecialtyTaxonomy

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider specialty.	-
name	string	true	The name of the specialty.	-
taxonomy	ProviderPublicApi_Entities_V2_Providers_Common_Taxonomy	true	The taxonomy of the provider specialty.	-
isPrimary	boolean	false	Indicates whether a specialty is the primary specialty.	-

ProviderPublicApi_Entities_V2_Providers_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