Coverage (HAPI FHIR - Core Library 0.7 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Coverage
extends BaseResource
implements IResource
```
HAPI/FHIR Coverage Resource (Insurance or medical plan)
Definition: Financial instrument by which payment information for health care

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Coverage.Subscriber
Block class for child element: Coverage.subscriber (Planholder information)

Nested Classes
Modifier and Type	Class and Description
`static class`	`Coverage.Subscriber` Block class for child element: Coverage.subscriber (Planholder information)

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`	`NAME` Fluent Client search parameter constant for name
`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_NAME` Search parameter constant for name
`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.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Coverage()

Constructors
Constructor and Description
`Coverage()`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`IntegerDt`	`getDependent()` Gets the value(s) for dependent (The dependent number).
`IdentifierDt`	`getGroup()` Gets the value(s) for group (An identifier for the group).
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier (The primary coverage ID).
`ResourceReferenceDt`	`getIssuer()` Gets the value(s) for issuer (An identifier for the plan issuer).
`PeriodDt`	`getPeriod()` Gets the value(s) for period (Coverage start and end dates).
`IdentifierDt`	`getPlan()` Gets the value(s) for plan (An identifier for the plan).
`IntegerDt`	`getSequence()` Gets the value(s) for sequence (The plan instance or sequence counter).
`IdentifierDt`	`getSubplan()` Gets the value(s) for subplan (An identifier for the subsection of the plan).
`Coverage.Subscriber`	`getSubscriber()` Gets the value(s) for subscriber (Planholder information).
`CodingDt`	`getType()` Gets the value(s) for type (Type of coverage).
`boolean`	`isEmpty()`
`Coverage`	`setDependent(int theInteger)` Sets the value for dependent (The dependent number)
`Coverage`	`setDependent(IntegerDt theValue)` Sets the value(s) for dependent (The dependent number)
`Coverage`	`setGroup(IdentifierDt theValue)` Sets the value(s) for group (An identifier for the group)
`Coverage`	`setGroup(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for group (An identifier for the group)
`Coverage`	`setGroup(String theSystem, String theValue)` Sets the value for group (An identifier for the group)
`Coverage`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier (The primary coverage ID)
`Coverage`	`setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for identifier (The primary coverage ID)
`Coverage`	`setIdentifier(String theSystem, String theValue)` Sets the value for identifier (The primary coverage ID)
`Coverage`	`setIssuer(ResourceReferenceDt theValue)` Sets the value(s) for issuer (An identifier for the plan issuer)
`Coverage`	`setPeriod(PeriodDt theValue)` Sets the value(s) for period (Coverage start and end dates)
`Coverage`	`setPlan(IdentifierDt theValue)` Sets the value(s) for plan (An identifier for the plan)
`Coverage`	`setPlan(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for plan (An identifier for the plan)
`Coverage`	`setPlan(String theSystem, String theValue)` Sets the value for plan (An identifier for the plan)
`Coverage`	`setSequence(int theInteger)` Sets the value for sequence (The plan instance or sequence counter)
`Coverage`	`setSequence(IntegerDt theValue)` Sets the value(s) for sequence (The plan instance or sequence counter)
`Coverage`	`setSubplan(IdentifierDt theValue)` Sets the value(s) for subplan (An identifier for the subsection of the plan)
`Coverage`	`setSubplan(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for subplan (An identifier for the subsection of the plan)
`Coverage`	`setSubplan(String theSystem, String theValue)` Sets the value for subplan (An identifier for the subsection of the plan)
`Coverage`	`setSubscriber(Coverage.Subscriber theValue)` Sets the value(s) for subscriber (Planholder information)
`Coverage`	`setType(CodingDt theValue)` Sets the value(s) for type (Type of coverage)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- 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
  - 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".
  - 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
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description: The name of the subscriber
    Type: token
    Path: Coverage.subscriber.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final TokenClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: The name of the subscriber
    Type: token
    Path: Coverage.subscriber.name
- Constructor Detail
  - Coverage
```
public Coverage()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIssuer
```
public ResourceReferenceDt getIssuer()
```
    Gets the value(s) for issuer (An identifier for the plan 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 (An identifier for the plan issuer)
    Definition: The program or plan underwriter or payor.
  - getPeriod
```
public PeriodDt getPeriod()
```
    Gets the value(s) for period (Coverage start and end dates). 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 (Coverage start and end dates)
    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 (Type of coverage). 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 (Type of coverage)
    Definition: The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (The primary coverage ID). 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 Subscriber Id, Certificate number or Personal Health Number or Case ID.
  - setIdentifier
```
public Coverage setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier (The primary coverage ID)
    Definition: The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID.
  - setIdentifier
```
public Coverage setIdentifier(IdentifierUseEnum theUse,
                     String theSystem,
                     String theValue,
                     String theLabel)
```
    Sets the value for identifier (The primary coverage ID)
    Definition: The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID.
  - setIdentifier
```
public Coverage setIdentifier(String theSystem,
                     String theValue)
```
    Sets the value for identifier (The primary coverage ID)
    Definition: The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID.
  - getGroup
```
public IdentifierDt getGroup()
```
    Gets the value(s) for group (An identifier for the group). creating it if it does not exist. Will not return null.
    Definition: Todo
  - setGroup
```
public Coverage setGroup(IdentifierDt theValue)
```
    Sets the value(s) for group (An identifier for the group)
    Definition: Todo
  - setGroup
```
public Coverage setGroup(IdentifierUseEnum theUse,
                String theSystem,
                String theValue,
                String theLabel)
```
    Sets the value for group (An identifier for the group)
    Definition: Todo
  - setGroup
```
public Coverage setGroup(String theSystem,
                String theValue)
```
    Sets the value for group (An identifier for the group)
    Definition: Todo
  - getPlan
```
public IdentifierDt getPlan()
```
    Gets the value(s) for plan (An identifier for the 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(IdentifierDt theValue)
```
    Sets the value(s) for plan (An identifier for the 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(IdentifierUseEnum theUse,
               String theSystem,
               String theValue,
               String theLabel)
```
    Sets the value for plan (An identifier for the 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 theSystem,
               String theValue)
```
    Sets the value for plan (An identifier for the 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.
  - getSubplan
```
public IdentifierDt getSubplan()
```
    Gets the value(s) for subplan (An identifier for the subsection of the plan). 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(IdentifierDt theValue)
```
    Sets the value(s) for subplan (An identifier for the subsection of the plan)
    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(IdentifierUseEnum theUse,
                  String theSystem,
                  String theValue,
                  String theLabel)
```
    Sets the value for subplan (An identifier for the subsection of the plan)
    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 theSystem,
                  String theValue)
```
    Sets the value for subplan (An identifier for the subsection of the plan)
    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.
  - getDependent
```
public IntegerDt getDependent()
```
    Gets the value(s) for dependent (The dependent number). 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(IntegerDt theValue)
```
    Sets the value(s) for dependent (The dependent number)
    Definition: A unique identifier for a dependent under the coverage.
  - setDependent
```
public Coverage setDependent(int theInteger)
```
    Sets the value for dependent (The dependent number)
    Definition: A unique identifier for a dependent under the coverage.
  - getSequence
```
public IntegerDt getSequence()
```
    Gets the value(s) for sequence (The plan instance or sequence counter). 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(IntegerDt theValue)
```
    Sets the value(s) for sequence (The plan instance or sequence counter)
    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 (The plan instance or sequence counter)
    Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.
  - getSubscriber
```
public Coverage.Subscriber getSubscriber()
```
    Gets the value(s) for subscriber (Planholder information). creating it if it does not exist. Will not return null.
    Definition:
  - setSubscriber
```
public Coverage setSubscriber(Coverage.Subscriber theValue)
```
    Sets the value(s) for subscriber (Planholder information)
    Definition:

Class Coverage

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

SP_ISSUER

ISSUER

INCLUDE_ISSUER

SP_IDENTIFIER

IDENTIFIER

SP_TYPE

TYPE

SP_PLAN

PLAN

SP_SUBPLAN

SUBPLAN

SP_GROUP

GROUP

SP_DEPENDENT

DEPENDENT

SP_SEQUENCE

SEQUENCE

SP_NAME

NAME

Constructor Detail

Coverage

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIssuer

setIssuer

getPeriod

setPeriod

getType

setType

getIdentifier

setIdentifier

setIdentifier

setIdentifier

getGroup

setGroup

setGroup

setGroup

getPlan

setPlan

setPlan

setPlan

getSubplan

setSubplan

setSubplan

setSubplan

getDependent

setDependent

setDependent

getSequence

setSequence

setSequence

getSubscriber

setSubscriber