NAV Navbar
Logo cerner
Ruby Shell

Salesforce Integration API v1

HealtheCRM is a health care customer and provider relationship management solution that integrates HealtheIntent with Salesforce Health Cloud and Salesforce Marketing Cloud. HealtheCRM provides organizations with advanced capabilities to optimize patient and provider engagement, advance clinical quality and outcomes, and reduce the total cost of care. By integrating HealtheIntent data, longitudinal records, and intelligence solutions such as HealtheRegistries and HealtheCare into Salesforce, you can customize targeted and personalized patient and provider campaigns to achieve patient satisfaction and loyalty and improve the provider and patient experience.

The Salesforce Integration API enables you to configure the Salesforce environment and authorization details required to send HealtheIntent data to Salesforce for HealtheCRM, the groups of patients whose data is sent, and the types of data that are sent.

URL: https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1

Insight Definitions

The insight definition defines the criteria that is used to gather the patients and patient facts that are sent to Salesforce. The insight definition includes the configuration of groups and facts. Groups are the sets of patients who are sent to the Salesforce environment. Facts are the information that defines the types of data (for example, REGISTRY) that is sent to Salesforce about the group of patients.

The following facts can be defined:

Create an Insight Definition

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/salesforce-integration/v1/insight-definitions', headers: headers, body: {"description":"Medicare Advantage Gaps in Care Insights"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Medicare Advantage Gaps in Care Insights"}

Example response

{
  "id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
  "description": "Medicare Advantage Gaps in Care Insights",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions

Creates an insight definition.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Create an Insight Definition InsightDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Insight Definitions

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/salesforce-integration/v1/insight-definitions', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
      "description": "Medicare Advantage Gaps in Care Insights",
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions?offset=0&limit=20"
}

GET /insight-definitions

Retrieves a list of insight definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
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 Retrieve a List of Insight Definitions InsightDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update an Insight Definition

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63', headers: headers, body: {"description":"Medicare Advantage Gaps in Care Insights"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"description":"Medicare Advantage Gaps in Care Insights"}

Example response

{
  "id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
  "description": "Medicare Advantage Gaps in Care Insights",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}

Updates a single insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body putInsightDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Insight Definition InsightDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Retrieve a Single Insight Definition

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
  "description": "Medicare Advantage Gaps in Care Insights",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}

Retrieves a single insight definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Insight Definition InsightDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Groups

Groups are the sets of patients whose data is sent to the Salesforce environment.

Create a Group

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups', headers: headers, body: {"type":"COHORT","groupEntityId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"type":"COHORT","groupEntityId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "22e6fd75-a2cb-4c74-a657-28341bff8a42",
  "type": "COHORT",
  "groupEntityId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions/{insightDefinitionId}/groups

Creates a group for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body postInsightDefinitionsInsightdefinitionidGroups true N/A No description -

Response Statuses

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

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Groups

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "22e6fd75-a2cb-4c74-a657-28341bff8a42",
      "type": "COHORT",
      "groupEntityId": "testpopulation.programname.environment.group.name",
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/groups?offset=0&limit=20"
}

GET /insight-definitions/{insightDefinitionId}/groups

Retrieves a list of groups for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
type query string false N/A The type of group. COHORT
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 Retrieve a List of Groups Groups
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Group

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42', headers: headers, body: {"type":"COHORT","groupEntityId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"type":"COHORT","groupEntityId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "22e6fd75-a2cb-4c74-a657-28341bff8a42",
  "type": "COHORT",
  "groupEntityId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}/groups/{groupId}

Updates a single group for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
groupId path string true N/A The unique ID of the group. -
body body putInsightDefinitionsInsightdefinitionidGroups true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Group Group
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Remove a Group

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'

DELETE /insight-definitions/{insightDefinitionId}/groups/{groupId}

Removes a group from an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
groupId path string true N/A The unique ID of the group. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Group None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Group

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/groups/22e6fd75-a2cb-4c74-a657-28341bff8a42 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "22e6fd75-a2cb-4c74-a657-28341bff8a42",
  "type": "COHORT",
  "groupEntityId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}/groups/{groupId}

Retrieves a single group for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
groupId path string true N/A The unique ID of the group. -

Response Statuses

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

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Attribution Personnel Group Facts

An attribution personnel group fact specifies the personnel and attributed provider information that is sent to Salesforce for the insight definition group.

Create an Attribution Personnel Group Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts', headers: headers, body: {"personnelGroupId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"personnelGroupId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "e6933ad0-61c8-4330-b83b-22de8932fdfa",
  "personnelGroupId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions/{insightDefinitionId}/attribution-personnel-group-facts

Creates an attribution personnel group fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body postInsightDefinitionsInsightdefinitionidAttributionPersonnelGroupFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create an Attribution Personnel Group Fact AttributionPersonnelGroupFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Attribution Personnel Group Facts

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "e6933ad0-61c8-4330-b83b-22de8932fdfa",
      "personnelGroupId": "testpopulation.programname.environment.group.name",
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/attribution-personnel-group-facts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/attribution-personnel-group-facts?offset=0&limit=20"
}

GET /insight-definitions/{insightDefinitionId}/attribution-personnel-group-facts

Retrieves a list of attribution personnel group facts for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
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 Retrieve a List of Attribution Personnel Group Facts AttributionPersonnelGroupFacts
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update an Attribution Personnel Group Fact

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa', headers: headers, body: {"personnelGroupId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"personnelGroupId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "e6933ad0-61c8-4330-b83b-22de8932fdfa",
  "personnelGroupId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}/attribution-personnel-group-facts/{attributionPersonnelGroupFactId}

Updates a single attribution personnel group fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
attributionPersonnelGroupFactId path string true N/A The unique ID of an attribution personnel group fact. -
body body putInsightDefinitionsInsightdefinitionidAttributionPersonnelGroupFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Attribution Personnel Group Fact AttributionPersonnelGroupFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Remove an Attribution Personnel Group Fact

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'

DELETE /insight-definitions/{insightDefinitionId}/attribution-personnel-group-facts/{attributionPersonnelGroupFactId}

Removes an attribution personnel group fact from an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
attributionPersonnelGroupFactId path string true N/A The unique ID of an attribution personnel group fact. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove an Attribution Personnel Group Fact None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Attribution Personnel Group Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/attribution-personnel-group-facts/e6933ad0-61c8-4330-b83b-22de8932fdfa \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "e6933ad0-61c8-4330-b83b-22de8932fdfa",
  "personnelGroupId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}/attribution-personnel-group-facts/{attributionPersonnelGroupFactId}

Retrieves a single attribution personnel group fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
attributionPersonnelGroupFactId path string true N/A The unique ID of an attribution personnel group fact. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Attribution Personnel Group Fact AttributionPersonnelGroupFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Care Management Identification Facts

A care management identification fact specifies the care management information that is sent to Salesforce for the insight definition group.

Create a Care Management Identification Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts', headers: headers, body: {"programId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"programId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "1601148f-5c34-4b06-aaa6-d26f6127b12",
  "programId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions/{insightDefinitionId}/care-management-identification-facts

Creates a care management identification fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body postInsightDefinitionsInsightdefinitionidCareManagementIdentificationFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Care Management Identification Fact CareManagementIdentificationFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Care Management Identification Facts

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "1601148f-5c34-4b06-aaa6-d26f6127b12",
      "programId": "testpopulation.programname.environment.group.name",
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/care-management-identification-facts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/care-management-identification-facts?offset=0&limit=20"
}

GET /insight-definitions/{insightDefinitionId}/care-management-identification-facts

Retrieves a list of care management identification facts for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
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 Retrieve a List of Care Management Identification Facts CareManagementIdentificationFacts
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Care Management Identification Fact

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12', headers: headers, body: {"programId":"testpopulation.programname.environment.group.name"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"programId":"testpopulation.programname.environment.group.name"}

Example response

{
  "id": "1601148f-5c34-4b06-aaa6-d26f6127b12",
  "programId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}/care-management-identification-facts/{careManagementIdentificationFactId}

Updates a single care management identification fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
careManagementIdentificationFactId path string true N/A The unique ID of a care management identification fact. -
body body putInsightDefinitionsInsightdefinitionidCareManagementIdentificationFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Care Management Identification Fact CareManagementIdentificationFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Remove a Care Management Identification Fact

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'

DELETE /insight-definitions/{insightDefinitionId}/care-management-identification-facts/{careManagementIdentificationFactId}

Removes a care management identification fact from an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
careManagementIdentificationFactId path string true N/A The unique ID of a care management identification fact. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Care Management Identification Fact None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Care Management Identification Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/care-management-identification-facts/1601148f-5c34-4b06-aaa6-d26f6127b12 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "1601148f-5c34-4b06-aaa6-d26f6127b12",
  "programId": "testpopulation.programname.environment.group.name",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}/care-management-identification-facts/{careManagementIdentificationFactId}

Retrieves a single care management identification fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
careManagementIdentificationFactId path string true N/A The unique ID of a care management identification fact. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Care Management Identification Fact CareManagementIdentificationFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Episode of Care Facts

An episode of care fact specifies the information about interactions between the group’s personnel and patients that is sent to Salesforce.

Create an Episode of Care Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts', headers: headers, body: {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"],"contextVersion":"2"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"],"contextVersion":"2"}

Example response

{
  "id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
  "contextId": "testpopulation.programname.environment.group.name",
  "contextVersion": "2",
  "conceptAliases": [
    "testpopulation.programname.environment/contributorname"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions/{insightDefinitionId}/episode-of-care-facts

Creates an episode of care fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body postInsightDefinitionsInsightdefinitionidEpisodeOfCareFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create an Episode of Care Fact EpisodeOfCareFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Episode of Care Facts

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
      "contextId": "testpopulation.programname.environment.group.name",
      "contextVersion": "2",
      "conceptAliases": [
        "testpopulation.programname.environment/contributorname"
      ],
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/episode-of-care-facts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/episode-of-care-facts?offset=0&limit=20"
}

GET /insight-definitions/{insightDefinitionId}/episode-of-care-facts

Retrieves a list of episode of care facts for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
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 Retrieve a List of Episode of Care Facts EpisodeOfCareFacts
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update an Episode of Care Fact

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779', headers: headers, body: {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"],"contextVersion":"2"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"],"contextVersion":"2"}

Example response

{
  "id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
  "contextId": "testpopulation.programname.environment.group.name",
  "contextVersion": "2",
  "conceptAliases": [
    "testpopulation.programname.environment/contributorname"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}/episode-of-care-facts/{episodeOfCareFactId}

Updates a single episode of care fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
episodeOfCareFactId path string true N/A The unique ID of the episode of care fact. -
body body putInsightDefinitionsInsightdefinitionidEpisodeOfCareFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update an Episode of Care Fact EpisodeOfCareFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Remove an Episode of Care Fact

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'

DELETE /insight-definitions/{insightDefinitionId}/episode-of-care-facts/{episodeOfCareFactId}

Removes an episode of care fact from an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
episodeOfCareFactId path string true N/A The unique ID of the episode of care fact. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove an Episode of Care Fact None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Episode of Care Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/episode-of-care-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
  "contextId": "testpopulation.programname.environment.group.name",
  "contextVersion": "2",
  "conceptAliases": [
    "testpopulation.programname.environment/contributorname"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}/episode-of-care-facts/{episodeOfCareFactId}

Retrieves a single episode of care fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
episodeOfCareFactId path string true N/A The unique ID of the episode of care fact. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Episode of Care Fact EpisodeOfCareFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Registry Facts

A registry fact specifies the registry information that is sent to Salesforce for the insight definition group.

Create a Registry Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts', headers: headers, body: {"programId":"testpopulation.programname.environment.group.name","measureFqns":["testpopulation.programname.environment/testmeasure"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"programId":"testpopulation.programname.environment.group.name","measureFqns":["testpopulation.programname.environment/testmeasure"]}

Example response

{
  "id": "cf37ff97-992a-4f99-a491-8b2d34795d93",
  "programId": "testpopulation.programname.environment.group.name",
  "measureFqns": [
    "testpopulation.programname.environment/testmeasure"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /insight-definitions/{insightDefinitionId}/registry-facts

Creates a registry fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
body body postInsightDefinitionsInsightdefinitionidRegistryFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Create a Registry Fact RegistryFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Registry Facts

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "cf37ff97-992a-4f99-a491-8b2d34795d93",
      "programId": "testpopulation.programname.environment.group.name",
      "measureFqns": [
        "testpopulation.programname.environment/testmeasure"
      ],
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/registry-facts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/registry-facts?offset=0&limit=20"
}

GET /insight-definitions/{insightDefinitionId}/registry-facts

Retrieves a list of registry facts for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
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 Retrieve a List of Registry Facts RegistryFacts
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Registry Fact

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93', headers: headers, body: {"programId":"testpopulation.programname.environment.group.name","measureFqns":["testpopulation.programname.environment/testmeasure"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"programId":"testpopulation.programname.environment.group.name","measureFqns":["testpopulation.programname.environment/testmeasure"]}

Example response

{
  "id": "cf37ff97-992a-4f99-a491-8b2d34795d93",
  "programId": "testpopulation.programname.environment.group.name",
  "measureFqns": [
    "testpopulation.programname.environment/testmeasure"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /insight-definitions/{insightDefinitionId}/registry-facts/{registryFactId}

Updates a single registry fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
registryFactId path string true N/A The unique ID of a registry fact. -
body body putInsightDefinitionsInsightdefinitionidRegistryFacts true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Registry Fact RegistryFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Remove a Registry Fact

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'

DELETE /insight-definitions/{insightDefinitionId}/registry-facts/{registryFactId}

Removes a registry fact from an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
insightDefinitionId path string true N/A The unique ID of an insight definition. -
registryFactId path string true N/A The unique ID of a registry fact. -

Response Statuses

Status Meaning Description Schema
204 No Content Remove a Registry Fact None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Retrieve a Single Registry Fact

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/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/registry-facts/cf37ff97-992a-4f99-a491-8b2d34795d93 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "cf37ff97-992a-4f99-a491-8b2d34795d93",
  "programId": "testpopulation.programname.environment.group.name",
  "measureFqns": [
    "testpopulation.programname.environment/testmeasure"
  ],
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /insight-definitions/{insightDefinitionId}/registry-facts/{registryFactId}

Retrieves a single registry fact for an insight definition.

Parameters

Parameter In Type Required Default Description Accepted Values
insightDefinitionId path string true N/A The unique ID of an insight definition. -
registryFactId path string true N/A The unique ID of a registry fact. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Registry Fact RegistryFact
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Salesforce Definitions

A Salesforce definition is the information that defines a Salesforce connection. The definition allows you to define specific information about a Salesforce organization and enable the HealtheIntent service to communicate with the Salesforce organization.

The following information is configured in the Salesforce definition:

Create a Salesforce Definition

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/salesforce-integration/v1/salesforce-definitions', headers: headers, body: {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}

Example response

{
  "id": "60142b13-b016-4523-bac4-af71953df412",
  "environmentDescription": "Cerner",
  "personModel": "PERSON",
  "authUrl": "https://login.salesforce.com",
  "consumerSecret": "1955279925675241571",
  "consumerKey": "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE",
  "refreshToken": "NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

POST /salesforce-definitions

Creates a Salesforce definition.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Create a Salesforce Definition SalesforceDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 ETag string The ETag of a specific version of the resource.

Retrieve a List of Salesforce Definitions

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/salesforce-integration/v1/salesforce-definitions', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "60142b13-b016-4523-bac4-af71953df412",
      "environmentDescription": "Cerner",
      "personModel": "PERSON",
      "authUrl": "https://login.salesforce.com",
      "consumerSecret": "1955279925675241571",
      "consumerKey": "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE",
      "refreshToken": "NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4",
      "version": "2",
      "createdAt": "2019-04-25T17:03:14.120Z",
      "updatedAt": "2019-04-25T17:03:14.120Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions?offset=0&limit=20"
}

GET /salesforce-definitions

Retrieves a list of Salesforce definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
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 Retrieve a List of Salesforce Definitions SalesforceDefinitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Salesforce Definition

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'If-Match' => {
  "type": "string"
}
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions/60142b13-b016-4523-bac4-af71953df412', headers: headers, body: {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions/60142b13-b016-4523-bac4-af71953df412 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}

Example response

{
  "id": "60142b13-b016-4523-bac4-af71953df412",
  "environmentDescription": "Cerner",
  "personModel": "PERSON",
  "authUrl": "https://login.salesforce.com",
  "consumerSecret": "1955279925675241571",
  "consumerKey": "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE",
  "refreshToken": "NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

PUT /salesforce-definitions/{salesforceDefinitionId}

Updates a single Salesforce definition.

Parameters

Parameter In Type Required Default Description Accepted Values
If-Match header string true N/A The ETag of a specific version of a resource to match against. -
salesforceDefinitionId path string true N/A The unique ID of a Salesforce definition. -
body body putSalesforceDefinitions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Update a Salesforce Definition SalesforceDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
412 Precondition Failed Precondition Failed Error
428 Precondition Required Precondition Required Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Retrieve a Single Salesforce Definition

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/salesforce-integration/v1/salesforce-definitions/60142b13-b016-4523-bac4-af71953df412', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/salesforce-integration/v1/salesforce-definitions/60142b13-b016-4523-bac4-af71953df412 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "60142b13-b016-4523-bac4-af71953df412",
  "environmentDescription": "Cerner",
  "personModel": "PERSON",
  "authUrl": "https://login.salesforce.com",
  "consumerSecret": "1955279925675241571",
  "consumerKey": "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE",
  "refreshToken": "NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4",
  "version": "2",
  "createdAt": "2019-04-25T17:03:14.120Z",
  "updatedAt": "2019-04-25T17:03:14.120Z"
}

GET /salesforce-definitions/{salesforceDefinitionId}

Retrieves a single Salesforce definition by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
salesforceDefinitionId path string true N/A The ID of the Salesforce definition. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieve a Single Salesforce Definition SalesforceDefinition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
200 ETag string The ETag of a specific version of the resource.

Schema Definitions

postInsightDefinitions

Name Type Required Description Accepted Values
description string true A description of what the insight definition represents. -

InsightDefinition

Name Type Required Description Accepted Values
id string true The unique ID of an insight definition. -
description string true A description of what the insight definition represents. -
version integer(int32) true The current version of the insight definition. -
createdAt string true The date and time when the insight definition was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the insight definition is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the insight definition was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the insight definition is modified; therefore, the field does not need to be set explicitly. -

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

InsightDefinitions

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

putInsightDefinitions

Name Type Required Description Accepted Values
description string true A description of what the insight definition represents. -

postInsightDefinitionsInsightdefinitionidGroups

Name Type Required Description Accepted Values
type string true The type of group, for example, COHORT. -
groupEntityId string true The unique ID of the group of people that is sent to the Salesforce environment. -

Group

Name Type Required Description Accepted Values
id string true The unique ID of the group. -
type string true The type of group, for example, COHORT. COHORT
groupEntityId string true The unique ID of the group of people that is sent to the Salesforce environment. -
version integer(int32) true The current version of the group. -
createdAt string true The date and time when the group was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the group is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the group was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the group is modified; therefore, the field does not need to be set explicitly. -

Groups

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

putInsightDefinitionsInsightdefinitionidGroups

Name Type Required Description Accepted Values
type string true The type of group, for example, COHORT. -
groupEntityId string true The unique ID of the group of people that is sent to the Salesforce environment. -

postInsightDefinitionsInsightdefinitionidAttributionPersonnelGroupFacts

Name Type Required Description Accepted Values
personnelGroupId string true The unique ID of a personnel group. -

AttributionPersonnelGroupFact

Name Type Required Description Accepted Values
id string true The unique ID of an attribution personnel group fact. -
personnelGroupId string true The unique ID of a personnel group. -
version integer(int32) true The current version of the attribution personnel group fact. -
createdAt string true The date and time when the attribution personnel group fact was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the attribution personnel group fact is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the attribution personnel group fact was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the attribution personnel group fact is modified; therefore, the field does not need to be set explicitly. -

AttributionPersonnelGroupFacts

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

putInsightDefinitionsInsightdefinitionidAttributionPersonnelGroupFacts

Name Type Required Description Accepted Values
personnelGroupId string true The unique ID of a personnel group. -

postInsightDefinitionsInsightdefinitionidCareManagementIdentificationFacts

Name Type Required Description Accepted Values
programId string true The ID of the care management program. -

CareManagementIdentificationFact

Name Type Required Description Accepted Values
id string true The unique ID of a care management identification fact. -
programId string true The ID of the care management program. -
version integer(int32) true The current version of the care management identification fact. -
createdAt string true The date and time when the care management identification fact was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the care management identification fact is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the care management identification fact was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the care management identification fact is modified; therefore, the field does not need to be set explicitly. -

CareManagementIdentificationFacts

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

putInsightDefinitionsInsightdefinitionidCareManagementIdentificationFacts

Name Type Required Description Accepted Values
programId string true The ID of the care management program. -

postInsightDefinitionsInsightdefinitionidEpisodeOfCareFacts

Name Type Required Description Accepted Values
contextId string true The unique ID of an ontology context. -
conceptAliases [string] true The IDs of a group of codes from various terminologies that have similar semantic meanings. -
contextVersion integer(int32) false The current version of the context. -

EpisodeOfCareFact

Name Type Required Description Accepted Values
id string true The unique ID of the episode of care fact. -
contextId string true The unique ID of an ontology context. -
contextVersion integer(int32) false The current version of the context. -
conceptAliases [string] true No description -
version integer(int32) true The current version of the episode of care fact. -
createdAt string true The date and time when the episode of care fact was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the episode of care fact is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the episode of care fact was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the episode of care fact is modified; therefore, the field does not need to be set explicitly. -

EpisodeOfCareFacts

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

putInsightDefinitionsInsightdefinitionidEpisodeOfCareFacts

Name Type Required Description Accepted Values
contextId string true The unique ID of an ontology context. -
conceptAliases [string] true The IDs of a group of codes from various terminologies that have similar semantic meanings. -
contextVersion integer(int32) false The current version of the context. -

postInsightDefinitionsInsightdefinitionidRegistryFacts

Name Type Required Description Accepted Values
programId string true The ID of the registry program. -
measureFqns [string] true The measure fully qualified names associated with the registry. -

RegistryFact

Name Type Required Description Accepted Values
id string true The unique ID of a registry fact. -
programId string true The ID of the registry program. -
measureFqns [string] true The measure fully qualified names associated with the registry. -
version integer(int32) true The current version of the registry fact. -
createdAt string true The date and time when the registry fact was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the registry fact is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the registry fact was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the registry fact is modified; therefore, the field does not need to be set explicitly. -

RegistryFacts

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

putInsightDefinitionsInsightdefinitionidRegistryFacts

Name Type Required Description Accepted Values
programId string true The ID of the registry program. -
measureFqns [string] true The measure fully qualified names associated with the registry. -

postSalesforceDefinitions

Name Type Required Description Accepted Values
refreshToken string true The Salesforce refresh token used to create a new access token if it expires. -
environmentDescription string true A description that identifies the Salesforce environment for this Salesforce definition. -
personModel string true The model that represents a person in a specified Salesforce environment. This can be either PERSON or INDIVIDUAL -
consumerKey string true The consumer key from the Salesforce Connected App definition. The key is used with the consumerSecret value to get authorization using an access token from the authUrl. -
consumerSecret string true The consumer secret from the Salesforce Connected App definition. The secret is used with the consumerKey value to get authorization using an access token from the authUrl. -
authUrl string true The URL to which the POST request is sent to create the Salesforce access token. -

SalesforceDefinition

Name Type Required Description Accepted Values
id string true The unique ID of a Salesforce definition. -
environmentDescription string true No description -
personModel string true The model that represents a person in a specified Salesforce environment. This can be either PERSON or INDIVIDUAL -
authUrl string true The URL to which the POST request is sent to create the Salesforce access token. -
consumerSecret integer(int32) true The consumer key from the Salesforce Connected App definition. The key is used with the consumerSecret value to get authorization using an access token from the authUrl. -
consumerKey string true The consumer secret from the Salesforce Connected App definition. The secret is used with the consumerKey value to get authorization using an access token from the authUrl. -
refreshToken string true The Salesforce refresh token used to create a new access token if it expires. -
version integer(int32) true The current version of the Salesforce definition. -
createdAt string true The date and time when the Salesforce definition was initially entered into the system. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T20:41:18.181Z. The time in this field is set automatically when the Salesforce definition is first created; therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the Salesforce definition was last modified. In ISO 8601 formatting with precision ranging up to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2019-04-25T17:03:14.120Z. The time in this field is set automatically every time the Salesforce definition is modified; therefore, the field does not need to be set explicitly. -

SalesforceDefinitions

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

putSalesforceDefinitions

Name Type Required Description Accepted Values
refreshToken string true The Salesforce refresh token used to create a new access token if it expires. -
environmentDescription string true A description that identifies the Salesforce environment for this Salesforce definition. -
personModel string true The model that represents a person in a specified Salesforce environment. This can be either PERSON or INDIVIDUAL -
consumerKey string true The consumer key from the Salesforce Connected App definition. The key is used with the consumerSecret value to get authorization using an access token from the authUrl. -
consumerSecret string true The consumer secret from the Salesforce Connected App definition. The secret is used with the consumerKey value to get authorization using an access token from the authUrl. -
authUrl string true The URL to which the POST request is sent to create the Salesforce access token. -