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-1.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:
- Appointment Status
- Attribution Personnel Group
- Care Management Identification
- Condition
- Encounter Type
- Episodes of Care
- HCC Outcome
- HCC RAF Score
- Health Plan
- Medication
- Organization
- Patient Alias
- Registry
- Risk Assessment
- Salesforce Data Partition
- Source Data Partition
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-1.healtheintent.com/salesforce-integration/v1/insight-definitions', headers: headers, body: {"description":"Medicare Advantage Gaps in Care Insights","settings":{"encounterLookBackDays":20,"appointmentLookBackDays":25,"appointmentLookForwardDays":15,"deceasedPatientLookBackDays":30,"conditionLookBackDays":365,"medicationLookBackDays":365,"enableEncounterParticipants":true}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","settings":{"encounterLookBackDays":20,"appointmentLookBackDays":25,"appointmentLookForwardDays":15,"deceasedPatientLookBackDays":30,"conditionLookBackDays":365,"medicationLookBackDays":365,"enableEncounterParticipants":true}}
Example response
{
"id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
"description": "Medicare Advantage Gaps in Care Insights",
"settings": {
"encounterLookBackDays": 20,
"appointmentLookBackDays": 25,
"appointmentLookForwardDays": 15,
"deceasedPatientLookBackDays": 30,
"conditionLookBackDays": 365,
"medicationLookBackDays": 365,
"enableEncounterParticipants": true
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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",
"settings": {
"encounterLookBackDays": 20,
"appointmentLookBackDays": 25,
"appointmentLookForwardDays": 15,
"deceasedPatientLookBackDays": 30,
"conditionLookBackDays": 365,
"medicationLookBackDays": 365,
"enableEncounterParticipants": true
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63', headers: headers, body: {"description":"Medicare Advantage Gaps in Care Insights","settings":{"encounterLookBackDays":20,"appointmentLookBackDays":25,"appointmentLookForwardDays":15,"deceasedPatientLookBackDays":30,"conditionLookBackDays":365,"medicationLookBackDays":365,"enableEncounterParticipants":true}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.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","settings":{"encounterLookBackDays":20,"appointmentLookBackDays":25,"appointmentLookForwardDays":15,"deceasedPatientLookBackDays":30,"conditionLookBackDays":365,"medicationLookBackDays":365,"enableEncounterParticipants":true}}
Example response
{
"id": "12d23cb1-41f5-43e3-9583-9068d7d7df63",
"description": "Medicare Advantage Gaps in Care Insights",
"settings": {
"encounterLookBackDays": 20,
"appointmentLookBackDays": 25,
"appointmentLookForwardDays": 15,
"deceasedPatientLookBackDays": 30,
"conditionLookBackDays": 365,
"medicationLookBackDays": 365,
"enableEncounterParticipants": true
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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",
"settings": {
"encounterLookBackDays": 20,
"appointmentLookBackDays": 25,
"appointmentLookForwardDays": 15,
"deceasedPatientLookBackDays": 30,
"conditionLookBackDays": 365,
"medicationLookBackDays": 365,
"enableEncounterParticipants": true
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/groups?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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. |
Appointment Status Facts
An appointment status fact specifies the appointments that are sent to Salesforce for the insight definition group.
Create an Appointment Status 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-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-eba6367ea796",
"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}/appointment-status-facts
Creates an appointment status fact for an insight definition. One fact cannot have duplicate concept aliases.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
insightDefinitionId | path | string | true | N/A | The unique ID of an insight definition. | - |
body | body | postInsightDefinitionsInsightdefinitionidAppointmentStatusFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create an Appointment Status Fact | SalesforceIntegrationPublicApi_Entities_V1_AppointmentStatusFact |
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 Appointment Status 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea796",
"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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/appointment-status-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/appointment-status-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/appointment-status-facts
Retrieves a list of appointment status 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 Appointment Status Facts | AppointmentStatusFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update an Appointment Status 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796', 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796 \
-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-eba6367ea796",
"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}/appointment-status-facts/{appointmentStatusFactId}
Updates a single appointment status 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. | - |
appointmentStatusFactId | path | string | true | N/A | The unique ID of the appointment status fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidAppointmentStatusFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update an Appointment Status Fact | SalesforceIntegrationPublicApi_Entities_V1_AppointmentStatusFact |
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 Appointment Status 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/appointment-status-facts/{appointmentStatusFactId}
Removes an appointment status 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. | - |
appointmentStatusFactId | path | string | true | N/A | The unique ID of the appointment status fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove an Appointment Status 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 Appointment Status 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/appointment-status-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea796 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea796",
"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}/appointment-status-facts/{appointmentStatusFactId}
Retrieves a single appointment status 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. | - |
appointmentStatusFactId | path | string | true | N/A | The unique ID of the appointment status fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Appointment Status Fact | SalesforceIntegrationPublicApi_Entities_V1_AppointmentStatusFact |
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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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. |
Condition Facts
A condition fact specifies the condition information that is sent to Salesforce for the insight definition group.
Create a Condition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts', headers: headers, body: {"dataPartitionIds":["41237482-9173-4719-4712-576398531687","81736284-9018-3741-5321-726948271341"],"condition":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]},"type":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["INFLUENZA_VACCINATION_STATUS_OBSTYPE"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"dataPartitionIds":["41237482-9173-4719-4712-576398531687","81736284-9018-3741-5321-726948271341"],"condition":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]},"type":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["INFLUENZA_VACCINATION_STATUS_OBSTYPE"]}}
Example response
{
"id": "7d73a817-d1d8-58e7-96a8-71c39a72e381",
"dataPartitionIds": [
"41237482-9173-4719-4712-576398531687",
"81736284-9018-3741-5321-726948271341"
],
"condition": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"type": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"INFLUENZA_VACCINATION_STATUS_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/condition-facts
Creates a condition 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 | postInsightDefinitionsInsightdefinitionidConditionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Condition Fact | SalesforceIntegrationPublicApi_Entities_V1_ConditionFact |
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 Condition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "7d73a817-d1d8-58e7-96a8-71c39a72e381",
"dataPartitionIds": [
"41237482-9173-4719-4712-576398531687",
"81736284-9018-3741-5321-726948271341"
],
"condition": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"type": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"INFLUENZA_VACCINATION_STATUS_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/condition-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/condition-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/condition-facts
Retrieves a list of condition 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 Condition Facts | ConditionFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Condition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381', headers: headers, body: {"dataPartitionIds":["41237482-9173-4719-4712-576398531687","81736284-9018-3741-5321-726948271341"],"condition":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]},"type":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["INFLUENZA_VACCINATION_STATUS_OBSTYPE"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"dataPartitionIds":["41237482-9173-4719-4712-576398531687","81736284-9018-3741-5321-726948271341"],"condition":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]},"type":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["INFLUENZA_VACCINATION_STATUS_OBSTYPE"]}}
Example response
{
"id": "7d73a817-d1d8-58e7-96a8-71c39a72e381",
"dataPartitionIds": [
"41237482-9173-4719-4712-576398531687",
"81736284-9018-3741-5321-726948271341"
],
"condition": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"type": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"INFLUENZA_VACCINATION_STATUS_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/condition-facts/{conditionFactId}
Updates a single condition 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. | - |
conditionFactId | path | string | true | N/A | The unique ID of the condition fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidConditionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Condition Fact | SalesforceIntegrationPublicApi_Entities_V1_ConditionFact |
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 Condition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/condition-facts/{conditionFactId}
Removes a condition 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. | - |
conditionFactId | path | string | true | N/A | The unique ID of the condition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Condition 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 Condition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/condition-facts/7d73a817-d1d8-58e7-96a8-71c39a72e381 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "7d73a817-d1d8-58e7-96a8-71c39a72e381",
"dataPartitionIds": [
"41237482-9173-4719-4712-576398531687",
"81736284-9018-3741-5321-726948271341"
],
"condition": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"type": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"INFLUENZA_VACCINATION_STATUS_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/condition-facts/{conditionFactId}
Retrieves a single condition 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. | - |
conditionFactId | path | string | true | N/A | The unique ID of the condition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Condition Fact | SalesforceIntegrationPublicApi_Entities_V1_ConditionFact |
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. |
Medication Facts
A medication fact specifies the medication information that is sent to Salesforce for the insight definition group.
Create a Medication 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts', headers: headers, body: {"medication":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"medication":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]}}
Example response
{
"id": "e2595092-b7b8-4e2d-a8ec-4be62ca08bae",
"medication": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/medication-facts
Creates a medication 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 | postInsightDefinitionsInsightdefinitionidMedicationFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Medication Fact | SalesforceIntegrationPublicApi_Entities_V1_MedicationFact |
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 Medication 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "e2595092-b7b8-4e2d-a8ec-4be62ca08bae",
"medication": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/e2595092-b7b8-4e2d-a8ec-4be62ca08bae/medication-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/e2595092-b7b8-4e2d-a8ec-4be62ca08bae/medication-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/medication-facts
Retrieves a list of medication 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 Medication Facts | MedicationFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Medication 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae', headers: headers, body: {"medication":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"medication":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["BRAIN_CANCER_CLIN","HOSPICE_CARE_CLIN"]},"status":{"contextId":"42a8a353-69bf-4c72-99f8-cf859bff7656","conceptAliases":["ACTIVE_QUAL"]}}
Example response
{
"id": "e2595092-b7b8-4e2d-a8ec-4be62ca08bae",
"medication": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/medication-facts/{medicationFactId}
Updates a single medication 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. | - |
medicationFactId | path | string | true | N/A | The unique ID of the medication fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidMedicationFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Medication Fact | SalesforceIntegrationPublicApi_Entities_V1_MedicationFact |
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 Medication 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/medication-facts/{medicationFactId}
Removes a medication 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. | - |
medicationFactId | path | string | true | N/A | The unique ID of the medication fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Medication 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 Medication 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/medication-facts/e2595092-b7b8-4e2d-a8ec-4be62ca08bae \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "e2595092-b7b8-4e2d-a8ec-4be62ca08bae",
"medication": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"BRAIN_CANCER_CLIN",
"HOSPICE_CARE_CLIN"
]
},
"status": {
"contextId": "42a8a353-69bf-4c72-99f8-cf859bff7656",
"conceptAliases": [
"ACTIVE_QUAL"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/medication-facts/{medicationFactId}
Retrieves a single medication 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. | - |
medicationFactId | path | string | true | N/A | The unique ID of the medication fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Medication Fact | SalesforceIntegrationPublicApi_Entities_V1_MedicationFact |
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. |
Encounter Type Facts
An encounter type fact specifies the encounter information that is sent to Salesforce for the insight definition group.
Create an Encounter Type 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-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-eba6367ea780",
"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}/encounter-type-facts
Creates an encounter type 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 | postInsightDefinitionsInsightdefinitionidEncounterTypeFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create an Encounter Type Fact | SalesforceIntegrationPublicApi_Entities_V1_EncounterTypeFact |
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 Encounter Type 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea780",
"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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/encounter-type-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/encounter-type-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/encounter-type-facts
Retrieves a list of encounter type 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 Encounter Type Facts | EncounterTypeFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update an Encounter Type 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780', 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780 \
-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-eba6367ea780",
"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}/encounter-type-facts/{encounterTypeFactId}
Updates a single encounter type 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. | - |
encounterTypeFactId | path | string | true | N/A | The unique ID of the encounter type fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidEncounterTypeFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update an Encounter Type Fact | SalesforceIntegrationPublicApi_Entities_V1_EncounterTypeFact |
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 Encounter Type 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/encounter-type-facts/{encounterTypeFactId}
Removes an encounter type 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. | - |
encounterTypeFactId | path | string | true | N/A | The unique ID of the encounter type fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove an Encounter Type 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 Encounter Type 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/encounter-type-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea780 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea780",
"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}/encounter-type-facts/{encounterTypeFactId}
Retrieves a single encounter type 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. | - |
encounterTypeFactId | path | string | true | N/A | The unique ID of the encounter type fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Encounter Type Fact | SalesforceIntegrationPublicApi_Entities_V1_EncounterTypeFact |
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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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. |
HCC Outcome Facts
An HCC outcome fact specifies the HCC outcome information that is sent to Salesforce for the insight definition group.
Create an HCC Outcome Fact
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "632487dd-4568-41e4-b82c-ff7ca6d03c1d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/hcc-outcome-facts
Creates an HCC outcome 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. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create an HCC Outcome Fact | SalesforceIntegrationPublicApi_Entities_V1_HccOutcomeFact |
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 HCC Outcome 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "632487dd-4568-41e4-b82c-ff7ca6d03c1d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/hcc-outcome-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/hcc-outcome-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/hcc-outcome-facts
Retrieves a list of HCC outcome 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 HCC Outcome Facts | HccOutcomeFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Remove an HCC Outcome 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts/632487dd-4568-41e4-b82c-ff7ca6d03c1d', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts/632487dd-4568-41e4-b82c-ff7ca6d03c1d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/hcc-outcome-facts/{hccOutcomeFactId}
Removes an HCC outcome 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. | - |
hccOutcomeFactId | path | string | true | N/A | The unique ID of the HCC outcome fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove an HCC Outcome 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 HCC Outcome 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts/632487dd-4568-41e4-b82c-ff7ca6d03c1d', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-outcome-facts/632487dd-4568-41e4-b82c-ff7ca6d03c1d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "632487dd-4568-41e4-b82c-ff7ca6d03c1d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/hcc-outcome-facts/{hccOutcomeFactId}
Retrieves a single HCC Outcome 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. | - |
hccOutcomeFactId | path | string | true | N/A | The unique ID of the HCC outcome fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single HCC Outcome Fact | SalesforceIntegrationPublicApi_Entities_V1_HccOutcomeFact |
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. |
HCC RAF Score Facts
An HCC RAF score fact specifies the HCC RAF information that is sent to Salesforce for the insight definition group.
Create an HCC RAF Score 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
Example response
{
"id": "23da78f5-0cdb-4f50-88c0-b3affb81bb49",
"riskAdjustmentModelType": [
"CMS_HCC",
"ESRD_HCC"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/hcc-raf-score-facts
Creates an HCC RAF score 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 | postInsightDefinitionsInsightdefinitionidHccRafScoreFactsRiskadjustmentmodeltype | true | N/A | The type of the risk adjustment model. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create an HCC RAF Score Fact | SalesforceIntegrationPublicApi_Entities_V1_HccRafScoreFact |
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 HCC RAF Score 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "23da78f5-0cdb-4f50-88c0-b3affb81bb49",
"riskAdjustmentModelType": [
"CMS_HCC",
"ESRD_HCC"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/23da78f5-0cdb-4f50-88c0-b3affb81bb49/hcc-raf-score-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/23da78f5-0cdb-4f50-88c0-b3affb81bb49/hcc-raf-score-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/hcc-raf-score-facts
Retrieves a list of HCC RAF score 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 HCC RAF Score Facts | HccRafScoreFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update an HCC RAF Score 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
Example response
{
"id": "23da78f5-0cdb-4f50-88c0-b3affb81bb49",
"riskAdjustmentModelType": [
"CMS_HCC",
"ESRD_HCC"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/hcc-raf-score-facts/{hccRafScoreFactId}
Updates a single HCC RAF score 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. | - |
hccRafScoreFactId | path | string | true | N/A | The unique ID of the HCC RAF score fact. | - |
body | body | postInsightDefinitionsInsightdefinitionidHccRafScoreFactsRiskadjustmentmodeltype | true | N/A | The type of the risk adjustment model. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update an HCC RAF Score Fact | SalesforceIntegrationPublicApi_Entities_V1_HccRafScoreFact |
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 HCC RAF Score 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/hcc-raf-score-facts/{hccRafScoreFactId}
Removes an HCC RAF score 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. | - |
hccRafScoreFactId | path | string | true | N/A | The unique ID of the HCC RAF score fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove an HCC RAF Score 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 HCC RAF Score 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/hcc-raf-score-facts/23da78f5-0cdb-4f50-88c0-b3affb81bb49 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "23da78f5-0cdb-4f50-88c0-b3affb81bb49",
"riskAdjustmentModelType": [
"CMS_HCC",
"ESRD_HCC"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/hcc-raf-score-facts/{hccRafScoreFactId}
Retrieves a single HCC RAF score 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. | - |
hccRafScoreFactId | path | string | true | N/A | The unique ID of the HCC RAF score fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single HCC RAF Score Fact | SalesforceIntegrationPublicApi_Entities_V1_HccRafScoreFact |
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. |
Health Plan Facts
A health plan fact specifies the health plan information that is sent to Salesforce for the insight definition group.
Create a Health Plan 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts', headers: headers, body: {"benefitSourceType":"testpopulation.programname.environment.group.name"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"benefitSourceType":"testpopulation.programname.environment.group.name"}
Example response
{
"id": "4c260093-3c0e-47b2-9454-59eb8b2cb47f",
"benefitSourceType": "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}/health-plan-facts
Creates a health plan 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 | postInsightDefinitionsInsightdefinitionidHealthPlanFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Health Plan Fact | SalesforceIntegrationPublicApi_Entities_V1_HealthPlanFact |
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 Health Plan 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "4c260093-3c0e-47b2-9454-59eb8b2cb47f",
"benefitSourceType": "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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/health-plan-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/health-plan-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/health-plan-facts
Retrieves a list of health plan 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 Health Plan Facts | HealthPlanFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Health Plan 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f', headers: headers, body: {"benefitSourceType":"testpopulation.programname.environment.group.name"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"benefitSourceType":"testpopulation.programname.environment.group.name"}
Example response
{
"id": "4c260093-3c0e-47b2-9454-59eb8b2cb47f",
"benefitSourceType": "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}/health-plan-facts/{healthPlanFactId}
Updates a single health plan 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. | - |
healthPlanFactId | path | string | true | N/A | The unique ID of a health plan fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidHealthPlanFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Health Plan Fact | SalesforceIntegrationPublicApi_Entities_V1_HealthPlanFact |
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 Health Plan 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/health-plan-facts/{healthPlanFactId}
Removes a health plan 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. | - |
healthPlanFactId | path | string | true | N/A | The unique ID of a health plan fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Health Plan 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 Health Plan 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/health-plan-facts/4c260093-3c0e-47b2-9454-59eb8b2cb47f \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "4c260093-3c0e-47b2-9454-59eb8b2cb47f",
"benefitSourceType": "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}/health-plan-facts/{healthPlanFactId}
Retrieves a single health plan 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. | - |
healthPlanFactId | path | string | true | N/A | The unique ID of a health plan fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Health Plan Fact | SalesforceIntegrationPublicApi_Entities_V1_HealthPlanFact |
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. |
Organization Facts
An organization fact specifies the organization information that is sent to Salesforce for the insight definition group. Only one organization fact can exist at a time for each insight definition.
Create an Organization Fact
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "4e7e4264-8760-4803-bc48-d6525e5900ba",
"version": "1",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/organization-facts
Creates an organization 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. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create an Organization Fact | SalesforceIntegrationPublicApi_Entities_V1_OrganizationFact |
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 Organization 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "4e7e4264-8760-4803-bc48-d6525e5900ba",
"version": "1",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/organization-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/organization-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/organization-facts
Retrieves a list of organization 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 Organization Facts | OrganizationFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Remove an Organization 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts/4e7e4264-8760-4803-bc48-d6525e5900ba', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts/4e7e4264-8760-4803-bc48-d6525e5900ba \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/organization-facts/{organizationFactId}
Removes an organization 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. | - |
organizationFactId | path | string | true | N/A | The unique ID of the organization fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove an Organization 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 Organization 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts/4e7e4264-8760-4803-bc48-d6525e5900ba', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/organization-facts/4e7e4264-8760-4803-bc48-d6525e5900ba \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "4e7e4264-8760-4803-bc48-d6525e5900ba",
"version": "1",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/organization-facts/{organizationFactId}
Retrieves a single organization 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. | - |
organizationFactId | path | string | true | N/A | The unique ID of the organization fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Organization Fact | SalesforceIntegrationPublicApi_Entities_V1_OrganizationFact |
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. |
Patient Alias Facts
A patient alias fact specifies the patient alias information that is sent to Salesforce for the insight definition group.
Create a Patient Alias 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts', headers: headers, body: {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-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"]}
Example response
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
"contextId": "301C26DD38E14028B202B77BF24D091E",
"conceptAliases": [
"MRN_IDTYPE",
"CMRN_IDTYPE"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/patient-alias-facts
Creates a patient alias fact for an insight definition. A fact cannot have duplicate concept aliases.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
insightDefinitionId | path | string | true | N/A | The unique ID of an insight definition. | - |
body | body | postInsightDefinitionsInsightdefinitionidPatientAliasFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Patient Alias Fact | SalesforceIntegrationPublicApi_Entities_V1_PatientAliasFact |
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 Patient Alias 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
"contextId": "301C26DD38E14028B202B77BF24D091E",
"conceptAliases": [
"MRN_IDTYPE",
"CMRN_IDTYPE"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/patient-alias-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/patient-alias-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/patient-alias-facts
Retrieves a list of patient alias 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 Patient Alias Facts | PatientAliasFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Patient Alias 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779', headers: headers, body: {"contextId":"testpopulation.programname.environment.group.name","conceptAliases":["testpopulation.programname.environment/contributorname"]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-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"]}
Example response
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
"contextId": "301C26DD38E14028B202B77BF24D091E",
"conceptAliases": [
"MRN_IDTYPE",
"CMRN_IDTYPE"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/patient-alias-facts/{patientAliasFactId}
Updates a single patient alias 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. | - |
patientAliasFactId | path | string | true | N/A | The unique ID of the patient alias fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidPatientAliasFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Patient Alias Fact | SalesforceIntegrationPublicApi_Entities_V1_PatientAliasFact |
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 Patient Alias 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/patient-alias-facts/{patientAliasFactId}
Removes a patient alias 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. | - |
patientAliasFactId | path | string | true | N/A | The unique ID of the patient alias fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Patient Alias 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 Patient Alias 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/patient-alias-facts/a3d2a06f-e8e1-4bb5-b501-eba6367ea779 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "a3d2a06f-e8e1-4bb5-b501-eba6367ea779",
"contextId": "301C26DD38E14028B202B77BF24D091E",
"conceptAliases": [
"MRN_IDTYPE",
"CMRN_IDTYPE"
],
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/patient-alias-facts/{patientAliasFactId}
Retrieves a single patient alias 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. | - |
patientAliasFactId | path | string | true | N/A | The unique ID of the patient alias fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Patient Alias Fact | SalesforceIntegrationPublicApi_Entities_V1_PatientAliasFact |
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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/registry-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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-1.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-1.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 | SalesforceIntegrationPublicApi_Entities_V1_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. |
Risk Assessment Facts
A risk assessment fact specifies the risk assessment information that is sent to Salesforce for the insight definition group.
Create a Risk Assessment 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts', headers: headers, body: {"name":"Cardiac Risk Score","type":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"method":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"condition":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cardiac Risk Score","type":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"method":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"condition":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]}}
Example response
{
"id": "7af9466a-b76c-4b6f-ab22-7c7732e99504",
"name": "Cardiac Risk Score",
"type": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"method": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"condition": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/risk-assessment-facts
Creates a risk assessment 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 | postInsightDefinitionsInsightdefinitionidRiskAssessmentFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Risk Assessment Fact | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentFact |
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 Risk Assessment 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "7af9466a-b76c-4b6f-ab22-7c7732e99504",
"name": "Cardiac Risk Score",
"type": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"method": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"condition": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/risk-assessment-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/7af9466a-b76c-4b6f-ab22-7c7732e99504/risk-assessment-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/risk-assessment-facts
Retrieves a list of risk assessment 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 Risk Assessment Facts | RiskAssessmentFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Risk Assessment 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504', headers: headers, body: {"name":"Cardiac Risk Score","type":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"method":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"condition":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"name":"Cardiac Risk Score","type":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"method":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]},"condition":{"contextId":"1CC077E8-C8C6-4E16-A383-0E82CA960C6F","conceptAliases":["MORBIDITY_PREDICTION_OBSTYPE"]}}
Example response
{
"id": "7af9466a-b76c-4b6f-ab22-7c7732e99504",
"name": "Cardiac Risk Score",
"type": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"method": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"condition": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/risk-assessment-facts/{riskAssessmentFactId}
Updates a single risk assessment 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. | - |
riskAssessmentFactId | path | string | true | N/A | The unique ID of the risk assessment fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidRiskAssessmentFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Risk Assessment Fact | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentFact |
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 Risk Assessment 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/risk-assessment-facts/{riskAssessmentFactId}
Removes a risk assessment 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. | - |
riskAssessmentFactId | path | string | true | N/A | The unique ID of the risk assessment fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Risk Assessment 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 Risk Assessment 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/risk-assessment-facts/7af9466a-b76c-4b6f-ab22-7c7732e99504 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "7af9466a-b76c-4b6f-ab22-7c7732e99504",
"name": "Cardiac Risk Score",
"type": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"method": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"condition": {
"contextId": "1CC077E8-C8C6-4E16-A383-0E82CA960C6F",
"conceptAliases": [
"MORBIDITY_PREDICTION_OBSTYPE"
]
},
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/risk-assessment-facts/{riskAssessmentFactId}
Retrieves a single risk assessment 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. | - |
riskAssessmentFactId | path | string | true | N/A | The unique ID of the risk assessment fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Risk Assessment Fact | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentFact |
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 Data Partition Facts
A Salesforce data partition fact specifies the Salesforce data partition information that is sent to Salesforce for the insight definition group.
Create a Salesforce Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts', headers: headers, body: {"dataPartitionId":"be892485-217a-42cc-9661-96f07c8dfc7d"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"dataPartitionId":"be892485-217a-42cc-9661-96f07c8dfc7d"}
Example response
{
"id": "2ad398f0-e8b4-43a3-98f2-7c23ae1f3996",
"dataPartitionId": "be892485-217a-42cc-9661-96f07c8dfc7d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/salesforce-data-partition-facts
Creates a Salesforce data partition 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 | postInsightDefinitionsInsightdefinitionidSalesforceDataPartitionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Salesforce Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SalesforceDataPartitionFact |
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 Salesforce Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2ad398f0-e8b4-43a3-98f2-7c23ae1f3996",
"dataPartitionId": "be892485-217a-42cc-9661-96f07c8dfc7d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/salesforce-data-partition-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/salesforce-data-partition-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/salesforce-data-partition-facts
Retrieves a list of Salesforce data partition 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 Salesforce Data Partition Facts | SalesforceDataPartitionFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Salesforce Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996', headers: headers, body: {"dataPartitionId":"be892485-217a-42cc-9661-96f07c8dfc7d"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"dataPartitionId":"be892485-217a-42cc-9661-96f07c8dfc7d"}
Example response
{
"id": "2ad398f0-e8b4-43a3-98f2-7c23ae1f3996",
"dataPartitionId": "be892485-217a-42cc-9661-96f07c8dfc7d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/salesforce-data-partition-facts/{salesforceDataPartitionFactId}
Updates a single Salesforce data partition 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. | - |
salesforceDataPartitionFactId | path | string | true | N/A | The unique ID of the salesforce data partition fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidSalesforceDataPartitionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Salesforce Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SalesforceDataPartitionFact |
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 Salesforce Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/salesforce-data-partition-facts/{salesforceDataPartitionFactId}
Removes a Salesforce data partition 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. | - |
salesforceDataPartitionFactId | path | string | true | N/A | The unique ID of the salesforce data partition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Salesforce Data Partition 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 Salesforce Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/salesforce-data-partition-facts/2ad398f0-e8b4-43a3-98f2-7c23ae1f3996 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "2ad398f0-e8b4-43a3-98f2-7c23ae1f3996",
"dataPartitionId": "be892485-217a-42cc-9661-96f07c8dfc7d",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/salesforce-data-partition-facts/{salesforceDataPartitionFactId}
Retrieves a single Salesforce data partition 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. | - |
salesforceDataPartitionFactId | path | string | true | N/A | The unique ID of the salesforce data partition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Salesforce Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SalesforceDataPartitionFact |
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. |
Source Data Partition Facts
A source data partition fact specifies the source data partition information that is sent to Salesforce for the insight definition group.
Create a Source Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts', headers: headers, body: {"dataPartitionId":"60142b13-b016-4523-bac4-af71953df412"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"dataPartitionId":"60142b13-b016-4523-bac4-af71953df412"}
Example response
{
"id": "926d9476-ac0e-4358-935e-38cca3363ca6",
"dataPartitionId": "60142b13-b016-4523-bac4-af71953df412",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /insight-definitions/{insightDefinitionId}/source-data-partition-facts
Creates a source data partition 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 | postInsightDefinitionsInsightdefinitionidSourceDataPartitionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Source Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SourceDataPartitionFact |
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 Source Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "926d9476-ac0e-4358-935e-38cca3363ca6",
"dataPartitionId": "60142b13-b016-4523-bac4-af71953df412",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/source-data-partition-facts?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/1807ba3e-569b-4dd8-841e-4e5026e5f900/source-data-partition-facts?offset=0&limit=20"
}
GET /insight-definitions/{insightDefinitionId}/source-data-partition-facts
Retrieves a list of source data partition 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 Source Data Partition Facts | SourceDataPartitionFacts |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Source Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6', headers: headers, body: {"dataPartitionId":"60142b13-b016-4523-bac4-af71953df412"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"dataPartitionId":"60142b13-b016-4523-bac4-af71953df412"}
Example response
{
"id": "926d9476-ac0e-4358-935e-38cca3363ca6",
"dataPartitionId": "60142b13-b016-4523-bac4-af71953df412",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /insight-definitions/{insightDefinitionId}/source-data-partition-facts/{sourceDataPartitionFactId}
Updates a single source data partition 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. | - |
sourceDataPartitionFactId | path | string | true | N/A | The unique ID of the source data partition fact. | - |
body | body | putInsightDefinitionsInsightdefinitionidSourceDataPartitionFacts | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Source Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SourceDataPartitionFact |
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 Source Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'If-Match: [object Object]'
DELETE /insight-definitions/{insightDefinitionId}/source-data-partition-facts/{sourceDataPartitionFactId}
Removes a source data partition 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. | - |
sourceDataPartitionFactId | path | string | true | N/A | The unique ID of the source data partition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Remove a Source Data Partition 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 Source Data Partition 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-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/insight-definitions/12d23cb1-41f5-43e3-9583-9068d7d7df63/source-data-partition-facts/926d9476-ac0e-4358-935e-38cca3363ca6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "926d9476-ac0e-4358-935e-38cca3363ca6",
"dataPartitionId": "60142b13-b016-4523-bac4-af71953df412",
"version": "2",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /insight-definitions/{insightDefinitionId}/source-data-partition-facts/{sourceDataPartitionFactId}
Retrieves a single source data partition 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. | - |
sourceDataPartitionFactId | path | string | true | N/A | The unique ID of the source data partition fact. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Source Data Partition Fact | SalesforceIntegrationPublicApi_Entities_V1_SourceDataPartitionFact |
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:
- Authorization URL
- Consumer key
- Consumer secret
- Person model
- Refresh token
- Salesforce environment name
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-1.healtheintent.com/salesforce-integration/v1/salesforce-definitions', headers: headers, body: {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","dataPartition":{"id":"877307a0-b5f5-4a01-9d4b-9fead6bcf788"},"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-1.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","dataPartition":{"id":"877307a0-b5f5-4a01-9d4b-9fead6bcf788"},"personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}
Example response
{
"id": "60142b13-b016-4523-bac4-af71953df412",
"environmentDescription": "Cerner",
"dataPartition": {
"id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788"
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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",
"dataPartition": {
"id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788"
},
"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-1.healtheintent.com/salesforce-integration/v1/salesforce-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.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-1.healtheintent.com/salesforce-integration/v1/salesforce-definitions/60142b13-b016-4523-bac4-af71953df412', headers: headers, body: {"refreshToken":"NIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4","environmentDescription":"Cerner","dataPartition":{"id":"877307a0-b5f5-4a01-9d4b-9fead6bcf788"},"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-1.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","dataPartition":{"id":"877307a0-b5f5-4a01-9d4b-9fead6bcf788"},"personModel":"PERSON","consumerKey":"3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE","consumerSecret":"1955279925675241571","authUrl":"https://login.salesforce.com"}
Example response
{
"id": "60142b13-b016-4523-bac4-af71953df412",
"environmentDescription": "Cerner",
"dataPartition": {
"id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788"
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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-1.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-1.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",
"dataPartition": {
"id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788"
},
"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 | SalesforceIntegrationPublicApi_Entities_V1_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. |
Salesforce Integration Connectors
A Salesforce integration connector includes the information that is needed for the Salesforce integration to be executed. The connector references the groups of patients in a population to gather data about, the insight facts to gather about each patient, and the Salesforce organization to which to send the data. A tenant can have only three active or suspended Salesforce integration connectors.
Create a Salesforce Integration Connector
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors', headers: headers, body: {"name":"Salesforce Integration Connector","population":{"id":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"insightDefinition":{"id":"60a60b96-5bb9-45e0-a3ca-cf715e307cb8"},"salesforceDefinition":{"id":"60142b13-b016-4523-bac4-af71953df412"},"status":"ACTIVE","frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":31,"timeOfDay":"00:00","startTime":"2019-08-27T18:00:00Z"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Salesforce Integration Connector","population":{"id":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"insightDefinition":{"id":"60a60b96-5bb9-45e0-a3ca-cf715e307cb8"},"salesforceDefinition":{"id":"60142b13-b016-4523-bac4-af71953df412"},"status":"ACTIVE","frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":31,"timeOfDay":"00:00","startTime":"2019-08-27T18:00:00Z"}
Example response
{
"id": "94e50360-cd64-400c-b715-6e586624590b",
"name": "Salesforce Integration Connector",
"population": {
"id": "1424e81d-8cea-4d6b-b140-d6630b684a58"
},
"insightDefinition": {
"id": "60a60b96-5bb9-45e0-a3ca-cf715e307cb8"
},
"salesforceDefinition": {
"id": "60142b13-b016-4523-bac4-af71953df412"
},
"status": "ACTIVE",
"frequencyValue": 1,
"frequencyUnit": "MONTHS",
"dayOfMonth": 31,
"timeOfDay": "00:00",
"startTime": "2019-08-27T18:00:00Z",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
POST /connectors
Creates a Salesforce integration connector.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postConnectors | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Create a Salesforce Integration Connector | SalesforceIntegrationPublicApi_Entities_V1_Connector |
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 Integration Connectors
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "94e50360-cd64-400c-b715-6e586624590b",
"name": "Salesforce Integration Connector",
"population": {
"id": "1424e81d-8cea-4d6b-b140-d6630b684a58"
},
"insightDefinition": {
"id": "60a60b96-5bb9-45e0-a3ca-cf715e307cb8"
},
"salesforceDefinition": {
"id": "60142b13-b016-4523-bac4-af71953df412"
},
"status": "ACTIVE",
"frequencyValue": 1,
"frequencyUnit": "MONTHS",
"dayOfMonth": 31,
"timeOfDay": "00:00",
"startTime": "2019-08-27T18:00:00Z",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors?offset=0&limit=20"
}
GET /connectors
Retrieves a list of Salesforce integration connectors.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
populationId | query | string | false | N/A | The unique ID of a population. | - |
status | query | string | false | N/A | The status of the connector. | - |
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 Integration Connectors | Connectors |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Salesforce Integration Connector
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-1.healtheintent.com/salesforce-integration/v1/connectors/94e50360-cd64-400c-b715-6e586624590b', headers: headers, body: {"name":"Salesforce Integration Connector","population":{"id":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"insightDefinition":{"id":"60a60b96-5bb9-45e0-a3ca-cf715e307cb8"},"salesforceDefinition":{"id":"60142b13-b016-4523-bac4-af71953df412"},"status":"ACTIVE","frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":31,"timeOfDay":"00:00","startTime":"2019-08-27T18:00:00Z"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors/94e50360-cd64-400c-b715-6e586624590b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'If-Match: [object Object]' \
-d {"name":"Salesforce Integration Connector","population":{"id":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"insightDefinition":{"id":"60a60b96-5bb9-45e0-a3ca-cf715e307cb8"},"salesforceDefinition":{"id":"60142b13-b016-4523-bac4-af71953df412"},"status":"ACTIVE","frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":31,"timeOfDay":"00:00","startTime":"2019-08-27T18:00:00Z"}
Example response
{
"id": "94e50360-cd64-400c-b715-6e586624590b",
"name": "Salesforce Integration Connector",
"population": {
"id": "1424e81d-8cea-4d6b-b140-d6630b684a58"
},
"insightDefinition": {
"id": "60a60b96-5bb9-45e0-a3ca-cf715e307cb8"
},
"salesforceDefinition": {
"id": "60142b13-b016-4523-bac4-af71953df412"
},
"status": "ACTIVE",
"frequencyValue": 1,
"frequencyUnit": "MONTHS",
"dayOfMonth": 31,
"timeOfDay": "00:00",
"startTime": "2019-08-27T18:00:00Z",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
PUT /connectors/{connectorId}
Updates a single Salesforce integration connector.
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. | - |
connectorId | path | string | true | N/A | The unique ID of a Salesforce integration connector. | - |
body | body | putConnectors | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a Salesforce Integration Connector | SalesforceIntegrationPublicApi_Entities_V1_Connector |
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 Integration Connector
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors/94e50360-cd64-400c-b715-6e586624590b', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/salesforce-integration/v1/connectors/94e50360-cd64-400c-b715-6e586624590b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "94e50360-cd64-400c-b715-6e586624590b",
"name": "Salesforce Integration Connector",
"population": {
"id": "1424e81d-8cea-4d6b-b140-d6630b684a58"
},
"insightDefinition": {
"id": "60a60b96-5bb9-45e0-a3ca-cf715e307cb8"
},
"salesforceDefinition": {
"id": "60142b13-b016-4523-bac4-af71953df412"
},
"status": "ACTIVE",
"frequencyValue": 1,
"frequencyUnit": "MONTHS",
"dayOfMonth": 31,
"timeOfDay": "00:00",
"startTime": "2019-08-27T18:00:00Z",
"createdAt": "2019-04-25T17:03:14.120Z",
"updatedAt": "2019-04-25T17:03:14.120Z"
}
GET /connectors/{connectorId}
Retrieves a single Salesforce integration connector by ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
connectorId | path | string | true | N/A | The unique ID of a Salesforce integration connector. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Salesforce Integration Connector | SalesforceIntegrationPublicApi_Entities_V1_Connector |
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
SalesforceIntegrationPublicApi_Entities_V1_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. | - |
settings | SalesforceIntegrationPublicApi_Entities_V1_SettingsReference | false | The number of days to look back to gather encounter data. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Encounter.period.start field of an encounter is used to determine whether the encounter is in the look-back period. |
- |
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_SettingsReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
encounterLookBackDays | integer(int32) | false | The number of days to look back to gather encounter data. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Encounter.period.start field of an encounter is used to determine whether the encounter is in the look-back period. |
- |
appointmentLookBackDays | integer(int32) | false | The number of days to look back to gather appointment data. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Appointment.startDate field of an appointment is used to determine whether the appointment is in the look-back period. |
- |
appointmentLookForwardDays | integer(int32) | false | The number of days to look forward to gather appointment data. The look-forward period is calculated from the time processing is run, as defined in the Connector resource. The Appointment.startDate field of an appointment is used to determine whether the appointment is in the look-forward period. |
- |
deceasedPatientLookBackDays | integer(int32) | false | The number of days to look back to gather data about deceased patients. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The PreferredDemographicsLite.dateOfDeath field of a patient is used to determine whether the patient is in the look-back period. |
- |
conditionLookBackDays | integer(int32) | false | The number of days to look back to gather data about conditions. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Condition.effectiveDate field of a patient is used to determine whether the patient is in the look-back period. If the Condition.effectiveDate field is null, the Condition.assertedDate field is used as a backup. |
- |
medicationLookBackDays | integer(int32) | false | The number of days to look back to gather data about medications. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Medication.effectiveDate field of a patient is used to determine whether the patient is in the look-back period. If the Medication.effectiveDate field is null, the Medication.assertedDate field is used as a backup. |
- |
enableEncounterParticipants | Object | false | The flag used to determine if the data for encounter participants is pushed to the health cloud. | - |
SalesforceIntegrationPublicApi_Entities_V1_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. | - |
SalesforceIntegrationPublicApi_Entities_V1_AppointmentStatusFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the appointment status fact. | - |
contextId | string | true | The unique ID of an ontology context. | - |
contextVersion | integer(int32) | false | The current version of the context. | - |
conceptAliases | [string] | true | The IDs of a group of codes from various terminologies that have similar semantic meanings. | - |
version | integer(int32) | true | The current version of the appointment status fact. | - |
createdAt | string | true | The date and time when the appointment status 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 appointment status fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the appointment status 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 appointment status fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_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. | - |
SalesforceIntegrationPublicApi_Entities_V1_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. | - |
SalesforceIntegrationPublicApi_Entities_V1_ConditionFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the condition fact. | - |
dataPartitionIds | [string] | false | The data partition IDs used to identify the subset of conditions of interest. | - |
condition | SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceCondition | true | The ontology configuration for validating the fact’s condition. | - |
status | SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceStatus | false | The ontology configuration for validating the fact’s status. | - |
type | SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceType | false | The ontology configuration for validating the fact’s type. | - |
version | integer(int32) | true | The current version of the condition fact. | - |
createdAt | string | true | The date and time when the condition 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 condition fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the condition 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 condition fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceCondition
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceStatus
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_ConditionReferenceType
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_MedicationFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the medication fact. | - |
medication | SalesforceIntegrationPublicApi_Entities_V1_MedicationReferenceMedication | true | The ontology configuration for validating the fact’s medication. | - |
status | SalesforceIntegrationPublicApi_Entities_V1_MedicationReferenceStatus | false | The ontology configuration for validating the fact’s status. | - |
version | integer(int32) | true | The current version of the medication fact. | - |
createdAt | string | true | The date and time when the medication 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 medication fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the medication 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 medication fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_MedicationReferenceMedication
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_MedicationReferenceStatus
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_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. | - |
SalesforceIntegrationPublicApi_Entities_V1_EncounterTypeFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the encounter type fact. | - |
contextId | string | true | The unique ID of an ontology context. | - |
contextVersion | integer(int32) | false | The current version of the context. | - |
conceptAliases | [string] | true | The IDs of a group of codes from various terminologies that have similar semantic meanings. | - |
version | integer(int32) | true | The current version of the encounter type fact. | - |
createdAt | string | true | The date and time when the encounter type 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 encounter type fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the encounter type 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 encounter type fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_HccOutcomeFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the HCC outcome fact. | - |
version | integer(int32) | true | The current version of the HCC outcome fact. | - |
createdAt | string | true | The date and time when the HCC outcome 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 HCC outcome fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the HCC outcome 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 HCC outcome fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_HccRafScoreFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the HCC RAF score fact. | - |
riskAdjustmentModelType | [string] | true | The type of the risk adjustment model. | - |
version | integer(int32) | true | The current version of the HCC RAF score fact. | - |
createdAt | string | true | The date and time when the HCC RAF score 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 HCC RAF score fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the HCC RAF score 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 HCC RAF score fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_HealthPlanFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a health plan fact. | - |
benefitSourceType | string | true | No description | - |
version | integer(int32) | true | The current version of the health plan fact. | - |
createdAt | string | true | The date and time when the health plan 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 health plan fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the health plan 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 health plan fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_OrganizationFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the organization fact. | - |
version | integer(int32) | true | The current version of the organization fact. | - |
createdAt | string | true | The date and time when the organization 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 organization fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the organization 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 organization fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_PatientAliasFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the patient alias fact. | - |
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. | - |
version | integer(int32) | true | The current version of the patient alias fact. | - |
createdAt | string | true | The date and time when the patient alias 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 patient alias fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the patient alias 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 patient alias fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_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] | false | 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. | - |
SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the risk assessment fact. | - |
name | string | true | A human-readable name corresponding to the risk assessment. | - |
type | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentReference | true | The ontology configuration for validating the risk assessment type. | - |
method | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentReference | false | The ontology configuration for validating the risk assessment method. | - |
condition | SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentReference | false | The ontology configuration for validating the risk assessment condition. | - |
version | integer(int32) | true | The current version of the risk assessment fact. | - |
createdAt | string | true | The date and time when the risk assessment 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 risk assessment fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the risk assessment 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 risk assessment fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentReference
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_SalesforceDataPartitionFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the salesforce data partition fact. | - |
dataPartitionId | string | true | The ID of the salesforce data partition. | - |
version | integer(int32) | true | The current version of the salesforce data partition fact. | - |
createdAt | string | true | The date and time when the salesforce data partition 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 salesforce data partition fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the salesforce data partition 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 salesforce data partition fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_SourceDataPartitionFact
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the source data partition fact. | - |
dataPartitionId | string | true | The ID of the source data partition. | - |
version | integer(int32) | true | The current version of the source data partition fact. | - |
createdAt | string | true | The date and time when the source data partition 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 source data partition fact is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the source data partition 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 source data partition fact is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_SalesforceDefinition
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a Salesforce definition. | - |
environmentDescription | string | true | No description | - |
dataPartition | SalesforceIntegrationPublicApi_Entities_V1_DataPartitionReference | false | Data partitions are the logical partitions of data in HealtheIntent for a data source. | - |
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. | - |
SalesforceIntegrationPublicApi_Entities_V1_DataPartitionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a data partition used to identify the corresponding record ID in Salesforce data. | - |
SalesforceIntegrationPublicApi_Entities_V1_Connector
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a Salesforce integration connector. | - |
name | string | true | The name of the connector. | - |
population | SalesforceIntegrationPublicApi_Entities_V1_PopulationReference | true | The unique ID of a population. | - |
insightDefinition | SalesforceIntegrationPublicApi_Entities_V1_InsightDefinitionReference | true | The unique ID of an insight definition. | - |
salesforceDefinition | SalesforceIntegrationPublicApi_Entities_V1_SalesforceDefinitionReference | false | The unique ID of a Salesforce definition. | - |
status | string | true | The status of the connector. | ACTIVE, INACTIVE, SUSPENDED |
frequencyValue | integer(int32) | true | The value of the frequency. | - |
frequencyUnit | string | true | The unit of the frequency. | - |
dayOfMonth | integer(int32) | false | The number of days past the beginning of the month that data is processed. | - |
timeOfDay | string | true | The time of day in Coordinated Universal Time (UTC) when data is processed. | - |
startTime | string | false | The date and time when the data processing starts. | - |
createdAt | string | true | The date and time when the Salesforce integration connector 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 integration connector is first created; therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the Salesforce integration connector 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 integration connector is modified; therefore, the field does not need to be set explicitly. | - |
SalesforceIntegrationPublicApi_Entities_V1_PopulationReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a population. | - |
SalesforceIntegrationPublicApi_Entities_V1_InsightDefinitionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of an insight definition. | - |
SalesforceIntegrationPublicApi_Entities_V1_SalesforceDefinitionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of a Salesforce definition. | - |
postInsightDefinitions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
description | string | true | A description of what the insight definition represents. | - |
settings | object | false | The number of days to look back to gather encounter data. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Encounter.period.start field of an encounter is used to determine whether the encounter is in the look-back period. |
- |
» encounterLookBackDays | string | false | The number of days to look back to gather encounter data. | - |
» appointmentLookBackDays | string | false | The number of days to look back to gather appointment data. | - |
» appointmentLookForwardDays | string | false | The number of days to look forward to gather appointment data. | - |
» deceasedPatientLookBackDays | string | false | The number of days to look back to gather data for deceased patients. | - |
» conditionLookBackDays | string | false | The number of days to look back to gather data for conditions. | - |
» medicationLookBackDays | string | false | The number of days to look back to gather data for medications. | - |
» enableEncounterParticipants | boolean | false | The flag used to determine if the data for encounter participants is pushed to the health cloud. | - |
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 | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
settings | object | false | The number of days to look back to gather encounter data. The look-back period is calculated from the time processing is run, as defined in the Connector resource. The Encounter.period.start field of an encounter is used to determine whether the encounter is in the look-back period. |
- |
» encounterLookBackDays | string | false | The number of days to look back to gather encounter data. | - |
» appointmentLookBackDays | string | false | The number of days to look back to gather appointment data. | - |
» appointmentLookForwardDays | string | false | The number of days to look forward to gather appointment data. | - |
» deceasedPatientLookBackDays | string | false | The number of days to look back to gather data for deceased patients. | - |
» conditionLookBackDays | string | false | The number of days to look back to gather data for conditions. | - |
» medicationLookBackDays | string | false | The number of days to look back to gather data for medications. | - |
» enableEncounterParticipants | boolean | false | The flag used to determine if the data for encounter participants is pushed to the health cloud. | - |
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. | - |
Groups
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
postInsightDefinitionsInsightdefinitionidAppointmentStatusFacts
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 | string | false | The current version of the context. | - |
AppointmentStatusFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_AppointmentStatusFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidAppointmentStatusFacts
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 | string | false | The current version of the context. | - |
postInsightDefinitionsInsightdefinitionidAttributionPersonnelGroupFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
personnelGroupId | string | true | The unique ID of a personnel group. | - |
AttributionPersonnelGroupFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
CareManagementIdentificationFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
postInsightDefinitionsInsightdefinitionidConditionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionIds | [string] | false | No description | - |
condition | object | true | The ontology configuration for validating the fact’s condition. | - |
» 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. | - |
status | object | false | The ontology configuration for validating the fact’s status. | - |
» 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. | - |
type | object | false | The ontology configuration for validating the fact’s type. | - |
» 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. | - |
ConditionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_ConditionFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidConditionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionIds | [string] | false | No description | - |
condition | object | true | The ontology configuration for validating the fact’s condition. | - |
» 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. | - |
status | object | false | The ontology configuration for validating the fact’s status. | - |
» 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. | - |
type | object | false | The ontology configuration for validating the fact’s type. | - |
» 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. | - |
postInsightDefinitionsInsightdefinitionidMedicationFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
medication | object | true | The ontology configuration for validating the fact’s medication. | - |
» 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. | - |
status | object | false | The ontology configuration for validating the fact’s status. | - |
» 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. | - |
MedicationFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_MedicationFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidMedicationFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
medication | object | true | The ontology configuration for validating the fact’s medication. | - |
» 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. | - |
status | object | false | The ontology configuration for validating the fact’s status. | - |
» 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. | - |
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. | - |
EpisodeOfCareFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
postInsightDefinitionsInsightdefinitionidEncounterTypeFacts
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 | string | false | The current version of the context. | - |
EncounterTypeFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_EncounterTypeFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidEncounterTypeFacts
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 | string | false | The current version of the context. | - |
HccOutcomeFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_HccOutcomeFact] | 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. | - |
HccRafScoreFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_HccRafScoreFact] | 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. | - |
postInsightDefinitionsInsightdefinitionidHealthPlanFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
benefitSourceType | string | true | No description | - |
HealthPlanFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_HealthPlanFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidHealthPlanFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
benefitSourceType | string | true | No description | - |
OrganizationFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_OrganizationFact] | 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. | - |
postInsightDefinitionsInsightdefinitionidPatientAliasFacts
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. | - |
PatientAliasFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_PatientAliasFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidPatientAliasFacts
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. | - |
postInsightDefinitionsInsightdefinitionidRegistryFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
programId | string | true | The ID of the registry program. | - |
measureFqns | [string] | false | The measure fully qualified names associated with the registry. | - |
RegistryFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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] | false | The measure fully qualified names associated with the registry. | - |
postInsightDefinitionsInsightdefinitionidRiskAssessmentFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | A human-readable name corresponding to the risk assessment. | - |
type | object | true | The ontology configuration for validating the risk assessment type. | - |
» 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. | - |
method | object | false | The ontology configuration for validating the risk assessment method. | - |
» 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. | - |
condition | object | false | The ontology configuration for validating the risk assessment condition. | - |
» 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. | - |
RiskAssessmentFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_RiskAssessmentFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidRiskAssessmentFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | A human-readable name corresponding to the risk assessment. | - |
type | object | true | The ontology configuration for validating the risk assessment type. | - |
» 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. | - |
method | object | false | The ontology configuration for validating the risk assessment method. | - |
» 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. | - |
condition | object | false | The ontology configuration for validating the risk assessment condition. | - |
» 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. | - |
postInsightDefinitionsInsightdefinitionidSalesforceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionId | string | true | The ID of the salesforce data partition. | - |
SalesforceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_SalesforceDataPartitionFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidSalesforceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionId | string | true | The ID of the salesforce data partition. | - |
postInsightDefinitionsInsightdefinitionidSourceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionId | string | true | The ID of the source data partition. | - |
SourceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_SourceDataPartitionFact] | 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. | - |
putInsightDefinitionsInsightdefinitionidSourceDataPartitionFacts
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
dataPartitionId | string | true | The ID of the source data partition. | - |
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. | - |
dataPartition | object | false | Data partitions are the logical partitions of data in HealtheIntent for a data source. | - |
» id | string | true | The unique ID of a data partition used to identify the corresponding record ID in Salesforce data. | - |
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. | - |
SalesforceDefinitions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_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. | - |
dataPartition | object | false | Data partitions are the logical partitions of data in HealtheIntent for a data source. | - |
» id | string | true | The unique ID of a data partition used to identify the corresponding record ID in Salesforce data. | - |
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. | - |
postConnectors
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the connector. | - |
population | object | true | The unique ID of a population. | - |
» id | string | true | The unique ID. | - |
insightDefinition | object | true | The unique ID of an insight definition. | - |
» id | string | true | The unique ID. | - |
salesforceDefinition | object | false | The unique ID of a Salesforce definition. | - |
» id | string | true | The unique ID. | - |
status | string | false | The status of the connector. | - |
frequencyValue | integer(int32) | false | The value of the frequency. | - |
frequencyUnit | string | false | The unit of the frequency. | - |
dayOfMonth | integer(int32) | false | The number of days past the beginning of the month that data is processed. | - |
timeOfDay | string | false | The time of day in Coordinated Universal Time (UTC) when data is processed. | - |
startTime | string | false | The date and time when the data processing starts. | - |
Connectors
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [SalesforceIntegrationPublicApi_Entities_V1_Connector] | 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. | - |
putConnectors
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the connector. | - |
population | object | true | The unique ID of a population. | - |
» id | string | true | The unique ID. | - |
insightDefinition | object | true | The unique ID of an insight definition. | - |
» id | string | true | The unique ID. | - |
salesforceDefinition | object | false | The unique ID of a Salesforce definition. | - |
» id | string | true | The unique ID. | - |
status | string | false | The status of the connector. | - |
frequencyValue | integer(int32) | false | The value of the frequency. | - |
frequencyUnit | string | false | The unit of the frequency. | - |
dayOfMonth | integer(int32) | false | The number of days past the beginning of the month that data is processed. | - |
timeOfDay | string | false | The time of day in Coordinated Universal Time (UTC) when data is processed. | - |
startTime | string | false | The date and time when the data processing starts. | - |