Coverage (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Coverage

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Coverage
extends BaseResource
implements IResource
```
HAPI/FHIR Coverage Resource ()
Definition: Financial instrument which may be used to pay for or reimburse health care products and services.

Requirements: Health care programs and insurers are significant payors of health service costs

Profile Definition: http://hl7.org/fhir/profiles/Coverage

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`DEPENDENT` Fluent Client search parameter constant for dependent
`static TokenClientParam`	`GROUP` Fluent Client search parameter constant for group
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_ISSUER` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`ISSUER` Fluent Client search parameter constant for issuer
`static TokenClientParam`	`PLAN` Fluent Client search parameter constant for plan
`static TokenClientParam`	`SEQUENCE` Fluent Client search parameter constant for sequence
`static String`	`SP_DEPENDENT` Search parameter constant for dependent
`static String`	`SP_GROUP` Search parameter constant for group
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_ISSUER` Search parameter constant for issuer
`static String`	`SP_PLAN` Search parameter constant for plan
`static String`	`SP_SEQUENCE` Search parameter constant for sequence
`static String`	`SP_SUBPLAN` Search parameter constant for subplan
`static String`	`SP_TYPE` Search parameter constant for type
`static TokenClientParam`	`SUBPLAN` Fluent Client search parameter constant for subplan
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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()

Constructors
Constructor and Description
`Coverage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addContract()` Adds and returns a new value for contract ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`Coverage`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`IdentifierDt`	`getBin()` Gets the value(s) for bin ().
`List<ResourceReferenceDt>`	`getContract()` Gets the value(s) for contract ().
`Integer`	`getDependent()` Gets the value(s) for dependent ().
`PositiveIntDt`	`getDependentElement()` Gets the value(s) for dependent ().
`String`	`getGroup()` Gets the value(s) for group ().
`StringDt`	`getGroupElement()` Gets the value(s) for group ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`ResourceReferenceDt`	`getIssuer()` Gets the value(s) for issuer ().
`IdentifierDt`	`getNetwork()` Gets the value(s) for network ().
`PeriodDt`	`getPeriod()` Gets the value(s) for period ().
`String`	`getPlan()` Gets the value(s) for plan ().
`StringDt`	`getPlanElement()` Gets the value(s) for plan ().
`String`	`getResourceName()`
`Integer`	`getSequence()` Gets the value(s) for sequence ().
`PositiveIntDt`	`getSequenceElement()` Gets the value(s) for sequence ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`String`	`getSubPlan()` Gets the value(s) for subPlan ().
`StringDt`	`getSubPlanElement()` Gets the value(s) for subPlan ().
`ResourceReferenceDt`	`getSubscriber()` Gets the value(s) for subscriber ().
`IdentifierDt`	`getSubscriberId()` Gets the value(s) for subscriberId ().
`CodingDt`	`getType()` Gets the value(s) for type ().
`boolean`	`isEmpty()`
`Coverage`	`setBin(IdentifierDt theValue)` Sets the value(s) for bin ()
`Coverage`	`setContract(List<ResourceReferenceDt> theValue)` Sets the value(s) for contract ()
`Coverage`	`setDependent(int theInteger)` Sets the value for dependent ()
`Coverage`	`setDependent(PositiveIntDt theValue)` Sets the value(s) for dependent ()
`Coverage`	`setGroup(String theString)` Sets the value for group ()
`Coverage`	`setGroup(StringDt theValue)` Sets the value(s) for group ()
`Coverage`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`Coverage`	`setIssuer(ResourceReferenceDt theValue)` Sets the value(s) for issuer ()
`Coverage`	`setNetwork(IdentifierDt theValue)` Sets the value(s) for network ()
`Coverage`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period ()
`Coverage`	`setPlan(String theString)` Sets the value for plan ()
`Coverage`	`setPlan(StringDt theValue)` Sets the value(s) for plan ()
`Coverage`	`setSequence(int theInteger)` Sets the value for sequence ()
`Coverage`	`setSequence(PositiveIntDt theValue)` Sets the value(s) for sequence ()
`Coverage`	`setSubPlan(String theString)` Sets the value for subPlan ()
`Coverage`	`setSubPlan(StringDt theValue)` Sets the value(s) for subPlan ()
`Coverage`	`setSubscriber(ResourceReferenceDt theValue)` Sets the value(s) for subscriber ()
`Coverage`	`setSubscriberId(IdentifierDt theValue)` Sets the value(s) for subscriberId ()
`Coverage`	`setType(CodingDt theValue)` Sets the value(s) for type ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_ISSUER
```
public static final String SP_ISSUER
```
    Search parameter constant for issuer
    Description: The identity of the insurer
    Type: reference
    Path: Coverage.issuer
    
    See Also:
    
    Constant Field Values
  - ISSUER
```
public static final ReferenceClientParam ISSUER
```
    Fluent Client search parameter constant for issuer
    Description: The identity of the insurer
    Type: reference
    Path: Coverage.issuer
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The primary identifier of the insured
    Type: token
    Path: Coverage.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The primary identifier of the insured
    Type: token
    Path: Coverage.identifier
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description: The kind of coverage
    Type: token
    Path: Coverage.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: The kind of coverage
    Type: token
    Path: Coverage.type
  - SP_PLAN
```
public static final String SP_PLAN
```
    Search parameter constant for plan
    Description: A plan or policy identifier
    Type: token
    Path: Coverage.plan
    
    See Also:
    
    Constant Field Values
  - PLAN
```
public static final TokenClientParam PLAN
```
    Fluent Client search parameter constant for plan
    Description: A plan or policy identifier
    Type: token
    Path: Coverage.plan
  - SP_SUBPLAN
```
public static final String SP_SUBPLAN
```
    Search parameter constant for subplan
    Description: Sub-plan identifier
    Type: token
    Path: Coverage.subPlan
    
    See Also:
    
    Constant Field Values
  - SUBPLAN
```
public static final TokenClientParam SUBPLAN
```
    Fluent Client search parameter constant for subplan
    Description: Sub-plan identifier
    Type: token
    Path: Coverage.subPlan
  - SP_GROUP
```
public static final String SP_GROUP
```
    Search parameter constant for group
    Description: Group identifier
    Type: token
    Path: Coverage.group
    
    See Also:
    
    Constant Field Values
  - GROUP
```
public static final TokenClientParam GROUP
```
    Fluent Client search parameter constant for group
    Description: Group identifier
    Type: token
    Path: Coverage.group
  - SP_DEPENDENT
```
public static final String SP_DEPENDENT
```
    Search parameter constant for dependent
    Description: Dependent number
    Type: token
    Path: Coverage.dependent
    
    See Also:
    
    Constant Field Values
  - DEPENDENT
```
public static final TokenClientParam DEPENDENT
```
    Fluent Client search parameter constant for dependent
    Description: Dependent number
    Type: token
    Path: Coverage.dependent
  - SP_SEQUENCE
```
public static final String SP_SEQUENCE
```
    Search parameter constant for sequence
    Description: Sequence number
    Type: token
    Path: Coverage.sequence
    
    See Also:
    
    Constant Field Values
  - SEQUENCE
```
public static final TokenClientParam SEQUENCE
```
    Fluent Client search parameter constant for sequence
    Description: Sequence number
    Type: token
    Path: Coverage.sequence
  - INCLUDE_ISSUER
```
public static final Include INCLUDE_ISSUER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:issuer".
- Constructor Detail
  - Coverage
```
public Coverage()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIssuer
```
public ResourceReferenceDt getIssuer()
```
    Gets the value(s) for issuer (). creating it if it does not exist. Will not return null.
    Definition: The program or plan underwriter or payor.
  - setIssuer
```
public Coverage setIssuer(ResourceReferenceDt theValue)
```
    Sets the value(s) for issuer ()
    Definition: The program or plan underwriter or payor.
  - getBin
```
public IdentifierDt getBin()
```
    Gets the value(s) for bin (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setBin
```
public Coverage setBin(IdentifierDt theValue)
```
    Sets the value(s) for bin ()
    Definition: 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 PeriodDt getPeriod()
```
    Gets the value(s) for period (). creating it if it does not exist. Will not return null.
    Definition: 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(PeriodDt theValue)
```
    Sets the value(s) for period ()
    Definition: 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 CodingDt getType()
```
    Gets the value(s) for type (). creating it if it does not exist. Will not return null.
    Definition: The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
  - setType
```
public Coverage setType(CodingDt theValue)
```
    Sets the value(s) for type ()
    Definition: The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
  - getSubscriberId
```
public IdentifierDt getSubscriberId()
```
    Gets the value(s) for subscriberId (). creating it if it does not exist. Will not return null.
    Definition: The id issued to the subscriber.
  - setSubscriberId
```
public Coverage setSubscriberId(IdentifierDt theValue)
```
    Sets the value(s) for subscriberId ()
    Definition: The id issued to the subscriber.
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setIdentifier
```
public Coverage setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: 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 IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: 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(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: 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.
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.
  - getGroupElement
```
public StringDt getGroupElement()
```
    Gets the value(s) for group (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - getGroup
```
public String getGroup()
```
    Gets the value(s) for group (). creating it if it does not exist. Will not return null.
    Definition: 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(StringDt theValue)
```
    Sets the value(s) for group ()
    Definition: 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 theString)
```
    Sets the value for group ()
    Definition: 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 StringDt getPlanElement()
```
    Gets the value(s) for plan (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - getPlan
```
public String getPlan()
```
    Gets the value(s) for plan (). creating it if it does not exist. Will not return null.
    Definition: 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(StringDt theValue)
```
    Sets the value(s) for plan ()
    Definition: 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 theString)
```
    Sets the value for plan ()
    Definition: 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 StringDt getSubPlanElement()
```
    Gets the value(s) for subPlan (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - getSubPlan
```
public String getSubPlan()
```
    Gets the value(s) for subPlan (). creating it if it does not exist. Will not return null.
    Definition: 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(StringDt theValue)
```
    Sets the value(s) for subPlan ()
    Definition: 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 theString)
```
    Sets the value for subPlan ()
    Definition: 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 PositiveIntDt getDependentElement()
```
    Gets the value(s) for dependent (). creating it if it does not exist. Will not return null.
    Definition: A unique identifier for a dependent under the coverage.
  - getDependent
```
public Integer getDependent()
```
    Gets the value(s) for dependent (). creating it if it does not exist. Will not return null.
    Definition: A unique identifier for a dependent under the coverage.
  - setDependent
```
public Coverage setDependent(PositiveIntDt theValue)
```
    Sets the value(s) for dependent ()
    Definition: A unique identifier for a dependent under the coverage.
  - setDependent
```
public Coverage setDependent(int theInteger)
```
    Sets the value for dependent ()
    Definition: A unique identifier for a dependent under the coverage.
  - getSequenceElement
```
public PositiveIntDt getSequenceElement()
```
    Gets the value(s) for sequence (). creating it if it does not exist. Will not return null.
    Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.
  - getSequence
```
public Integer getSequence()
```
    Gets the value(s) for sequence (). creating it if it does not exist. Will not return null.
    Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.
  - setSequence
```
public Coverage setSequence(PositiveIntDt theValue)
```
    Sets the value(s) for sequence ()
    Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.
  - setSequence
```
public Coverage setSequence(int theInteger)
```
    Sets the value for sequence ()
    Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.
  - getSubscriber
```
public ResourceReferenceDt getSubscriber()
```
    Gets the value(s) for subscriber (). creating it if it does not exist. Will not return null.
    Definition: The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.
  - setSubscriber
```
public Coverage setSubscriber(ResourceReferenceDt theValue)
```
    Sets the value(s) for subscriber ()
    Definition: The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.
  - getNetwork
```
public IdentifierDt getNetwork()
```
    Gets the value(s) for network (). creating it if it does not exist. Will not return null.
    Definition: The identifier for a community of providers.
  - setNetwork
```
public Coverage setNetwork(IdentifierDt theValue)
```
    Sets the value(s) for network ()
    Definition: The identifier for a community of providers.
  - getContract
```
public List<ResourceReferenceDt> getContract()
```
    Gets the value(s) for contract (). creating it if it does not exist. Will not return null.
    Definition: The policy(s) which constitute this insurance coverage.
  - setContract
```
public Coverage setContract(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for contract ()
    Definition: The policy(s) which constitute this insurance coverage.
  - addContract
```
public ResourceReferenceDt addContract()
```
    Adds and returns a new value for contract ()
    Definition: The policy(s) which constitute this insurance coverage.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Coverage

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_ISSUER

ISSUER

SP_IDENTIFIER

IDENTIFIER

SP_TYPE

TYPE

SP_PLAN

PLAN

SP_SUBPLAN

SUBPLAN

SP_GROUP

GROUP

SP_DEPENDENT

DEPENDENT

SP_SEQUENCE

SEQUENCE

INCLUDE_ISSUER

Constructor Detail

Coverage

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIssuer

setIssuer

getBin

setBin

getPeriod

setPeriod

getType

setType

getSubscriberId

setSubscriberId

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getGroupElement

getGroup

setGroup

setGroup

getPlanElement

getPlan

setPlan

setPlan

getSubPlanElement

getSubPlan

setSubPlan

setSubPlan

getDependentElement

getDependent

setDependent

setDependent

getSequenceElement

getSequence

setSequence

setSequence

getSubscriber

setSubscriber

getNetwork

setNetwork

getContract

setContract

addContract

getResourceName

getStructureFhirVersionEnum