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:
    Serialized Form
    • Field Detail

      • identifier

        protected 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.
      • subtitle

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

        protected Type 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.
      • 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.
      • copyright

        protected MarkdownType 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.
      • approvalDate

        protected DateType 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

        protected DateType 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

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

        protected 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.
      • author

        protected List<ContactDetail> author
        An individiual or organization primarily involved in the creation and maintenance of the content.
      • editor

        protected List<ContactDetail> editor
        An individual or organization primarily responsible for internal coherence of the content.
      • reviewer

        protected List<ContactDetail> reviewer
        An individual or organization primarily responsible for review of some aspect of the content.
      • endorser

        protected List<ContactDetail> endorser
        An individual or organization responsible for officially endorsing the content for use in some setting.
      • library

        protected List<CanonicalType> library
        A reference to a Library resource containing the formal logic used by the measure.
      • disclaimer

        protected MarkdownType disclaimer
        Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
      • scoring

        protected 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.
      • compositeScoring

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

        protected 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.
      • riskAdjustment

        protected StringType 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

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

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

        protected 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).
      • guidance

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

        public static final String SP_DATE
        Search parameter: date

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

        See Also:
        Constant Field Values
      • 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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

        See Also:
        Constant Field Values
      • 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_SUCCESSOR

        public static final String SP_SUCCESSOR
        Search parameter: successor

        Description: What resource is being referenced
        Type: reference
        Path: Measure.relatedArtifact.resource

        See Also:
        Constant Field Values
      • 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.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".
      • 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:

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

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

        See Also:
        Constant Field Values
      • 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

      • 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_DERIVED_FROM

        public static final String SP_DERIVED_FROM
        Search parameter: derived-from

        Description: What resource is being referenced
        Type: reference
        Path: Measure.relatedArtifact.resource

        See Also:
        Constant Field Values
      • 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.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_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:
        Constant Field Values
      • 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_PREDECESSOR

        public static final String SP_PREDECESSOR
        Search parameter: predecessor

        Description: What resource is being referenced
        Type: reference
        Path: Measure.relatedArtifact.resource

        See Also:
        Constant Field Values
      • 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.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_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:
        Constant Field Values
      • 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_COMPOSED_OF

        public static final String SP_COMPOSED_OF
        Search parameter: composed-of

        Description: What resource is being referenced
        Type: reference
        Path: Measure.relatedArtifact.resource

        See Also:
        Constant Field Values
      • 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.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_VERSION

        public static final String SP_VERSION
        Search parameter: version

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

        See Also:
        Constant Field Values
      • 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

      • 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:
        Constant Field Values
      • 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_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.valueQuantity, Measure.useContext.valueRange

        See Also:
        Constant Field Values
      • 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.valueQuantity, Measure.useContext.valueRange

      • 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:
        Constant Field Values
      • 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_DEPENDS_ON

        public static final String SP_DEPENDS_ON
        Search parameter: depends-on

        Description: What resource is being referenced
        Type: reference
        Path: Measure.relatedArtifact.resource, Measure.library

        See Also:
        Constant Field Values
      • 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.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_NAME

        public static final String SP_NAME
        Search parameter: name

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

        See Also:
        Constant Field Values
      • 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_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the measure
        Type: token
        Path: Measure.useContext.valueCodeableConcept

        See Also:
        Constant Field Values
      • 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.valueCodeableConcept

      • 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:
        Constant Field Values
      • 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_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

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

        See Also:
        Constant Field Values
      • 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_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:

        See Also:
        Constant Field Values
      • 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:

      • 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:
        Constant Field Values
      • 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