blob: 4912165352a4afcc92c708895f39d122700759c7 [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>Explanation Of Benefit Detail</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getSequence <em>Sequence</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getService <em>Service</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getQuantity <em>Quantity</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getUnitPrice <em>Unit Price</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getFactor <em>Factor</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getPoints <em>Points</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getNet <em>Net</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getUdi <em>Udi</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getAdjudication <em>Adjudication</em>}</li>
* <li>{@link org.hl7.fhir.ExplanationOfBenefitDetail#getSubDetail <em>Sub Detail</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail()
* @model extendedMetaData="name='ExplanationOfBenefit.Detail' kind='elementOnly'"
* @generated
*/
public interface ExplanationOfBenefitDetail extends BackboneElement {
/**
* Returns the value of the '<em><b>Sequence</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A service line number.
* <!-- end-model-doc -->
* @return the value of the '<em>Sequence</em>' containment reference.
* @see #setSequence(PositiveInt)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Sequence()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='sequence' namespace='##targetNamespace'"
* @generated
*/
PositiveInt getSequence();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getSequence <em>Sequence</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Sequence</em>' containment reference.
* @see #getSequence()
* @generated
*/
void setSequence(PositiveInt 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 product or service.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(Coding)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Type()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
Coding getType();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#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(Coding value);
/**
* Returns the value of the '<em><b>Service</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.
* <!-- end-model-doc -->
* @return the value of the '<em>Service</em>' containment reference.
* @see #setService(Coding)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Service()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='service' namespace='##targetNamespace'"
* @generated
*/
Coding getService();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getService <em>Service</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Service</em>' containment reference.
* @see #getService()
* @generated
*/
void setService(Coding value);
/**
* Returns the value of the '<em><b>Quantity</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The number of repetitions of a service or product.
* <!-- end-model-doc -->
* @return the value of the '<em>Quantity</em>' containment reference.
* @see #setQuantity(SimpleQuantity)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Quantity()
* @model containment="true"
* extendedMetaData="kind='element' name='quantity' namespace='##targetNamespace'"
* @generated
*/
SimpleQuantity getQuantity();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getQuantity <em>Quantity</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Quantity</em>' containment reference.
* @see #getQuantity()
* @generated
*/
void setQuantity(SimpleQuantity value);
/**
* Returns the value of the '<em><b>Unit Price</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
* <!-- end-model-doc -->
* @return the value of the '<em>Unit Price</em>' containment reference.
* @see #setUnitPrice(Money)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_UnitPrice()
* @model containment="true"
* extendedMetaData="kind='element' name='unitPrice' namespace='##targetNamespace'"
* @generated
*/
Money getUnitPrice();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getUnitPrice <em>Unit Price</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Unit Price</em>' containment reference.
* @see #getUnitPrice()
* @generated
*/
void setUnitPrice(Money value);
/**
* Returns the value of the '<em><b>Factor</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
* <!-- end-model-doc -->
* @return the value of the '<em>Factor</em>' containment reference.
* @see #setFactor(Decimal)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Factor()
* @model containment="true"
* extendedMetaData="kind='element' name='factor' namespace='##targetNamespace'"
* @generated
*/
Decimal getFactor();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getFactor <em>Factor</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Factor</em>' containment reference.
* @see #getFactor()
* @generated
*/
void setFactor(Decimal value);
/**
* Returns the value of the '<em><b>Points</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
* <!-- end-model-doc -->
* @return the value of the '<em>Points</em>' containment reference.
* @see #setPoints(Decimal)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Points()
* @model containment="true"
* extendedMetaData="kind='element' name='points' namespace='##targetNamespace'"
* @generated
*/
Decimal getPoints();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getPoints <em>Points</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Points</em>' containment reference.
* @see #getPoints()
* @generated
*/
void setPoints(Decimal value);
/**
* Returns the value of the '<em><b>Net</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
* <!-- end-model-doc -->
* @return the value of the '<em>Net</em>' containment reference.
* @see #setNet(Money)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Net()
* @model containment="true"
* extendedMetaData="kind='element' name='net' namespace='##targetNamespace'"
* @generated
*/
Money getNet();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getNet <em>Net</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Net</em>' containment reference.
* @see #getNet()
* @generated
*/
void setNet(Money value);
/**
* Returns the value of the '<em><b>Udi</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* List of Unique Device Identifiers associated with this line item.
* <!-- end-model-doc -->
* @return the value of the '<em>Udi</em>' containment reference.
* @see #setUdi(Coding)
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Udi()
* @model containment="true"
* extendedMetaData="kind='element' name='udi' namespace='##targetNamespace'"
* @generated
*/
Coding getUdi();
/**
* Sets the value of the '{@link org.hl7.fhir.ExplanationOfBenefitDetail#getUdi <em>Udi</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Udi</em>' containment reference.
* @see #getUdi()
* @generated
*/
void setUdi(Coding value);
/**
* Returns the value of the '<em><b>Adjudication</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.ExplanationOfBenefitAdjudication1}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The adjudications results.
* <!-- end-model-doc -->
* @return the value of the '<em>Adjudication</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_Adjudication()
* @model containment="true"
* extendedMetaData="kind='element' name='adjudication' namespace='##targetNamespace'"
* @generated
*/
EList<ExplanationOfBenefitAdjudication1> getAdjudication();
/**
* Returns the value of the '<em><b>Sub Detail</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.ExplanationOfBenefitSubDetail}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Third tier of goods and services.
* <!-- end-model-doc -->
* @return the value of the '<em>Sub Detail</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getExplanationOfBenefitDetail_SubDetail()
* @model containment="true"
* extendedMetaData="kind='element' name='subDetail' namespace='##targetNamespace'"
* @generated
*/
EList<ExplanationOfBenefitSubDetail> getSubDetail();
} // ExplanationOfBenefitDetail