Data Model Libraries
    Preparing search index...

    Class Measure

    Measure Class

    The Measure resource provides the definition of a quality measure.

    FHIR Specification

    • Short: A quality measure definition
    • Definition: The Measure resource provides the definition of a quality measure.
    • FHIR Version: 5.0.0

    FHIR Measure

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? versionAlgorithm? name? title? subtitle? publicationStatusEnum status experimental? subject? fhirTypesEnum basis? date? publisher? contact? description? useContext? jurisdiction? purpose? usage? copyright? copyrightLabel? approvalDate? lastReviewDate? effectivePeriod? topic? author? editor? reviewer? endorser? relatedArtifact? library? disclaimer? scoring? scoringUnit? compositeScoring? type_? riskAdjustment? rateAggregation? rationale? clinicalRecommendationStatement? improvementNotation? term? guidance? group? supplementalData?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getSubtitleElement setSubtitleElement hasSubtitleElement getSubtitle setSubtitle hasSubtitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getBasisEnumType setBasisEnumType hasBasisEnumType getBasisElement setBasisElement hasBasisElement getBasis setBasis hasBasis getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getUsageElement setUsageElement hasUsageElement getUsage setUsage hasUsage getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getLibraryElement setLibraryElement addLibraryElement hasLibraryElement getLibrary setLibrary addLibrary hasLibrary getDisclaimerElement setDisclaimerElement hasDisclaimerElement getDisclaimer setDisclaimer hasDisclaimer getScoring setScoring hasScoring getScoringUnit setScoringUnit hasScoringUnit getCompositeScoring setCompositeScoring hasCompositeScoring getType setType addType hasType getRiskAdjustmentElement setRiskAdjustmentElement hasRiskAdjustmentElement getRiskAdjustment setRiskAdjustment hasRiskAdjustment getRateAggregationElement setRateAggregationElement hasRateAggregationElement getRateAggregation setRateAggregation hasRateAggregation getRationaleElement setRationaleElement hasRationaleElement getRationale setRationale hasRationale getClinicalRecommendationStatementElement setClinicalRecommendationStatementElement hasClinicalRecommendationStatementElement getClinicalRecommendationStatement setClinicalRecommendationStatement hasClinicalRecommendationStatement getImprovementNotation setImprovementNotation hasImprovementNotation getTerm setTerm addTerm hasTerm getGuidanceElement setGuidanceElement hasGuidanceElement getGuidance setGuidance hasGuidance getGroup setGroup addGroup hasGroup getSupplementalData setSupplementalData addSupplementalData hasSupplementalData fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initLibrary initType initTerm initGroup initSupplementalData

    Constructors

    Properties

    url?: UriType

    Measure.url Element

    FHIR Specification

    • Short: Canonical identifier for this measure, represented as a URI (globally unique)
    • Definition: 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.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the measure to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    Measure.identifier Element

    FHIR Specification

    • Short: Additional identifier for the measure
    • Definition: 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.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this measure outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    Measure.version Element

    FHIR Specification

    • Short: Business version of the measure
    • Definition: 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.
    • Comment: There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the measure with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    Measure.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('Measure.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Measure.name Element

    FHIR Specification

    • Short: Name for this measure (computer friendly)
    • Definition: 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.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Measure.title Element

    FHIR Specification

    • Short: Name for this measure (human friendly)
    • Definition: A short, descriptive, user-friendly title for the measure.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subtitle?: StringType

    Measure.subtitle Element

    FHIR Specification

    • Short: Subordinate title of the measure
    • Definition: An explanatory or alternate title for the measure giving additional information about its content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    Measure.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this measure. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of measures that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    Measure.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: 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.
    • Comment: Allows filtering of measures that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level measure.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: IDataType

    Measure.subject[x] Element

    @ChoiceDataTypesMeta('Measure.subject[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    • Definition: 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.
    • Comment: The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    fhirTypesEnum: FhirTypesEnum

    FHIR CodeSystem: FhirTypes

    FhirTypesEnum

    basis?: EnumCodeType

    Measure.basis Element

    FHIR Specification

    • Short: Population basis
    • Definition: 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.
    • Comment: For a subject-based measure, the population basis is simply boolean; all the criteria are expressed as true/false conditions that determine membership of an individual case in the population. For non-subject-based measures, the population basis can be any resource type, and the criteria are queries that return the subject's contribution to the population as a list of that resource type. For example, for a procedure-based measure, the population criteria would return lists of procedures that should be included in each population.
    • Requirements: Allows non-subject-based measures to be specified. Note that because the binding is to all fhir types, it is possible to specify abstract types such as Resource or DomainResource as the basis for a measure. Authoring environments may wish to constrain this further, depending on content needs.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: FhirTypesEnum

    date?: DateTimeType

    Measure.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: 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.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    Measure.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the measure.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the measure. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    Measure.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    Measure.description Element

    FHIR Specification

    • Short: Natural language description of the measure
    • Definition: A free text natural language description of the measure from a consumer's perspective.
    • Comment: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the measure as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the measure is presumed to be the predominant language in the place the measure was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    Measure.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: 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.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    Measure.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for measure (if applicable)
    • Definition: A legal or geographic region in which the measure is intended to be used.
    • Comment: It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    Measure.purpose Element

    FHIR Specification

    • Short: Why this measure is defined
    • Definition: Explanation of why this measure is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the measure. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    usage?: MarkdownType

    Measure.usage Element

    FHIR Specification

    • Short: Describes the clinical usage of the measure
    • Definition: A detailed description, from a clinical perspective, of how the measure is used.
    • Comment: This metadata element was typically referred to as Guidance in HQMF
    • Requirements: Measure developers must be able to provide additional guidance for implementers to understand the intent with greater specificity than that provided in the population criteria of the measure. This element provides detailed guidance, where the usage element provides a summary of the guidance.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    Measure.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: 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.
    • Comment: The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the measure and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    Measure.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: 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').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    Measure.approvalDate Element

    FHIR Specification

    • Short: When the measure was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    Measure.lastReviewDate Element

    FHIR Specification

    • Short: When the measure was last reviewed by the publisher
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    Measure.effectivePeriod Element

    FHIR Specification

    • Short: When the measure is expected to be used
    • Definition: The period during which the measure content was or is planned to be in active use.
    • Comment: The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the measure are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    Measure.topic Element

    FHIR Specification

    • Short: The category of the measure, such as Education, Treatment, Assessment, etc
    • Definition: 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.
    • Comment: DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
    • Requirements: Repositories must be able to determine how to categorize the measure so that it can be found by topical searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    Measure.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    Measure.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individual or organization primarily responsible for internal coherence of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    Measure.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    Measure.endorser Element

    FHIR Specification

    • Short: Who endorsed the content
    • Definition: An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    Measure.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc
    • Definition: Related artifacts such as additional documentation, justification, or bibliographic references.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: Measures must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    library?: CanonicalType[]

    Measure.library Element

    FHIR Specification

    • Short: Logic used by the measure
    • Definition: A reference to a Library resource containing the formal logic used by the measure.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    disclaimer?: MarkdownType

    Measure.disclaimer Element

    FHIR Specification

    • Short: Disclaimer for use of the measure or its referenced content
    • Definition: Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
    • Requirements: Some organizations require that notices and disclosures be included when publishing measures that reference their intellecutal property.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    scoring?: CodeableConcept

    Measure.scoring Element

    FHIR Specification

    • Short: proportion | ratio | continuous-variable | cohort
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    scoringUnit?: CodeableConcept

    Measure.scoringUnit Element

    FHIR Specification

    • Short: What units?
    • Definition: Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.
    • Comment: When this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM.
    • Requirements: When the unit cannot be inferred directly from the calculation logic, this element allows the specification of the desired units of measure of the output.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    compositeScoring?: CodeableConcept

    Measure.compositeScoring Element

    FHIR Specification

    • Short: opportunity | all-or-nothing | linear | weighted
    • Definition: If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept[]

    Measure.type Element

    FHIR Specification

    • Short: process | outcome | structure | patient-reported-outcome | composite
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    riskAdjustment?: MarkdownType

    Measure.riskAdjustment Element

    FHIR Specification

    • Short: How risk adjustment is applied for this measure
    • Definition: 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.
    • Comment: Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether a measure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow for more useful comparisons.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    rateAggregation?: MarkdownType

    Measure.rateAggregation Element

    FHIR Specification

    • Short: How is rate aggregation performed for this measure
    • Definition: Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
    • Comment: The measure rate for an organization or clinician is based upon the entities' aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    rationale?: MarkdownType

    Measure.rationale Element

    FHIR Specification

    • Short: Detailed description of why the measure exists
    • Definition: Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
    • Requirements: Measure developers need to be able to provide a detailed description of the purpose of the measure. This element provides detailed rationale, where the purpose element provides a summary of the rationale.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    clinicalRecommendationStatement?: MarkdownType

    Measure.clinicalRecommendationStatement Element

    FHIR Specification

    • Short: Summary of clinical guidelines
    • Definition: Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    improvementNotation?: CodeableConcept

    Measure.improvementNotation Element

    FHIR Specification

    • Short: increase | decrease
    • Definition: 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).
    • Requirements: Measure consumers and implementers must be able to determine how to interpret a measure score.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    term?: MeasureTermComponent[]

    Measure.term Element

    FHIR Specification

    • Short: Defined terms used in the measure documentation
    • Definition: Provides a description of an individual term used within the measure.
    • Requirements: Measure developers must be able to provide precise definitions of terms used within measure descriptions and guidance to help communicate the intent of the measure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    guidance?: MarkdownType

    Measure.guidance Element

    FHIR Specification

    • Short: Additional guidance for implementers (deprecated)
    • Definition: Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
    • Comment: NOTE: This element is deprecated in favor of the usage element
    • Requirements: Measure developers must be able to provide additional guidance for implementers to understand the intent with greater specificity than that provided in the population criteria of the measure. This element provides detailed guidance, where the usage element provides a summary of the guidance.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    group?: MeasureGroupComponent[]

    Measure.group Element

    FHIR Specification

    • Short: Population criteria group
    • Definition: A group of population criteria for the measure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supplementalData?: MeasureSupplementalDataComponent[]

    Measure.supplementalData Element

    FHIR Specification

    • Short: What other data should be reported with the measure
    • Definition: 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.
    • Comment: Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Measure JSON to instantiate the Measure data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Measure

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Measure

      Returns undefined | Measure

      Measure data model or undefined for Measure

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided primitive value to the clinicalRecommendationStatement property.

      Parameters

      • value: undefined | string

        the clinicalRecommendationStatement value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetVersionAlgorithmsetVersionAlgorithmhasVersionAlgorithmgetVersionAlgorithmStringTypehasVersionAlgorithmStringTypegetVersionAlgorithmCodinghasVersionAlgorithmCodinggetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetSubtitleElementsetSubtitleElementhasSubtitleElementgetSubtitlesetSubtitlehasSubtitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetSubjectsetSubjecthasSubjectgetSubjectCodeableConcepthasSubjectCodeableConceptgetSubjectReferencehasSubjectReferencegetBasisEnumTypesetBasisEnumTypehasBasisEnumTypegetBasisElementsetBasisElementhasBasisElementgetBasissetBasishasBasisgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetUsageElementsetUsageElementhasUsageElementgetUsagesetUsagehasUsagegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetCopyrightLabelElementsetCopyrightLabelElementhasCopyrightLabelElementgetCopyrightLabelsetCopyrightLabelhasCopyrightLabelgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetTopicsetTopicaddTopichasTopicgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetLibraryElementsetLibraryElementaddLibraryElementhasLibraryElementgetLibrarysetLibraryaddLibraryhasLibrarygetDisclaimerElementsetDisclaimerElementhasDisclaimerElementgetDisclaimersetDisclaimerhasDisclaimergetScoringsetScoringhasScoringgetScoringUnitsetScoringUnithasScoringUnitgetCompositeScoringsetCompositeScoringhasCompositeScoringgetTypesetTypeaddTypehasTypegetRiskAdjustmentElementsetRiskAdjustmentElementhasRiskAdjustmentElementgetRiskAdjustmentsetRiskAdjustmenthasRiskAdjustmentgetRateAggregationElementsetRateAggregationElementhasRateAggregationElementgetRateAggregationsetRateAggregationhasRateAggregationgetRationaleElementsetRationaleElementhasRationaleElementgetRationalesetRationalehasRationalegetClinicalRecommendationStatementElementsetClinicalRecommendationStatementElementhasClinicalRecommendationStatementElementgetClinicalRecommendationStatementsetClinicalRecommendationStatementhasClinicalRecommendationStatementgetImprovementNotationsetImprovementNotationhasImprovementNotationgetTermsetTermaddTermhasTermgetGuidanceElementsetGuidanceElementhasGuidanceElementgetGuidancesetGuidancehasGuidancegetGroupsetGroupaddGrouphasGroupgetSupplementalDatasetSupplementalDataaddSupplementalDatahasSupplementalDatafhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitUseContextinitJurisdictioninitTopicinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitLibraryinitTypeinitTerminitGroupinitSupplementalData