NAV Navbar
Logo cerner
Ruby Shell

Healthcare Service API v1

The Healthcare Service API allows you to retrieve and manage the set of health care services that can be used in your health care system. Health care services describe procedures that are performed by a health care practitioner on a person for the purpose of diagnosing or treating a disease, injury, or other illness. Health care services, categories, and types are especially useful for referral management, orders processing, and scheduling systems.

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

You can define the health care service types that are available for your organizations. You also can define a hierarchy of service categories and subcategories to narrow these classifications as needed. Once you define service types and service categories, health care service instances can be defined to assign these entities to specific locations in the context of a providing organization. Optionally, a specialty also can be assigned to each health care service instance. Each service type must be part of a service category.

See the following examples of types:

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

Once service types and service categories are defined, the health care service instances may be defined to assign these entities to specific locations within the context of a providing organization. Optionally, a specialty also may be assigned to each health care service instance as deemed appropriate.

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

URL: https://cernerdemo.api.us.healtheintent.com/healthcare-service/v1

Service Categories

Service categories classify groupings of service types that can be delivered or performed.

Create a Service Category

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

POST /service-categories

Creates a service category.

Parameters

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

Response Statuses

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

Retrieve a List of Service Categories

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /service-categories

Retrieves a list of service categories.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The service category IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name of the service category. Filtering by a partial match is allowed. -
parentId query string false N/A The parent category ID. If the value is zero, the response includes all service categories at the root level. Otherwise, the API retrieves all immediate child service categories for the specified parent ID (with one level of depth). If no value is provided, the API retrieves categories at all levels. -
status query string false N/A The status of the health care service category. ACTIVE, INACTIVE
offset query integer(int32) false N/A Indicates the starting index of the paginated collection. -
limit query integer(int32) false 20 Indicates the number of results returned in a single page. The value set must be between 1 and 100. -
orderBy query string false name 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

Update a Service Category

Example Request:




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

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

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

print JSON.pretty_generate(result)




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

PUT /service-categories/{serviceCategoryId}

Updates a service category.

Parameters

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

Response Statuses

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

Retrieve a Single Service Category

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /service-categories/{serviceCategoryId}

Retrieve a single service category.

Parameters

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

Response Statuses

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

Service Types

Service types are the specific kinds of services that can be delivered or performed.

Create a Service Type

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-types', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




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

POST /service-types

Creates a service type.

Parameters

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

Response Statuses

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

Retrieve a List of Service Types

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /service-types

Retrieves a list of service types.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The service type IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name of the service type. Filtering by a partial match is allowed. -
serviceCategoryId query string false N/A Filters by service type definitions associated with the specifiedservice category ID. -
status query string false N/A The status of the service type. ACTIVE, INACTIVE
offset query integer(int32) false N/A Indicates the starting index of the paginated collection. -
limit query integer(int32) false 20 Indicates the number of results returned in a single page. The value set must be between 1 and 100. -
orderBy query string false name 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

Update a Service Type

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/service-types/2f4df666deae11e7a3d646705f8c9e77', headers: headers, body: {"name":"Electrocardiograph (ECG/EKG)","description":"Instrument for recording the electrical activity of the heart ECG.","status":"ACTIVE","category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




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

PUT /service-types/{serviceTypeId}

Updates a service type.

Parameters

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

Response Statuses

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

Retrieve a Single Service Type

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /service-types/{serviceTypeId}

Retrieves a single service type.

Parameters

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

Response Statuses

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

Health Care Services

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

Create a Health Care Service

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/healthcare-services', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




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

POST /healthcare-services

Creates a health care service.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a list of Health Care Services

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /healthcare-services

Retrieves a list of health care services.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A The health care service IDs to filter by. If you specify the ids parameter, the other query parameters are ignored. -
name query string false N/A The name or partial name of the health care service. -
categoryId query string false N/A The service category ID for which the health care service details are defined. -
providedAt query string false N/A The location where the service can be provided. -
providedBy query string false N/A The organization that provides this service. -
specialtyId query string false N/A The unique ID of the specialty that is handled by the health care service. -
status query string false N/A The status of the health care service. ACTIVE, INACTIVE
typeId query string false N/A The service type ID for which the health care service details are defined. -
offset query integer(int32) false N/A Indicates the starting index of the paginated collection. -
limit query integer(int32) false 20 Indicates the number of results returned in a single page. The value set must be between 1 and 100. -
orderBy query string false name 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

Update a Health Care Service

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healthcare-service/v1/healthcare-services/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Ped Cardiology Consult","description":"Ped Cardiology Consult","status":"ACTIVE","type":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"category":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"providedBy":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"},"providedAt":{"id":"d2874990f21d11e7a3d646705f8c9e77"},"specialties":{"id":"4a3a2f3edeae11e7a3d646705f8c9e77"}}.to_json )

print JSON.pretty_generate(result)




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

PUT /healthcare-services/{serviceId}

Updates a health care service.

Parameters

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

Response Statuses

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

Retrieve a single Health Care Service

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

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

GET /healthcare-services/{serviceId}

Retrieves a single health care service.

Parameters

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

Response Statuses

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

Schema Definitions

postServiceCategories

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

Error

Name Type Required Description Accepted Values
code integer(int32) true Http response status code representing the error. -
message string true Human readable description of the error. -
errorDetails [ErrorDetail] false List of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false Codified value representing the specific error resulting in the current error status. -
message string false Human readable description of an error. -
locationType string false Location or type of the field that caused an error. query, header, path, formData, body
location string false Name of the field that caused an error. -

ServiceCategories

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

ServiceCategory

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

Type

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

Category

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

putServiceCategories

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

postServiceTypes

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

ServiceTypes

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

ServiceType

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

putServiceTypes

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

postHealthcareServices

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

HealthcareServices

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

HealthcareService

Name Type Required Description Accepted Values
id string false The unique ID of the healthcare service. -
name string false The name of the healthcare service. -
description string false The description of the healthcare service. -
providedBy Organization false No description -
providedAt [Location] false The locations where the healthcare service is provided. -
specialties [Specialty] false The specialty associated with the healthcare service. -
type Type false No description -
category Category false No description -
status string false The current state of the healthcare service. ACTIVE, INACTIVE
createdAt string false The create date of the healthcare service. -
updatedAt string false The modify date of the healthcare service. -

Organization

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

Location

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

Specialty

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

putHealthcareServices

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