blob: 71d289fbe5c47f9593a9a39a7f2925186e96f6b3 [file] [log] [blame]
/**
*/
package org.hl7.fhir;
import org.eclipse.emf.common.util.EList;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Measure Report</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
* If the element is present, it must have either a @value, an @id, or extensions
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.MeasureReport#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getMeasure <em>Measure</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getSubject <em>Subject</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getDate <em>Date</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getReporter <em>Reporter</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getPeriod <em>Period</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getImprovementNotation <em>Improvement Notation</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getGroup <em>Group</em>}</li>
* <li>{@link org.hl7.fhir.MeasureReport#getEvaluatedResource <em>Evaluated Resource</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getMeasureReport()
* @model extendedMetaData="name='MeasureReport' kind='elementOnly'"
* @generated
*/
public interface MeasureReport extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Identifier}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* 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.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Status</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The MeasureReport status. No data will be available until the MeasureReport status is complete.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(MeasureReportStatus)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Status()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
MeasureReportStatus getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getStatus <em>Status</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status</em>' containment reference.
* @see #getStatus()
* @generated
*/
void setStatus(MeasureReportStatus value);
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* 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.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(MeasureReportType)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Type()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
MeasureReportType getType();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getType <em>Type</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type</em>' containment reference.
* @see #getType()
* @generated
*/
void setType(MeasureReportType value);
/**
* Returns the value of the '<em><b>Measure</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A reference to the Measure that was calculated to produce this report.
* <!-- end-model-doc -->
* @return the value of the '<em>Measure</em>' containment reference.
* @see #setMeasure(Canonical)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Measure()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='measure' namespace='##targetNamespace'"
* @generated
*/
Canonical getMeasure();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getMeasure <em>Measure</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Measure</em>' containment reference.
* @see #getMeasure()
* @generated
*/
void setMeasure(Canonical value);
/**
* Returns the value of the '<em><b>Subject</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Optional subject identifying the individual or individuals the report is for.
* <!-- end-model-doc -->
* @return the value of the '<em>Subject</em>' containment reference.
* @see #setSubject(Reference)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Subject()
* @model containment="true"
* extendedMetaData="kind='element' name='subject' namespace='##targetNamespace'"
* @generated
*/
Reference getSubject();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getSubject <em>Subject</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Subject</em>' containment reference.
* @see #getSubject()
* @generated
*/
void setSubject(Reference value);
/**
* Returns the value of the '<em><b>Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The date this measure report was generated.
* <!-- end-model-doc -->
* @return the value of the '<em>Date</em>' containment reference.
* @see #setDate(DateTime)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Date()
* @model containment="true"
* extendedMetaData="kind='element' name='date' namespace='##targetNamespace'"
* @generated
*/
DateTime getDate();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getDate <em>Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Date</em>' containment reference.
* @see #getDate()
* @generated
*/
void setDate(DateTime value);
/**
* Returns the value of the '<em><b>Reporter</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The individual, location, or organization that is reporting the data.
* <!-- end-model-doc -->
* @return the value of the '<em>Reporter</em>' containment reference.
* @see #setReporter(Reference)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Reporter()
* @model containment="true"
* extendedMetaData="kind='element' name='reporter' namespace='##targetNamespace'"
* @generated
*/
Reference getReporter();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getReporter <em>Reporter</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Reporter</em>' containment reference.
* @see #getReporter()
* @generated
*/
void setReporter(Reference value);
/**
* Returns the value of the '<em><b>Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The reporting period for which the report was calculated.
* <!-- end-model-doc -->
* @return the value of the '<em>Period</em>' containment reference.
* @see #setPeriod(Period)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Period()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='period' namespace='##targetNamespace'"
* @generated
*/
Period getPeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getPeriod <em>Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Period</em>' containment reference.
* @see #getPeriod()
* @generated
*/
void setPeriod(Period value);
/**
* Returns the value of the '<em><b>Improvement Notation</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Whether improvement in the measure is noted by an increase or decrease in the measure score.
* <!-- end-model-doc -->
* @return the value of the '<em>Improvement Notation</em>' containment reference.
* @see #setImprovementNotation(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getMeasureReport_ImprovementNotation()
* @model containment="true"
* extendedMetaData="kind='element' name='improvementNotation' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getImprovementNotation();
/**
* Sets the value of the '{@link org.hl7.fhir.MeasureReport#getImprovementNotation <em>Improvement Notation</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Improvement Notation</em>' containment reference.
* @see #getImprovementNotation()
* @generated
*/
void setImprovementNotation(CodeableConcept value);
/**
* Returns the value of the '<em><b>Group</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.MeasureReportGroup}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The results of the calculation, one for each population group in the measure.
* <!-- end-model-doc -->
* @return the value of the '<em>Group</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMeasureReport_Group()
* @model containment="true"
* extendedMetaData="kind='element' name='group' namespace='##targetNamespace'"
* @generated
*/
EList<MeasureReportGroup> getGroup();
/**
* Returns the value of the '<em><b>Evaluated Resource</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Reference}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A reference to a Bundle containing the Resources that were used in the calculation of this measure.
* <!-- end-model-doc -->
* @return the value of the '<em>Evaluated Resource</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getMeasureReport_EvaluatedResource()
* @model containment="true"
* extendedMetaData="kind='element' name='evaluatedResource' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getEvaluatedResource();
} // MeasureReport