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 reimburse or pay for health care products and services.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
      • type

        protected CodeableConcept type
        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
      • policyHolder

        protected Reference policyHolder
        The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
      • policyHolderTarget

        protected Resource policyHolderTarget
        The actual object that is the target of the reference (The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.)
      • subscriber

        protected Reference subscriber
        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.
      • subscriberTarget

        protected Resource subscriberTarget
        The actual object that is the target of the reference (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.)
      • beneficiary

        protected Reference beneficiary
        The party who benefits from the insurance coverage., the patient when services are provided.
      • beneficiaryTarget

        protected Patient beneficiaryTarget
        The actual object that is the target of the reference (The party who benefits from the insurance coverage., the patient when services are provided.)
      • 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.
      • payor

        protected List<Reference> payor
        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
      • payorTarget

        protected List<Resource> payorTarget
        The actual objects that are the target of the reference (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).)
      • grouping

        protected Coverage.GroupComponent grouping
        A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
      • dependent

        protected StringType dependent
        A unique identifier for a dependent under the coverage.
      • sequence

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

        protected PositiveIntType order
        The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
      • network

        protected StringType network
        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.
      • contractTarget

        protected List<Contract> contractTarget
        The actual objects that are the target of the reference (The policy(s) which constitute this insurance coverage.)
      • 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

      • SP_SUBGROUP

        public static final String SP_SUBGROUP
        Search parameter: subgroup

        Description: Sub-group identifier
        Type: string
        Path: Coverage.grouping.subGroup

        See Also:
        Constant Field Values
      • SUBGROUP

        public static final ca.uhn.fhir.rest.gclient.StringClientParam SUBGROUP
        Fluent Client search parameter constant for subgroup

        Description: Sub-group identifier
        Type: string
        Path: Coverage.grouping.subGroup

      • SP_SUBSCRIBER

        public static final String SP_SUBSCRIBER
        Search parameter: subscriber

        Description: Reference to the subscriber
        Type: reference
        Path: Coverage.subscriber

        See Also:
        Constant Field Values
      • SUBSCRIBER

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

        Description: Reference to the subscriber
        Type: reference
        Path: Coverage.subscriber

      • INCLUDE_SUBSCRIBER

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

        public static final String SP_SUBPLAN
        Search parameter: subplan

        Description: Sub-plan identifier
        Type: string
        Path: Coverage.grouping.subPlan

        See Also:
        Constant Field Values
      • SUBPLAN

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

        Description: Sub-plan identifier
        Type: string
        Path: Coverage.grouping.subPlan

      • 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

      • SEQUENCE

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

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

      • SP_PAYOR

        public static final String SP_PAYOR
        Search parameter: payor

        Description: The identity of the insurer or party paying for services
        Type: reference
        Path: Coverage.payor

        See Also:
        Constant Field Values
      • PAYOR

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

        Description: The identity of the insurer or party paying for services
        Type: reference
        Path: Coverage.payor

      • INCLUDE_PAYOR

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

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

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

      • INCLUDE_BENEFICIARY

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

        public static final String SP_SUBCLASS
        Search parameter: subclass

        Description: Sub-class identifier
        Type: string
        Path: Coverage.grouping.subClass

        See Also:
        Constant Field Values
      • SUBCLASS

        public static final ca.uhn.fhir.rest.gclient.StringClientParam SUBCLASS
        Fluent Client search parameter constant for subclass

        Description: Sub-class identifier
        Type: string
        Path: Coverage.grouping.subClass

      • SP_PLAN

        public static final String SP_PLAN
        Search parameter: plan

        Description: A plan or policy identifier
        Type: string
        Path: Coverage.grouping.plan

        See Also:
        Constant Field Values
      • PLAN

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

        Description: A plan or policy identifier
        Type: string
        Path: Coverage.grouping.plan

      • SP_CLASS

        public static final String SP_CLASS
        Search parameter: class

        Description: Class identifier
        Type: string
        Path: Coverage.grouping.class

        See Also:
        Constant Field Values
      • CLASS

        public static final ca.uhn.fhir.rest.gclient.StringClientParam CLASS
        Fluent Client search parameter constant for class

        Description: Class identifier
        Type: string
        Path: Coverage.grouping.class

      • DEPENDENT

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

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

      • SP_GROUP

        public static final String SP_GROUP
        Search parameter: group

        Description: Group identifier
        Type: string
        Path: Coverage.grouping.group

        See Also:
        Constant Field Values
      • GROUP

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

        Description: Group identifier
        Type: string
        Path: Coverage.grouping.group

      • POLICY_HOLDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam POLICY_HOLDER
        Fluent Client search parameter constant for policy-holder

        Description: Reference to the policyholder
        Type: reference
        Path: Coverage.policyHolder

      • INCLUDE_POLICY_HOLDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_POLICY_HOLDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:policy-holder".
    • Constructor Detail

      • Coverage

        public Coverage()
        Constructor
    • Method Detail

      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        identifier (The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.)
      • getType

        public CodeableConcept getType()
        Returns:
        type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.)
      • hasType

        public boolean hasType()
      • setType

        public Coverage setType​(CodeableConcept value)
        Parameters:
        value - type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.)
      • getPolicyHolder

        public Reference getPolicyHolder()
        Returns:
        policyHolder (The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.)
      • getPolicyHolderTarget

        public Resource getPolicyHolderTarget()
        Returns:
        policyHolder 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 policy, may be an individual, corporation or the subscriber's employer.)
      • setPolicyHolderTarget

        public Coverage setPolicyHolderTarget​(Resource value)
        Parameters:
        value - policyHolder 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 policy, may be an individual, corporation or the subscriber's employer.)
      • getSubscriber

        public Reference getSubscriber()
        Returns:
        subscriber (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.)
      • setSubscriber

        public Coverage setSubscriber​(Reference value)
        Parameters:
        value - subscriber (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.)
      • getSubscriberTarget

        public Resource 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 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.)
      • setSubscriberTarget

        public Coverage setSubscriberTarget​(Resource 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 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.)
      • getSubscriberIdElement

        public StringType getSubscriberIdElement()
        Returns:
        subscriberId (The insurer assigned ID for the Subscriber.). This is the underlying object with id, value and extensions. The accessor "getSubscriberId" gives direct access to the value
      • setSubscriberIdElement

        public Coverage setSubscriberIdElement​(StringType value)
        Parameters:
        value - subscriberId (The insurer assigned ID for the Subscriber.). This is the underlying object with id, value and extensions. The accessor "getSubscriberId" gives direct access to the value
      • getBeneficiaryTarget

        public Patient getBeneficiaryTarget()
        Returns:
        beneficiary 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 benefits from the insurance coverage., the patient when services are provided.)
      • setBeneficiaryTarget

        public Coverage setBeneficiaryTarget​(Patient value)
        Parameters:
        value - beneficiary 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 benefits from the insurance coverage., the patient when services are provided.)
      • 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.)
      • getPayor

        public List<ReferencegetPayor()
        Returns:
        payor (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).)
      • getPayorFirstRep

        public Reference getPayorFirstRep()
        Returns:
        The first repetition of repeating field payor, creating it if it does not already exist
      • getGrouping

        public Coverage.GroupComponent getGrouping()
        Returns:
        grouping (A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.)
      • getDependentElement

        public StringType 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​(StringType 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 String getDependent()
        Returns:
        A unique identifier for a dependent under the coverage.
      • setDependent

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

        public StringType 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​(StringType 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 String getSequence()
        Returns:
        An optional counter for a particular instance of the identified coverage which increments upon each renewal.
      • setSequence

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

        public PositiveIntType getOrderElement()
        Returns:
        order (The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.). This is the underlying object with id, value and extensions. The accessor "getOrder" gives direct access to the value
      • setOrderElement

        public Coverage setOrderElement​(PositiveIntType value)
        Parameters:
        value - order (The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.). This is the underlying object with id, value and extensions. The accessor "getOrder" gives direct access to the value
      • getOrder

        public int getOrder()
        Returns:
        The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
      • setOrder

        public Coverage setOrder​(int value)
        Parameters:
        value - The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
      • getNetworkElement

        public StringType getNetworkElement()
        Returns:
        network (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.). 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 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.). 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 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.
      • setNetwork

        public Coverage setNetwork​(String value)
        Parameters:
        value - 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.
      • 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
      • isEmpty

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