blob: bdd7ddd560b365e860f9cdc47d95abdb71d3f18e [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>Payment Reconciliation</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* This resource provides payment details and claim references supporting a bulk payment.
* 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.PaymentReconciliation#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getRequest <em>Request</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getOutcome <em>Outcome</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getDisposition <em>Disposition</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getRuleset <em>Ruleset</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getOriginalRuleset <em>Original Ruleset</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getCreated <em>Created</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getPeriod <em>Period</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getOrganization <em>Organization</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getRequestProvider <em>Request Provider</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getRequestOrganization <em>Request Organization</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getDetail <em>Detail</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getForm <em>Form</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getTotal <em>Total</em>}</li>
* <li>{@link org.hl7.fhir.PaymentReconciliation#getNote <em>Note</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation()
* @model extendedMetaData="name='PaymentReconciliation' kind='elementOnly'"
* @generated
*/
public interface PaymentReconciliation 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 -->
* The Response business identifier.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Request</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Original request resource reference.
* <!-- end-model-doc -->
* @return the value of the '<em>Request</em>' containment reference.
* @see #setRequest(Reference)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Request()
* @model containment="true"
* extendedMetaData="kind='element' name='request' namespace='##targetNamespace'"
* @generated
*/
Reference getRequest();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getRequest <em>Request</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Request</em>' containment reference.
* @see #getRequest()
* @generated
*/
void setRequest(Reference value);
/**
* Returns the value of the '<em><b>Outcome</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Transaction status: error, complete.
* <!-- end-model-doc -->
* @return the value of the '<em>Outcome</em>' containment reference.
* @see #setOutcome(Code)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Outcome()
* @model containment="true"
* extendedMetaData="kind='element' name='outcome' namespace='##targetNamespace'"
* @generated
*/
Code getOutcome();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getOutcome <em>Outcome</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Outcome</em>' containment reference.
* @see #getOutcome()
* @generated
*/
void setOutcome(Code value);
/**
* Returns the value of the '<em><b>Disposition</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A description of the status of the adjudication.
* <!-- end-model-doc -->
* @return the value of the '<em>Disposition</em>' containment reference.
* @see #setDisposition(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Disposition()
* @model containment="true"
* extendedMetaData="kind='element' name='disposition' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getDisposition();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getDisposition <em>Disposition</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Disposition</em>' containment reference.
* @see #getDisposition()
* @generated
*/
void setDisposition(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Ruleset</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
* <!-- end-model-doc -->
* @return the value of the '<em>Ruleset</em>' containment reference.
* @see #setRuleset(Coding)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Ruleset()
* @model containment="true"
* extendedMetaData="kind='element' name='ruleset' namespace='##targetNamespace'"
* @generated
*/
Coding getRuleset();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getRuleset <em>Ruleset</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Ruleset</em>' containment reference.
* @see #getRuleset()
* @generated
*/
void setRuleset(Coding value);
/**
* Returns the value of the '<em><b>Original Ruleset</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The style (standard) and version of the original material which was converted into this resource.
* <!-- end-model-doc -->
* @return the value of the '<em>Original Ruleset</em>' containment reference.
* @see #setOriginalRuleset(Coding)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_OriginalRuleset()
* @model containment="true"
* extendedMetaData="kind='element' name='originalRuleset' namespace='##targetNamespace'"
* @generated
*/
Coding getOriginalRuleset();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getOriginalRuleset <em>Original Ruleset</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Original Ruleset</em>' containment reference.
* @see #getOriginalRuleset()
* @generated
*/
void setOriginalRuleset(Coding value);
/**
* Returns the value of the '<em><b>Created</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The date when the enclosed suite of services were performed or completed.
* <!-- end-model-doc -->
* @return the value of the '<em>Created</em>' containment reference.
* @see #setCreated(DateTime)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Created()
* @model containment="true"
* extendedMetaData="kind='element' name='created' namespace='##targetNamespace'"
* @generated
*/
DateTime getCreated();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getCreated <em>Created</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Created</em>' containment reference.
* @see #getCreated()
* @generated
*/
void setCreated(DateTime value);
/**
* Returns the value of the '<em><b>Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The period of time for which payments have been gathered into this bulk payment for settlement.
* <!-- end-model-doc -->
* @return the value of the '<em>Period</em>' containment reference.
* @see #setPeriod(Period)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Period()
* @model containment="true"
* extendedMetaData="kind='element' name='period' namespace='##targetNamespace'"
* @generated
*/
Period getPeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#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>Organization</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The Insurer who produced this adjudicated response.
* <!-- end-model-doc -->
* @return the value of the '<em>Organization</em>' containment reference.
* @see #setOrganization(Reference)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Organization()
* @model containment="true"
* extendedMetaData="kind='element' name='organization' namespace='##targetNamespace'"
* @generated
*/
Reference getOrganization();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getOrganization <em>Organization</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Organization</em>' containment reference.
* @see #getOrganization()
* @generated
*/
void setOrganization(Reference value);
/**
* Returns the value of the '<em><b>Request Provider</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The practitioner who is responsible for the services rendered to the patient.
* <!-- end-model-doc -->
* @return the value of the '<em>Request Provider</em>' containment reference.
* @see #setRequestProvider(Reference)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_RequestProvider()
* @model containment="true"
* extendedMetaData="kind='element' name='requestProvider' namespace='##targetNamespace'"
* @generated
*/
Reference getRequestProvider();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getRequestProvider <em>Request Provider</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Request Provider</em>' containment reference.
* @see #getRequestProvider()
* @generated
*/
void setRequestProvider(Reference value);
/**
* Returns the value of the '<em><b>Request Organization</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The organization which is responsible for the services rendered to the patient.
* <!-- end-model-doc -->
* @return the value of the '<em>Request Organization</em>' containment reference.
* @see #setRequestOrganization(Reference)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_RequestOrganization()
* @model containment="true"
* extendedMetaData="kind='element' name='requestOrganization' namespace='##targetNamespace'"
* @generated
*/
Reference getRequestOrganization();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getRequestOrganization <em>Request Organization</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Request Organization</em>' containment reference.
* @see #getRequestOrganization()
* @generated
*/
void setRequestOrganization(Reference value);
/**
* Returns the value of the '<em><b>Detail</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.PaymentReconciliationDetail}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* List of individual settlement amounts and the corresponding transaction.
* <!-- end-model-doc -->
* @return the value of the '<em>Detail</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Detail()
* @model containment="true"
* extendedMetaData="kind='element' name='detail' namespace='##targetNamespace'"
* @generated
*/
EList<PaymentReconciliationDetail> getDetail();
/**
* Returns the value of the '<em><b>Form</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The form to be used for printing the content.
* <!-- end-model-doc -->
* @return the value of the '<em>Form</em>' containment reference.
* @see #setForm(Coding)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Form()
* @model containment="true"
* extendedMetaData="kind='element' name='form' namespace='##targetNamespace'"
* @generated
*/
Coding getForm();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getForm <em>Form</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Form</em>' containment reference.
* @see #getForm()
* @generated
*/
void setForm(Coding value);
/**
* Returns the value of the '<em><b>Total</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Total payment amount.
* <!-- end-model-doc -->
* @return the value of the '<em>Total</em>' containment reference.
* @see #setTotal(Money)
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Total()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='total' namespace='##targetNamespace'"
* @generated
*/
Money getTotal();
/**
* Sets the value of the '{@link org.hl7.fhir.PaymentReconciliation#getTotal <em>Total</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Total</em>' containment reference.
* @see #getTotal()
* @generated
*/
void setTotal(Money value);
/**
* Returns the value of the '<em><b>Note</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.PaymentReconciliationNote}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Suite of notes.
* <!-- end-model-doc -->
* @return the value of the '<em>Note</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getPaymentReconciliation_Note()
* @model containment="true"
* extendedMetaData="kind='element' name='note' namespace='##targetNamespace'"
* @generated
*/
EList<PaymentReconciliationNote> getNote();
} // PaymentReconciliation