Package org.linuxforhealth.fhir.model.resource

Class Coverage

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class Coverage
extends DomainResource
    Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        A unique identifier assigned to this coverage.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getStatus

        public CoverageStatus getStatus()
        The status of the resource instance.
        Returns:
        An immutable object of type CoverageStatus that is non-null.

      • getType

        public CodeableConcept getType()
        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getPolicyHolder

        public Reference getPolicyHolder()
        The party who 'owns' the insurance policy.
        Returns:
        An immutable object of type Reference that may be null.

      • getSubscriber

        public Reference getSubscriber()
        The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
        Returns:
        An immutable object of type Reference that may be null.

      • getSubscriberId

        public String getSubscriberId()
        The insurer assigned ID for the Subscriber.
        Returns:
        An immutable object of type String that may be null.

      • getBeneficiary

        public Reference getBeneficiary()
        The party who benefits from the insurance coverage; the patient when products and/or services are provided.
        Returns:
        An immutable object of type Reference that is non-null.

      • getDependent

        public String getDependent()
        A unique identifier for a dependent under the coverage.
        Returns:
        An immutable object of type String that may be null.

      • getRelationship

        public CodeableConcept getRelationship()
        The relationship of beneficiary (patient) to the subscriber.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getPeriod

        public Period getPeriod()
        Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
        Returns:
        An immutable object of type Period that may be null.

      • getPayor

        public java.util.List<Reference> getPayor()
        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that is non-empty.

      • getClazz

        public java.util.List<Coverage.Class> getClazz()
        A suite of underwriter specific classifiers.
        Returns:
        An unmodifiable list containing immutable objects of type Coverage.Class that may be empty.

      • getOrder

        public PositiveInt getOrder()
        The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
        Returns:
        An immutable object of type PositiveInt that may be null.

      • getNetwork

        public String getNetwork()
        The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
        Returns:
        An immutable object of type String that may be null.

      • getCostToBeneficiary

        public java.util.List<Coverage.CostToBeneficiary> getCostToBeneficiary()
        A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
        Returns:
        An unmodifiable list containing immutable objects of type Coverage.CostToBeneficiary that may be empty.

      • getSubrogation

        public Boolean getSubrogation()
        When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
        Returns:
        An immutable object of type Boolean that may be null.

      • getContract

        public java.util.List<Reference> getContract()
        The policy(s) which constitute this insurance coverage.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object