Package org.hl7.fhir.dstu2016may.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 Type issuer
        The program or plan underwriter or payor.

      • bin

        protected StringType bin
        Business Identification Number (BIN number) used to identify the routing of eClaims.

      • 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.

      • planholder

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

      • beneficiary

        protected Type beneficiary
        The party who benefits from the insurance coverage.

      • relationship

        protected Coding relationship
        The relationship of the patient to the planholdersubscriber).

      • 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.

      • exception

        protected List<Coding> exception
        Factors which may influence the applicability of coverage.

      • contractTarget

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

      • DEPENDENT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam DEPENDENT
        Fluent Client search parameter constant for dependent

        Description: Dependent number
        Type: token
        Path: Coverage.dependent

      • BENEFICIARYREFERENCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BENEFICIARYREFERENCE
        Fluent Client search parameter constant for beneficiaryreference

        Description: Covered party
        Type: reference
        Path: Coverage.beneficiaryReference

      • INCLUDE_BENEFICIARYREFERENCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_BENEFICIARYREFERENCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:beneficiaryreference".

      • PLANHOLDERIDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PLANHOLDERIDENTIFIER
        Fluent Client search parameter constant for planholderidentifier

        Description: Reference to the planholder
        Type: token
        Path: Coverage.planholderIdentifier

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The kind of coverage (health plan, auto, Workers Compensation)
        Type: token
        Path: Coverage.type

        See Also:
        Constant Field Values

      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: The kind of coverage (health plan, auto, Workers Compensation)
        Type: token
        Path: Coverage.type

      • ISSUERIDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ISSUERIDENTIFIER
        Fluent Client search parameter constant for issueridentifier

        Description: The identity of the insurer
        Type: token
        Path: Coverage.issuerIdentifier

      • SUBPLAN

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBPLAN
        Fluent Client search parameter constant for subplan

        Description: Sub-plan identifier
        Type: token
        Path: Coverage.subPlan

      • ISSUERREFERENCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ISSUERREFERENCE
        Fluent Client search parameter constant for issuerreference

        Description: The identity of the insurer
        Type: reference
        Path: Coverage.issuerReference

      • INCLUDE_ISSUERREFERENCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ISSUERREFERENCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:issuerreference".

      • SP_PLAN

        public static final String SP_PLAN
        Search parameter: plan

        Description: A plan or policy identifier
        Type: token
        Path: Coverage.plan

        See Also:
        Constant Field Values

      • PLAN

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PLAN
        Fluent Client search parameter constant for plan

        Description: A plan or policy identifier
        Type: token
        Path: Coverage.plan

      • SEQUENCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SEQUENCE
        Fluent Client search parameter constant for sequence

        Description: Sequence number
        Type: token
        Path: Coverage.sequence

      • BENEFICIARYIDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BENEFICIARYIDENTIFIER
        Fluent Client search parameter constant for beneficiaryidentifier

        Description: Covered party
        Type: token
        Path: Coverage.beneficiaryIdentifier

      • GROUP

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP
        Fluent Client search parameter constant for group

        Description: Group identifier
        Type: token
        Path: Coverage.group

      • PLANHOLDERREFERENCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PLANHOLDERREFERENCE
        Fluent Client search parameter constant for planholderreference

        Description: Reference to the planholder
        Type: reference
        Path: Coverage.planholderReference

      • INCLUDE_PLANHOLDERREFERENCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PLANHOLDERREFERENCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:planholderreference".

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: The primary identifier of the insured and the coverage
        Type: token
        Path: Coverage.identifier

        See Also:
        Constant Field Values

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: The primary identifier of the insured and the coverage
        Type: token
        Path: Coverage.identifier

    • Method Detail

      • getIssuer

        public Type getIssuer()
        Returns:
        issuer (The program or plan underwriter or payor.)

      • getIssuerIdentifier

        public Identifier getIssuerIdentifier()
                               throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        issuer (The program or plan underwriter or payor.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getIssuerReference

        public Reference getIssuerReference()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        issuer (The program or plan underwriter or payor.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getBinElement

        public StringType getBinElement()
        Returns:
        bin (Business Identification Number (BIN number) used to identify the routing of eClaims.). This is the underlying object with id, value and extensions. The accessor "getBin" gives direct access to the value

      • hasBin

        public boolean hasBin()

      • setBinElement

        public Coverage setBinElement​(StringType value)
        Parameters:
        value - bin (Business Identification Number (BIN number) used to identify the routing of eClaims.). This is the underlying object with id, value and extensions. The accessor "getBin" gives direct access to the value

      • getBin

        public String getBin()
        Returns:
        Business Identification Number (BIN number) used to identify the routing of eClaims.

      • setBin

        public Coverage setBin​(String value)
        Parameters:
        value - Business Identification Number (BIN number) used to identify the routing of eClaims.

      • 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.)

      • getPlanholder

        public Type getPlanholder()
        Returns:
        planholder (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)

      • getPlanholderIdentifier

        public Identifier getPlanholderIdentifier()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        planholder (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getPlanholderReference

        public Reference getPlanholderReference()
                                 throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        planholder (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setPlanholder

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

      • getBeneficiaryIdentifier

        public Identifier getBeneficiaryIdentifier()
                                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        beneficiary (The party who benefits from the insurance coverage.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getBeneficiaryReference

        public Reference getBeneficiaryReference()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        beneficiary (The party who benefits from the insurance coverage.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • 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.

      • getSchoolElement

        public StringType getSchoolElement()
        Returns:
        school (Name of school for over-aged dependants.). This is the underlying object with id, value and extensions. The accessor "getSchool" gives direct access to the value

      • setSchoolElement

        public Coverage setSchoolElement​(StringType value)
        Parameters:
        value - school (Name of school for over-aged dependants.). This is the underlying object with id, value and extensions. The accessor "getSchool" gives direct access to the value

      • getSchool

        public String getSchool()
        Returns:
        Name of school for over-aged dependants.

      • setSchool

        public Coverage setSchool​(String value)
        Parameters:
        value - Name of school for over-aged dependants.

      • getNetworkElement

        public StringType getNetworkElement()
        Returns:
        network (The identifier for a community of providers.). This is the underlying object with id, value and extensions. The accessor "getNetwork" gives direct access to the value

      • setNetworkElement

        public Coverage setNetworkElement​(StringType value)
        Parameters:
        value - network (The identifier for a community of providers.). This is the underlying object with id, value and extensions. The accessor "getNetwork" gives direct access to the value

      • getNetwork

        public String getNetwork()
        Returns:
        The identifier for a community of providers.

      • setNetwork

        public Coverage setNetwork​(String value)
        Parameters:
        value - The identifier for a community of providers.

      • 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.)

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

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