Class Measure
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Measure
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class Measure extends DomainResource
The Measure resource provides the definition of a quality measure.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Measure.Builder
static class
Measure.Group
A group of population criteria for the measure.static class
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.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Measure.Builder
builder()
boolean
equals(java.lang.Object obj)
Date
getApprovalDate()
The date on which the resource content was approved by the publisher.java.util.List<ContactDetail>
getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.Markdown
getClinicalRecommendationStatement()
Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.CodeableConcept
getCompositeScoring()
If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the measure and/or its contents.DateTime
getDate()
The date (and optionally time) when the measure was published.java.util.List<Markdown>
getDefinition()
Provides a description of an individual term used within the measure.Markdown
getDescription()
A free text natural language description of the measure from a consumer's perspective.Markdown
getDisclaimer()
Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.java.util.List<ContactDetail>
getEditor()
An individual or organization primarily responsible for internal coherence of the content.Period
getEffectivePeriod()
The period during which the measure content was or is planned to be in active use.java.util.List<ContactDetail>
getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.Boolean
getExperimental()
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.java.util.List<Measure.Group>
getGroup()
A group of population criteria for the measure.Markdown
getGuidance()
Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.java.util.List<Identifier>
getIdentifier()
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.CodeableConcept
getImprovementNotation()
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).java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the measure is intended to be used.Date
getLastReviewDate()
The date on which the resource content was last reviewed.java.util.List<Canonical>
getLibrary()
A reference to a Library resource containing the formal logic used by the measure.String
getName()
A natural language name identifying the measure.String
getPublisher()
The name of the organization or individual that published the measure.Markdown
getPurpose()
Explanation of why this measure is needed and why it has been designed as it has.String
getRateAggregation()
Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.Markdown
getRationale()
Provides a succinct statement of the need for the measure.java.util.List<RelatedArtifact>
getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.java.util.List<ContactDetail>
getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.String
getRiskAdjustment()
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.CodeableConcept
getScoring()
Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort.PublicationStatus
getStatus()
The status of this measure.Element
getSubject()
The intended subjects for the measure.String
getSubtitle()
An explanatory or alternate title for the measure giving additional information about its content.java.util.List<Measure.SupplementalData>
getSupplementalData()
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.String
getTitle()
A short, descriptive, user-friendly title for the measure.java.util.List<CodeableConcept>
getTopic()
Descriptive topics related to the content of the measure.java.util.List<CodeableConcept>
getType()
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.Uri
getUrl()
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.String
getUsage()
A detailed description, from a clinical perspective, of how the measure is used.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.String
getVersion()
The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
Measure.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getUrl
public Uri getUrl()
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.- Returns:
- An immutable object of type
Uri
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getVersion
public String getVersion()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getName
public String getName()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for the measure.- Returns:
- An immutable object of type
String
that may be null.
-
getSubtitle
public String getSubtitle()
An explanatory or alternate title for the measure giving additional information about its content.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this measure. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getExperimental
public Boolean getExperimental()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getSubject
public Element getSubject()
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.- Returns:
- An immutable object of type
CodeableConcept
orReference
that may be null.
-
getDate
public DateTime getDate()
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.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the measure.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public java.util.List<ContactDetail> getContact()
Contact details to assist a user in finding and communicating with the publisher.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getDescription
public Markdown getDescription()
A free text natural language description of the measure from a consumer's perspective.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUseContext
public java.util.List<UsageContext> getUseContext()
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.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getJurisdiction
public java.util.List<CodeableConcept> getJurisdiction()
A legal or geographic region in which the measure is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getPurpose
public Markdown getPurpose()
Explanation of why this measure is needed and why it has been designed as it has.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUsage
public String getUsage()
A detailed description, from a clinical perspective, of how the measure is used.- Returns:
- An immutable object of type
String
that may be null.
-
getCopyright
public Markdown getCopyright()
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.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getApprovalDate
public Date getApprovalDate()
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.- Returns:
- An immutable object of type
Date
that may be null.
-
getLastReviewDate
public Date getLastReviewDate()
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.- Returns:
- An immutable object of type
Date
that may be null.
-
getEffectivePeriod
public Period getEffectivePeriod()
The period during which the measure content was or is planned to be in active use.- Returns:
- An immutable object of type
Period
that may be null.
-
getTopic
public java.util.List<CodeableConcept> getTopic()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getAuthor
public java.util.List<ContactDetail> getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEditor
public java.util.List<ContactDetail> getEditor()
An individual or organization primarily responsible for internal coherence of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getReviewer
public java.util.List<ContactDetail> getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEndorser
public java.util.List<ContactDetail> getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getRelatedArtifact
public java.util.List<RelatedArtifact> getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifact
that may be empty.
-
getLibrary
public java.util.List<Canonical> getLibrary()
A reference to a Library resource containing the formal logic used by the measure.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getDisclaimer
public Markdown getDisclaimer()
Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getScoring
public CodeableConcept getScoring()
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.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getCompositeScoring
public CodeableConcept getCompositeScoring()
If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getType
public java.util.List<CodeableConcept> getType()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getRiskAdjustment
public String getRiskAdjustment()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getRateAggregation
public String getRateAggregation()
Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.- Returns:
- An immutable object of type
String
that may be null.
-
getRationale
public Markdown getRationale()
Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getClinicalRecommendationStatement
public Markdown getClinicalRecommendationStatement()
Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getImprovementNotation
public CodeableConcept getImprovementNotation()
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).- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDefinition
public java.util.List<Markdown> getDefinition()
Provides a description of an individual term used within the measure.- Returns:
- An unmodifiable list containing immutable objects of type
Markdown
that may be empty.
-
getGuidance
public Markdown getGuidance()
Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getGroup
public java.util.List<Measure.Group> getGroup()
A group of population criteria for the measure.- Returns:
- An unmodifiable list containing immutable objects of type
Measure.Group
that may be empty.
-
getSupplementalData
public java.util.List<Measure.SupplementalData> getSupplementalData()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Measure.SupplementalData
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Measure.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Measure.Builder builder()
-
-