Package org.hl7.fhir.r5.model

Class MeasureReport

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.MeasureReport
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 MeasureReport extends DomainResource
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
See Also:
Serialized Form

  • Field Details

    • identifier

      protected List<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.

    • status

      protected Enumeration<MeasureReport.MeasureReportStatus> status
      The MeasureReport status. No data will be available until the MeasureReport status is complete.

    • type

      protected Enumeration<MeasureReport.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.

    • dataUpdateType

      protected Enumeration<MeasureReport.SubmitDataUpdateType> dataUpdateType
      Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.

    • measure

      protected CanonicalType measure
      A reference to the Measure that was calculated to produce this report.

    • subject

      protected Reference subject
      Optional subject identifying the individual or individuals the report is for.

    • date

      protected DateTimeType date
      The date this measure report was generated.

    • reporter

      protected Reference reporter
      The individual, location, or organization that is reporting the data.

    • reportingVendor

      protected Reference reportingVendor
      A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.

    • period

      protected Period period
      The reporting period for which the report was calculated.

    • 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. It is expected to be the same as the scoring element on the referenced Measure.

    • improvementNotation

      protected CodeableConcept improvementNotation
      Whether improvement in the measure is noted by an increase or decrease in the measure score.

    • group

      protected List<MeasureReport.MeasureReportGroupComponent> group
      The results of the calculation, one for each population group in the measure.

    • evaluatedResource

      protected List<Reference> evaluatedResource
      A reference to a Bundle containing the Resources that were used in the calculation of this measure.

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The date of the measure report
      Type: date
      Path: MeasureReport.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 date of the measure report
      Type: date
      Path: MeasureReport.date

    • SP_EVALUATED_RESOURCE

      public static final String SP_EVALUATED_RESOURCE
      Search parameter: evaluated-resource

      Description: An evaluated resource referenced by the measure report
      Type: reference
      Path: MeasureReport.evaluatedResource

      See Also:
      Constant Field Values

    • EVALUATED_RESOURCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EVALUATED_RESOURCE
      Fluent Client search parameter constant for evaluated-resource

      Description: An evaluated resource referenced by the measure report
      Type: reference
      Path: MeasureReport.evaluatedResource

    • INCLUDE_EVALUATED_RESOURCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_EVALUATED_RESOURCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MeasureReport:evaluated-resource".

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier of the measure report to be returned
      Type: token
      Path: MeasureReport.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 of the measure report to be returned
      Type: token
      Path: MeasureReport.identifier

    • SP_MEASURE

      public static final String SP_MEASURE
      Search parameter: measure

      Description: The measure to return measure report results for
      Type: reference
      Path: MeasureReport.measure

      See Also:
      Constant Field Values

    • MEASURE

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

      Description: The measure to return measure report results for
      Type: reference
      Path: MeasureReport.measure

    • INCLUDE_MEASURE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MEASURE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MeasureReport:measure".

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: The identity of a patient to search for individual measure report results for
      Type: reference
      Path: MeasureReport.subject.where(resolve() is Patient)

      See Also:
      Constant Field Values

    • PATIENT

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

      Description: The identity of a patient to search for individual measure report results for
      Type: reference
      Path: MeasureReport.subject.where(resolve() is Patient)

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MeasureReport:patient".

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

      Description: The period of the measure report
      Type: date
      Path: MeasureReport.period

      See Also:
      Constant Field Values

    • PERIOD

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

      Description: The period of the measure report
      Type: date
      Path: MeasureReport.period

    • SP_REPORTER

      public static final String SP_REPORTER
      Search parameter: reporter

      Description: The reporter to return measure report results for
      Type: reference
      Path: MeasureReport.reporter

      See Also:
      Constant Field Values

    • REPORTER

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

      Description: The reporter to return measure report results for
      Type: reference
      Path: MeasureReport.reporter

    • INCLUDE_REPORTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REPORTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MeasureReport:reporter".

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the measure report
      Type: token
      Path: MeasureReport.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 status of the measure report
      Type: token
      Path: MeasureReport.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: The identity of a subject to search for individual measure report results for
      Type: reference
      Path: MeasureReport.subject

      See Also:
      Constant Field Values

    • SUBJECT

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

      Description: The identity of a subject to search for individual measure report results for
      Type: reference
      Path: MeasureReport.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MeasureReport:subject".

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      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.)

    • setIdentifier

      public MeasureReport setIdentifier​(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()

    • addIdentifier

      public MeasureReport addIdentifier​(Identifier t)

    • getIdentifierFirstRep

      public Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist {3}

    • getStatusElement

      public Enumeration<MeasureReport.MeasureReportStatus> getStatusElement()
      Returns:
      status (The MeasureReport status. No data will be available until the MeasureReport status is complete.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public MeasureReport setStatusElement​(Enumeration<MeasureReport.MeasureReportStatus> value)
      Parameters:
      value - status (The MeasureReport status. No data will be available until the MeasureReport status is complete.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public MeasureReport.MeasureReportStatus getStatus()
      Returns:
      The MeasureReport status. No data will be available until the MeasureReport status is complete.

    • setStatus

      public MeasureReport setStatus​(MeasureReport.MeasureReportStatus value)
      Parameters:
      value - The MeasureReport status. No data will be available until the MeasureReport status is complete.

    • getTypeElement

      public Enumeration<MeasureReport.MeasureReportType> getTypeElement()
      Returns:
      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 is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • hasTypeElement

      public boolean hasTypeElement()

    • hasType

      public boolean hasType()

    • setTypeElement

      public MeasureReport setTypeElement​(Enumeration<MeasureReport.MeasureReportType> value)
      Parameters:
      value - 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 is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • getType

      public MeasureReport.MeasureReportType getType()
      Returns:
      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.

    • setType

      public MeasureReport setType​(MeasureReport.MeasureReportType value)
      Parameters:
      value - 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.

    • getDataUpdateTypeElement

      public Enumeration<MeasureReport.SubmitDataUpdateType> getDataUpdateTypeElement()
      Returns:
      dataUpdateType (Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.). This is the underlying object with id, value and extensions. The accessor "getDataUpdateType" gives direct access to the value

    • hasDataUpdateTypeElement

      public boolean hasDataUpdateTypeElement()

    • hasDataUpdateType

      public boolean hasDataUpdateType()

    • setDataUpdateTypeElement

      public MeasureReport setDataUpdateTypeElement​(Enumeration<MeasureReport.SubmitDataUpdateType> value)
      Parameters:
      value - dataUpdateType (Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.). This is the underlying object with id, value and extensions. The accessor "getDataUpdateType" gives direct access to the value

    • getDataUpdateType

      public MeasureReport.SubmitDataUpdateType getDataUpdateType()
      Returns:
      Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.

    • setDataUpdateType

      public MeasureReport setDataUpdateType​(MeasureReport.SubmitDataUpdateType value)
      Parameters:
      value - Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.

    • getMeasureElement

      public CanonicalType getMeasureElement()
      Returns:
      measure (A reference to the Measure that was calculated to produce this report.). This is the underlying object with id, value and extensions. The accessor "getMeasure" gives direct access to the value

    • hasMeasureElement

      public boolean hasMeasureElement()

    • hasMeasure

      public boolean hasMeasure()

    • setMeasureElement

      public MeasureReport setMeasureElement​(CanonicalType value)
      Parameters:
      value - measure (A reference to the Measure that was calculated to produce this report.). This is the underlying object with id, value and extensions. The accessor "getMeasure" gives direct access to the value

    • getMeasure

      public String getMeasure()
      Returns:
      A reference to the Measure that was calculated to produce this report.

    • setMeasure

      public MeasureReport setMeasure​(String value)
      Parameters:
      value - A reference to the Measure that was calculated to produce this report.

    • getSubject

      public Reference getSubject()
      Returns:
      subject (Optional subject identifying the individual or individuals the report is for.)

    • hasSubject

      public boolean hasSubject()

    • setSubject

      public MeasureReport setSubject​(Reference value)
      Parameters:
      value - subject (Optional subject identifying the individual or individuals the report is for.)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      date (The date this measure report was generated.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public MeasureReport setDateElement​(DateTimeType value)
      Parameters:
      value - date (The date this measure report was generated.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • getDate

      public Date getDate()
      Returns:
      The date this measure report was generated.

    • setDate

      public MeasureReport setDate​(Date value)
      Parameters:
      value - The date this measure report was generated.

    • getReporter

      public Reference getReporter()
      Returns:
      reporter (The individual, location, or organization that is reporting the data.)

    • hasReporter

      public boolean hasReporter()

    • setReporter

      public MeasureReport setReporter​(Reference value)
      Parameters:
      value - reporter (The individual, location, or organization that is reporting the data.)

    • getReportingVendor

      public Reference getReportingVendor()
      Returns:
      reportingVendor (A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.)

    • hasReportingVendor

      public boolean hasReportingVendor()

    • setReportingVendor

      public MeasureReport setReportingVendor​(Reference value)
      Parameters:
      value - reportingVendor (A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.)

    • getPeriod

      public Period getPeriod()
      Returns:
      period (The reporting period for which the report was calculated.)

    • hasPeriod

      public boolean hasPeriod()

    • setPeriod

      public MeasureReport setPeriod​(Period value)
      Parameters:
      value - period (The reporting period for which the report was calculated.)

    • getScoring

      public CodeableConcept getScoring()
      Returns:
      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. It is expected to be the same as the scoring element on the referenced Measure.)

    • hasScoring

      public boolean hasScoring()

    • setScoring

      public MeasureReport setScoring​(CodeableConcept value)
      Parameters:
      value - 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. It is expected to be the same as the scoring element on the referenced Measure.)

    • getImprovementNotation

      public CodeableConcept getImprovementNotation()
      Returns:
      improvementNotation (Whether improvement in the measure is noted by an increase or decrease in the measure score.)

    • hasImprovementNotation

      public boolean hasImprovementNotation()

    • setImprovementNotation

      public MeasureReport setImprovementNotation​(CodeableConcept value)
      Parameters:
      value - improvementNotation (Whether improvement in the measure is noted by an increase or decrease in the measure score.)

    • getGroup

      public List<MeasureReport.MeasureReportGroupComponent> getGroup()
      Returns:
      group (The results of the calculation, one for each population group in the measure.)

    • setGroup

      public MeasureReport setGroup​(List<MeasureReport.MeasureReportGroupComponent> theGroup)
      Returns:
      Returns a reference to this for easy method chaining

    • hasGroup

      public boolean hasGroup()

    • addGroup

      public MeasureReport.MeasureReportGroupComponent addGroup()

    • addGroup

      public MeasureReport addGroup​(MeasureReport.MeasureReportGroupComponent t)

    • getGroupFirstRep

      public MeasureReport.MeasureReportGroupComponent getGroupFirstRep()
      Returns:
      The first repetition of repeating field group, creating it if it does not already exist {3}

    • getEvaluatedResource

      public List<Reference> getEvaluatedResource()
      Returns:
      evaluatedResource (A reference to a Bundle containing the Resources that were used in the calculation of this measure.)

    • setEvaluatedResource

      public MeasureReport setEvaluatedResource​(List<Reference> theEvaluatedResource)
      Returns:
      Returns a reference to this for easy method chaining

    • hasEvaluatedResource

      public boolean hasEvaluatedResource()

    • addEvaluatedResource

      public Reference addEvaluatedResource()

    • addEvaluatedResource

      public MeasureReport addEvaluatedResource​(Reference t)

    • getEvaluatedResourceFirstRep

      public Reference getEvaluatedResourceFirstRep()
      Returns:
      The first repetition of repeating field evaluatedResource, creating it if it does not already exist {3}

    • listChildren

      protected void listChildren​(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty​(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty​(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty​(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty​(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild​(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public MeasureReport copy()
      Specified by:
      copy in class DomainResource

    • copyValues

      public void copyValues​(MeasureReport dst)

    • typedCopy

      protected MeasureReport typedCopy()

    • equalsDeep

      public boolean equalsDeep​(Base other_)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow​(Base other_)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource