Package org.hl7.fhir.dstu2.model

Class Coverage

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
    public class Coverage
extends DomainResource
    Financial instrument which may be used to pay for or reimburse health care products and services.
    See Also:
    Serialized Form

    • Field Detail

      • issuer

        protected Reference issuer
        The program or plan underwriter or payor.

      • issuerTarget

        protected Organization issuerTarget
        The actual object that is the target of the reference (The program or plan underwriter or payor.)

      • bin

        protected Identifier bin
        Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.

      • period

        protected Period period
        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.

      • type

        protected Coding type
        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.

      • identifier

        protected List<Identifier> identifier
        The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.

      • group

        protected StringType group
        Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • plan

        protected StringType plan
        Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • subPlan

        protected StringType subPlan
        Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.

      • sequence

        protected PositiveIntType sequence
        An optional counter for a particular instance of the identified coverage which increments upon each renewal.

      • subscriber

        protected Reference subscriber
        The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.

      • subscriberTarget

        protected Patient subscriberTarget
        The actual object that is the target of the reference (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • contractTarget

        protected List<Contract> contractTarget
        The actual objects that are the target of the reference (The policy(s) which constitute this insurance coverage.)

    • Method Detail

      • getIssuerTarget

        public Organization getIssuerTarget()
        Returns:
        issuer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The program or plan underwriter or payor.)

      • setIssuerTarget

        public Coverage setIssuerTarget​(Organization value)
        Parameters:
        value - issuer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The program or plan underwriter or payor.)

      • getBin

        public Identifier getBin()
        Returns:
        bin (Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.)

      • hasBin

        public boolean hasBin()

      • setBin

        public Coverage setBin​(Identifier value)
        Parameters:
        value - bin (Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.)

      • getPeriod

        public Period getPeriod()
        Returns:
        period (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.)

      • setPeriod

        public Coverage setPeriod​(Period value)
        Parameters:
        value - period (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.)

      • getType

        public Coding getType()
        Returns:
        type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.)

      • hasType

        public boolean hasType()

      • setType

        public Coverage setType​(Coding value)
        Parameters:
        value - type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.)

      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        identifier (The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.)

      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.)

      • getGroupElement

        public StringType getGroupElement()
        Returns:
        group (Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.). This is the underlying object with id, value and extensions. The accessor "getGroup" gives direct access to the value

      • setGroupElement

        public Coverage setGroupElement​(StringType value)
        Parameters:
        value - group (Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.). This is the underlying object with id, value and extensions. The accessor "getGroup" gives direct access to the value

      • getGroup

        public String getGroup()
        Returns:
        Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • setGroup

        public Coverage setGroup​(String value)
        Parameters:
        value - Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • getPlanElement

        public StringType getPlanElement()
        Returns:
        plan (Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.). This is the underlying object with id, value and extensions. The accessor "getPlan" gives direct access to the value

      • hasPlan

        public boolean hasPlan()

      • setPlanElement

        public Coverage setPlanElement​(StringType value)
        Parameters:
        value - plan (Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.). This is the underlying object with id, value and extensions. The accessor "getPlan" gives direct access to the value

      • getPlan

        public String getPlan()
        Returns:
        Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • setPlan

        public Coverage setPlan​(String value)
        Parameters:
        value - Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.

      • getSubPlanElement

        public StringType getSubPlanElement()
        Returns:
        subPlan (Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.). This is the underlying object with id, value and extensions. The accessor "getSubPlan" gives direct access to the value

      • setSubPlanElement

        public Coverage setSubPlanElement​(StringType value)
        Parameters:
        value - subPlan (Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.). This is the underlying object with id, value and extensions. The accessor "getSubPlan" gives direct access to the value

      • getSubPlan

        public String getSubPlan()
        Returns:
        Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.

      • setSubPlan

        public Coverage setSubPlan​(String value)
        Parameters:
        value - Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.

      • getDependentElement

        public PositiveIntType getDependentElement()
        Returns:
        dependent (A unique identifier for a dependent under the coverage.). This is the underlying object with id, value and extensions. The accessor "getDependent" gives direct access to the value

      • setDependentElement

        public Coverage setDependentElement​(PositiveIntType value)
        Parameters:
        value - dependent (A unique identifier for a dependent under the coverage.). This is the underlying object with id, value and extensions. The accessor "getDependent" gives direct access to the value

      • getDependent

        public int getDependent()
        Returns:
        A unique identifier for a dependent under the coverage.

      • setDependent

        public Coverage setDependent​(int value)
        Parameters:
        value - A unique identifier for a dependent under the coverage.

      • getSequenceElement

        public PositiveIntType getSequenceElement()
        Returns:
        sequence (An optional counter for a particular instance of the identified coverage which increments upon each renewal.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

      • setSequenceElement

        public Coverage setSequenceElement​(PositiveIntType value)
        Parameters:
        value - sequence (An optional counter for a particular instance of the identified coverage which increments upon each renewal.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

      • getSequence

        public int getSequence()
        Returns:
        An optional counter for a particular instance of the identified coverage which increments upon each renewal.

      • setSequence

        public Coverage setSequence​(int value)
        Parameters:
        value - An optional counter for a particular instance of the identified coverage which increments upon each renewal.

      • getSubscriber

        public Reference getSubscriber()
        Returns:
        subscriber (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • setSubscriber

        public Coverage setSubscriber​(Reference value)
        Parameters:
        value - subscriber (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • getSubscriberTarget

        public Patient getSubscriberTarget()
        Returns:
        subscriber The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • setSubscriberTarget

        public Coverage setSubscriberTarget​(Patient value)
        Parameters:
        value - subscriber The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • getContractTarget

        public List<Contract> getContractTarget()
        Returns:
        contract (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The policy(s) which constitute this insurance coverage.)

      • addContractTarget

        public Contract addContractTarget()
        Returns:
        contract (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The policy(s) which constitute this insurance coverage.)

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource