Measure class
Measure The Measure resource provides the definition of a quality
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Measure({@Default(R4ResourceType.Measure) @JsonKey(unknownEnumValue: R4ResourceType.Measure) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, List<Identifier> ? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, String? subtitle, @JsonKey(name: '_subtitle') Element? subtitleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail> ? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext> ? useContext, List<CodeableConcept> ? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, String? usage, @JsonKey(name: '_usage') Element? usageElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<CodeableConcept> ? topic, List<ContactDetail> ? author, List<ContactDetail> ? editor, List<ContactDetail> ? reviewer, List<ContactDetail> ? endorser, @JsonKey(name: 'library') List<FhirCanonical> ? library_, FhirMarkdown? disclaimer, @JsonKey(name: '_disclaimer') Element? disclaimerElement, CodeableConcept? scoring, CodeableConcept? compositeScoring, List<CodeableConcept> ? type, String? riskAdjustment, @JsonKey(name: '_riskAdjustment') Element? riskAdjustmentElement, String? rateAggregation, @JsonKey(name: '_rateAggregation') Element? rateAggregationElement, FhirMarkdown? rationale, @JsonKey(name: '_rationale') Element? rationaleElement, FhirMarkdown? clinicalRecommendationStatement, @JsonKey(name: '_clinicalRecommendationStatement') Element? clinicalRecommendationStatementElement, CodeableConcept? improvementNotation, List<FhirMarkdown> ? definition, @JsonKey(name: '_definition') List<Element?> ? definitionElement, FhirMarkdown? guidance, @JsonKey(name: '_guidance') Element? guidanceElement, List<MeasureGroup> ? group, List<MeasureSupplementalData> ? supplementalData}) -
Measure The Measure resource provides the definition of a quality
measure.
constfactory
-
Measure.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Measure.fromJsonString(String source)
-
Acts like a constructor, returns a Measure, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Measure.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- approvalDate → FhirDate?
-
approvalDate The date on which the resource content was approved by the
publisher. Approval happens once when the content is officially approved
for usage.
no setterinherited
- approvalDateElement → Element?
-
approvalDateElement Extensions for approvalDate
no setterinherited
-
author An individiual or organization primarily involved in the
creation and maintenance of the content.
no setterinherited
- clinicalRecommendationStatement → FhirMarkdown?
-
clinicalRecommendationStatement Provides a summary of relevant clinical
guidelines or other clinical recommendations supporting the measure.
no setterinherited
- clinicalRecommendationStatementElement → Element?
-
no setterinherited
- compositeScoring → CodeableConcept?
-
compositeScoring If this is a composite measure, the scoring method
used to combine the component measures to determine the composite score.
no setterinherited
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating
with the publisher.
no setterinherited
-
contained
→ List<
Resource> ? -
contained 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.
no setterinherited
- copyright → FhirMarkdown?
-
copyright A copyright statement relating to the measure and/or its
contents. Copyright statements are generally legal restrictions on the use
and publishing of the measure.
no setterinherited
- copyrightElement → Element?
-
copyrightElement Extensions for copyright
no setterinherited
-
copyWith
→ $MeasureCopyWith<
Measure> -
no setterinherited
- date → FhirDateTime?
-
date The 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.
no setterinherited
- dateElement → Element?
-
dateElement Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
-
definition
→ List<
FhirMarkdown> ? -
definition Provides a description of an individual term used within the
measure.
no setterinherited
-
definitionElement
→ List<
Element?> ? -
definitionElement Extensions for definition
no setterinherited
- description → FhirMarkdown?
-
description A free text natural language description of the measure
from a consumer's perspective.
no setterinherited
- descriptionElement → Element?
-
descriptionElement Extensions for description
no setterinherited
- disclaimer → FhirMarkdown?
-
disclaimer Notices and disclaimers regarding the use of the measure or
related to intellectual property (such as code systems) referenced by the
measure.
no setterinherited
- disclaimerElement → Element?
-
disclaimerElement Extensions for disclaimer
no setterinherited
-
editor
→ List<
ContactDetail> ? -
editor An individual or organization primarily responsible for internal
coherence of the content.
no setterinherited
- effectivePeriod → Period?
-
effectivePeriod The period during which the measure content was or is
planned to be in active use.
no setterinherited
-
endorser
→ List<
ContactDetail> ? -
endorser An individual or organization responsible for officially
endorsing the content for use in some setting.
no setterinherited
- experimental → FhirBoolean?
-
experimental A 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.
no setterinherited
- experimentalElement → Element?
-
experimentalElement Extensions for experimental
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
-
group
→ List<
MeasureGroup> ? -
group A group of population criteria for the measure.
no setterinherited
- guidance → FhirMarkdown?
-
guidance Additional guidance for the measure including how it can be
used in a clinical context, and the intent of the measure.
no setterinherited
- guidanceElement → Element?
-
guidanceElement Extensions for guidance
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
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.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A 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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement Extensions for implicitRules
no setterinherited
- improvementNotation → CodeableConcept?
-
improvementNotation Information 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).
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A legal or geographic region in which the measure is
intended to be used.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
- lastReviewDate → FhirDate?
-
lastReviewDate The date on which the resource content was last
reviewed. Review happens periodically after approval but does not change
the original approval date.
no setterinherited
- lastReviewDateElement → Element?
-
lastReviewDateElement Extensions for lastReviewDate
no setterinherited
-
library_
→ List<
FhirCanonical> ? -
library
A reference to a Library resource containing the formal logic used by the measure.no setterinherited - meta → FhirMeta?
-
meta The 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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension 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).
no setterinherited
- name → String?
-
name A 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.
no setterinherited
- nameElement → Element?
-
nameElement Extensions for name
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- publisher → String?
-
publisher The name of the organization or individual that published the
measure.
no setterinherited
- publisherElement → Element?
-
publisherElement Extensions for publisher
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explanation of why this measure is needed and why it has been
designed as it has.
no setterinherited
- purposeElement → Element?
-
purposeElement Extensions for purpose
no setterinherited
- rateAggregation → String?
-
rateAggregation Describes how to combine the information calculated,
based on logic in each of several populations, into one summarized
result.
no setterinherited
- rateAggregationElement → Element?
-
rateAggregationElement Extensions for rateAggregation
no setterinherited
- rationale → FhirMarkdown?
-
rationale Provides a succinct statement of the need for the measure.
Usually includes statements pertaining to importance criterion: impact,
gap in care, and evidence.
no setterinherited
- rationaleElement → Element?
-
rationaleElement Extensions for rationale
no setterinherited
-
relatedArtifact Related artifacts such as additional documentation,
justification, or bibliographic references.
no setterinherited
- resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
-
reviewer
→ List<
ContactDetail> ? -
reviewer An individual or organization primarily responsible for review
of some aspect of the content.
no setterinherited
- riskAdjustment → String?
-
riskAdjustment A 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.
no setterinherited
- riskAdjustmentElement → Element?
-
riskAdjustmentElement Extensions for riskAdjustment
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scoring → CodeableConcept?
-
scoring Indicates 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.
no setterinherited
- status → FhirCode?
-
status The status of this measure. Enables tracking the life-cycle of
the content.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
- subjectCodeableConcept → CodeableConcept?
-
subjectCodeableConcept The 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.
no setterinherited
- subjectReference → Reference?
-
subjectReference The 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.
no setterinherited
- subtitle → String?
-
subtitle An explanatory or alternate title for the measure giving
additional information about its content.
no setterinherited
- subtitleElement → Element?
-
subtitleElement Extensions for subtitle
no setterinherited
-
supplementalData
→ List<
MeasureSupplementalData> ? -
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.
no setterinherited
- text → Narrative?
-
text A 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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the measure.
no setterinherited
- titleElement → Element?
-
titleElement Extensions for title
no setterinherited
-
topic
→ List<
CodeableConcept> ? -
topic 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.
no setterinherited
-
type
→ List<
CodeableConcept> ? -
type 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.
no setterinherited
- url → FhirUri?
-
url An 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.
no setterinherited
- urlElement → Element?
-
urlElement Extensions for url
no setterinherited
- usage → String?
-
usage A detailed description, from a clinical perspective, of how the
measure is used.
no setterinherited
- usageElement → Element?
-
usageElement Extensions for usage
no setterinherited
-
useContext
→ List<
UsageContext> ? -
useContext 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.
no setterinherited
- version → String?
-
version The 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.
no setterinherited
- versionElement → Element?
-
versionElement Extensions for version
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited