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. Includes both insurance and self-payment.
See Also:
  • Field Details

    • identifier

      A unique identifier assigned to this coverage.
    • status

      The status of the resource instance.
    • 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

      The party who 'owns' the insurance policy.
    • policyHolderTarget

      The actual object that is the target of the reference (The party who 'owns' the insurance policy.)
    • 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

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

      The insurer assigned ID for the Subscriber.
    • beneficiary

      The party who benefits from the insurance coverage; the patient when products and/or services are provided.
    • beneficiaryTarget

      The actual object that is the target of the reference (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
    • dependent

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

      The relationship of beneficiary (patient) to the subscriber.
    • 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.
    • 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.)
    • class_

      A suite of underwriter specific classifiers.
    • order

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

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

      When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
    • contract

      protected List<Reference> contract
      The policy(s) which constitute this insurance coverage.
    • 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:
    • 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_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:
    • 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".
    • SP_SUBSCRIBER

      public static final String SP_SUBSCRIBER
      Search parameter: subscriber

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

      See Also:
    • 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_BENEFICIARY

      public static final String SP_BENEFICIARY
      Search parameter: beneficiary

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

      See Also:
    • 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_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Retrieve coverages for a patient
      Type: reference
      Path: Coverage.beneficiary

      See Also:
    • PATIENT

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

      Description: Retrieve coverages for a patient
      Type: reference
      Path: Coverage.beneficiary

    • INCLUDE_PATIENT

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

      public static final String SP_CLASS_VALUE
      Search parameter: class-value

      Description: Value of the class (eg. Plan number, group number)
      Type: string
      Path: Coverage.class.value

      See Also:
    • CLASS_VALUE

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

      Description: Value of the class (eg. Plan number, group number)
      Type: string
      Path: Coverage.class.value

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

    • SP_DEPENDENT

      public static final String SP_DEPENDENT
      Search parameter: dependent

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

      See Also:
    • 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_CLASS_TYPE

      public static final String SP_CLASS_TYPE
      Search parameter: class-type

      Description: Coverage class (eg. plan, group)
      Type: token
      Path: Coverage.class.type

      See Also:
    • CLASS_TYPE

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

      Description: Coverage class (eg. plan, group)
      Type: token
      Path: Coverage.class.type

    • SP_POLICY_HOLDER

      public static final String SP_POLICY_HOLDER
      Search parameter: policy-holder

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

      See Also:
    • 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".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of the Coverage
      Type: token
      Path: Coverage.status

      See Also:
    • STATUS

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

      Description: The status of the Coverage
      Type: token
      Path: Coverage.status

  • Constructor Details

  • Method Details

    • getIdentifier

      Returns:
      identifier (A unique identifier assigned to this coverage.)
    • setIdentifier

      public Coverage setIdentifier(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining
    • hasIdentifier

      public boolean hasIdentifier()
    • addIdentifier

    • addIdentifier

    • getIdentifierFirstRep

      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist
    • getStatusElement

      Returns:
      status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
    • hasStatusElement

      public boolean hasStatusElement()
    • hasStatus

      public boolean hasStatus()
    • setStatusElement

      Parameters:
      value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
    • getStatus

      Returns:
      The status of the resource instance.
    • setStatus

      Parameters:
      value - The status of the resource instance.
    • 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

      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

      Returns:
      policyHolder (The party who 'owns' the insurance policy.)
    • hasPolicyHolder

      public boolean hasPolicyHolder()
    • setPolicyHolder

      Parameters:
      value - policyHolder (The party who 'owns' the insurance policy.)
    • 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.)
    • setPolicyHolderTarget

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

      public boolean hasSubscriber()
    • setSubscriber

      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

      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

      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

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

      public boolean hasSubscriberIdElement()
    • hasSubscriberId

      public boolean hasSubscriberId()
    • setSubscriberIdElement

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

      Returns:
      The insurer assigned ID for the Subscriber.
    • setSubscriberId

      Parameters:
      value - The insurer assigned ID for the Subscriber.
    • getBeneficiary

      Returns:
      beneficiary (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
    • hasBeneficiary

      public boolean hasBeneficiary()
    • setBeneficiary

      Parameters:
      value - beneficiary (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
    • 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 products and/or services are provided.)
    • setBeneficiaryTarget

      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 products and/or services are provided.)
    • 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
    • hasDependentElement

      public boolean hasDependentElement()
    • hasDependent

      public boolean hasDependent()
    • setDependentElement

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

      Returns:
      relationship (The relationship of beneficiary (patient) to the subscriber.)
    • hasRelationship

      public boolean hasRelationship()
    • setRelationship

      Parameters:
      value - relationship (The relationship of beneficiary (patient) to the subscriber.)
    • 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.)
    • hasPeriod

      public boolean hasPeriod()
    • 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<Reference> getPayor()
      Returns:
      payor (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)
    • setPayor

      public Coverage setPayor(List<Reference> thePayor)
      Returns:
      Returns a reference to this for easy method chaining
    • hasPayor

      public boolean hasPayor()
    • addPayor

      public Reference addPayor()
    • addPayor

    • getPayorFirstRep

      Returns:
      The first repetition of repeating field payor, creating it if it does not already exist
    • getPayorTarget

      Deprecated.
      Use Reference#setResource(IBaseResource) instead
    • getClass_

      Returns:
      class_ (A suite of underwriter specific classifiers.)
    • setClass_

      Returns:
      Returns a reference to this for easy method chaining
    • hasClass_

      public boolean hasClass_()
    • addClass_

    • addClass_

    • getClass_FirstRep

      Returns:
      The first repetition of repeating field class_, creating it if it does not already exist
    • getOrderElement

      Returns:
      order (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.). This is the underlying object with id, value and extensions. The accessor "getOrder" gives direct access to the value
    • hasOrderElement

      public boolean hasOrderElement()
    • hasOrder

      public boolean hasOrder()
    • setOrderElement

      Parameters:
      value - order (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.). 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 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.
    • setOrder

      public Coverage setOrder(int value)
      Parameters:
      value - 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.
    • 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
    • hasNetworkElement

      public boolean hasNetworkElement()
    • hasNetwork

      public boolean hasNetwork()
    • setNetworkElement

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

      Returns:
      costToBeneficiary (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.)
    • setCostToBeneficiary

      Returns:
      Returns a reference to this for easy method chaining
    • hasCostToBeneficiary

      public boolean hasCostToBeneficiary()
    • addCostToBeneficiary

    • addCostToBeneficiary

    • getCostToBeneficiaryFirstRep

      Returns:
      The first repetition of repeating field costToBeneficiary, creating it if it does not already exist
    • getSubrogationElement

      Returns:
      subrogation (When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.). This is the underlying object with id, value and extensions. The accessor "getSubrogation" gives direct access to the value
    • hasSubrogationElement

      public boolean hasSubrogationElement()
    • hasSubrogation

      public boolean hasSubrogation()
    • setSubrogationElement

      Parameters:
      value - subrogation (When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.). This is the underlying object with id, value and extensions. The accessor "getSubrogation" gives direct access to the value
    • getSubrogation

      public boolean getSubrogation()
      Returns:
      When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
    • setSubrogation

      public Coverage setSubrogation(boolean value)
      Parameters:
      value - When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
    • getContract

      Returns:
      contract (The policy(s) which constitute this insurance coverage.)
    • setContract

      public Coverage setContract(List<Reference> theContract)
      Returns:
      Returns a reference to this for easy method chaining
    • hasContract

      public boolean hasContract()
    • addContract

    • addContract

    • getContractFirstRep

      Returns:
      The first repetition of repeating field contract, creating it if it does not already exist
    • getContractTarget

      Deprecated.
      Use Reference#setResource(IBaseResource) instead
    • addContractTarget

      Deprecated.
      Use Reference#setResource(IBaseResource) instead
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • 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
    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource
    • copy

      public Coverage copy()
      Specified by:
      copy in class DomainResource
    • copyValues

      public void copyValues(Coverage dst)
    • typedCopy

      protected Coverage typedCopy()
    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class DomainResource
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class DomainResource
    • isEmpty

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

      Specified by:
      getResourceType in class Resource