Class MeasureReport.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.MeasureReport.Builder
-
- Enclosing class:
- MeasureReport
public static class MeasureReport.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeasureReport
build()
Build theMeasureReport
MeasureReport.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.MeasureReport.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.MeasureReport.Builder
date(DateTime date)
The date this measure report was generated.MeasureReport.Builder
evaluatedResource(Reference... evaluatedResource)
A reference to a Bundle containing the Resources that were used in the calculation of this measure.MeasureReport.Builder
evaluatedResource(java.util.Collection<Reference> evaluatedResource)
A reference to a Bundle containing the Resources that were used in the calculation of this measure.MeasureReport.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.MeasureReport.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.protected MeasureReport.Builder
from(MeasureReport measureReport)
MeasureReport.Builder
group(MeasureReport.Group... group)
The results of the calculation, one for each population group in the measure.MeasureReport.Builder
group(java.util.Collection<MeasureReport.Group> group)
The results of the calculation, one for each population group in the measure.MeasureReport.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.MeasureReport.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.MeasureReport.Builder
identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.MeasureReport.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.MeasureReport.Builder
improvementNotation(CodeableConcept improvementNotation)
Whether improvement in the measure is noted by an increase or decrease in the measure score.MeasureReport.Builder
language(Code language)
The base language in which the resource is written.MeasureReport.Builder
measure(Canonical measure)
A reference to the Measure that was calculated to produce this report.MeasureReport.Builder
meta(Meta meta)
The metadata about the resource.MeasureReport.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.MeasureReport.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.MeasureReport.Builder
period(Period period)
The reporting period for which the report was calculated.MeasureReport.Builder
reporter(Reference reporter)
The individual, location, or organization that is reporting the data.MeasureReport.Builder
status(MeasureReportStatus status)
The MeasureReport status.MeasureReport.Builder
subject(Reference subject)
Optional subject identifying the individual or individuals the report is for.MeasureReport.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.MeasureReport.Builder
type(MeasureReportType type)
The type of measure report.protected void
validate(MeasureReport measureReport)
-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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 MeasureReport.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
-
identifier
public MeasureReport.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this MeasureReport 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 MeasureReport- Returns:
- A reference to this Builder instance
-
identifier
public MeasureReport.Builder identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this MeasureReport 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 MeasureReport- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public MeasureReport.Builder status(MeasureReportStatus status)
The MeasureReport status. No data will be available until the MeasureReport status is complete.This element is required.
- Parameters:
status
- complete | pending | error- Returns:
- A reference to this Builder instance
-
type
public MeasureReport.Builder type(MeasureReportType type)
The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.This element is required.
- Parameters:
type
- individual | subject-list | summary | data-collection- Returns:
- A reference to this Builder instance
-
measure
public MeasureReport.Builder measure(Canonical measure)
A reference to the Measure that was calculated to produce this report.This element is required.
- Parameters:
measure
- What measure was calculated- Returns:
- A reference to this Builder instance
-
subject
public MeasureReport.Builder subject(Reference subject)
Optional subject identifying the individual or individuals the report is for.Allowed resource types for this reference:
- Parameters:
subject
- What individual(s) the report is for- Returns:
- A reference to this Builder instance
-
date
public MeasureReport.Builder date(DateTime date)
The date this measure report was generated.- Parameters:
date
- When the report was generated- Returns:
- A reference to this Builder instance
-
reporter
public MeasureReport.Builder reporter(Reference reporter)
The individual, location, or organization that is reporting the data.Allowed resource types for this reference:
- Parameters:
reporter
- Who is reporting the data- Returns:
- A reference to this Builder instance
-
period
public MeasureReport.Builder period(Period period)
The reporting period for which the report was calculated.This element is required.
- Parameters:
period
- What period the report covers- Returns:
- A reference to this Builder instance
-
improvementNotation
public MeasureReport.Builder improvementNotation(CodeableConcept improvementNotation)
Whether improvement in the measure is noted by an increase or decrease in the measure score.- Parameters:
improvementNotation
- increase | decrease- Returns:
- A reference to this Builder instance
-
group
public MeasureReport.Builder group(MeasureReport.Group... group)
The results of the calculation, one for each population group in the measure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
group
- Measure results for each group- Returns:
- A reference to this Builder instance
-
group
public MeasureReport.Builder group(java.util.Collection<MeasureReport.Group> group)
The results of the calculation, one for each population group in 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
- Measure results for each group- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
evaluatedResource
public MeasureReport.Builder evaluatedResource(Reference... evaluatedResource)
A reference to a Bundle containing the Resources that were used in the calculation of this measure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
evaluatedResource
- What data was used to calculate the measure score- Returns:
- A reference to this Builder instance
-
evaluatedResource
public MeasureReport.Builder evaluatedResource(java.util.Collection<Reference> evaluatedResource)
A reference to a Bundle containing the Resources that were used in the calculation of this 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:
evaluatedResource
- What data was used to calculate the measure score- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public MeasureReport build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
MeasureReport
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid MeasureReport per the base specification
-
validate
protected void validate(MeasureReport measureReport)
-
from
protected MeasureReport.Builder from(MeasureReport measureReport)
-
-