blob: 84a98db6a3ae75f2813ec16f07ebd451f3735d1d [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>Eligibility Request</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service.
* 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.EligibilityRequest#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getRuleset <em>Ruleset</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getOriginalRuleset <em>Original Ruleset</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getCreated <em>Created</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getTarget <em>Target</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getProvider <em>Provider</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getOrganization <em>Organization</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getPriority <em>Priority</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getEnterer <em>Enterer</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getFacility <em>Facility</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getPatient <em>Patient</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getCoverage <em>Coverage</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getBusinessArrangement <em>Business Arrangement</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getRelationship <em>Relationship</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getServicedDate <em>Serviced Date</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getServicedPeriod <em>Serviced Period</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getBenefitCategory <em>Benefit Category</em>}</li>
* <li>{@link org.hl7.fhir.EligibilityRequest#getBenefitSubCategory <em>Benefit Sub Category</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest()
* @model extendedMetaData="name='EligibilityRequest' kind='elementOnly'"
* @generated
*/
public interface EligibilityRequest 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#getEligibilityRequest_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* 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#getEligibilityRequest_Ruleset()
* @model containment="true"
* extendedMetaData="kind='element' name='ruleset' namespace='##targetNamespace'"
* @generated
*/
Coding getRuleset();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#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#getEligibilityRequest_OriginalRuleset()
* @model containment="true"
* extendedMetaData="kind='element' name='originalRuleset' namespace='##targetNamespace'"
* @generated
*/
Coding getOriginalRuleset();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#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 this resource was created.
* <!-- end-model-doc -->
* @return the value of the '<em>Created</em>' containment reference.
* @see #setCreated(DateTime)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Created()
* @model containment="true"
* extendedMetaData="kind='element' name='created' namespace='##targetNamespace'"
* @generated
*/
DateTime getCreated();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#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>Target</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The Insurer who is target of the request.
* <!-- end-model-doc -->
* @return the value of the '<em>Target</em>' containment reference.
* @see #setTarget(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Target()
* @model containment="true"
* extendedMetaData="kind='element' name='target' namespace='##targetNamespace'"
* @generated
*/
Reference getTarget();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getTarget <em>Target</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Target</em>' containment reference.
* @see #getTarget()
* @generated
*/
void setTarget(Reference value);
/**
* Returns the value of the '<em><b>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>Provider</em>' containment reference.
* @see #setProvider(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Provider()
* @model containment="true"
* extendedMetaData="kind='element' name='provider' namespace='##targetNamespace'"
* @generated
*/
Reference getProvider();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getProvider <em>Provider</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Provider</em>' containment reference.
* @see #getProvider()
* @generated
*/
void setProvider(Reference value);
/**
* Returns the value of the '<em><b>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>Organization</em>' containment reference.
* @see #setOrganization(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Organization()
* @model containment="true"
* extendedMetaData="kind='element' name='organization' namespace='##targetNamespace'"
* @generated
*/
Reference getOrganization();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#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>Priority</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Immediate (STAT), best effort (NORMAL), deferred (DEFER).
* <!-- end-model-doc -->
* @return the value of the '<em>Priority</em>' containment reference.
* @see #setPriority(Coding)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Priority()
* @model containment="true"
* extendedMetaData="kind='element' name='priority' namespace='##targetNamespace'"
* @generated
*/
Coding getPriority();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getPriority <em>Priority</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Priority</em>' containment reference.
* @see #getPriority()
* @generated
*/
void setPriority(Coding value);
/**
* Returns the value of the '<em><b>Enterer</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Person who created the invoice/claim/pre-determination or pre-authorization.
* <!-- end-model-doc -->
* @return the value of the '<em>Enterer</em>' containment reference.
* @see #setEnterer(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Enterer()
* @model containment="true"
* extendedMetaData="kind='element' name='enterer' namespace='##targetNamespace'"
* @generated
*/
Reference getEnterer();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getEnterer <em>Enterer</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Enterer</em>' containment reference.
* @see #getEnterer()
* @generated
*/
void setEnterer(Reference value);
/**
* Returns the value of the '<em><b>Facility</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Facility where the services were provided.
* <!-- end-model-doc -->
* @return the value of the '<em>Facility</em>' containment reference.
* @see #setFacility(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Facility()
* @model containment="true"
* extendedMetaData="kind='element' name='facility' namespace='##targetNamespace'"
* @generated
*/
Reference getFacility();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getFacility <em>Facility</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Facility</em>' containment reference.
* @see #getFacility()
* @generated
*/
void setFacility(Reference value);
/**
* Returns the value of the '<em><b>Patient</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Patient Resource.
* <!-- end-model-doc -->
* @return the value of the '<em>Patient</em>' containment reference.
* @see #setPatient(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Patient()
* @model containment="true"
* extendedMetaData="kind='element' name='patient' namespace='##targetNamespace'"
* @generated
*/
Reference getPatient();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getPatient <em>Patient</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Patient</em>' containment reference.
* @see #getPatient()
* @generated
*/
void setPatient(Reference value);
/**
* Returns the value of the '<em><b>Coverage</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Financial instrument by which payment information for health care.
* <!-- end-model-doc -->
* @return the value of the '<em>Coverage</em>' containment reference.
* @see #setCoverage(Reference)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Coverage()
* @model containment="true"
* extendedMetaData="kind='element' name='coverage' namespace='##targetNamespace'"
* @generated
*/
Reference getCoverage();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getCoverage <em>Coverage</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Coverage</em>' containment reference.
* @see #getCoverage()
* @generated
*/
void setCoverage(Reference value);
/**
* Returns the value of the '<em><b>Business Arrangement</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The contract number of a business agreement which describes the terms and conditions.
* <!-- end-model-doc -->
* @return the value of the '<em>Business Arrangement</em>' containment reference.
* @see #setBusinessArrangement(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_BusinessArrangement()
* @model containment="true"
* extendedMetaData="kind='element' name='businessArrangement' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getBusinessArrangement();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getBusinessArrangement <em>Business Arrangement</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Business Arrangement</em>' containment reference.
* @see #getBusinessArrangement()
* @generated
*/
void setBusinessArrangement(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Relationship</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The relationship of the patient to the subscriber.
* <!-- end-model-doc -->
* @return the value of the '<em>Relationship</em>' containment reference.
* @see #setRelationship(Coding)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_Relationship()
* @model containment="true"
* extendedMetaData="kind='element' name='relationship' namespace='##targetNamespace'"
* @generated
*/
Coding getRelationship();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getRelationship <em>Relationship</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Relationship</em>' containment reference.
* @see #getRelationship()
* @generated
*/
void setRelationship(Coding value);
/**
* Returns the value of the '<em><b>Serviced Date</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Serviced Date</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Serviced Date</em>' containment reference.
* @see #setServicedDate(Date)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_ServicedDate()
* @model containment="true"
* extendedMetaData="kind='element' name='servicedDate' namespace='##targetNamespace'"
* @generated
*/
Date getServicedDate();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getServicedDate <em>Serviced Date</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Serviced Date</em>' containment reference.
* @see #getServicedDate()
* @generated
*/
void setServicedDate(Date value);
/**
* Returns the value of the '<em><b>Serviced Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Serviced Period</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Serviced Period</em>' containment reference.
* @see #setServicedPeriod(Period)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_ServicedPeriod()
* @model containment="true"
* extendedMetaData="kind='element' name='servicedPeriod' namespace='##targetNamespace'"
* @generated
*/
Period getServicedPeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getServicedPeriod <em>Serviced Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Serviced Period</em>' containment reference.
* @see #getServicedPeriod()
* @generated
*/
void setServicedPeriod(Period value);
/**
* Returns the value of the '<em><b>Benefit Category</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Dental, Vision, Medical, Pharmacy, Rehab etc.
* <!-- end-model-doc -->
* @return the value of the '<em>Benefit Category</em>' containment reference.
* @see #setBenefitCategory(Coding)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_BenefitCategory()
* @model containment="true"
* extendedMetaData="kind='element' name='benefitCategory' namespace='##targetNamespace'"
* @generated
*/
Coding getBenefitCategory();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getBenefitCategory <em>Benefit Category</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Benefit Category</em>' containment reference.
* @see #getBenefitCategory()
* @generated
*/
void setBenefitCategory(Coding value);
/**
* Returns the value of the '<em><b>Benefit Sub Category</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
* <!-- end-model-doc -->
* @return the value of the '<em>Benefit Sub Category</em>' containment reference.
* @see #setBenefitSubCategory(Coding)
* @see org.hl7.fhir.FhirPackage#getEligibilityRequest_BenefitSubCategory()
* @model containment="true"
* extendedMetaData="kind='element' name='benefitSubCategory' namespace='##targetNamespace'"
* @generated
*/
Coding getBenefitSubCategory();
/**
* Sets the value of the '{@link org.hl7.fhir.EligibilityRequest#getBenefitSubCategory <em>Benefit Sub Category</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Benefit Sub Category</em>' containment reference.
* @see #getBenefitSubCategory()
* @generated
*/
void setBenefitSubCategory(Coding value);
} // EligibilityRequest