Coverage (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

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

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Type`	`beneficiary` The party who benefits from the insurance coverage.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`BENEFICIARYIDENTIFIER` Fluent Client search parameter constant for beneficiaryidentifier
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`BENEFICIARYREFERENCE` Fluent Client search parameter constant for beneficiaryreference
`protected StringType`	`bin` Business Identification Number (BIN number) used to identify the routing of eClaims.
`protected List<Reference>`	`contract` The policy(s) which constitute this insurance coverage.
`protected List<Contract>`	`contractTarget` The actual objects that are the target of the reference (The policy(s) which constitute this insurance coverage.)
`protected PositiveIntType`	`dependent` A unique identifier for a dependent under the coverage.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`DEPENDENT` Fluent Client search parameter constant for dependent
`protected List<Coding>`	`exception` Factors which may influence the applicability of coverage.
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`GROUP` Fluent Client search parameter constant for group
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_BENEFICIARYREFERENCE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ISSUERREFERENCE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PLANHOLDERREFERENCE` Constant for fluent queries to be used to add include statements.
`protected Type`	`issuer` The program or plan underwriter or payor.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ISSUERIDENTIFIER` Fluent Client search parameter constant for issueridentifier
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ISSUERREFERENCE` Fluent Client search parameter constant for issuerreference
`protected StringType`	`network` The identifier for a community of providers.
`protected Period`	`period` Time period during which the coverage is in force.
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PLAN` Fluent Client search parameter constant for plan
`protected Type`	`planholder` The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PLANHOLDERIDENTIFIER` Fluent Client search parameter constant for planholderidentifier
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PLANHOLDERREFERENCE` Fluent Client search parameter constant for planholderreference
`protected Coding`	`relationship` The relationship of the patient to the planholdersubscriber).
`protected StringType`	`school` Name of school for over-aged dependants.
`protected PositiveIntType`	`sequence` An optional counter for a particular instance of the identified coverage which increments upon each renewal.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SEQUENCE` Fluent Client search parameter constant for sequence
`static String`	`SP_BENEFICIARYIDENTIFIER` Search parameter: beneficiaryidentifier
`static String`	`SP_BENEFICIARYREFERENCE` Search parameter: beneficiaryreference
`static String`	`SP_DEPENDENT` Search parameter: dependent
`static String`	`SP_GROUP` Search parameter: group
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_ISSUERIDENTIFIER` Search parameter: issueridentifier
`static String`	`SP_ISSUERREFERENCE` Search parameter: issuerreference
`static String`	`SP_PLAN` Search parameter: plan
`static String`	`SP_PLANHOLDERIDENTIFIER` Search parameter: planholderidentifier
`static String`	`SP_PLANHOLDERREFERENCE` Search parameter: planholderreference
`static String`	`SP_SEQUENCE` Search parameter: sequence
`static String`	`SP_SUBPLAN` Search parameter: subplan
`static String`	`SP_TYPE` Search parameter: type
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SUBPLAN` Fluent Client search parameter constant for subplan
`protected Coding`	`type` The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Coverage()
Constructor

Coverage(Type issuer, Type planholder, Type beneficiary, Coding relationship)
Constructor

Constructors
Constructor and Description
`Coverage()` Constructor
`Coverage(Type issuer, Type planholder, Type beneficiary, Coding relationship)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Reference`	`addContract()`
`Coverage`	`addContract(Reference t)`
`Contract`	`addContractTarget()`
`Coding`	`addException()`
`Coverage`	`addException(Coding t)`
`Identifier`	`addIdentifier()`
`Coverage`	`addIdentifier(Identifier t)`
`Coverage`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Type`	`getBeneficiary()`
`Identifier`	`getBeneficiaryIdentifier()`
`Reference`	`getBeneficiaryReference()`
`String`	`getBin()`
`StringType`	`getBinElement()`
`List<Reference>`	`getContract()`
`List<Contract>`	`getContractTarget()`
`int`	`getDependent()`
`PositiveIntType`	`getDependentElement()`
`List<Coding>`	`getException()`
`String`	`getGroup()`
`StringType`	`getGroupElement()`
`List<Identifier>`	`getIdentifier()`
`Type`	`getIssuer()`
`Identifier`	`getIssuerIdentifier()`
`Reference`	`getIssuerReference()`
`String`	`getNetwork()`
`StringType`	`getNetworkElement()`
`Period`	`getPeriod()`
`String`	`getPlan()`
`StringType`	`getPlanElement()`
`Type`	`getPlanholder()`
`Identifier`	`getPlanholderIdentifier()`
`Reference`	`getPlanholderReference()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Coding`	`getRelationship()`
`ResourceType`	`getResourceType()`
`String`	`getSchool()`
`StringType`	`getSchoolElement()`
`int`	`getSequence()`
`PositiveIntType`	`getSequenceElement()`
`String`	`getSubPlan()`
`StringType`	`getSubPlanElement()`
`Coding`	`getType()`
`boolean`	`hasBeneficiary()`
`boolean`	`hasBeneficiaryIdentifier()`
`boolean`	`hasBeneficiaryReference()`
`boolean`	`hasBin()`
`boolean`	`hasBinElement()`
`boolean`	`hasContract()`
`boolean`	`hasDependent()`
`boolean`	`hasDependentElement()`
`boolean`	`hasException()`
`boolean`	`hasGroup()`
`boolean`	`hasGroupElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasIssuer()`
`boolean`	`hasIssuerIdentifier()`
`boolean`	`hasIssuerReference()`
`boolean`	`hasNetwork()`
`boolean`	`hasNetworkElement()`
`boolean`	`hasPeriod()`
`boolean`	`hasPlan()`
`boolean`	`hasPlanElement()`
`boolean`	`hasPlanholder()`
`boolean`	`hasPlanholderIdentifier()`
`boolean`	`hasPlanholderReference()`
`boolean`	`hasRelationship()`
`boolean`	`hasSchool()`
`boolean`	`hasSchoolElement()`
`boolean`	`hasSequence()`
`boolean`	`hasSequenceElement()`
`boolean`	`hasSubPlan()`
`boolean`	`hasSubPlanElement()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Coverage`	`setBeneficiary(Type value)`
`Coverage`	`setBin(String value)`
`Coverage`	`setBinElement(StringType value)`
`Coverage`	`setDependent(int value)`
`Coverage`	`setDependentElement(PositiveIntType value)`
`Coverage`	`setGroup(String value)`
`Coverage`	`setGroupElement(StringType value)`
`Coverage`	`setIssuer(Type value)`
`Coverage`	`setNetwork(String value)`
`Coverage`	`setNetworkElement(StringType value)`
`Coverage`	`setPeriod(Period value)`
`Coverage`	`setPlan(String value)`
`Coverage`	`setPlanElement(StringType value)`
`Coverage`	`setPlanholder(Type value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Coverage`	`setRelationship(Coding value)`
`Coverage`	`setSchool(String value)`
`Coverage`	`setSchoolElement(StringType value)`
`Coverage`	`setSequence(int value)`
`Coverage`	`setSequenceElement(PositiveIntType value)`
`Coverage`	`setSubPlan(String value)`
`Coverage`	`setSubPlanElement(StringType value)`
`Coverage`	`setType(Coding value)`
`protected Coverage`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- 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.
  - 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.
  - exception
```
protected List<Coding> exception
```
    Factors which may influence the applicability of coverage.
  - school
```
protected StringType school
```
    Name of school for over-aged dependants.
  - network
```
protected StringType 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_DEPENDENT
```
public static final String SP_DEPENDENT
```
    Search parameter: dependent
    Description: Dependent number
    Type: token
    Path: Coverage.dependent
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_BENEFICIARYREFERENCE
```
public static final String SP_BENEFICIARYREFERENCE
```
    Search parameter: beneficiaryreference
    Description: Covered party
    Type: reference
    Path: Coverage.beneficiaryReference
    
    See Also:
    
    Constant Field Values
  - 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".
  - SP_PLANHOLDERIDENTIFIER
```
public static final String SP_PLANHOLDERIDENTIFIER
```
    Search parameter: planholderidentifier
    Description: Reference to the planholder
    Type: token
    Path: Coverage.planholderIdentifier
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_ISSUERIDENTIFIER
```
public static final String SP_ISSUERIDENTIFIER
```
    Search parameter: issueridentifier
    Description: The identity of the insurer
    Type: token
    Path: Coverage.issuerIdentifier
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_SUBPLAN
```
public static final String SP_SUBPLAN
```
    Search parameter: subplan
    Description: Sub-plan identifier
    Type: token
    Path: Coverage.subPlan
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_ISSUERREFERENCE
```
public static final String SP_ISSUERREFERENCE
```
    Search parameter: issuerreference
    Description: The identity of the insurer
    Type: reference
    Path: Coverage.issuerReference
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_SEQUENCE
```
public static final String SP_SEQUENCE
```
    Search parameter: sequence
    Description: Sequence number
    Type: token
    Path: Coverage.sequence
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_BENEFICIARYIDENTIFIER
```
public static final String SP_BENEFICIARYIDENTIFIER
```
    Search parameter: beneficiaryidentifier
    Description: Covered party
    Type: token
    Path: Coverage.beneficiaryIdentifier
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_GROUP
```
public static final String SP_GROUP
```
    Search parameter: group
    Description: Group identifier
    Type: token
    Path: Coverage.group
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_PLANHOLDERREFERENCE
```
public static final String SP_PLANHOLDERREFERENCE
```
    Search parameter: planholderreference
    Description: Reference to the planholder
    Type: reference
    Path: Coverage.planholderReference
    
    See Also:
    
    Constant Field Values
  - 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
- Constructor Detail
  - Coverage
```
public Coverage()
```
    Constructor
  - Coverage
```
public Coverage(Type issuer,
                Type planholder,
                Type beneficiary,
                Coding relationship)
```
    Constructor
- 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
  - hasIssuerIdentifier
```
public boolean hasIssuerIdentifier()
```
  - 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
  - hasIssuerReference
```
public boolean hasIssuerReference()
```
  - hasIssuer
```
public boolean hasIssuer()
```
  - setIssuer
```
public Coverage setIssuer(Type value)
```
    Parameters:
    
    value - issuer (The program or plan underwriter or payor.)
  - 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
  - hasBinElement
```
public boolean hasBinElement()
```
  - 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.)
  - 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.)
  - 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
  - hasPlanholderIdentifier
```
public boolean hasPlanholderIdentifier()
```
  - 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
  - hasPlanholderReference
```
public boolean hasPlanholderReference()
```
  - hasPlanholder
```
public boolean hasPlanholder()
```
  - 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.)
  - getBeneficiary
```
public Type getBeneficiary()
```
    Returns:
    
    beneficiary (The party who benefits from the insurance coverage.)
  - 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
  - hasBeneficiaryIdentifier
```
public boolean hasBeneficiaryIdentifier()
```
  - 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
  - hasBeneficiaryReference
```
public boolean hasBeneficiaryReference()
```
  - hasBeneficiary
```
public boolean hasBeneficiary()
```
  - setBeneficiary
```
public Coverage setBeneficiary(Type value)
```
    Parameters:
    
    value - beneficiary (The party who benefits from the insurance coverage.)
  - getRelationship
```
public Coding getRelationship()
```
    Returns:
    
    relationship (The relationship of the patient to the planholdersubscriber).)
  - hasRelationship
```
public boolean hasRelationship()
```
  - setRelationship
```
public Coverage setRelationship(Coding value)
```
    Parameters:
    
    value - relationship (The relationship of the patient to the planholdersubscriber).)
  - 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.
  - getException
```
public List<Coding> getException()
```
    Returns:
    
    exception (Factors which may influence the applicability of coverage.)
  - hasException
```
public boolean hasException()
```
  - addException
```
public Coding addException()
```
    Returns:
    
    exception (Factors which may influence the applicability of coverage.)
  - addException
```
public Coverage addException(Coding t)
```
  - 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
  - hasSchoolElement
```
public boolean hasSchoolElement()
```
  - hasSchool
```
public boolean hasSchool()
```
  - 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
  - hasNetworkElement
```
public boolean hasNetworkElement()
```
  - hasNetwork
```
public boolean hasNetwork()
```
  - 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.
  - 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
  - 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 void 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 void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty 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
  - 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()
```
    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

Class Coverage

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

issuer

bin

period

type

planholder

beneficiary

relationship

identifier

group

plan

subPlan

dependent

sequence

exception

school

network

contract

contractTarget

SP_DEPENDENT

DEPENDENT

SP_BENEFICIARYREFERENCE

BENEFICIARYREFERENCE

INCLUDE_BENEFICIARYREFERENCE

SP_PLANHOLDERIDENTIFIER

PLANHOLDERIDENTIFIER

SP_TYPE

TYPE

SP_ISSUERIDENTIFIER

ISSUERIDENTIFIER

SP_SUBPLAN

SUBPLAN

SP_ISSUERREFERENCE

ISSUERREFERENCE

INCLUDE_ISSUERREFERENCE

SP_PLAN

PLAN

SP_SEQUENCE

SEQUENCE

SP_BENEFICIARYIDENTIFIER

BENEFICIARYIDENTIFIER

SP_GROUP

GROUP

SP_PLANHOLDERREFERENCE

PLANHOLDERREFERENCE

INCLUDE_PLANHOLDERREFERENCE

SP_IDENTIFIER

IDENTIFIER

Constructor Detail

Coverage

Coverage

Method Detail

getIssuer

getIssuerIdentifier

hasIssuerIdentifier

getIssuerReference

hasIssuerReference

hasIssuer

setIssuer

getBinElement

hasBinElement

hasBin

setBinElement

getBin