measures

Create Measure

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

The Measure resource provides the definition of a quality measure.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Measure resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
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.
subtitlestringAn explanatory or alternate title for the measure giving additional information about its content.
statusdraft|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.
subjectCodeableConceptCodeableConceptThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
subjectReferenceReferenceThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
datedateTimeThe date (and optionally time) when the measure was published. The date must change 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 organization or individual that published the measure.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the measure from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this measure is needed and why it has been designed as it has.
usagestringA detailed description, from a clinical perspective, of how the measure is used.
copyrightmarkdownA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing the formal logic used by the measure.
disclaimermarkdownNotices 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.
rationalemarkdownProvides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementmarkdownProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationCodeableConceptInformation 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 within a range).
definitionarray(markdown)Provides a description of an individual term used within the measure.
guidancemarkdownAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
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/4/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*This is a Measure resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
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.
subtitlestringAn explanatory or alternate title for the measure giving additional information about its content.
statusdraft|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.
subjectCodeableConceptCodeableConceptThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
subjectReferenceReferenceThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
datedateTimeThe date (and optionally time) when the measure was published. The date must change 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 organization or individual that published the measure.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the measure from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this measure is needed and why it has been designed as it has.
usagestringA detailed description, from a clinical perspective, of how the measure is used.
copyrightmarkdownA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing the formal logic used by the measure.
disclaimermarkdownNotices 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.
rationalemarkdownProvides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementmarkdownProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationCodeableConceptInformation 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 within a range).
definitionarray(markdown)Provides a description of an individual term used within the measure.
guidancemarkdownAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
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/4/Measure/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Measure

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Measure/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Measure

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Measure

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

Request

Headers

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

Query params

_idstring
_languagestring
composed-ofstring
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
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/4/Measure/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
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*This is a Measure resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
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.
subtitlestringAn explanatory or alternate title for the measure giving additional information about its content.
statusdraft|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.
subjectCodeableConceptCodeableConceptThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
subjectReferenceReferenceThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
datedateTimeThe date (and optionally time) when the measure was published. The date must change 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 organization or individual that published the measure.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the measure from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this measure is needed and why it has been designed as it has.
usagestringA detailed description, from a clinical perspective, of how the measure is used.
copyrightmarkdownA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing the formal logic used by the measure.
disclaimermarkdownNotices 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.
rationalemarkdownProvides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementmarkdownProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationCodeableConceptInformation 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 within a range).
definitionarray(markdown)Provides a description of an individual term used within the measure.
guidancemarkdownAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
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/4/Measure/{resourceId}

The Measure resource provides the definition of a quality measure.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Measure resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
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.
subtitlestringAn explanatory or alternate title for the measure giving additional information about its content.
statusdraft|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.
subjectCodeableConceptCodeableConceptThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
subjectReferenceReferenceThe intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
datedateTimeThe date (and optionally time) when the measure was published. The date must change 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 organization or individual that published the measure.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the measure from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this measure is needed and why it has been designed as it has.
usagestringA detailed description, from a clinical perspective, of how the measure is used.
copyrightmarkdownA copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the measure content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing the formal logic used by the measure.
disclaimermarkdownNotices 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.
rationalemarkdownProvides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
clinicalRecommendationStatementmarkdownProvides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
improvementNotationCodeableConceptInformation 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 within a range).
definitionarray(markdown)Provides a description of an individual term used within the measure.
guidancemarkdownAdditional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
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