Package org.hl7.fhir.dstu2.model

Class Coverage

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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:

  • Field Details

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

    • subscriberId

      protected Identifier subscriberId
      The id issued to the subscriber.

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

    • dependent

      protected PositiveIntType dependent
      A unique identifier for a dependent under the coverage.

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

    • network

      protected Identifier network
      The identifier for a community of providers.

    • contract

      protected List<Reference> contract
      The policy(s) which constitute this insurance coverage.

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

    • SP_SEQUENCE

      public static final String SP_SEQUENCE
      See Also:

    • SP_SUBPLAN

      public static final String SP_SUBPLAN
      See Also:

    • SP_TYPE

      public static final String SP_TYPE
      See Also:

    • SP_PLAN

      public static final String SP_PLAN
      See Also:

    • SP_DEPENDENT

      public static final String SP_DEPENDENT
      See Also:

    • SP_ISSUER

      public static final String SP_ISSUER
      See Also:

    • SP_GROUP

      public static final String SP_GROUP
      See Also:

  • Constructor Details

  • Method Details

    • getIssuer

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

    • hasIssuer

      public boolean hasIssuer()

    • setIssuer

      public Coverage setIssuer(Reference value)
      Parameters:
      value - issuer (The program or plan underwriter or payor.)

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

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

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

    • getSubscriberId

      public Identifier getSubscriberId()
      Returns:
      subscriberId (The id issued to the subscriber.)

    • hasSubscriberId

      public boolean hasSubscriberId()

    • setSubscriberId

      public Coverage setSubscriberId(Identifier value)
      Parameters:
      value - subscriberId (The id issued to the subscriber.)

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

    • hasIdentifier

      public boolean hasIdentifier()

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

    • addIdentifier

      public Coverage addIdentifier(Identifier t)

    • 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

    • hasGroupElement

      public boolean hasGroupElement()

    • hasGroup

      public boolean hasGroup()

    • 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

    • hasPlanElement

      public boolean hasPlanElement()

    • 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

    • hasSubPlanElement

      public boolean hasSubPlanElement()

    • hasSubPlan

      public boolean hasSubPlan()

    • 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

    • hasDependentElement

      public boolean hasDependentElement()

    • hasDependent

      public boolean hasDependent()

    • 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

    • hasSequenceElement

      public boolean hasSequenceElement()

    • hasSequence

      public boolean hasSequence()

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

    • hasSubscriber

      public boolean hasSubscriber()

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

    • getNetwork

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

    • hasNetwork

      public boolean hasNetwork()

    • setNetwork

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

    • getContract

      public List<Reference> getContract()
      Returns:
      contract (The policy(s) which constitute this insurance coverage.)

    • hasContract

      public boolean hasContract()

    • addContract

      public Reference addContract()
      Returns:
      contract (The policy(s) which constitute this insurance coverage.)

    • addContract

      public Coverage addContract(Reference t)

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

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty 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

    • 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

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource