Measure class

Measure The Measure resource provides the definition of a quality measure.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

Measure({@Default(R5ResourceType.Measure) @JsonKey(unknownEnumValue: R5ResourceType.Measure) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? 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? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, 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, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, 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, List<RelatedArtifact>? relatedArtifact, String? subtitle, @JsonKey(name: '_subtitle') Element? subtitleElement, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, FhirCode? basis, @JsonKey(name: '_basis') Element? basisElement, FhirMarkdown? usage, @JsonKey(name: '_usage') Element? usageElement, @JsonKey(name: 'library') List<FhirCanonical>? library_, FhirMarkdown? disclaimer, @JsonKey(name: '_disclaimer') Element? disclaimerElement, CodeableConcept? scoring, CodeableConcept? scoringUnit, CodeableConcept? compositeScoring, List<CodeableConcept>? type, FhirMarkdown? riskAdjustment, @JsonKey(name: '_riskAdjustment') Element? riskAdjustmentElement, FhirMarkdown? rateAggregation, @JsonKey(name: '_rateAggregation') Element? rateAggregationElement, FhirMarkdown? rationale, @JsonKey(name: '_rationale') Element? rationaleElement, FhirMarkdown? clinicalRecommendationStatement, @JsonKey(name: '_clinicalRecommendationStatement') Element? clinicalRecommendationStatementElement, CodeableConcept? improvementNotation, List<MeasureTerm>? term, FhirMarkdown? guidance, @JsonKey(name: '_guidance') Element? guidanceElement, List<MeasureGroup>? group, List<MeasureSupplementalData>? supplementalData})

Measure The Measure resource provides the definition of a quality measure.

const

factory

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 setter, inherited

approvalDateElement → Element?

approvalDateElement ("_approvalDate") Extensions for approvalDate

no setter, inherited

author → List<ContactDetail>?

author An individiual or organization primarily involved in the creation and maintenance of the content.

no setter, inherited

basis → FhirCode?

basis The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.

no setter, inherited

basisElement → Element?

basisElement ("_basis") Extensions for basis

no setter, inherited

clinicalRecommendationStatement → FhirMarkdown?

clinicalRecommendationStatement Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.

no setter, inherited

clinicalRecommendationStatementElement → Element?

clinicalRecommendationStatementElement ("_clinicalRecommendationStatement") Extensions for clinicalRecommendationStatement

no setter, inherited

compositeScoring → CodeableConcept?

compositeScoring If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.

no setter, inherited

contact → List<ContactDetail>?

contact Contact details to assist a user in finding and communicating with the publisher.

no setter, inherited

contained → List<Resource>?

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

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 setter, inherited

copyrightElement → Element?

copyrightElement ("_copyright") Extensions for copyright

no setter, inherited

copyrightLabel → String?

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

no setter, inherited

copyrightLabelElement → Element?

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

no setter, inherited

copyWith → $MeasureCopyWith<Measure>

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the measure was last significantly changed. 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 setter, inherited

dateElement → Element?

dateElement ("_date") Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

description → FhirMarkdown?

description A free text natural language description of the measure from a consumer's perspective.

no setter, inherited

descriptionElement → Element?

descriptionElement ("_description") Extensions for description

no setter, inherited

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 setter, inherited

disclaimerElement → Element?

disclaimerElement ("_disclaimer") Extensions for disclaimer

no setter, inherited

editor → List<ContactDetail>?

editor An individual or organization primarily responsible for internal coherence of the content.

no setter, inherited

effectivePeriod → Period?

effectivePeriod The period during which the measure content was or is planned to be in active use.

no setter, inherited

endorser → List<ContactDetail>?

endorser An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

no setter, inherited

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 setter, inherited

experimentalElement → Element?

experimentalElement ("_experimental") Extensions for experimental

no setter, inherited

extension_ → List<FhirExtension>?

extension_ ("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 managable, 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 setter, inherited

fhirId → FhirId?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

group → List<MeasureGroup>?

group A group of population criteria for the measure.

no setter, inherited

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 setter, inherited

guidanceElement → Element?

guidanceElement ("_guidance") Extensions for guidance

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

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 setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

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 setter, inherited

jurisdiction → List<CodeableConcept>?

jurisdiction A legal or geographic region in which the measure is intended to be used.

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement ("_language") Extensions for language

no setter, inherited

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 setter, inherited

lastReviewDateElement → Element?

lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate

no setter, inherited

library_ → List<FhirCanonical>?

library_ ("library") A reference to a Library resource containing the formal logic used by the measure.

no setter, inherited

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 setter, inherited

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 managable, 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 setter, inherited

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 setter, inherited

nameElement → Element?

nameElement ("_name") Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

publisher → String?

publisher The name of the organization or individual responsible for the release and ongoing maintenance of the measure.

no setter, inherited

publisherElement → Element?

publisherElement ("_publisher") Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

purpose Explanation of why this measure is needed and why it has been designed as it has.

no setter, inherited

purposeElement → Element?

purposeElement ("_purpose") Extensions for purpose

no setter, inherited

rateAggregation → FhirMarkdown?

rateAggregation Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.

no setter, inherited

rateAggregationElement → Element?

rateAggregationElement ("_rateAggregation") Extensions for rateAggregation

no setter, inherited

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 setter, inherited

rationaleElement → Element?

rationaleElement ("_rationale") Extensions for rationale

no setter, inherited

relatedArtifact → List<RelatedArtifact>?

relatedArtifact Related artifacts such as additional documentation, justification, or bibliographic references.

no setter, inherited

resourceType → R5ResourceType

resourceType This is a Measure resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

reviewer → List<ContactDetail>?

reviewer An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

no setter, inherited

riskAdjustment → FhirMarkdown?

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 setter, inherited

riskAdjustmentElement → Element?

riskAdjustmentElement ("_riskAdjustment") Extensions for riskAdjustment

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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 setter, inherited

scoringUnit → CodeableConcept?

scoringUnit Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.

no setter, inherited

status → FhirCode?

status The status of this measure. Enables tracking the life-cycle of the content.

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

no setter, inherited

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 setter, inherited

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 setter, inherited

subtitle → String?

subtitle An explanatory or alternate title for the measure giving additional information about its content.

no setter, inherited

subtitleElement → Element?

subtitleElement ("_subtitle") Extensions for subtitle

no setter, inherited

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 setter, inherited

term → List<MeasureTerm>?

term Provides a description of an individual term used within the measure.

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

title A short, descriptive, user-friendly title for the measure.

no setter, inherited

titleElement → Element?

titleElement ("_title") Extensions for title

no setter, inherited

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 setter, inherited

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 setter, inherited

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 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 setter, inherited

urlElement → Element?

urlElement ("_url") Extensions for url

no setter, inherited

usage → FhirMarkdown?

usage A detailed description, from a clinical perspective, of how the measure is used.

no setter, inherited

usageElement → Element?

usageElement ("_usage") Extensions for usage

no setter, inherited

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 setter, inherited

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 setter, inherited

versionAlgorithmCoding → Coding?

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmString → String?

versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmStringElement → Element?

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

no setter, inherited

versionElement → Element?

versionElement ("_version") Extensions for version

no setter, inherited

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

override

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