Class Measure

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Measure extends MetadataResource
The Measure resource provides the definition of a quality measure.
See Also:
  • Field Details

    • url

      protected UriType 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.
    • 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.
    • version

      protected StringType 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.
    • name

      protected StringType 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.
    • title

      protected StringType title
      A short, descriptive, user-friendly title for the measure.
    • subtitle

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

      The status of this measure. Enables tracking the life-cycle of the content.
    • 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.
    • subject

      protected DataType subject
      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.
    • 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.
    • date

      protected DateTimeType 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.
    • publisher

      protected StringType publisher
      The name of the organization or individual that published the measure.
    • contact

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

      A free text natural language description of the measure from a consumer's perspective.
    • 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.
    • jurisdiction

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

      protected MarkdownType purpose
      Explanation of why this measure is needed and why it has been designed as it has.
    • usage

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

      The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • lastReviewDate

      The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • effectivePeriod

      The period during which the measure content was or is planned to be in active use.
    • 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.
    • author

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

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

      An individual or organization primarily responsible for review of some aspect of the content.
    • endorser

      An individual or organization responsible for officially endorsing the content for use in some setting.
    • relatedArtifact

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

      A reference to a Library resource containing the formal logic used by the measure.
    • disclaimer

      Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
    • 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.
    • scoringUnit

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

      If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
    • 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.
    • 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.
    • rateAggregation

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

      Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
    • clinicalRecommendationStatement

      Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
    • 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).
    • definition

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

      Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
    • group

      A group of population criteria for the 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.
    • SP_COMPOSED_OF

      public static final String SP_COMPOSED_OF
      Search parameter: composed-of

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='composed-of').resource

      See Also:
    • COMPOSED_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
      Fluent Client search parameter constant for composed-of

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='composed-of').resource

    • INCLUDE_COMPOSED_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Measure:composed-of".
    • SP_CONTEXT_QUANTITY

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the measure
      Type: quantity
      Path: (Measure.useContext.value as Quantity) | (Measure.useContext.value as Range)

      See Also:
    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the measure
      Type: quantity
      Path: (Measure.useContext.value as Quantity) | (Measure.useContext.value as Range)

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the measure
      Type: composite
      Path: Measure.useContext

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the measure
      Type: composite
      Path: Measure.useContext

    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the measure
      Type: composite
      Path: Measure.useContext

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the measure
      Type: composite
      Path: Measure.useContext

    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the measure
      Type: token
      Path: Measure.useContext.code

      See Also:
    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the measure
      Type: token
      Path: Measure.useContext.code

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the measure
      Type: token
      Path: (Measure.useContext.value as CodeableConcept)

      See Also:
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the measure
      Type: token
      Path: (Measure.useContext.value as CodeableConcept)

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The measure publication date
      Type: date
      Path: Measure.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The measure publication date
      Type: date
      Path: Measure.date

    • SP_DEPENDS_ON

      public static final String SP_DEPENDS_ON
      Search parameter: depends-on

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='depends-on').resource | Measure.library

      See Also:
    • DEPENDS_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
      Fluent Client search parameter constant for depends-on

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='depends-on').resource | Measure.library

    • INCLUDE_DEPENDS_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Measure:depends-on".
    • SP_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='derived-from').resource

      See Also:
    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='derived-from').resource

    • INCLUDE_DERIVED_FROM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Measure:derived-from".
    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the measure
      Type: string
      Path: Measure.description

      See Also:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the measure
      Type: string
      Path: Measure.description

    • SP_EFFECTIVE

      public static final String SP_EFFECTIVE
      Search parameter: effective

      Description: The time during which the measure is intended to be in use
      Type: date
      Path: Measure.effectivePeriod

      See Also:
    • EFFECTIVE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
      Fluent Client search parameter constant for effective

      Description: The time during which the measure is intended to be in use
      Type: date
      Path: Measure.effectivePeriod

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the measure
      Type: token
      Path: Measure.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: External identifier for the measure
      Type: token
      Path: Measure.identifier

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the measure
      Type: token
      Path: Measure.jurisdiction

      See Also:
    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the measure
      Type: token
      Path: Measure.jurisdiction

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the measure
      Type: string
      Path: Measure.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the measure
      Type: string
      Path: Measure.name

    • SP_PREDECESSOR

      public static final String SP_PREDECESSOR
      Search parameter: predecessor

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='predecessor').resource

      See Also:
    • PREDECESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
      Fluent Client search parameter constant for predecessor

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='predecessor').resource

    • INCLUDE_PREDECESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Measure:predecessor".
    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the measure
      Type: string
      Path: Measure.publisher

      See Also:
    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the measure
      Type: string
      Path: Measure.publisher

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the measure
      Type: token
      Path: Measure.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the measure
      Type: token
      Path: Measure.status

    • SP_SUCCESSOR

      public static final String SP_SUCCESSOR
      Search parameter: successor

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='successor').resource

      See Also:
    • SUCCESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
      Fluent Client search parameter constant for successor

      Description: What resource is being referenced
      Type: reference
      Path: Measure.relatedArtifact.where(type='successor').resource

    • INCLUDE_SUCCESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Measure:successor".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the measure
      Type: string
      Path: Measure.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the measure
      Type: string
      Path: Measure.title

    • SP_TOPIC

      public static final String SP_TOPIC
      Search parameter: topic

      Description: Topics associated with the measure
      Type: token
      Path: Measure.topic

      See Also:
    • TOPIC

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
      Fluent Client search parameter constant for topic

      Description: Topics associated with the measure
      Type: token
      Path: Measure.topic

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the measure
      Type: uri
      Path: Measure.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the measure
      Type: uri
      Path: Measure.url

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the measure
      Type: token
      Path: Measure.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the measure
      Type: token
      Path: Measure.version

  • Constructor Details

  • Method Details