Quality Measure API v1
The Quality Measure API enables assessing performance related to a specific clinical process, structure, or outcome using measures. Measure recommendations are conditional intervention or reminder messages that can help providers know what actions to perform to ensure that a measure is achieved on time.
Note: The data retrieved by this API is filtered based on the sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.
URL: https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1
Recommendation Fields
Recommendation fields are the fields that can be referenced in recommendation policies and that allow systems to retrieve a measure outcome’s attributes and supporting data.
Retrieve a List of Recommendation Fields
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/quality-measure/v1/recommendation-fields', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-fields \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /recommendation-fields
Retrieves a list of recommendation fields.
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 | A collection of recommendation fields. | RecommendationFields |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Recommendation Policies
A recommendation policy is the collection of recommendation messages that can be displayed to users. The policy determines what messages are generated. Each measure can have only one recommendation policy.
Create a Recommendation Policy
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/quality-measure/v1/recommendation-policies', headers: headers, body: {"name":"adult-bmi-assessment-not-current","title":"BMI Not Current","fields":[{"name":"IsMeasureMissingInMeasurementPeriod","componentName":"cernerstandard.diabetesmellitus.org2014.clinical/ldl-poorly-controlled-ldl-gte-130"},{"name":"MostRecentCondition","populationGroupType":"DENOMINATOR"},{"name":"MostRecentObservationEffectiveDate"}],"measureDefinition":{"id":"49d0677b-28e6-4648-9159-1e114eb7b829","alias":{"system":"CERNER Standard","value":"cernerstandard.adultwellness.org2014.clinical/body-mass-index"}},"tests":[{"field":"IsMeasureMissingInMeasurementPeriod","operator":"EQ","value":"true"}],"messages":[{"format":"TEXT","type":"NARRATIVE","template":"BMI was last recorded on {{MostRecentObservationEffectiveDate}}. Assess BMI at least once every two years."},{"format":"TEXT","type":"RESULT_OUTCOME","template":"{{MostRecentCondition}}"},{"format":"TEXT","type":"RESULT_OUTCOME_DATE","template":"{{MostRecentObservationEffectiveDate}}"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"adult-bmi-assessment-not-current","title":"BMI Not Current","fields":[{"name":"IsMeasureMissingInMeasurementPeriod","componentName":"cernerstandard.diabetesmellitus.org2014.clinical/ldl-poorly-controlled-ldl-gte-130"},{"name":"MostRecentCondition","populationGroupType":"DENOMINATOR"},{"name":"MostRecentObservationEffectiveDate"}],"measureDefinition":{"id":"49d0677b-28e6-4648-9159-1e114eb7b829","alias":{"system":"CERNER Standard","value":"cernerstandard.adultwellness.org2014.clinical/body-mass-index"}},"tests":[{"field":"IsMeasureMissingInMeasurementPeriod","operator":"EQ","value":"true"}],"messages":[{"format":"TEXT","type":"NARRATIVE","template":"BMI was last recorded on {{MostRecentObservationEffectiveDate}}. Assess BMI at least once every two years."},{"format":"TEXT","type":"RESULT_OUTCOME","template":"{{MostRecentCondition}}"},{"format":"TEXT","type":"RESULT_OUTCOME_DATE","template":"{{MostRecentObservationEffectiveDate}}"}]}
POST /recommendation-policies
Creates a recommendation policy.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postRecommendationPolicies | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The recommendation policy is created. | RecommendationPolicy |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The URL of the created definition. |
Retrieve a List of Recommendation Policies
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/quality-measure/v1/recommendation-policies', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /recommendation-policies
Retrieves a list of recommendation policies for a measure.
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 | A collection of recommendation policies. | RecommendationPolicies |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Delete a Recommendation Policy
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /recommendation-policies/{recommendationPolicyId}
Deletes a recommendation policy.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| recommendationPolicyId | path | string | true | N/A | The ID of the recommendation policy. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The recommendation policy is deleted. | RecommendationPolicy |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Recommendation Policy
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/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /recommendation-policies/{recommendationPolicyId}
Retrieves a single recommendation policy.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| recommendationPolicyId | path | string | true | N/A | The ID of the recommendation policy. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single recommendation policy. | RecommendationPolicy |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Recommendations
Recommendations are the conditional intervention or reminder messages that can help providers know what actions to perform to ensure that measures are achieved on time for a patient.
Retrieve a List of Recommendations
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/quality-measure/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/recommendations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/recommendations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"pipeline": {
"id": "80da2056-a86a-11e7-abc4-cec278b6b50a"
},
"patient": {
"id": "49d0677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "49d0677b-28e6-4648-9159-1e114eb7b829"
}
},
"measureDefinition": {
"id": "49d0677b-28e6-4648-9159-1e114eb7b829",
"alias": {
"system": "CERNER Standard",
"value": "cernerstandard.adultwellness.org2014.clinical/body-mass-index"
}
},
"recommendationPolicy": {
"id": "49d0677b-28e6-4648-9159-1e114eb7b829",
"name": "adult-bmi-assessment-recommendations",
"title": "Adult BMI Assessment"
},
"messages": [
{
"format": "TEXT",
"type": "NARRATIVE",
"message": "BMI Not Current. Assess BMI at least once every 2 years."
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /pipelines/{pipelineId}/patients/{patientId}/recommendations
Retrieves a list of recommendations for a patient.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| pipelineId | path | string | true | N/A | The ID of the pipeline. | - |
| patientId | path | string | true | N/A | The ID of the patient. | - |
| 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. | - |
| includeTrumped | query | boolean | false | N/A | Filters recommendation messages for the measure. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of recommendations. | RecommendationPeople |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Measure Results
Measure results represent the outcomes of evaluating one or more measures against a population record.
Retrieve a List of Measure Results
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/quality-measure/v1/reporting-projects/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/measure-results', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/measure-results \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"patient": {
"id": "17d0677b-28e6-4648-9159-1e114eb7b829",
"populationId": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce",
"empiVersion": "4606",
"empiPersonVersion": "2"
},
"event": {
"id": "24717504-b333-382b-8934-1ff618c9590b",
"date": "2018-01-02"
},
"measure": {
"name": "action-plan-complete",
"registry": {
"aliases": [
{
"system": "synapse.clinical.programs/program-id",
"value": "advocate.events.documentation-of-current-medications"
}
]
}
},
"resultOutcomeSummary": "ACHIEVED",
"due": "true",
"daysUntilDue": "7",
"status": "MET",
"results": [
{
"populationGroupTypes": [
"DENOMINATOR"
],
"name": "lumerismaestro.medicationmanagement.clinical/pdc-arv-inclusion-group",
"value": {
"component": {
"status": "SATISFIED"
}
},
"basis": [
{
"id": "e8f0e126-2e4b-11e9-b210-d663bd873d93"
}
]
}
],
"supportingData": [
{
"dataIdentifiers": [
{
"sourceIdentifier": {
"id": "82C4A9126BACE6CE5A8A25B832AB8E746E6B78CA",
"dataPartitionId": "PH Client 1, Source 3, Claim",
"partitionDescription": "Partition description",
"type": "Type",
"contributingOrganization": "Contributing organization name"
},
"reference": {
"id": "e8f0e126-2e4b-11e9-b210-d663bd873d93"
}
}
],
"codifiedValues": [
{
"sourceCodings": [
{
"code": "434.01",
"system": "urn:oid:2.16.840.1.113883.6.103",
"display": "CEREBRAL THROMBOSIS W/INFARCTION"
}
],
"codings": [
{
"code": "434.01",
"system": "2.16.840.1.113883.6.103",
"display": "Cerebral thrombosis with cerebral infarction"
}
],
"text": "CEREBRAL THROMBOSIS W/INFARCTION"
}
],
"value": {
"codified": " ",
"type": "CONDITION",
"period": {
"type": "SINGLE",
"end": "2020-02-24",
"start": "2020-02-24"
},
"text": "Hba 1c",
"numeric": {
"modifier": ">",
"value": "4.3",
"unitOfMeasure": " "
}
},
"state": "_NOT_VALUED",
"personnel": [
{
"id": "personnel-id"
}
],
"additionalValues": [
{
"categoryType": "GENERAL",
"fields": [
{
"name": "BIRTH_DATE",
"value": {
"type": "DATE",
"period": {
"type": "SINGLE",
"end": "2013-04-10",
"start": "2013-04-10"
},
"codified": " ",
"text": "Hba 1c",
"numeric": {
"modifier": ">",
"value": "4.3",
"unitOfMeasure": " "
}
}
},
{
"name": "GENDER",
"value": {
"type": "CODIFIED",
"codified": [
{
"sourceCodings": [
{
"code": "F",
"system": "geidx:gender",
"display": "F"
}
],
"codings": [
{
"code": "female",
"system": "http://hl7.org/fhir/administrative-gender",
"display": "http://hl7.org/fhir/administrative-gender female"
}
],
"text": "F"
}
],
"period": {
"type": "SINGLE",
"end": "2013-04-10",
"start": "2013-04-10"
},
"text": "Hba 1c",
"numeric": {
"modifier": ">",
"value": "4.3",
"unitOfMeasure": " "
}
}
}
]
}
],
"period": {
"type": "SINGLE",
"end": "2013-04-10",
"start": "2013-04-10"
}
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /reporting-projects/{reportingProjectId}/patients/{patientId}/measure-results
Retrieves a list of measure results for a patient.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectId | path | string | true | N/A | The ID of the reporting project. | - |
| patientId | path | string | true | N/A | The ID of the patient. | - |
| daysUntilDue | query | string | false | N/A | Number of days until due. To filter overdue measures, pass 0. | - |
| 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. | - |
| includeSupportingData | query | boolean | false | N/A | The Boolean value which is set when supporting data is needed. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of measure results is retrieved. | MeasureResults |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Tags
You can use the Tag resource to assign your own metadata to the Quality Measure resources. The most common reason to tag a resource is to categorize its use (for example, Use = Production or Use = Validation). You can also use tags to add issue-tracking IDs to Quality Measure resources as a reference to when and why the resource was created.
Create a Tag
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/quality-measure/v1/tags', headers: headers, body: {"key":"Use","value":"Production","resource":{"type":"MEASURE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/tags \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"key":"Use","value":"Production","resource":{"type":"MEASURE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"}}
Example response
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"resource": {
"type": "MEASURE",
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"key": "Use",
"value": "Production"
}
POST /tags
Creates a tag.
The following basic restrictions apply to tags:
- For each resource, each tag key must be unique and can have only one value.
- The maximum key length is 128 characters.
- The maximum value length is 256 characters.
- The tag keys and values are case-sensitive.
- Letters, numbers, and the following characters are allowed: # $ & - . / + : = ? @ _
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postTags | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A tag object | QualityMeasurePublicApi_Entities_V1_Tags_Tag |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The URL of the created tag. |
Retrieve a List of Tags
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/quality-measure/v1/tags',
query: {
'resourceType' => 'string',
'key' => 'string'
}, headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/tags?resourceType=type,string,enum,CLINICAL_DATA_ENTRY_FORM%2CMEASURE%2CREGISTRY%2CREPORTING_PROJECT%2CREPORTING_PROJECT_CONFIGURATION&key=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"resource": {
"type": "MEASURE",
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"key": "Use",
"value": "Production"
},
{
"id": "f2c9455a-7a6e-4f9f-9241-5df093996078",
"resource": {
"type": "MEASURE",
"id": "50cce9f4-1602-4479-b682-309da08e24c3"
},
"key": "Use",
"value": "Staging"
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=20&limit=20"
}
GET /tags
Retrieves a list of tags.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| tagId | query | array[string] | false | N/A | The ID of the tag. This query parameter can be repeated multiple times to query for multiple tags at a time. | - |
| resourceId | query | array[string] | false | N/A | The resource ID of the tag. This query parameter can be repeated multiple times to query for multiple tags at a time. The resourceType parameter should also be defined when searching by resource ID or IDs. |
- |
| resourceType | query | string | true | N/A | The resource type of the tag. | CLINICAL_DATA_ENTRY_FORM, MEASURE, REGISTRY, REPORTING_PROJECT, REPORTING_PROJECT_CONFIGURATION |
| key | query | string | true | N/A | The tag key to search for. The search is for exact matches. | - |
| value | query | string | false | N/A | The tag value to search for. The search is for exact matches. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | key | A comma-separated list of fields by which to sort. | key, -key, value, -value, resourceType, -resourceType |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of tag objects. | Tags |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Remove a Tag
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/tags/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/tags/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /tags/{id}
Removes a tag.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | path | string | true | N/A | The ID of the tag. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | No content | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Tag
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/quality-measure/v1/tags/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/tags/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /tags/{id}
Retrieves a single tag.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | path | string | true | N/A | The ID of the tag. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A tag object. | QualityMeasurePublicApi_Entities_V1_Tags_Tag |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Categorizations
Categorizations are an organizational construct that provides a first-class mechanism to organize the Quality Measure service definitional entities based on various categorization use cases.
Retrieve a List of Categorizations
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/quality-measure/v1/categorizations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "publisher-catalog",
"title": "Categorization based on the cataloging",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /categorizations
Retrieves a list of categorizations.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| name | query | string | false | N/A | Filters the response by the specified name. | - |
| title | query | string | false | N/A | Filters the response by the specified title. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
| 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 | A collection of categorizations. | Categorizations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Categorization
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/quality-measure/v1/categorizations', headers: headers, body: {"name":"publisher-catalog","title":"Categorization based on the cataloging"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"publisher-catalog","title":"Categorization based on the cataloging"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "publisher-catalog",
"title": "Categorization based on the cataloging",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
POST /categorizations
Creates a categorization.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postCategorizations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The categorization is created. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Delete a Single Categorization
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /categorizations/{categorizationId}
Deletes a single categorization.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The categorization is deleted. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Single Categorization
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"publisher-catalog","title":"Categorization based on the cataloging"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"publisher-catalog","title":"Categorization based on the cataloging"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "publisher-catalog",
"title": "Categorization based on the cataloging",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
PUT /categorizations/{categorizationId}
Updates a single categorization.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| body | body | putCategorizations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The categorization is updated. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Categorization
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/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "publisher-catalog",
"title": "Categorization based on the cataloging",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /categorizations/{categorizationId}
Retrieves a single categorization.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single categorization is retrieved. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Categories
Categories are an organizational construct that can be used to group measures or registries.
Retrieve a List of Categories
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8d844faf-d158-11e8-80f4-005056a80294",
"title": "HEDIS",
"ranking": 1,
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /categorizations/{categorizationId}/categories
Retrieves a list of categories.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| ranking | query | string | false | N/A | Filters by the category ranking. | - |
| title | query | string | false | N/A | Filters by the category title. Partial text search is supported. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -title, title, ranking, -ranking |
| 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 | A collection of categories. | Categories |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Create a Category
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories', headers: headers, body: {"title":"HEDIS","ranking":1}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":"HEDIS","ranking":1}
Example response
{
"id": "8d844faf-d158-11e8-80f4-005056a80294",
"title": "HEDIS",
"ranking": 1,
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /categorizations/{categorizationId}/categories
Creates a new category.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| body | body | postCategorizationsCategorizationidCategories | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The category is successfully created. | QualityMeasurePublicApi_Entities_V1_Category |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Delete a Category
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /categorizations/{categorizationId}/categories/{categoryId}
Deletes the category with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| categoryId | path | string | true | N/A | The ID of the category field. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The category is deleted. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Category
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8d844faf-d158-11e8-80f4-005056a80294",
"title": "HEDIS",
"ranking": 1,
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /categorizations/{categorizationId}/categories/{categoryId}
Retrieves the category with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| categoryId | path | string | true | N/A | The ID of the category field. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single category. | QualityMeasurePublicApi_Entities_V1_Category |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Update a Category
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"title":"HEDIS","ranking":1}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":"HEDIS","ranking":1}
Example response
{
"id": "8d844faf-d158-11e8-80f4-005056a80294",
"title": "HEDIS",
"ranking": 1,
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /categorizations/{categorizationId}/categories/{categoryId}
Updates the category with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| categorizationId | path | string | true | N/A | The ID of the categorization. | - |
| categoryId | path | string | true | N/A | The ID of the category field. | - |
| body | body | putCategorizationsCategorizationidCategories | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The category is successfully updated. | QualityMeasurePublicApi_Entities_V1_Category |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Registries
A registry represents the set of people who match a set of qualifying criteria. You can use registries to identify people who will be participating in a Quality Reporting project for different sets of measures. You can define the registry using an automated approach that applies a logic library to a set of population records. A registry can also be curated using a manual identification processes.
The registry definition resource does not represent a registry; it represents the metadata that helps describe a registry.
Retrieve a List of Registry 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/quality-measure/v1/registries', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"type": "PERSON",
"subjectType": "PATIENT",
"effectivePeriod": {
"start": "2018-07-25T17:03:14.123Z",
"end": "2020-07-25T17:03:14.123Z"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /registries
Retrieves a list of registry definitions.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | query | array[string] | false | N/A | Filters the response by registry ID or IDs. | - |
| name | query | string | false | N/A | Filters the response by registry name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by registry title. Partial text search is supported. | - |
| categoryId | query | array[string] | false | N/A | Filters the response by the specified category ID or IDs. | - |
| tag | query | array[string] | false | N/A | Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. |
- |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
| 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 | A collection of registry definitions. | Registries |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Registry 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/quality-measure/v1/registries', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2021-01-01","end":"2021-12-31"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2021-01-01","end":"2021-12-31"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"type": "PERSON",
"subjectType": "PATIENT",
"effectivePeriod": {
"start": "2018-07-25T17:03:14.123Z",
"end": "2020-07-25T17:03:14.123Z"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /registries
Creates a registry definition.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postRegistries | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The registry definition is created. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Single Registry 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.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2021-01-01","end":"2021-12-31"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2021-01-01","end":"2021-12-31"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"type": "PERSON",
"subjectType": "PATIENT",
"effectivePeriod": {
"start": "2018-07-25T17:03:14.123Z",
"end": "2020-07-25T17:03:14.123Z"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"type": "PERSON",
"subjectType": "PATIENT",
"effectivePeriod": {
"start": "2018-07-25T17:03:14.123Z",
"end": "2020-07-25T17:03:14.123Z"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /registries/{registryId}
Updates a single registry definition.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryId | path | string | true | N/A | The ID of the registry. | - |
| body | body | putRegistries | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The registry definition is updated. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
| 201 | Created | The registry definition is created. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Registry 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/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"type": "PERSON",
"subjectType": "PATIENT",
"effectivePeriod": {
"start": "2018-07-25T17:03:14.123Z",
"end": "2020-07-25T17:03:14.123Z"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /registries/{registryId}
Retrieves a single registry definition.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryId | path | string | true | N/A | The ID of the registry. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single registry definition. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Measures
Measures represent a structured, computable definition of a health-related measure such as a clinical quality measure, public health indicator, or population analytics measure. A quality measure is a quantitative tool used to assess the performance of an individual or organization with respect to a specified process or outcome using the measurement of actions, processes, or outcomes of clinical care. Quality measures are often derived from clinical guidelines and are designed to determine whether the appropriate care has been provided given a set of clinical criteria and an evidence base. The initial population of a measure can be indicated by referencing a registry.
Retrieve a List of Measures
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/quality-measure/v1/measures', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2310677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"improvementNotation": "INCREASE",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /measures
Retrieves a list of measures.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | query | array[string] | false | N/A | Filters the response by measure ID or IDs. | - |
| name | query | string | false | N/A | Filters the response by measure name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by measure title. Partial text search is supported. | - |
| categoryId | query | array[string] | false | N/A | Filters the response by the specified category ID or IDs. | - |
| registryId | query | array[string] | false | N/A | Filters the response by the specified registry ID or IDs. | - |
| tag | query | array[string] | false | N/A | Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. |
- |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
| 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 | A collection of measures. | Measures |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Measure
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/quality-measure/v1/measures', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}
Example response
{
"id": "2310677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"improvementNotation": "INCREASE",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /measures
Creates a measure.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postMeasures | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The measure is created. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Single Measure
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}
Example response
{
"id": "2310677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"improvementNotation": "INCREASE",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
{
"id": "2310677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"improvementNotation": "INCREASE",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /measures/{measureId}
Updates a single measure.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureId | path | string | true | N/A | The ID of the measure. | - |
| body | body | putMeasures | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The measure is updated. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
| 201 | Created | The measure is created. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Measure
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/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "2310677b-28e6-4648-9159-1e114eb7b829",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"categories": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"title": "Cerner Standard",
"categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
}
],
"aliases": [
{
"system": "SOMESYSTEM",
"value": "some-value"
}
],
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "cerner-standard-rules",
"title": "Cerner Standard Rules"
}
],
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"improvementNotation": "INCREASE",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /measures/{measureId}
Retrieves a single measure.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureId | path | string | true | N/A | The ID of the measure. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single measure. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Measure Configurations
The measure configuration represents a configuration scenario for a measure by specifying the version of the libraries to use as well as the values for the input parameters. A single measure can have many different configuration scenarios that are created to facilitate different use cases for measure evaluations.
Retrieve a List of Measure Configuration
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/quality-measure/v1/measure-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /measure-configurations
Retrieves a list of measure configuration.
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. | - |
| id | query | array[string] | false | N/A | Filters the response by measure configuration ID or IDs. | - |
| name | query | string | false | N/A | Filters the response by measure configuration name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by measure configuration title. Partial text search is supported. | - |
| status | query | string | false | N/A | Filters the response by activation status. Valid options are: ACTIVE or INACTIVE. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of measure configuration. | MeasureConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Measure Configuration
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/quality-measure/v1/measure-configurations', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"status":"ACTIVE","createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"status":"ACTIVE","createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /measure-configurations
Creates a measure configuration.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postMeasureConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The measure configuration is created. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Measure Configuration
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/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /measure-configurations/{measureConfigurationId}
Retrieves the measure configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single measure configuration. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Measure Configuration
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"status":"ACTIVE","updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"status":"ACTIVE","updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /measure-configurations/{measureConfigurationId}
Updates the measure configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
| body | body | putMeasureConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The measure configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
| 201 | Created | The measure configuration is successfully created. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a List of Measure Configuration Versions
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/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /measure-configurations/{measureConfigurationId}/versions
Retrieves a list of measure configuration versions.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | -version | A comma-separated list of fields by which to sort. | version, -version |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of measure configuration versions. | MeasureConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Version of Single Measure Configuration
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/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"subtitle": "Asthma Action Plan",
"description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"status": "ACTIVE",
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /measure-configurations/{measureConfigurationId}/versions/{versionNumber}
Retrieves the version of measure configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
| versionNumber | path | string | true | N/A | The version number. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single measure configuration. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Measurement Periods
The measurement period represents a structure that provides a single point of reference for all library parameters, such as the start and end of the measurement period that should be applied. The measurement period structure supports both a fixed set of dates and a relative date definition.
Retrieve a List of Measurement Periods
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/quality-measure/v1/measurement-periods', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04",
"startRelativeTimeModifier": "-12mon",
"endRelativeTimeModifier": "now",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /measurement-periods
Retrieves a list of measurement periods.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| name | query | string | false | N/A | Filters the response by the specified name. | - |
| title | query | string | false | N/A | Filters the response by the specified title. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
| 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 | A collection of measurement periods. | MeasurementPeriods |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Measurement Period
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/quality-measure/v1/measurement-periods', headers: headers, body: {"name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04","startRelativeTimeModifier":"-12mon","endRelativeTimeModifier":"now"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04","startRelativeTimeModifier":"-12mon","endRelativeTimeModifier":"now"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04",
"startRelativeTimeModifier": "-12mon",
"endRelativeTimeModifier": "now",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
POST /measurement-periods
Creates a measurement period.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postMeasurementPeriods | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The measurement period is created. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Delete a Measurement Period
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /measurement-periods/{measurementPeriodId}
Deletes a measurement period.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The measurement period is deleted. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Measurement Period
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04","startRelativeTimeModifier":"-12mon","endRelativeTimeModifier":"now"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"r12m","title":"Rolling 12 Months","start":"2019-12-04","end":"2020-12-04","startRelativeTimeModifier":"-12mon","endRelativeTimeModifier":"now"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04",
"startRelativeTimeModifier": "-12mon",
"endRelativeTimeModifier": "now",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
PUT /measurement-periods/{measurementPeriodId}
Updates a measurement period.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
| body | body | putMeasurementPeriods | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The measurement period is updated. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Measurement Period
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/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04",
"startRelativeTimeModifier": "-12mon",
"endRelativeTimeModifier": "now",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /measurement-periods/{measurementPeriodId}
Retrieves a measurement period.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single measurement period. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Registry Configurations
The registry configuration represents a configuration scenario for a registry by specifying the version of the libraries to use as well as the values for the input parameters. A single registry can have many different configuration scenarios that are created to facilitate different use cases for registry evaluations and the associated measures evaluations.
Retrieve a List of Registry Configurations
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/quality-measure/v1/registry-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /registry-configurations
Retrieves a list of registry configurations.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | query | array[string] | false | N/A | Filters the response by registry configuration ID or IDs. | - |
| name | query | string | false | N/A | Filters the response by registry configuration name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by registry configuration title. Partial text search is supported. | - |
| status | query | string | false | N/A | Filters the response by activation status. Valid options are: ACTIVE or INACTIVE. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of registry configurations. | RegistryConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Registry Configuration
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/quality-measure/v1/registry-configurations', headers: headers, body: {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"status":"ACTIVE","createdBy":{"id":"e2025ca9-a137-4309-adef-08cda086eefe"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"status":"ACTIVE","createdBy":{"id":"e2025ca9-a137-4309-adef-08cda086eefe"}}
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
POST /registry-configurations
Creates a registry configuration.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postRegistryConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The registry configuration is created. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Registry Configuration
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/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
GET /registry-configurations/{registryConfigurationId}
Retrieves the registry configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single registry configuration. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Registry Configuration
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"status":"ACTIVE","updatedBy":{"id":"368cde2d-760e-4ceb-978b-20f16102891c"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","description":"The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or the previous two measurement periods.","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"status":"ACTIVE","updatedBy":{"id":"368cde2d-760e-4ceb-978b-20f16102891c"}}
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
PUT /registry-configurations/{registryConfigurationId}
Updates the registry configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
| body | body | putRegistryConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The registry configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
| 201 | Created | The registry configuration is created. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a List of Registry Configuration Versions
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/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /registry-configurations/{registryConfigurationId}/versions
Retrieves a list of registry configuration versions.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | -version | A comma-separated list of fields by which to sort. | -version, version |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of registry configuration versions. | RegistryConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Version of a Registry Configuration
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/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"type": "PERSON"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"status": "ACTIVE",
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
GET /registry-configurations/{registryConfigurationId}/versions/{versionNumber}
Retrieves the specified version of a registry configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
| versionNumber | path | string | true | N/A | The version number of the registry configuration. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single registry configuration. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Reporting Project Configurations
The reporting project configuration represents a configuration scenario for a reporting project. The configuration is used as the input instructions to run the quality measure reporting project configuration.
Retrieve a List of Reporting Project Configurations
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/x-www-form-urlencoded',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /reporting-project-configurations
Retrieves a list of reporting project configurations.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| name | query | string | false | N/A | Filters the response by measure name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by measure title. Partial text search is supported. | - |
| tag | query | array[string] | false | N/A | Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. |
- |
| population | query | array[string] | false | N/A | Filters the response by population ID. | - |
| measurementPeriodId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
| registryConfigurationId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
| measureConfigurationId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
| measureHierarchyIndexId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
| body | body | object | false | N/A | No description | - |
| » id | body | [string] | false | N/A | Filters the response by reporting project configuration ID or IDs. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of reporting project configurations. | ReportingProjectConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Reporting Project Configuration
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/quality-measure/v1/reporting-project-configurations', headers: headers, body: {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
POST /reporting-project-configurations
Creates a new reporting project configuration.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postReportingProjectConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The reporting project configuration is successfully created. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Reporting Project Configuration
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/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /reporting-project-configurations/{reportingProjectConfigurationId}
Retrieves the reporting project configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single reporting project configuration. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Reporting Project Configuration
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7', headers: headers, body: {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
PUT /reporting-project-configurations/{reportingProjectConfigurationId}
Updates the reporting project configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
| body | body | putReportingProjectConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The reporting project configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
| 201 | Created | The reporting project configuration is created. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a List of Reporting Project Configuration Versions
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/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /reporting-project-configurations/{reportingProjectConfigurationId}/versions
Retrieves a list of reporting project configuration versions.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | -version | A comma-separated list of fields by which to sort. | -version, version |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of reporting project configuration versions. | ReportingProjectConfigurations |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Version of a Reporting Project Configuration
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/quality-measure/v1/reporting-project-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-project-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months",
"start": "2019-12-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /reporting-project-configurations/{reportingProjectConfigurationId}/versions/{versionNumber}
Retrieves the specified version of a reporting project configuration with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
| versionNumber | path | string | true | N/A | The version number. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single reporting project configuration. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Hierarchy Indexes
Hierarchy indexes indicate related measures that have prioritization relationships.
Create a Hierarchy Index
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/quality-measure/v1/hierarchy-indexes', headers: headers, body: {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}
POST /hierarchy-indexes
Creates a hierarchy index.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postHierarchyIndexes | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The hierarchy index is created. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The URL of the created definition. |
Retrieve a List of Hierarchy Indexes
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/quality-measure/v1/hierarchy-indexes', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes
Retrieves a list of hierarchy indexes.
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 | The collection of hierarchy indexes is retrieved. | HierarchyIndices |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Update a Hierarchy Index
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}
PUT /hierarchy-indexes/{indexId}
Updates a hierarchy index.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
| body | body | putHierarchyIndexes | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The hierarchy index is updated. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Delete a Hierarchy Index
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /hierarchy-indexes/{indexId}
Deletes a hierarchy index. When a hierarchy index is deleted, all the hierarchy groups associated with the index are also deleted.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The hierarchy index is deleted. | None |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Hierarchy Index
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/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}
Retrieves a single hierarchy index.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single hierarchy index is retrieved. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Hierarchy Indexes - Groups
Hierarchy groups are defined under hierarchy indexes and indicate which collections of measures have the same priorities.
Create a Hierarchy Group
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/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
POST /hierarchy-indexes/{indexId}/groups
Creates a hierarchy group.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The hierarchy group is created. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The URL of the created definition. |
Retrieve a List of Hierarchy 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/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}/groups
Retrieves a list of the hierarchy groups associated with the specified index ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
| 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 | The collection of hierarchy groups is retrieved. | HierarchyGroups |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Update a Hierarchy Group
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
PUT /hierarchy-indexes/{indexId}/groups/{groupId}
Updates a hierarchy group.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
| groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The hierarchy group is updated. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Delete a Hierarchy Group
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /hierarchy-indexes/{indexId}/groups/{groupId}
Deletes a hierarchy group.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
| groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The hierarchy group is deleted. | None |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Hierarchy 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/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}/groups/{groupId}
Retrieves a single hierarchy group.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
| groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single hierarchy group is retrieved. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Reporting Projects
Reporting projects represent an environment for executing measures under a targeted usage scenario. The scenario may be for an end-user workflow or for an analytics-based need.
Retrieve a List of Reporting Projects
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/quality-measure/v1/reporting-projects', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /reporting-projects
Retrieves a list of reporting projects.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| id | query | array[string] | false | N/A | Filters the response by reporting project ID or IDs. | - |
| name | query | string | false | N/A | Filters the response by reporting project name. Partial text search is supported. | - |
| title | query | string | false | N/A | Filters the response by reporting project title. Partial text search is supported. | - |
| tag | query | array[string] | false | N/A | Filters the response by the specified tags. Each tag can be represented as a single key or as a key:value pair. |
- |
| useContextsType | query | string | false | N/A | The type of context being specified. Requires useContextsValue. | - |
| useContextsValue | query | string | false | N/A | The value that defines the context. Requires useContextsType. | - |
| population | query | array[string] | false | N/A | Filters the response by population ID. | - |
| measurementPeriodId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
| status | query | array[string] | false | N/A | Filters the response by the status that represents the lifecycle step of the reporting project. The following options are available: DRAFT, PUBLISHED or SUSPENDED. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of reporting projects. | ReportingProjects |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Create a Reporting Project
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/quality-measure/v1/reporting-projects', headers: headers, body: {"name":"healthe-registries","title":"HealtheRegistries","reportingProjectConfiguration":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"},"status":"PUBLISHED","useContexts":[{"type":"PROGRAM","value":{"text":"Clinical Standard v4"}}],"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"healthe-registries","title":"HealtheRegistries","reportingProjectConfiguration":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"},"status":"PUBLISHED","useContexts":[{"type":"PROGRAM","value":{"text":"Clinical Standard v4"}}],"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /reporting-projects
Creates a new reporting project.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postReportingProjects | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The reporting project is successfully created. | QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Reporting Project
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/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /reporting-projects/{reportingProjectId}
Retrieves the reporting project with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectId | path | string | true | N/A | The ID of the reporting project. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single reporting project. | QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Update a Reporting Project
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'application/json',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7', headers: headers, body: {"name":"healthe-registries","title":"HealtheRegistries","reportingProjectConfiguration":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"},"status":"PUBLISHED","useContexts":[{"type":"PROGRAM","value":{"text":"Clinical Standard v4"}}],"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"healthe-registries","title":"HealtheRegistries","reportingProjectConfiguration":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"},"status":"PUBLISHED","useContexts":[{"type":"PROGRAM","value":{"text":"Clinical Standard v4"}}],"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /reporting-projects/{reportingProjectId}
Updates the reporting project with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectId | path | string | true | N/A | The ID of the reporting project. | - |
| body | body | putReportingProjects | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The reporting project is successfully updated. | QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject |
| 201 | Created | The reporting project is created. | QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a List of Reporting Project Versions
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/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/d1ed37db-3380-4428-91de-fe2e951ccf7/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}
GET /reporting-projects/{reportingProjectId}/versions
Retrieves a list of reporting project versions.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectId | path | string | true | N/A | The ID of the reporting project. | - |
| offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
| limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
| orderBy | query | string | false | -version | A comma-separated list of fields by which to sort. | -version, version |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A collection of reporting project versions. | ReportingProjects |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Retrieve a Single Version of a Reporting Project
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/quality-measure/v1/reporting-projects/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/reporting-projects/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"reportingProjectConfiguration": {
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "Member Population",
"subpopulation": {
"id": "f90892d6-249c-413e-9f37-a1b94c5cfd66",
"name": "Member Subpopulation"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "r12m",
"title": "Rolling 12 Months"
}
},
"status": "PUBLISHED",
"version": 1,
"tags": [
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
],
"useContexts": {
"type": "PROGRAM",
"value": {
"text": "Clinical Standard v4"
}
},
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /reporting-projects/{reportingProjectId}/versions/{versionNumber}
Retrieves the specified version of a reporting project with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| reportingProjectId | path | string | true | N/A | The ID of the reporting project. | - |
| versionNumber | path | string | true | N/A | The version number. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single reporting project. | QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Clinical Data Entry - Forms
Clinical data entry (CDE) forms represent the input forms used to collect clinical data for measure evaluation.
Create a Clinical Data Entry Form
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/quality-measure/v1/clinical-data-entry-forms', headers: headers, body: {"name":"clinical data entry forms","title":"v1 clinical data entry forms","createdBy":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"clinical data entry forms","title":"v1 clinical data entry forms","createdBy":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}
POST /clinical-data-entry-forms
Creates a clinical data entry form.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| body | body | postClinicalDataEntryForms | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The clinical data entry form is created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Delete a Clinical Data Entry Form
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/3123179c-9617-4ac5-8601-8054755a2124', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/3123179c-9617-4ac5-8601-8054755a2124 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /clinical-data-entry-forms/{cdeFormId}
Deletes a clinical data entry form.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The clinical data entry form is deleted. | None |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 404 | Not Found | Not Found | Error |
Retrieve a Single Clinical Data Entry Form
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/quality-measure/v1/clinical-data-entry-forms/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "6891677b-28e6-4648-9159-1e114eb7c123",
"name": "clinical data entry form",
"title": "v1 clinical data entry form",
"status": "DRAFT",
"createdAt": "2021-04-19T13:00:14.120Z",
"createdBy": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
GET /clinical-data-entry-forms/{cdeFormId}
Retrieves the clinical data entry form with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A single clinical data entry form is retrieved. | QualityMeasurePublicApi_Entities_V1_CDE_Forms_Form |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Retrieve a Clinical Data Entry Form
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/quality-measure/v1/clinical-data-entry-forms/6d984963-5306-40e8-8157-c65348a2fe43/expansion', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/6d984963-5306-40e8-8157-c65348a2fe43/expansion \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"fieldSets": {
"fieldSets": [
{
"id": "6891677b-28e6-4648-9159-1e114eb7c930",
"name": "CSv4 BMI",
"fieldSetType": "multi_line_bmi",
"title": "BMI",
"fields": [
{
"name": "Height",
"inputType": "number",
"serviceType": "NUMERIC",
"dataType": "decimal",
"placeholder": "Height",
"coding": {
"code": "50373000",
"system": "2.16.840.1.113883.6.96"
},
"unitOfMeasure": [
{
"text": "in",
"minValue": "12",
"maxValue": "100",
"coding": {
"code": "258677007",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "cm",
"minValue": "30",
"maxValue": "250",
"coding": {
"code": "258672001",
"system": "2.16.840.1.113883.6.96"
}
}
],
"usesModifierCode": true,
"servicePeriod": {
"start": "2021-01-01",
"end": "2021-12-31"
},
"attachmentFileTypes": [
".pdf"
],
"attachmentRequired": false,
"approvalRequired": true
},
{
"name": "Weight",
"inputType": "number",
"serviceType": "NUMERIC",
"dataType": "decimal",
"placeholder": "Weight",
"coding": {
"code": "27113001",
"system": "2.16.840.1.113883.6.96"
},
"unitOfMeasure": [
{
"text": "lb",
"minValue": "0",
"maxValue": "999",
"coding": {
"code": "258693003",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "kg",
"minValue": "0",
"maxValue": "540",
"coding": {
"code": "258683005",
"system": "2.16.840.1.113883.6.96"
}
}
],
"usesModifierCode": true,
"servicePeriod": {
"start": "2021-01-01",
"end": "2021-12-31"
},
"attachmentFileTypes": [
".pdf"
],
"attachmentRequired": true,
"approvalRequired": false
}
]
},
{
"id": "6891677b-28e6-4648-9159-1e114eb7c931",
"name": "CSv4 LFT",
"fieldSetType": "multi_select",
"title": "LFT",
"fields": [
{
"name": "LFT",
"inputType": "multi_select",
"serviceType": "PROCEDURE",
"dataType": "string",
"placeholder": "weight",
"coding": {
"code": "390979001",
"system": "2.16.840.1.113883.6.96"
},
"inputValues": [
{
"text": "ALT",
"minValue": 12,
"maxValue": 100,
"coding": {
"code": "250637003",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "AST",
"minValue": 12,
"maxValue": 100,
"coding": {
"code": "45896001",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "Alkaline phosphatase",
"minValue": 12,
"maxValue": 100,
"coding": {
"code": "390979001",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "Albumin",
"minValue": 12,
"maxValue": 100,
"coding": {
"code": "104485008",
"system": "2.16.840.1.113883.6.96"
}
},
{
"text": "Bilirubin",
"minValue": 12,
"maxValue": 100,
"coding": {
"code": "313840000",
"system": "2.16.840.1.113883.6.96"
}
}
],
"unitOfMeasure": [],
"usesModifierCode": true,
"servicePeriod": {
"start": "2021-01-01",
"end": "2021-12-31"
},
"attachmentFileTypes": [
".pdf"
],
"attachmentRequired": false,
"approvalRequired": true
}
]
}
]
},
"categories": [
{
"name": "vitals",
"title": "Vitals",
"fieldSets": [
{
"id": "6891677b-28e6-4648-9159-1e114eb7c930",
"name": "CSv4 BMI"
}
]
},
{
"name": "vitals2",
"title": "Vitals2",
"fieldSets": [
{
"id": "9291677b-28e6-4648-9159-1e114eb7c930",
"name": "CSv4 BMI"
}
]
}
],
"measures": [
{
"measure": {
"id": "5780677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"fieldSets": [
{
"id": "6891677b-28e6-4648-9159-1e114eb7c931",
"name": "CSv4 BMI"
}
]
}
],
"registryConfigurations": [
{
"registryConfiguration": {
"id": "lumeris.depression.clinical.depression.YTD",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical"
},
"fieldSets": [
{
"id": "6891677b-28e6-4648-9159-1e114eb7c931",
"name": "CSv4 BMI"
}
]
}
],
"cohorts": [
{
"cohort": {
"id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
},
"fieldSets": [
{
"id": "6891677b-28e6-4648-9159-1e114eb7c931",
"name": "CSv4 BMI"
}
]
},
{
"cohort": {
"id": "8ed017ef-7d31-390e-b4fe-52d9f86e517e"
},
"fieldSets": [
{
"id": "4591677b-28e6-4648-9159-1e114eb7c931",
"name": "CSv4 BMI"
}
]
}
]
}
GET /clinical-data-entry-forms/{cdeFormId}/expansion
Retrieves the clinical data entry form expansion with the specified ID.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The clinical data entry form expansion is retrieved. | QualityMeasurePublicApi_Entities_V1_CDE_Forms_Expansion |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
Clinical Data Entry - Field Sets
Field sets represent the definition of input controls used to capture clinical data. The field set definitions commonly assign meaning to the data entered by mapping the values to standard code systems (for example, SNOMED-CT or LOINC).
Create a Field Set
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/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-sets', headers: headers, body: {"fieldSets":[{"cohortId":"874a4fff-5d2e-4a08-8633-32d6f3dfdaa8","name":"CSv4 BMI","fieldSetType":"multi_line_bmi","title":"BMI","fields":[{"name":"Height","inputType":"number","serviceType":"NUMERIC","dataType":"decimal","placeholder":"Height","coding":{"code":"50373000","system":"2.16.840.1.113883.6.96"},"inputValues":[{"text":"in","minValue":12,"maxValue":100,"coding":{"code":"258677007","system":"2.16.840.1.113883.6.96"}},{"text":"cm","minValue":30,"maxValue":250,"coding":{"code":"258672001","system":"2.16.840.1.113883.6.96"}}],"usesModifierCode":true,"servicePeriod":{"start":"2021-01-01","end":"2021-12-31"},"attachmentFileTypes":[".pdf"],"attachmentRequired":false,"approvalRequired":true},{"name":"Weight","inputType":"number","serviceType":"NUMERIC","dataType":"decimal","placeholder":"Weight","coding":{"code":"27113001","system":"2.16.840.1.113883.6.96"},"inputValues":[{"text":"lb","minValue":0,"maxValue":999,"coding":{"code":"258693003","system":"2.16.840.1.113883.6.96"}},{"text":"kg","minValue":0,"maxValue":540,"coding":{"code":"258683005","system":"2.16.840.1.113883.6.96"}}],"usesModifierCode":true,"servicePeriod":{"start":"2021-01-01","end":"2021-12-31"},"attachmentFileTypes":[".pdf"],"attachmentRequired":true,"approvalRequired":false}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-sets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fieldSets":[{"cohortId":"874a4fff-5d2e-4a08-8633-32d6f3dfdaa8","name":"CSv4 BMI","fieldSetType":"multi_line_bmi","title":"BMI","fields":[{"name":"Height","inputType":"number","serviceType":"NUMERIC","dataType":"decimal","placeholder":"Height","coding":{"code":"50373000","system":"2.16.840.1.113883.6.96"},"inputValues":[{"text":"in","minValue":12,"maxValue":100,"coding":{"code":"258677007","system":"2.16.840.1.113883.6.96"}},{"text":"cm","minValue":30,"maxValue":250,"coding":{"code":"258672001","system":"2.16.840.1.113883.6.96"}}],"usesModifierCode":true,"servicePeriod":{"start":"2021-01-01","end":"2021-12-31"},"attachmentFileTypes":[".pdf"],"attachmentRequired":false,"approvalRequired":true},{"name":"Weight","inputType":"number","serviceType":"NUMERIC","dataType":"decimal","placeholder":"Weight","coding":{"code":"27113001","system":"2.16.840.1.113883.6.96"},"inputValues":[{"text":"lb","minValue":0,"maxValue":999,"coding":{"code":"258693003","system":"2.16.840.1.113883.6.96"}},{"text":"kg","minValue":0,"maxValue":540,"coding":{"code":"258683005","system":"2.16.840.1.113883.6.96"}}],"usesModifierCode":true,"servicePeriod":{"start":"2021-01-01","end":"2021-12-31"},"attachmentFileTypes":[".pdf"],"attachmentRequired":true,"approvalRequired":false}]}]}
POST /clinical-data-entry-forms/{cdeFormId}/field-sets
Creates a field set.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
| body | body | postClinicalDataEntryFormsCdeformidFieldSets | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The field set is created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The web address of the created definition. |
Clinical Data Entry - Field Set Categories
Field set categories are clinical data entry construct that can be used to group field sets to a category.
Create Field Set Categories
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/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-categories', headers: headers, body: {"fieldSetCategories":[{"name":"vitals","title":"Vitals","fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c930"},{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]},{"name":"labs","title":"Labs","fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c930"},{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fieldSetCategories":[{"name":"vitals","title":"Vitals","fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c930"},{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]},{"name":"labs","title":"Labs","fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c930"},{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}
POST /clinical-data-entry-forms/{cdeFormId}/field-set-categories
Creates field set categories.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
| body | body | postClinicalDataEntryFormsCdeformidFieldSetCategories | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The field set categories are created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The web address of the created definition. |
Clinical Data Entry - Field Set Registries Configurations
Field set registries configurations are clinical data entry construct that can be used to group field sets to a registries configurations.
Create Field Set Registries Configuration
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/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-registries-configurations', headers: headers, body: {"fieldsetRegistriesConfigurations":[{"registryConfiguration":{"id":"9320677b-28e6-4648-9159-1e114eb7b829"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-registries-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fieldsetRegistriesConfigurations":[{"registryConfiguration":{"id":"9320677b-28e6-4648-9159-1e114eb7b829"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}
POST /clinical-data-entry-forms/{cdeFormId}/field-set-registries-configurations
Creates field set registries configuration.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
| body | body | postClinicalDataEntryFormsCdeformidFieldSetRegistriesConfigurations | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The field set registries configuration is created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The web address of the created definition. |
Clinical Data Entry - Field Set Measures
Field set measures are clinical data entry construct that can beused to group field sets to a measure.
Create a Field Set Measure
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/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-measures', headers: headers, body: {"fieldsetMeasures":[{"measure":{"id":"5780677b-28e6-4648-9159-1e114eb7b829"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]},{"measure":{"id":"5780677b-28e6-4648-9159-1e114eb7b839"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c940"}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-measures \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fieldsetMeasures":[{"measure":{"id":"5780677b-28e6-4648-9159-1e114eb7b829"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]},{"measure":{"id":"5780677b-28e6-4648-9159-1e114eb7b839"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c940"}]}]}
POST /clinical-data-entry-forms/{cdeFormId}/field-set-measures
Creates a field set measure.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
| body | body | postClinicalDataEntryFormsCdeformidFieldSetMeasures | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The field set measure is created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The web address of the created definition. |
Clinical Data Entry - Field Set Cohorts
Field set cohorts are clinical data entry constructs that can be used to group field sets to a cohort.
Create Field Set Cohorts
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/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-cohorts', headers: headers, body: {"fieldSetCohorts":[{"cohort":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/clinical-data-entry-forms/d1ed37db-3380-4428-91de-fe2e951ccf7/field-set-cohorts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fieldSetCohorts":[{"cohort":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e"},"fieldSets":[{"id":"6891677b-28e6-4648-9159-1e114eb7c931"}]}]}
POST /clinical-data-entry-forms/{cdeFormId}/field-set-cohorts
Creates field set cohorts.
Parameters
| Parameter | In | Type | Required | Default | Description | Accepted Values |
|---|---|---|---|---|---|---|
| cdeFormId | path | string | true | N/A | The unique ID of the clinical data entry form. | - |
| body | body | postClinicalDataEntryFormsCdeformidFieldSetCohorts | true | N/A | No description | - |
Response Statuses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | The field set cohorts are created. | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | Error |
| 403 | Forbidden | Forbidden | Error |
| 415 | Unsupported Media Type | Unsupported Media Type | Error |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | The web address of the created definition. |
Schema Definitions
Field
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the field. | - |
| componentName | string | false | The qualified name of the component. | - |
| populationGroupType | string | false | The qualified type of population group. | DENOMINATOR, DENOMINATOR-EXCEPTION, DENOMINATOR-EXCLUSION, NUMERATOR |
MeasureDefReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | false | The ID of the measure definition. This ID is required if an alias is not specified. | - |
| alias | Alias | false | The alias details of the measure definition. This alias is required if an ID is not specified. | - |
Alias
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| system | string | false | The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. | - |
| value | string | false | The unique ID of the provider in the context of the system or assigning authority. | - |
Tests
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| field | string | true | The name of the field to be used in the test. | - |
| operator | string | true | The relational operator that is used to perform the operations on two operands. The following operators are available:
|
EQ, GTE, GT, LT, LTE, NE |
| value | string | true | The value to compare to the field using the operator. | - |
Messages
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| format | string | true | The format of the message. | TEXT, MARKDOWN |
| type | string | true | The type of the message. | NARRATIVE, RESULT_OUTCOME, RESULT_OUTCOME_DATE |
| template | string | true | The message template that is displayed for the measure if the test is successful. | - |
postRecommendationPolicies
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The name of the recommendation policy. | - |
| title | string | true | The title of the recommendation policy. | - |
| fields | [Field] | false | No description | - |
| measureDefinition | MeasureDefReference | true | A reference to the measure definition. | - |
| tests | [Tests] | false | The tests that contain the fields, operators, and values. | - |
| messages | [Messages] | true | The messages that specify the formats and the templates of the recommendations. | - |
RecommendationPolicy
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the recommendation policy. | - |
| name | string | true | The name of the recommendation policy. | - |
| title | string | true | The title of the recommendation policy. | - |
| fields | [Field] | false | The recommendation names and types. | - |
| measureDefinition | MeasureDefReference | true | The reference to a measure definition. | - |
| tests | [Tests] | false | The tests that contain the fields, operators, and values. | - |
| messages | [Messages] | true | An array of messages that specify the formats and templates of the recommendations. | - |
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. | - |
RecommendationPolicies
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecommendationPolicy] | 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. | - |
RecommendationFields
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecommendationField] | 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. | - |
RecommendationField
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the measure recommendation field. | - |
| name | string | true | The name of the measure recommendation field. | - |
| type | string | true | The type of the field. | string, numeric, boolean, date |
| description | string | false | The description of the measure recommendation field. | - |
| dataPointType | string | false | The supporting data point type. | - |
| path | string | false | The path of the supporting data type from which the values are retrieved. | - |
RecommendationPeople
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [RecommendationPerson] | 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. | - |
RecommendationPerson
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| pipeline | object | true | A reference to the pipeline. | - |
| » id | string | true | The ID of the pipeline. | - |
| patient | Patient | true | The patient details. | - |
| measureDefinition | MeasureDefReference | true | A reference to the measure definition. | - |
| recommendationPolicy | RecommendationPolicyPerson | true | A reference to the recommendation policy. | - |
| messages | MessagesPerson | true | The messages that specify the format and message. | - |
Patient
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the person. | - |
| population | object | true | A reference to the population. | - |
| » id | string | true | The ID of the population. | - |
RecommendationPolicyPerson
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the recommendation policy. | - |
| name | string | true | The name of the recommendation policy. | - |
| title | string | true | The title of the recommendation policy, which is most useful for display purposes. | - |
MessagesPerson
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| format | string | true | The format of the message. | - |
| type | string | true | The type of the recommendation message. | NARRATIVE, RESULT_OUTCOME, RESULT_OUTCOME_DATE |
| message | string | true | The message that is displayed to indicate required values. | - |
MeasureResults
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [MeasureResult] | 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. | - |
MeasureResult
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| patient | Patient | true | The patient details. | - |
| event | Event | false | The event details. The event field is displayed only when the outcome is an event measure outcome. |
- |
| measure | MeasureResultsMeasure | true | The reference to the measure that the results are for. | - |
| resultOutcomeSummary | string | true | The outcomes of the measure. The following outcomes are available:
|
ACHIEVED, NOT_ACHIEVED, EXCLUDED, MISSING_DATA |
| due | string | false | Returned true if the measure is due within 30 days or if the date is beyond the due date. Returned false if not, or null if there is no due date. | - |
| daysUntilDue | string | false | Returns the number of days until due. | - |
| status | string | true | The status of the measure. The following states are available:
|
EXCLUDED, MET, EXCEPTION_EXCLUDED, NOT_MET |
| results | [MeasureResultsResult] | false | The list of results for the measure. | - |
| supportingData | [MeasureResultsSupportingData] | false | The list of supporting data for the measure. | - |
Event
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the event. | - |
| date | string | true | The date of the event. In ISO 8601 formatting with precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ. | - |
MeasureResultsMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the measure definition. | - |
| registry | MeasureResultsRegistry | true | The reference to the registry with which the measure is grouped. | - |
MeasureResultsRegistry
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| aliases | [Alias] | false | The list of registry aliases. | - |
MeasureResultsResult
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| populationGroupTypes | [string] | false | The population group types that use expression results to determine the organization of a patient. | - |
| name | string | false | The name of the expression in the condition identification content that generates a value. | - |
| value | MeasureResultsResultValue | false | The value of the expression. | - |
| basis | [MeasureResultsId] | false | The basis for identifying the condition. | - |
MeasureResultsResultValue
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| boolean | boolean | false | The Boolean flag that indicates whether the result is excluded or not. | - |
| component | MeasureResultsComponent | false | The component type of the result. | - |
| dueDate | MeasureResultsDueDate | false | The due date of the result. | - |
MeasureResultsComponent
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| status | string | false | The status of the result. | - |
MeasureResultsDueDate
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| date | string | false | The due date associated with the result. | - |
| frequency | integer(int32) | false | The frequency of the due date of the result. | - |
| frequencyUnit | string | false | The frequency unit of the due date of the result. | - |
| lastSatisfiedDate | string | false | The last satisfied date of the result. | - |
MeasureResultsId
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | false | The ID of the entity. | - |
MeasureResultsSupportingData
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| dataIdentifiers | [MeasureResultsDataIdentifier] | false | The list of data points that contributed to the derivation of the SupportingDataPointLite. | - |
| codifiedValues | [CodeableConcept] | false | The coded values associated with the supporting data. | - |
| additionalValues | [MeasureResultsAdditionalValue] | false | The list of additional relevant fields associated with the intermediate or parent data points. | - |
| period | MeasureResultsPeriod | false | The collection time period of the supporting data. | - |
| value | MeasureResultsValue | false | The result of the observation or measurement. The data type of the result value can be numeric, codified, text, or a date. | - |
| state | string | false | The state of the supporting data. | - |
| personnel | [string] | false | The personnel associated with the creation of the supporting data. | - |
| type | string | false | The type of basis that was considered for the supporting data. | - |
MeasureResultsDataIdentifier
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| sourceIdentifier | MeasureResultsSourceIdentifier | false | The unique ID of the condition for a patient in a data partition. | - |
| reference | MeasureResultsId | false | The ID of the supporting data. | - |
MeasureResultsSourceIdentifier
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | false | The ID of the source identifier. | - |
| dataPartitionId | string | false | The partition ID of the source identifier. | - |
| partitionDescription | string | false | The partition description of the source identifier. | - |
| type | string | false | The type of the source identifier. | - |
| contributingOrganization | string | false | The contributing organization name of the source identifier. | - |
CodeableConcept
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| codings | [Code] | true | A list of codified values from standard code systems recognized by HealtheIntent. | - |
| sourceCodings | [Code] | true | The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. | - |
| text | string | false | This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. | - |
Code
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | string | true | The unique ID of the code. | - |
| display | string | false | A human-readable representation of the code. | - |
| system | string | true | The ID of the coding system that gives meaning to the code. | - |
MeasureResultsAdditionalValue
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| categoryType | string | false | The type of supporting data. | - |
| fields | [MeasureResultsField] | false | The additional values for the supporting data. | - |
MeasureResultsField
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | false | The name of the field. | - |
| value | MeasureResultsValue | false | The field’s value for the data point. | - |
MeasureResultsValue
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| codified | CodeableConcept | false | The codified values of the result for the observation or measurement. | - |
| type | string | false | The type of supporting data. | - |
| period | MeasureResultsPeriod | false | The period of the supporting data. | - |
| text | string | false | The text value of the result for the observation or measurement. | - |
| numeric | MeasureResultsNumeric | false | The numeric value of the result for the observation or measurement. | - |
MeasureResultsPeriod
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| type | string | false | The type of the period. | - |
| end | string | false | The end date of the period. | - |
| start | string | false | The start date of the period. | - |
MeasureResultsNumeric
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| modifier | string | false | An operator that indicates how to interpret the numeric value. For example, greater than (>), less than (<), greater than or equal to (>=), or less than or equal to (<=). Modifiers are often present because of limitations in measurement precision. | - |
| value | string | false | The low or high reference range value, expressed as a numeric value that can be a positive or a negative whole number, or decimal value. | - |
| unitOfMeasure | CodeableConcept | false | The unit of measure for the observation. | - |
ReportingProjects
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject] | 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. | - |
QualityMeasurePublicApi_Entities_V1_ReportingProjects_ReportingProject
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the reporting project being configured. | - |
| name | string | true | The unique, computer-friendly name of the reporting project being configured. | - |
| title | string | true | The human-friendly title of the reporting project. | - |
| reportingProjectConfiguration | ReportingProjectsReportingProjectConfiguration | false | The configuration associated with the reporting project. | - |
| status | string | true | The status that represents the lifecycle step of the reporting project. The following states are available:
|
DRAFT, PUBLISHED, SUSPENDED |
| version | integer(int32) | true | The version of the reporting project. | - |
| tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the reporting project. | - |
| useContexts | [ReportingProjectsUseContext] | false | Use context for the reporting project. | - |
| createdBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who created the reporting project. | - |
| updatedBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who updated the reporting project. This defaults to the createdBy value when the reporting project is created. |
- |
| createdAt | string | true | The date and time when the reporting project was created. | - |
| updatedAt | string | true | The date and time when the reporting project was last updated. | - |
ReportingProjectsReportingProjectConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the reporting project configuration. | - |
| population | CommonPopulation | true | The population that identifies the longitudinal records used to process the quality measures. | - |
| measurementPeriod | ReportingProjectsMeasurementPeriod | false | An optional reference to a measurement period that can be used in the configurations. | - |
CommonPopulation
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the population. | - |
| name | string | false | The unique, computer-friendly name of the population. | - |
| subpopulation | CommonSubpopulation | false | The subpopulation that is being configured. | - |
CommonSubpopulation
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the subpopulation. | - |
| name | string | false | The unique, computer-friendly name of the subpopulation. | - |
ReportingProjectsMeasurementPeriod
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the measurement period. | - |
| name | string | true | The unique, computer-friendly name of the measurement period. | - |
| title | string | true | The unique, human-friendly title of the measurement period. | - |
QualityMeasurePublicApi_Entities_V1_Common_TagReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| key | string | true | The key name of the tag. | - |
| value | string | false | The value of the tag. | - |
ReportingProjectsUseContext
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| type | string | true | Type of context being specified. The following types are available:
|
PROGRAM |
| value | ReportingProjectsTypedValue | true | The value that defines the context. | - |
ReportingProjectsTypedValue
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| text | string | true | The text value for the context type. | - |
QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the individual who updated the resource. | - |
QualityMeasurePublicApi_Entities_V1_Common_CreatedBy
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the individual who created the resource. | - |
postReportingProjects
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the reporting project. | - |
| title | string | true | The title of the reporting project. | - |
| reportingProjectConfiguration | object | false | The ID of the associated reporting project configuration. | - |
| » id | string | true | The unique ID for the reporting project configuration. | - |
| status | string | true | The status that represents the lifecycle step of the reporting project. | DRAFT, PUBLISHED, SUSPENDED |
| useContexts | [object] | false | The coding context used by the reporting project. | - |
| » type | string | true | The type of context. | PROGRAM |
| » value | object | true | The construct for holding typed values. | - |
| »» text | string | true | The text value for the context type. | - |
| createdBy | object | false | An optional reference to the user who created the project. | - |
| » id | string | true | The ID of the individual who created the project. | - |
putReportingProjects
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the reporting project. | - |
| title | string | true | The title of the reporting project. | - |
| reportingProjectConfiguration | object | false | The ID of the associated reporting project configuration. | - |
| » id | string | true | The unique ID for the reporting project configuration. | - |
| status | string | true | The status that represents the lifecycle step of the reporting project. | DRAFT, PUBLISHED, SUSPENDED |
| useContexts | [object] | false | The coding context used by the reporting project. | - |
| » type | string | true | The type of context. | PROGRAM |
| » value | object | true | The construct for holding typed values. | - |
| »» text | string | true | The text value for the context type. | - |
| updatedBy | object | false | An optional reference to the user who updated the project. | - |
| » id | string | true | The ID of the individual who updated the project. | - |
postTags
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| key | string | true | The key for the tag. | - |
| value | string | false | The value for the tag. | - |
| resource | object | true | A reference to the related resource. | - |
| » type | string | true | The resource type. | CLINICAL_DATA_ENTRY_FORM, MEASURE, REGISTRY, REPORTING_PROJECT, REPORTING_PROJECT_CONFIGURATION |
| » id | string | true | The resource ID. | - |
QualityMeasurePublicApi_Entities_V1_Tags_Tag
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The tag ID. | - |
| resource | QualityMeasurePublicApi_Entities_V1_Tags_ResourceReference | true | The resource reference for the tag. | - |
| key | string | true | The key for the tag. | - |
| value | string | false | The value for the tag. | - |
QualityMeasurePublicApi_Entities_V1_Tags_ResourceReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| type | string | true | The resource type. | CLINICAL_DATA_ENTRY_FORM, MEASURE, REGISTRY, REPORTING_PROJECT, REPORTING_PROJECT_CONFIGURATION |
| id | string | true | The resource ID. | - |
Tags
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Tags_Tag] | 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. | - |
Categorizations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization] | 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. | - |
QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the categorization. | - |
| name | string | true | The unique name of the categorization. | - |
| title | string | true | The title of the categorization. | - |
| createdAt | string | true | The date and time when the categorization was created. | - |
| updatedAt | string | true | The date and time when the categorization was updated. This is defaulted to the createdAt value when the categorization is created. |
- |
postCategorizations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the categorization. | - |
| title | string | true | The title of the categorization. | - |
putCategorizations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the categorization. | - |
| title | string | true | The title of the categorization. | - |
Categories
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Category] | 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. | - |
QualityMeasurePublicApi_Entities_V1_Category
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the category. | - |
| title | string | true | A unique human-friendly display for the category. | - |
| ranking | integer(int32) | false | The priority of the category. | - |
| createdAt | string | true | The date and time when the category was created. | - |
| updatedAt | string | true | The date and time when the category was last updated. | - |
postCategorizationsCategorizationidCategories
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| title | string | true | A unique human-friendly display for the category. | - |
| ranking | integer(int32) | false | The priority of the category. | - |
putCategorizationsCategorizationidCategories
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| title | string | true | A unique human-friendly display for the category. | - |
| ranking | integer(int32) | false | The priority of the category. | - |
Registries
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Registries_Registry] | 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. | - |
QualityMeasurePublicApi_Entities_V1_Registries_Registry
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the registry definition. | - |
| version | integer(int32) | true | The version of the registry definition. | - |
| name | string | true | The unique, computer-friendly name of the registry definition. | - |
| title | string | true | The human-friendly title of the registry definition. | - |
| description | string | false | A brief description of the registry definition. This may include Markdown-formatted text. | - |
| categories | [QualityMeasurePublicApi_Entities_V1_Common_CategoryReference] | false | The categories of the registry. Categories are used to categorize registries based on various categorization concepts. | - |
| aliases | [Alias] | false | An optional list of aliases for the registry definition. | - |
| tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the registry definition. | - |
| type | string | true | The type of the registry definition. The following values are available:
|
PERSON, EVENT, OPERATIONAL |
| subjectType | string | true | The subject type of the registry definition. The following values are available:
|
PATIENT, PROVIDER |
| effectivePeriod | QualityMeasurePublicApi_Entities_V1_Registries_EffectivePeriod | false | The effective period details. | - |
| libraries | [QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference] | false | An optional list of libraries for the registry definition. | - |
| createdAt | string | true | The date and time when the registry definition was created. | - |
| updatedAt | string | true | The date and time when the registry definition was updated. This defaults to the createdAt value when the registry definition is created. |
- |
QualityMeasurePublicApi_Entities_V1_Common_CategoryReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the category. | - |
| title | string | false | A human-friendly display for the category. | - |
| categorizationId | string | true | The unique ID for the categorization that the category belongs to. | - |
QualityMeasurePublicApi_Entities_V1_Registries_EffectivePeriod
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| start | string | false | The date and time when the period starts. | - |
| end | string | false | The date and time when the period ends. | - |
QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the measure library. | - |
| name | string | false | The unique, computer-friendly display for the measure library. | - |
| title | string | false | The human-friendly display for the measure library. | - |
postRegistries
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the registry definition. | - |
| title | string | true | The human-friendly title of the registry definition. | - |
| description | string | false | A brief description of the registry definition. This may include Markdown-formatted text. | - |
| type | string | true | The type of the registry definition. The following values are available:
|
PERSON, EVENT, OPERATIONAL |
| subjectType | string | true | The subject type of the registry definition. The following values are available:
|
PATIENT, PROVIDER |
| categories | [object] | false | The category of the registry. Categories are used to group registries based on various categorization concepts. | - |
| » id | string | true | The unique ID of the category. | - |
| aliases | [object] | false | An optional list of aliases for the registry definition. | - |
| » system | string | true | The authority responsible for assigning the alias value. Alias values are unique in this system namespace, but not across systems. | - |
| » value | string | true | The unique ID of the provider in the context of the system or the assigning authority. | - |
| effectivePeriod | object | false | The effective period details. | - |
| » start | string | false | The date and time when the period starts. | - |
| » end | string | false | The date and time when the period ends. | - |
| libraries | [object] | false | An optional list of libraries for the registry definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
putRegistries
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the registry definition. | - |
| title | string | true | The human-friendly title of the registry definition. | - |
| description | string | false | A brief description of the registry definition. This may include Markdown-formatted text. | - |
| type | string | true | The type of the registry definition. The following values are available:
|
PERSON, EVENT, OPERATIONAL |
| subjectType | string | true | The subject type of the registry definition. The following values are available:
|
PATIENT, PROVIDER |
| categories | [object] | false | The category of the registry. Categories are used to group registries based on various categorization concepts. | - |
| » id | string | true | The unique ID of the category. | - |
| aliases | [object] | false | An optional list of aliases for the registry definition. | - |
| » system | string | true | The authority responsible for assigning the alias value. Alias values are unique in this system namespace, but not across systems. | - |
| » value | string | true | The unique ID of the provider in the context of the system or the assigning authority. | - |
| effectivePeriod | object | false | The effective period details. | - |
| » start | string | false | The date and time when the period starts. | - |
| » end | string | false | The date and time when the period ends. | - |
| libraries | [object] | false | An optional list of libraries for the registry definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
Measures
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Measures_Measure] | 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. | - |
QualityMeasurePublicApi_Entities_V1_Measures_Measure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the measure definition. | - |
| version | integer(int32) | true | The version of the measure definition. | - |
| name | string | true | The unique, computer-friendly name of the measure definition. | - |
| title | string | true | The human-friendly title of the measure definition. | - |
| subtitle | string | false | An explanatory or alternate title for the measure giving additional content information. | - |
| description | string | false | A brief description of the measure definition. This may include markdown-formatted text. | - |
| categories | [QualityMeasurePublicApi_Entities_V1_Common_CategoryReference] | false | The categories of the measure. Categories are used to group like measures together. | - |
| aliases | [Alias] | false | An optional list of aliases for the measure definition. | - |
| tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the measure definition. | - |
| libraries | [QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference] | false | An optional list of libraries for the measure definition. | - |
| registry | QualityMeasurePublicApi_Entities_V1_Measures_RegistryReference | false | An optional registry definition that the measure definition is associated with. | - |
| improvementNotation | string | true | The polarity of the measure. A value of INCREASE indicates that you want a higher score for the measure (a positive polarity). A value of DECREASE indicates that you want a lower score for the measure (a negative polarity). |
INCREASE, DECREASE |
| createdAt | string | true | The date and time when the measure definition was created. | - |
| updatedAt | string | true | The date and time when the measure definition was updated. This defaults to the createdAt value when the measure definition is created. |
- |
QualityMeasurePublicApi_Entities_V1_Measures_RegistryReference
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the registry definition. | - |
| name | string | true | The unique, computer-friendly display for the registry definition. | - |
| title | string | true | The unique, human-friendly display for the registry definition. | - |
| type | string | true | The type of the registry definition. | PERSON, EVENT, OPERATIONAL |
postMeasures
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the measure definition. | - |
| title | string | true | The human-friendly title of the measure definition. | - |
| subtitle | string | false | An explanatory or alternative title for the measure giving additional information about its content. | - |
| description | string | false | A brief description of the measure definition. This may include Markdown-formatted text. | - |
| improvementNotation | string | true | The polarity of the measure. A value of INCREASE indicates that you want a higher score for the measure (a positive polarity). A value of DECREASE indicates that you want a lower score for the measure (a negative polarity). |
INCREASE, DECREASE |
| categories | [object] | false | The category of the measure. Categories are used to group similar measure definitions together. | - |
| » id | string | true | The unique ID of the category. | - |
| aliases | [object] | false | An optional list of aliases for the measure definition. | - |
| » system | string | true | The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. | - |
| » value | string | true | The unique ID of the provider in the context of the system or the assigning authority. | - |
| libraries | [object] | false | An optional list of libraries for the measure definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| registry | object | false | An optional registry definition that the measure definition is associated with. | - |
| » id | string | true | The unique ID of the registry definition. | - |
putMeasures
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| title | string | true | The human-friendly title of the measure definition. | - |
| subtitle | string | false | An explanatory or alternative title for the measure giving additional information about its content. | - |
| description | string | false | A brief description of the measure definition. This may include Markdown-formatted text. | - |
| improvementNotation | string | true | The polarity of the measure. A value of INCREASE indicates that you want a higher score for the measure (a positive polarity). A value of DECREASE indicates that you want a lower score for the measure (a negative polarity). |
INCREASE, DECREASE |
| categories | [object] | false | The category of the measure. Categories are used to group similar measure definitions together. | - |
| » id | string | true | The unique ID of the category. | - |
| aliases | [object] | false | An optional list of aliases for the measure definition. | - |
| » system | string | true | The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. | - |
| » value | string | true | The unique ID of the provider in the context of the system or the assigning authority. | - |
| libraries | [object] | false | An optional list of libraries for the measure definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| registry | object | false | An optional registry definition that the measure definition is associated with. | - |
| » id | string | true | The unique ID of the registry definition. | - |
MeasureConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | false | The unique, computer-friendly name of the measure configuration. | - |
| name | string | false | The unique, computer-friendly name of the measure configuration. | - |
| title | string | false | The human-friendly title of the measure configuration. | - |
| subtitle | string | false | An explanatory or alternate title for the measure configuration providing additional content information. | - |
| description | string | false | A brief description of the measure configuration. This may include markdown-formatted text. | - |
| measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a measurement period that can be used in the configurations | - |
| measure | MeasureConfigurationsMeasure | false | The measure definition that is being configured | - |
| libraries | [QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary] | false | The libraries the are configured as part of this measure configuration.Note: This list should match the libraries that are defined as part of the measure-definition. | - |
| version | integer(int32) | true | The version of the registry configuration. | - |
| status | string | false | The activation status of the configuration. The following states are available:
|
ACTIVE, INACTIVE |
| createdBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who created the measure configuration. | - |
| updatedBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who updated the measure configuration. This is defaulted to the createdBy value when the registry configuration is created. |
- |
| createdAt | string | false | The date and time when the measure configuration was created. | - |
| updatedAt | string | false | The date and time when the measure configuration was updated. This is defaulted to the createdAt value when the measure definition is created. |
- |
CommonMeasurementPeriod
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | Unique identifier for the measurement period. | - |
| name | string | true | The unique, computer-friendly name of the measurement period. | - |
| title | string | true | The unique, human-friendly title of the measurement period. | - |
| start | string | false | The start of the measurement period. This value will either be static and provided by a consumer as part of a POST/PUT request or will be dynamically calculated on the response (and not saved in the database) if startRelativeTimeModifier and endRelativeTimeModifier were provided in a POST/PUT request. | - |
| end | string | false | The end of the measurement period. This value will either be static and provided by a consumer as part of a POST/PUT request or will be dynamically calculated on the response (and not saved in the database) if startRelativeTimeModifier and endRelativeTimeModifier were provided in a POST/PUT request. | - |
MeasureConfigurationsMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | false | The unique, computer-friendly name of the measure definition. | - |
| title | string | false | The human-friendly title of the measure definition. | - |
| id | string | false | The unique ID of the measure definition. | - |
QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the measure library. | - |
| name | string | false | The unique, computer-friendly display for the measure library. | - |
| title | string | false | The human-friendly display for the measure library. | - |
| versionedContent | CommonVersionedContent | true | The versioned content of the measure library. | - |
CommonVersionedContent
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| releaseNumber | integer(int32) | true | The version/release number for the given measure library. | - |
| parameters | [CommonVersionedContentParameter] | false | The parameters for the given version of the measure library. | - |
CommonVersionedContentParameter
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The name for the parameter being configured. Note: The name should match a parameter configured in the measure library. | - |
| value | string | false | The value for the parameter being configured. Note: Value type should match the expected type configured in the measure library. | - |
| valueRef | string | false | The value reference for the parameter being configured. | - |
postMeasureConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the measure configuration. | - |
| title | string | true | The human-friendly title of the measure configuration. | - |
| subtitle | string | false | An explanatory or alternative title for the measure configuration providing additional content information. | - |
| description | string | false | A brief description of the measure configuration. This may include markdown-formatted text. | - |
| measurementPeriod | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| measure | object | true | The measure definition that is being configured. | - |
| » id | string | true | The unique ID for the measure being configured. | - |
| libraries | [object] | false | The libraries that are configured as part of this measure configuration. Note: This list should only include the libraries that are referenced as part of the measure definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| » versionedContent | object | true | An optional reference to a measurement period that can be used in the configurations. | - |
| »» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
| »» parameters | [object] | false | The parameters for the given version of the measure library. | - |
| »»» name | string | true | The name of the parameter being configured. Note: Validations should be completed to ensure that the name matches the parameters that are configured in the measure library. | - |
| »»» value | string | false | The value of the parameter being configured. Note: Validations should be completed to ensure that the value type matches the parameters that are configured in the measure library. | - |
| »»» valueRef | string | false | The value reference for the parameter being configured. | - |
| status | string | false | The activation status of the configuration. | ACTIVE, INACTIVE |
| createdBy | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The ID of the individual who created the configuration. | - |
putMeasureConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the measure configuration. | - |
| title | string | true | The human-friendly title of the measure configuration. | - |
| subtitle | string | false | An explanatory or alternative title for the measure configuration providing additional content information. | - |
| description | string | false | A brief description of the measure configuration. This may include markdown-formatted text. | - |
| measurementPeriod | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| measure | object | true | The measure definition that is being configured. | - |
| » id | string | true | The unique ID for the measure being configured. | - |
| libraries | [object] | false | The libraries that are configured as part of this measure configuration. Note: This list should only include the libraries that are referenced as part of the measure definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| » versionedContent | object | true | An optional reference to a measurement period that can be used in the configurations. | - |
| »» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
| »» parameters | [object] | false | The parameters for the given version of the measure library. | - |
| »»» name | string | true | The name of the parameter being configured. Note: Validations should be completed to ensure that the name matches the parameters that are configured in the measure library. | - |
| »»» value | string | false | The value of the parameter being configured. Note: Validations should be completed to ensure that the value type matches the parameters that are configured in the measure library. | - |
| »»» valueRef | string | false | The value reference for the parameter being configured. | - |
| status | string | false | The activation status of the configuration. | ACTIVE, INACTIVE |
| updatedBy | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The ID of the individual who updated the configuration. | - |
MeasurementPeriods
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod] | 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. | - |
QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the measurement period. | - |
| name | string | true | The unique name of the measurement period. | - |
| title | string | true | The unique title of the measurement period. | - |
| start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier. | - |
| end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier. | - |
| startRelativeTimeModifier | string | false | Alias for start relative to the time of the request. Mutually exclusive with start. | - |
| endRelativeTimeModifier | string | false | Alias for end relative to the time of the request. Mutually exclusive with end. | - |
| createdAt | string | true | The date and time when the measurement period was created. | - |
| updatedAt | string | true | The date and time when the measurement period was updated. This is defaulted to the createdAt value when the measurement period is created. |
- |
postMeasurementPeriods
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the measurement period. | - |
| title | string | true | The unique title of the measurement period. | - |
| start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier. |
- |
| end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier. Valid time units are: now, day, month, year. |
- |
| startRelativeTimeModifier | string | false | Alias for the start time relative to the time of the request. Mutually exclusive with start. Valid time units are: now, day, month, year. |
- |
| endRelativeTimeModifier | string | false | Alias for the end time relative to the time of the request. Mutually exclusive with end. |
- |
putMeasurementPeriods
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the measurement period. | - |
| title | string | true | The unique title of the measurement period. | - |
| start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier. |
- |
| end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier. Valid time units are: now, day, month, year. |
- |
| startRelativeTimeModifier | string | false | Alias for the start time relative to the time of the request. Mutually exclusive with start. Valid time units are: now, day, month, year. |
- |
| endRelativeTimeModifier | string | false | Alias for the end time relative to the time of the request. Mutually exclusive with end. |
- |
RegistryConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the registry configuration. | - |
| name | string | true | The unique, computer-friendly name of the registry configuration. | - |
| title | string | true | The human-friendly title of the registry configuration. | - |
| description | string | false | A brief description of the registry configuration. This may include markdown-formatted text. | - |
| version | integer(int32) | true | The version of the registry configuration. | - |
| registry | RegistryConfigurationsRegistry | true | The registry definition that is being configured. | - |
| libraries | [QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
| measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a measurement period that can be used in the configurations. | - |
| status | string | false | The activation status of the configuration. The following states are available:
|
ACTIVE, INACTIVE |
| createdBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who created the registry configuration. | - |
| updatedBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who updated the registry configuration. This defaults to the createdBy value when the registry configuration is created. |
- |
| createdAt | string | true | The date and time when the registry configuration was created. | - |
| updatedAt | string | true | The date and time when the registry configuration was updated. This defaults to the createdAt value when the registry configuration is created. |
- |
RegistryConfigurationsRegistry
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the registry being configured. | - |
| name | string | false | The unique, computer-friendly name of the registry being configured. | - |
| title | string | false | The human-friendly title of the registry being configured. | - |
postRegistryConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the registry configuration. | - |
| title | string | true | The human-friendly title of the registry configuration. | - |
| description | string | false | A brief description of the registry configuration. This may include markdown-formatted text. | - |
| registry | object | true | The registry definition that is being configured. | - |
| » id | string | true | The unique ID of the registry being configured. | - |
| libraries | [object] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| » versionedContent | object | true | The versioned content of the measure library. | - |
| »» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
| »» parameters | [object] | false | The parameters for the given version of the measure library. | - |
| »»» name | string | true | The name for the parameter being configured. Note: Validations should be completed to ensure that the name matches the parameters that are configured in the measure library. | - |
| »»» value | string | false | The value for the parameter being configured. Note: Validations should be completed to ensure that the value type matches the parameters that are configured in the measure library. | - |
| »»» valueRef | string | false | The value reference for the parameter being configured. | - |
| measurementPeriod | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| status | string | false | The activation status of the configuration. | ACTIVE, INACTIVE |
| createdBy | object | false | The individual who created the registry configuration. | - |
| » id | string | true | The ID of the individual who created the resource. | - |
putRegistryConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the registry configuration. | - |
| title | string | true | The human-friendly title of the registry configuration. | - |
| description | string | false | A brief description of the registry configuration. This may include markdown-formatted text. | - |
| registry | object | true | The registry definition that is being configured. | - |
| » id | string | true | The unique ID of the registry being configured. | - |
| libraries | [object] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
| » id | string | true | The unique ID of the measure library. | - |
| » versionedContent | object | true | The versioned content of the measure library. | - |
| »» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
| »» parameters | [object] | false | The parameters for the given version of the measure library. | - |
| »»» name | string | true | The name for the parameter being configured. Note: Validations should be completed to ensure that the name matches the parameters that are configured in the measure library. | - |
| »»» value | string | false | The value for the parameter being configured. Note: Validations should be completed to ensure that the value type matches the parameters that are configured in the measure library. | - |
| »»» valueRef | string | false | The value reference for the parameter being configured. | - |
| measurementPeriod | object | false | An optional reference to a measurement period that can be used in the configurations. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| status | string | false | The activation status of the configuration. | ACTIVE, INACTIVE |
| updatedBy | object | false | The individual who updated the registry configuration. This defaults to the createdBy value when the registry configuration is created. |
- |
| » id | string | true | The ID of the individual who updated the resource. | - |
ReportingProjectConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the reporting project configuration. | - |
| name | string | true | The unique name of the reporting project configuration. | - |
| title | string | true | The title of the reporting project configuration. | - |
| population | CommonPopulation | true | The population that identifies the longitudinal records used to process the quality measures. | - |
| measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
| registryConfigurations | ReportingProjectConfigurationsRegistryConfiguration | false | An optional collection of references to registry configurations. | - |
| measureConfigurations | ReportingProjectConfigurationsMeasureConfiguration | false | An optional collection of references to measure configurations. | - |
| measureHierarchyIndex | ReportingProjectConfigurationsMeasureHierarchyIndex | true | Ranking in the measure hierarchy. | - |
| tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the reporting project configuration. | - |
| version | integer(int32) | true | The version of the reporting project configuration. | - |
| createdBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who created the reporting project configuration. | - |
| updatedBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who updated the reporting project configuration. This defaults to the createdBy value when the reporting project configuration is created. |
- |
| createdAt | string | true | The date and time when the reporting project configuration is created. | - |
| updatedAt | string | true | The date and time when the reporting project configuration is updated. This defaults to the createdAt value when the reporting project configuration is created. |
- |
ReportingProjectConfigurationsRegistryConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the registry configuration. | - |
| registry | CommonRegistry | true | The registry definition that is being configured. | - |
CommonRegistry
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the registry being configured. | - |
| name | string | false | The unique, computer-friendly name of the registry being configured. | - |
| title | string | false | The human-friendly title of the registry being configured. | - |
ReportingProjectConfigurationsMeasureConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the measure configuration. | - |
| measure | CommonMeasure | true | The measure definition that is being configured. | - |
CommonMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | false | The unique, computer-friendly name of the measure definition. | - |
| title | string | false | The human-friendly title of the measure definition. | - |
| id | string | true | The unique ID of the measure definition. | - |
ReportingProjectConfigurationsMeasureHierarchyIndex
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | false | The unique ID of the measure hierarchy index. | - |
| name | string | false | The unique, computer-friendly name of the measure hierarchy index. | - |
postReportingProjectConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the reporting project configuration. | - |
| title | string | true | The title of the reporting project configuration. | - |
| population | object | true | The population and, optionally, subpopulation ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measure hierarchy index. | - |
| » subpopulation | object | false | The object containing the unique ID of the subpopulation. | - |
| »» id | string | true | The unique ID of the subpopulation. | - |
| measurementPeriod | object | false | The measurement period ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| registryConfigurations | [object] | false | The registry configurations associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the registry configuration. | - |
| measureConfigurations | [object] | false | The measure configurations associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the registry configuration. | - |
| measureHierarchyIndex | object | false | The measure hierarchy index ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measure hierarchy index. | - |
| createdBy | object | false | An optional reference to the user that created the configuration. | - |
| » id | string | true | The ID of the individual who created the configuration. | - |
putReportingProjectConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the reporting project configuration. | - |
| title | string | true | The title of the reporting project configuration. | - |
| population | object | true | The population and, optionally, subpopulation ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measure hierarchy index. | - |
| » subpopulation | object | false | The object containing the unique ID of the subpopulation. | - |
| »» id | string | true | The unique ID of the subpopulation. | - |
| measurementPeriod | object | false | The measurement period ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measurement period. | - |
| registryConfigurations | [object] | false | The registry configurations associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the registry configuration. | - |
| measureConfigurations | [object] | false | The measure configurations associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the registry configuration. | - |
| measureHierarchyIndex | object | false | The measure hierarchy index ID associated with the reporting project configuration. | - |
| » id | string | true | The unique ID of the measure hierarchy index. | - |
| updatedBy | object | false | An optional reference to the user that updated the configuration. | - |
| » id | string | true | The ID of the individual who updated the configuration. | - |
postHierarchyIndexes
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The name of the hierarchy index. | - |
| title | string | true | The title of the hierarchy index. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the measure hierarchy index. | - |
| name | string | true | The name of the measure hierarchy index. | - |
| title | string | true | The title of the hierarchy index. | - |
| createdAt | string(date-time) | false | The date and time when the hierarchy index was created. | - |
| updatedAt | string(date-time) | false | The date and time when the hierarchy index was most recently updated. | - |
HierarchyIndices
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex] | 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. | - |
putHierarchyIndexes
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The name of the hierarchy index. | - |
| title | string | true | The title of the hierarchy index. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the measure hierarchy group. | - |
| name | string | true | The name of the measure hierarchy group. | - |
| title | string | true | The title of the hierarchy group. | - |
| rankedMeasures | [QualityMeasurePublicApi_Entities_V1_Hierarchies_RankedMeasure] | false | The list of measures ranked based on priority. | - |
| createdAt | string(date-time) | false | The date and time when the hierarchy group was created. | - |
| updatedAt | string(date-time) | false | The date and time when the hierarchy group was most recently updated. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_RankedMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| measure | QualityMeasurePublicApi_Entities_V1_Hierarchies_Measure | true | A reference to the measure being ranked. | - |
| rank | integer(int32) | true | The rank of the hierarchy group. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_Measure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The ID of the measure. | - |
| name | string | true | The unique, computer-friendly name of the measure definition. | - |
HierarchyGroups
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| items | [QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup] | 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. | - |
postClinicalDataEntryForms
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The name of the clinical data entry form. | - |
| title | string | true | The human-friendly title of the clinical data entry form. | - |
| createdBy | string | true | An reference to the user who created the clinical data entry form. | - |
QualityMeasurePublicApi_Entities_V1_CDE_Forms_Form
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the clinical data entry form. | - |
| name | string | true | The unique name of the clinical data entry form. | - |
| title | string | true | The human-friendly title of the clinical data entry form. | - |
| status | string | true | The status of the clinical data entry form. | - |
| createdAt | string(date-time) | false | The date and time when the clinical data entry form was created. | - |
| createdBy | string | false | The unique identifier for an individual who created the clinical data entry form. | - |
QualityMeasurePublicApi_Entities_V1_CDE_Forms_Expansion
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldSets | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_FieldSet] | true | An array of field sets associated with clinical data entry form. | - |
| categories | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCategories_Category] | true | An array of categories associated with clinical data entry form. | - |
| measures | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetMeasures_FieldSetMeasure] | true | An array of measures associated with clinical data entry form. | - |
| registryConfigurations | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetRegistriesConfigurations_FieldSetRegistriesConfiguration] | true | An array of registries configuration associated with clinical data entry form. | - |
| cohorts | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCohorts_FieldSetCohort] | true | An array of cohorts associated with clinical data entry form. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_FieldSet
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the field set. | - |
| name | string | true | The unique name of the field set. | - |
| fieldSetType | string | true | The type of the field set. | - |
| title | string | true | The human-friendly title of the field set. | - |
| fields | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Field] | true | An array of fields associated with a field set. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Field
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique, computer-friendly name of the field. | - |
| inputType | string | true | The type of user action that takes place for the field. | - |
| serviceType | string | true | The unique String identifier for the type of service. | - |
| dataType | string | true | The data type of the field. | - |
| placeholder | string | false | The application display value of the field. | - |
| coding | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Code | true | The coding object associated with the field. | - |
| inputValues | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_InputValue] | false | The array of inputValues for the field. |
- |
| unitOfMeasure | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_UnitMeasure] | false | The unit of measure of the field. | - |
| usesModifierCode | boolean | true | Indicates whether inputValues are qualifiers and need the associated entryItem, codeSystem, and codeValue. |
- |
| servicePeriod | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Period | false | The service date range for the field. | - |
| attachmentFileTypes | string | false | The file type of the attachment. | - |
| attachmentRequired | boolean | false | Indicates whether attachment is needed for a field set. | - |
| approvalRequired | boolean | false | Indicates whether approval is needed for a field set. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Code
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| code | string | true | The unique ID of the code. | - |
| system | string | true | The ID of the coding system that gives meaning to the code. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_InputValue
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| text | string | true | The description of the input value. | - |
| minValue | integer(int32) | true | The minimum value that can be assigned to a input field. | - |
| maxValue | integer(int32) | true | The maximum value that can be assigned to a input field. | - |
| coding | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Code | true | The coding object associated with the input value. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_UnitMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| text | string | true | The description of the measure. | - |
| minValue | integer(int32) | true | The minimum value of the measure. | - |
| maxValue | integer(int32) | true | The maximum value of the measure. | - |
| coding | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Code | true | The standard code for the unit of measure. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Period
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| start | string(date) | false | The Date of Service can be on or after this specified date. | - |
| end | string(date) | false | The Date of Service can be on or before this specified date. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCategories_Category
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| name | string | true | The unique name of the field set category. | - |
| title | string | true | The human-friendly title of the field set category. | - |
| fieldSets | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCommon] | true | An array of field sets associated to a category. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCommon
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the field set. | - |
| name | string | true | The unique name of the field set. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetMeasures_FieldSetMeasure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| measure | QualityMeasurePublicApi_Entities_V1_CDE_FieldSetMeasures_Measure | true | The measure associated to field set. | - |
| fieldSets | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCommon] | true | An array of field sets associated to a measure. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetMeasures_Measure
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the measure. | - |
| name | string | true | The unique, computer-friendly name of the measure. | - |
| title | string | true | The human-friendly title of the measure. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetRegistriesConfigurations_FieldSetRegistriesConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| registryConfiguration | QualityMeasurePublicApi_Entities_V1_CDE_FieldSetRegistriesConfigurations_RegistryConfiguration | true | The registry configuration. | - |
| fieldSets | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCommon] | true | An array of field sets associated to a registry configuration. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetRegistriesConfigurations_RegistryConfiguration
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique identifier for the registry configuration. | - |
| name | string | true | The unique, computer-friendly name of the registry configuration. | - |
| title | string | true | The human-friendly title of the registry configuration. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCohorts_FieldSetCohort
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| cohort | QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCohorts_Cohort | true | The related cohort. | - |
| fieldSets | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCommon] | true | An array of field sets associated to a cohort. | - |
QualityMeasurePublicApi_Entities_V1_CDE_FieldSetCohorts_Cohort
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| id | string | true | The unique ID of the cohort. | - |
postClinicalDataEntryFormsCdeformidFieldSets
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldSets | [object] | true | No description | - |
| » cohortId | string | true | The unique identifier of the cohort. | - |
| » name | string | true | The unique name of the field set. | - |
| » fieldSetType | string | true | The type of field set. | multi_line, multi_line_bmi, multi_select, slash_separated |
| » title | string | true | The human-friendly title of the field set. | - |
| » fields | [object] | true | An array of fields associated with a field set. | - |
| »» name | string | true | The unique, computer-friendly name of the field. | - |
| »» inputType | string | true | The type of user action that takes place for the field. | number, checkbox, multi_select, single_select |
| »» serviceType | string | true | The unique identifier for the type of service. | CONDITION, NUMERIC, CODIFIED, TEXT, DATE, PROCEDURE, MEDICATION, IMMUNIZATION, ALLERGY |
| »» dataType | string | true | The data type of the field. | string, boolean, integer, decimal |
| »» placeholder | string | false | The application display value of the field. | - |
| »» coding | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Code | true | The input value standard code. | - |
| »» inputValues | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_InputValue] | false | The array of inputValues for the field. |
- |
| »» unitOfMeasure | [QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_UnitMeasure] | false | The unit of measure of the field. | - |
| »» usesModifierCode | boolean | false | Indicates whether inputValues are qualifiers and need the associated entryItem, codeSystem, and codeValue. |
- |
| »» servicePeriod | QualityMeasurePublicApi_Entities_V1_CDE_FieldSets_Period | false | The service date range for the field. | - |
| »» attachmentFileTypes | [string] | false | The file type of the attachment. | - |
| »» attachmentRequired | boolean | false | Indicates whether an attachment is needed for a field set. | - |
| »» approvalRequired | boolean | false | Indicates whether approval is needed for a field set. | - |
postClinicalDataEntryFormsCdeformidFieldSetCategories
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldSetCategories | [object] | true | No description | - |
| » name | string | true | The unique name of the category. | - |
| » title | string | true | The human-friendly title of the category. | - |
| » fieldSets | [object] | true | An array of field sets associated to a category. | - |
| »» id | string | true | The unique identifier of the field set. | - |
postClinicalDataEntryFormsCdeformidFieldSetRegistriesConfigurations
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldsetRegistriesConfigurations | [object] | true | No description | - |
| » registryConfiguration | object | true | The unique identifier for the registry configuration. | - |
| »» id | string | true | The unique identifier of the registry configuration. | - |
| » fieldSets | [object] | true | An array of field sets associated to a cohort. | - |
| »» id | string | true | The unique identifier of the field set. | - |
postClinicalDataEntryFormsCdeformidFieldSetMeasures
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldsetMeasures | [object] | true | No description | - |
| » measure | object | true | The unique identifier of the field set measure. | - |
| »» id | string | true | The unique identifier of the measure. | - |
| » fieldSets | [object] | true | An array of field sets associated to a measure. | - |
| »» id | string | true | The unique identifier of the field set. | - |
postClinicalDataEntryFormsCdeformidFieldSetCohorts
| Name | Type | Required | Description | Accepted Values |
|---|---|---|---|---|
| fieldSetCohorts | [object] | true | No description | - |
| » cohort | object | true | The field set cohorts. | - |
| »» id | string | true | The unique identifier of the cohort. | - |
| » fieldSets | [object] | true | An array of field sets associated with a cohort. | - |
| »» id | string | true | The unique identifier of the field set. | - |