measures

Create Measure

post
/organizations/{organizationId}/fhir/3/Measure

The Measure resource provides the definition of a quality measure.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringMeasureThis is a Measure resource
urlstringAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
namestringA natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the measure.
statusstringdraft|active|retired|unknownThe status of this measure. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
publisherstringThe name of the individual or organization that published the measure.
descriptionstringA free text natural language description of the measure from a consumer's perspective.
purposestringExplaination of why this measure is needed and why it has been designed as it has.
usagestringA detailed description of how the measure is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the measure is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing the formal logic used by the measure.
disclaimerstringNotices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
scoringCodeableConceptIndicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
compositeScoringCodeableConceptIf this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
typearray(CodeableConcept)Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
riskAdjustmentstringA description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
rateAggregationstringDescribes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
rationalestringProvides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementstringProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationstringInformation on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
definitionarray()Provides a description of an individual term used within the measure.
guidancestringAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
setstringThe measure set, e.g. Preventive Care and Screening.
grouparray(Measure_Group)A group of population criteria for the measure.
supplementalDataarray(Measure_SupplementalData)The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

Response

Patch Measure

patch
/organizations/{organizationId}/fhir/3/Measure/{resourceId}

The Measure resource provides the definition of a quality measure.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMeasureThis is a Measure resource
urlstringAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
namestringA natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the measure.
statusstringdraft|active|retired|unknownThe status of this measure. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
publisherstringThe name of the individual or organization that published the measure.
descriptionstringA free text natural language description of the measure from a consumer's perspective.
purposestringExplaination of why this measure is needed and why it has been designed as it has.
usagestringA detailed description of how the measure is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the measure is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing the formal logic used by the measure.
disclaimerstringNotices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
scoringCodeableConceptIndicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
compositeScoringCodeableConceptIf this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
typearray(CodeableConcept)Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
riskAdjustmentstringA description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
rateAggregationstringDescribes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
rationalestringProvides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementstringProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationstringInformation on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
definitionarray()Provides a description of an individual term used within the measure.
guidancestringAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
setstringThe measure set, e.g. Preventive Care and Screening.
grouparray(Measure_Group)A group of population criteria for the measure.
supplementalDataarray(Measure_SupplementalData)The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

Response

Read Measure

get
/organizations/{organizationId}/fhir/3/Measure/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Measure

get
/organizations/{organizationId}/fhir/3/Measure/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Measure

get
/organizations/{organizationId}/fhir/3/Measure/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Measure

delete
/organizations/{organizationId}/fhir/3/Measure/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Measure

get
/organizations/{organizationId}/fhir/3/Measure

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
composed-ofstring
datestring
depends-onstring
derived-fromstring
descriptionstring
effectivestring
identifierstring
jurisdictionstring
namestring
predecessorstring
publisherstring
statusstring
successorstring
titlestring
topicstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Measure

get
/organizations/{organizationId}/fhir/3/Measure/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Measure

post
/organizations/{organizationId}/fhir/3/Measure/_search

The Measure resource provides the definition of a quality measure.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
composed-ofstring
datestring
depends-onstring
derived-fromstring
descriptionstring
effectivestring
identifierstring
jurisdictionstring
namestring
predecessorstring
publisherstring
statusstring
successorstring
titlestring
topicstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMeasureThis is a Measure resource
urlstringAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
namestringA natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the measure.
statusstringdraft|active|retired|unknownThe status of this measure. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
publisherstringThe name of the individual or organization that published the measure.
descriptionstringA free text natural language description of the measure from a consumer's perspective.
purposestringExplaination of why this measure is needed and why it has been designed as it has.
usagestringA detailed description of how the measure is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the measure is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing the formal logic used by the measure.
disclaimerstringNotices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
scoringCodeableConceptIndicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
compositeScoringCodeableConceptIf this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
typearray(CodeableConcept)Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
riskAdjustmentstringA description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
rateAggregationstringDescribes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
rationalestringProvides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementstringProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationstringInformation on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
definitionarray()Provides a description of an individual term used within the measure.
guidancestringAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
setstringThe measure set, e.g. Preventive Care and Screening.
grouparray(Measure_Group)A group of population criteria for the measure.
supplementalDataarray(Measure_SupplementalData)The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

Response

Update Measure

put
/organizations/{organizationId}/fhir/3/Measure/{resourceId}

The Measure resource provides the definition of a quality measure.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMeasureThis is a Measure resource
urlstringAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
namestringA natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the measure.
statusstringdraft|active|retired|unknownThe status of this measure. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
publisherstringThe name of the individual or organization that published the measure.
descriptionstringA free text natural language description of the measure from a consumer's perspective.
purposestringExplaination of why this measure is needed and why it has been designed as it has.
usagestringA detailed description of how the measure is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the measure is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing the formal logic used by the measure.
disclaimerstringNotices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
scoringCodeableConceptIndicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
compositeScoringCodeableConceptIf this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
typearray(CodeableConcept)Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
riskAdjustmentstringA description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
rateAggregationstringDescribes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
rationalestringProvides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementstringProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationstringInformation on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
definitionarray()Provides a description of an individual term used within the measure.
guidancestringAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
setstringThe measure set, e.g. Preventive Care and Screening.
grouparray(Measure_Group)A group of population criteria for the measure.
supplementalDataarray(Measure_SupplementalData)The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

Response