Class Measure.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.Measure.Builder
-
- Enclosing class:
- Measure
public static class Measure.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Measure.Builder
approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.Measure.Builder
approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher.Measure.Builder
author(java.util.Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.Measure.Builder
author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.Measure
build()
Build theMeasure
Measure.Builder
clinicalRecommendationStatement(Markdown clinicalRecommendationStatement)
Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.Measure.Builder
compositeScoring(CodeableConcept compositeScoring)
If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.Measure.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.Measure.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Measure.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Measure.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Measure.Builder
copyright(Markdown copyright)
A copyright statement relating to the measure and/or its contents.Measure.Builder
date(DateTime date)
The date (and optionally time) when the measure was published.Measure.Builder
definition(java.util.Collection<Markdown> definition)
Provides a description of an individual term used within the measure.Measure.Builder
definition(Markdown... definition)
Provides a description of an individual term used within the measure.Measure.Builder
description(Markdown description)
A free text natural language description of the measure from a consumer's perspective.Measure.Builder
disclaimer(Markdown disclaimer)
Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.Measure.Builder
editor(java.util.Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.Measure.Builder
editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.Measure.Builder
effectivePeriod(Period effectivePeriod)
The period during which the measure content was or is planned to be in active use.Measure.Builder
endorser(java.util.Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.Measure.Builder
endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.Measure.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.Measure.Builder
experimental(Boolean 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.Measure.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.Measure.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Measure.Builder
from(Measure measure)
Measure.Builder
group(java.util.Collection<Measure.Group> group)
A group of population criteria for the measure.Measure.Builder
group(Measure.Group... group)
A group of population criteria for the measure.Measure.Builder
guidance(Markdown guidance)
Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.Measure.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Measure.Builder
identifier(java.util.Collection<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.Measure.Builder
identifier(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.Measure.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.Measure.Builder
improvementNotation(CodeableConcept improvementNotation)
Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).Measure.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the measure is intended to be used.Measure.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the measure is intended to be used.Measure.Builder
language(Code language)
The base language in which the resource is written.Measure.Builder
lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.Measure.Builder
lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed.Measure.Builder
library(java.util.Collection<Canonical> library)
A reference to a Library resource containing the formal logic used by the measure.Measure.Builder
library(Canonical... library)
A reference to a Library resource containing the formal logic used by the measure.Measure.Builder
meta(Meta meta)
The metadata about the resource.Measure.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.Measure.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.Measure.Builder
name(java.lang.String name)
Convenience method for settingname
.Measure.Builder
name(String name)
A natural language name identifying the measure.Measure.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.Measure.Builder
publisher(String publisher)
The name of the organization or individual that published the measure.Measure.Builder
purpose(Markdown purpose)
Explanation of why this measure is needed and why it has been designed as it has.Measure.Builder
rateAggregation(java.lang.String rateAggregation)
Convenience method for settingrateAggregation
.Measure.Builder
rateAggregation(String rateAggregation)
Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.Measure.Builder
rationale(Markdown rationale)
Provides a succinct statement of the need for the measure.Measure.Builder
relatedArtifact(java.util.Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.Measure.Builder
relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.Measure.Builder
reviewer(java.util.Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.Measure.Builder
reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.Measure.Builder
riskAdjustment(java.lang.String riskAdjustment)
Convenience method for settingriskAdjustment
.Measure.Builder
riskAdjustment(String 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.Measure.Builder
scoring(CodeableConcept scoring)
Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort.Measure.Builder
status(PublicationStatus status)
The status of this measure.Measure.Builder
subject(Element subject)
The intended subjects for the measure.Measure.Builder
subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.Measure.Builder
subtitle(String subtitle)
An explanatory or alternate title for the measure giving additional information about its content.Measure.Builder
supplementalData(java.util.Collection<Measure.SupplementalData> 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.Measure.Builder
supplementalData(Measure.SupplementalData... 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.Measure.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.Measure.Builder
title(java.lang.String title)
Convenience method for settingtitle
.Measure.Builder
title(String title)
A short, descriptive, user-friendly title for the measure.Measure.Builder
topic(java.util.Collection<CodeableConcept> topic)
Descriptive topics related to the content of the measure.Measure.Builder
topic(CodeableConcept... topic)
Descriptive topics related to the content of the measure.Measure.Builder
type(java.util.Collection<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.Measure.Builder
type(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.Measure.Builder
url(Uri 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.Measure.Builder
usage(java.lang.String usage)
Convenience method for settingusage
.Measure.Builder
usage(String usage)
A detailed description, from a clinical perspective, of how the measure is used.Measure.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.Measure.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(Measure measure)
Measure.Builder
version(java.lang.String version)
Convenience method for settingversion
.Measure.Builder
version(String version)
The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance.-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Measure.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public Measure.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public Measure.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public Measure.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public Measure.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public Measure.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public Measure.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public Measure.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Measure.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public Measure.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public Measure.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
url
public Measure.Builder url(Uri 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.- Parameters:
url
- Canonical identifier for this measure, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public Measure.Builder identifier(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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the measure- Returns:
- A reference to this Builder instance
-
identifier
public Measure.Builder identifier(java.util.Collection<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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the measure- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public Measure.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the measure- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public Measure.Builder version(String version)
The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.- Parameters:
version
- Business version of the measure- Returns:
- A reference to this Builder instance
-
name
public Measure.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name for this measure (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public Measure.Builder name(String name)
A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Parameters:
name
- Name for this measure (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public Measure.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this measure (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public Measure.Builder title(String title)
A short, descriptive, user-friendly title for the measure.- Parameters:
title
- Name for this measure (human friendly)- Returns:
- A reference to this Builder instance
-
subtitle
public Measure.Builder subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.- Parameters:
subtitle
- Subordinate title of the measure- Returns:
- A reference to this Builder instance
- See Also:
subtitle(org.linuxforhealth.fhir.model.type.String)
-
subtitle
public Measure.Builder subtitle(String subtitle)
An explanatory or alternate title for the measure giving additional information about its content.- Parameters:
subtitle
- Subordinate title of the measure- Returns:
- A reference to this Builder instance
-
status
public Measure.Builder status(PublicationStatus status)
The status of this measure. Enables tracking the life-cycle of the content.This element is required.
- Parameters:
status
- draft | active | retired | unknown- Returns:
- A reference to this Builder instance
-
experimental
public Measure.Builder experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
- See Also:
experimental(org.linuxforhealth.fhir.model.type.Boolean)
-
experimental
public Measure.Builder experimental(Boolean 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.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
-
subject
public Measure.Builder subject(Element 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.This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
subject
- E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device- Returns:
- A reference to this Builder instance
-
date
public Measure.Builder date(DateTime 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.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public Measure.Builder publisher(java.lang.String publisher)
Convenience method for settingpublisher
.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
- See Also:
publisher(org.linuxforhealth.fhir.model.type.String)
-
publisher
public Measure.Builder publisher(String publisher)
The name of the organization or individual that published the measure.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public Measure.Builder contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
contact
public Measure.Builder contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public Measure.Builder description(Markdown description)
A free text natural language description of the measure from a consumer's perspective.- Parameters:
description
- Natural language description of the measure- Returns:
- A reference to this Builder instance
-
useContext
public Measure.Builder useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
useContext
public Measure.Builder useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
jurisdiction
public Measure.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the measure is intended to be used.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for measure (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public Measure.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the measure is intended to be used.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for measure (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
purpose
public Measure.Builder purpose(Markdown purpose)
Explanation of why this measure is needed and why it has been designed as it has.- Parameters:
purpose
- Why this measure is defined- Returns:
- A reference to this Builder instance
-
usage
public Measure.Builder usage(java.lang.String usage)
Convenience method for settingusage
.- Parameters:
usage
- Describes the clinical usage of the measure- Returns:
- A reference to this Builder instance
- See Also:
usage(org.linuxforhealth.fhir.model.type.String)
-
usage
public Measure.Builder usage(String usage)
A detailed description, from a clinical perspective, of how the measure is used.- Parameters:
usage
- Describes the clinical usage of the measure- Returns:
- A reference to this Builder instance
-
copyright
public Measure.Builder copyright(Markdown 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.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
approvalDate
public Measure.Builder approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.- Parameters:
approvalDate
- When the measure was approved by publisher- Returns:
- A reference to this Builder instance
- See Also:
approvalDate(org.linuxforhealth.fhir.model.type.Date)
-
approvalDate
public Measure.Builder approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.- Parameters:
approvalDate
- When the measure was approved by publisher- Returns:
- A reference to this Builder instance
-
lastReviewDate
public Measure.Builder lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.- Parameters:
lastReviewDate
- When the measure was last reviewed- Returns:
- A reference to this Builder instance
- See Also:
lastReviewDate(org.linuxforhealth.fhir.model.type.Date)
-
lastReviewDate
public Measure.Builder lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.- Parameters:
lastReviewDate
- When the measure was last reviewed- Returns:
- A reference to this Builder instance
-
effectivePeriod
public Measure.Builder effectivePeriod(Period effectivePeriod)
The period during which the measure content was or is planned to be in active use.- Parameters:
effectivePeriod
- When the measure is expected to be used- Returns:
- A reference to this Builder instance
-
topic
public Measure.Builder topic(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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
topic
- The category of the measure, such as Education, Treatment, Assessment, etc.- Returns:
- A reference to this Builder instance
-
topic
public Measure.Builder topic(java.util.Collection<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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
topic
- The category of the measure, such as Education, Treatment, Assessment, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
author
public Measure.Builder author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
author
- Who authored the content- Returns:
- A reference to this Builder instance
-
author
public Measure.Builder author(java.util.Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
author
- Who authored the content- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
editor
public Measure.Builder editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
editor
- Who edited the content- Returns:
- A reference to this Builder instance
-
editor
public Measure.Builder editor(java.util.Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
editor
- Who edited the content- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
reviewer
public Measure.Builder reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
reviewer
- Who reviewed the content- Returns:
- A reference to this Builder instance
-
reviewer
public Measure.Builder reviewer(java.util.Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
reviewer
- Who reviewed the content- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
endorser
public Measure.Builder endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
endorser
- Who endorsed the content- Returns:
- A reference to this Builder instance
-
endorser
public Measure.Builder endorser(java.util.Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
endorser
- Who endorsed the content- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
relatedArtifact
public Measure.Builder relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
relatedArtifact
- Additional documentation, citations, etc.- Returns:
- A reference to this Builder instance
-
relatedArtifact
public Measure.Builder relatedArtifact(java.util.Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
relatedArtifact
- Additional documentation, citations, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
library
public Measure.Builder library(Canonical... library)
A reference to a Library resource containing the formal logic used by the measure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
library
- Logic used by the measure- Returns:
- A reference to this Builder instance
-
library
public Measure.Builder library(java.util.Collection<Canonical> library)
A reference to a Library resource containing the formal logic used by the measure.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
library
- Logic used by the measure- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
disclaimer
public Measure.Builder disclaimer(Markdown disclaimer)
Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.- Parameters:
disclaimer
- Disclaimer for use of the measure or its referenced content- Returns:
- A reference to this Builder instance
-
scoring
public Measure.Builder scoring(CodeableConcept scoring)
Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.- Parameters:
scoring
- proportion | ratio | continuous-variable | cohort- Returns:
- A reference to this Builder instance
-
compositeScoring
public Measure.Builder compositeScoring(CodeableConcept compositeScoring)
If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.- Parameters:
compositeScoring
- opportunity | all-or-nothing | linear | weighted- Returns:
- A reference to this Builder instance
-
type
public Measure.Builder type(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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
type
- process | outcome | structure | patient-reported-outcome | composite- Returns:
- A reference to this Builder instance
-
type
public Measure.Builder type(java.util.Collection<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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
type
- process | outcome | structure | patient-reported-outcome | composite- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
riskAdjustment
public Measure.Builder riskAdjustment(java.lang.String riskAdjustment)
Convenience method for settingriskAdjustment
.- Parameters:
riskAdjustment
- How risk adjustment is applied for this measure- Returns:
- A reference to this Builder instance
- See Also:
riskAdjustment(org.linuxforhealth.fhir.model.type.String)
-
riskAdjustment
public Measure.Builder riskAdjustment(String 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.- Parameters:
riskAdjustment
- How risk adjustment is applied for this measure- Returns:
- A reference to this Builder instance
-
rateAggregation
public Measure.Builder rateAggregation(java.lang.String rateAggregation)
Convenience method for settingrateAggregation
.- Parameters:
rateAggregation
- How is rate aggregation performed for this measure- Returns:
- A reference to this Builder instance
- See Also:
rateAggregation(org.linuxforhealth.fhir.model.type.String)
-
rateAggregation
public Measure.Builder rateAggregation(String rateAggregation)
Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.- Parameters:
rateAggregation
- How is rate aggregation performed for this measure- Returns:
- A reference to this Builder instance
-
rationale
public Measure.Builder rationale(Markdown rationale)
Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.- Parameters:
rationale
- Detailed description of why the measure exists- Returns:
- A reference to this Builder instance
-
clinicalRecommendationStatement
public Measure.Builder clinicalRecommendationStatement(Markdown clinicalRecommendationStatement)
Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.- Parameters:
clinicalRecommendationStatement
- Summary of clinical guidelines- Returns:
- A reference to this Builder instance
-
improvementNotation
public Measure.Builder improvementNotation(CodeableConcept improvementNotation)
Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).- Parameters:
improvementNotation
- increase | decrease- Returns:
- A reference to this Builder instance
-
definition
public Measure.Builder definition(Markdown... definition)
Provides a description of an individual term used within the measure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
definition
- Defined terms used in the measure documentation- Returns:
- A reference to this Builder instance
-
definition
public Measure.Builder definition(java.util.Collection<Markdown> definition)
Provides a description of an individual term used within the measure.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
definition
- Defined terms used in the measure documentation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
guidance
public Measure.Builder guidance(Markdown guidance)
Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.- Parameters:
guidance
- Additional guidance for implementers- Returns:
- A reference to this Builder instance
-
group
public Measure.Builder group(Measure.Group... group)
A group of population criteria for the measure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
group
- Population criteria group- Returns:
- A reference to this Builder instance
-
group
public Measure.Builder group(java.util.Collection<Measure.Group> group)
A group of population criteria for the measure.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
group
- Population criteria group- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
supplementalData
public Measure.Builder supplementalData(Measure.SupplementalData... 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
supplementalData
- What other data should be reported with the measure- Returns:
- A reference to this Builder instance
-
supplementalData
public Measure.Builder supplementalData(java.util.Collection<Measure.SupplementalData> 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
supplementalData
- What other data should be reported with the measure- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public Measure build()
-
validate
protected void validate(Measure measure)
-
from
protected Measure.Builder from(Measure measure)
-
-