Coverage (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.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 reimburse or pay for health care products and services. Includes both insurance and self-payment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Coverage.ClassComponent`
`static class`	`Coverage.CostToBeneficiaryComponent`
`static class`	`Coverage.CoverageStatus`
`static class`	`Coverage.CoverageStatusEnumFactory`
`static class`	`Coverage.ExemptionComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`beneficiary` The party who benefits from the insurance coverage; the patient when products and/or services are provided.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`BENEFICIARY` Fluent Client search parameter constant for beneficiary
`protected Patient`	`beneficiaryTarget` The actual object that is the target of the reference (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
`protected List<Coverage.ClassComponent>`	`class_` A suite of underwriter specific classifiers.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CLASS_TYPE` Fluent Client search parameter constant for class-type
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`CLASS_VALUE` Fluent Client search parameter constant for class-value
`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 List<Coverage.CostToBeneficiaryComponent>`	`costToBeneficiary` A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
`protected StringType`	`dependent` A unique identifier for a dependent under the coverage.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`DEPENDENT` Fluent Client search parameter constant for dependent
`protected List<Identifier>`	`identifier` A unique identifier assigned to this coverage.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_BENEFICIARY` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PAYOR` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_POLICY_HOLDER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBSCRIBER` Constant for fluent queries to be used to add include statements.
`protected StringType`	`network` The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
`protected PositiveIntType`	`order` The order of applicability of this coverage relative to other coverages which are currently in force.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected List<Reference>`	`payor` The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PAYOR` Fluent Client search parameter constant for payor
`protected List<Resource>`	`payorTarget` The actual objects that are the target of the reference (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)
`protected Period`	`period` Time period during which the coverage is in force.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`POLICY_HOLDER` Fluent Client search parameter constant for policy-holder
`protected Reference`	`policyHolder` The party who 'owns' the insurance policy.
`protected Resource`	`policyHolderTarget` The actual object that is the target of the reference (The party who 'owns' the insurance policy.)
`protected CodeableConcept`	`relationship` The relationship of beneficiary (patient) to the subscriber.
`static String`	`SP_BENEFICIARY` Search parameter: beneficiary
`static String`	`SP_CLASS_TYPE` Search parameter: class-type
`static String`	`SP_CLASS_VALUE` Search parameter: class-value
`static String`	`SP_DEPENDENT` Search parameter: dependent
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PAYOR` Search parameter: payor
`static String`	`SP_POLICY_HOLDER` Search parameter: policy-holder
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBSCRIBER` Search parameter: subscriber
`static String`	`SP_TYPE` Search parameter: type
`protected Enumeration<Coverage.CoverageStatus>`	`status` The status of the resource instance.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected BooleanType`	`subrogation` When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
`protected Reference`	`subscriber` The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBSCRIBER` Fluent Client search parameter constant for subscriber
`protected StringType`	`subscriberId` The insurer assigned ID for the Subscriber.
`protected Resource`	`subscriberTarget` The actual object that is the target of the reference (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
`protected CodeableConcept`	`type` The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

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

Fields inherited from class org.hl7.fhir.r4.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(Enumeration<Coverage.CoverageStatus> status, Reference beneficiary)
Constructor

Constructors
Constructor and Description
`Coverage()` Constructor
`Coverage(Enumeration<Coverage.CoverageStatus> status, Reference beneficiary)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Coverage.ClassComponent`	`addClass_()`
`Coverage`	`addClass_(Coverage.ClassComponent t)`
`Reference`	`addContract()`
`Coverage`	`addContract(Reference t)`
`Contract`	`addContractTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Coverage.CostToBeneficiaryComponent`	`addCostToBeneficiary()`
`Coverage`	`addCostToBeneficiary(Coverage.CostToBeneficiaryComponent t)`
`Identifier`	`addIdentifier()`
`Coverage`	`addIdentifier(Identifier t)`
`Reference`	`addPayor()`
`Coverage`	`addPayor(Reference t)`
`Coverage`	`copy()`
`void`	`copyValues(Coverage dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Reference`	`getBeneficiary()`
`Patient`	`getBeneficiaryTarget()`
`List<Coverage.ClassComponent>`	`getClass_()`
`Coverage.ClassComponent`	`getClass_FirstRep()`
`List<Reference>`	`getContract()`
`Reference`	`getContractFirstRep()`
`List<Contract>`	`getContractTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<Coverage.CostToBeneficiaryComponent>`	`getCostToBeneficiary()`
`Coverage.CostToBeneficiaryComponent`	`getCostToBeneficiaryFirstRep()`
`String`	`getDependent()`
`StringType`	`getDependentElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`String`	`getNetwork()`
`StringType`	`getNetworkElement()`
`int`	`getOrder()`
`PositiveIntType`	`getOrderElement()`
`List<Reference>`	`getPayor()`
`Reference`	`getPayorFirstRep()`
`List<Resource>`	`getPayorTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Period`	`getPeriod()`
`Reference`	`getPolicyHolder()`
`Resource`	`getPolicyHolderTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`CodeableConcept`	`getRelationship()`
`ResourceType`	`getResourceType()`
`Coverage.CoverageStatus`	`getStatus()`
`Enumeration<Coverage.CoverageStatus>`	`getStatusElement()`
`boolean`	`getSubrogation()`
`BooleanType`	`getSubrogationElement()`
`Reference`	`getSubscriber()`
`String`	`getSubscriberId()`
`StringType`	`getSubscriberIdElement()`
`Resource`	`getSubscriberTarget()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasBeneficiary()`
`boolean`	`hasClass_()`
`boolean`	`hasContract()`
`boolean`	`hasCostToBeneficiary()`
`boolean`	`hasDependent()`
`boolean`	`hasDependentElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNetwork()`
`boolean`	`hasNetworkElement()`
`boolean`	`hasOrder()`
`boolean`	`hasOrderElement()`
`boolean`	`hasPayor()`
`boolean`	`hasPeriod()`
`boolean`	`hasPolicyHolder()`
`boolean`	`hasRelationship()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubrogation()`
`boolean`	`hasSubrogationElement()`
`boolean`	`hasSubscriber()`
`boolean`	`hasSubscriberId()`
`boolean`	`hasSubscriberIdElement()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Coverage`	`setBeneficiary(Reference value)`
`Coverage`	`setBeneficiaryTarget(Patient value)`
`Coverage`	`setClass_(List<Coverage.ClassComponent> theClass_)`
`Coverage`	`setContract(List<Reference> theContract)`
`Coverage`	`setCostToBeneficiary(List<Coverage.CostToBeneficiaryComponent> theCostToBeneficiary)`
`Coverage`	`setDependent(String value)`
`Coverage`	`setDependentElement(StringType value)`
`Coverage`	`setIdentifier(List<Identifier> theIdentifier)`
`Coverage`	`setNetwork(String value)`
`Coverage`	`setNetworkElement(StringType value)`
`Coverage`	`setOrder(int value)`
`Coverage`	`setOrderElement(PositiveIntType value)`
`Coverage`	`setPayor(List<Reference> thePayor)`
`Coverage`	`setPeriod(Period value)`
`Coverage`	`setPolicyHolder(Reference value)`
`Coverage`	`setPolicyHolderTarget(Resource value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Coverage`	`setRelationship(CodeableConcept value)`
`Coverage`	`setStatus(Coverage.CoverageStatus value)`
`Coverage`	`setStatusElement(Enumeration<Coverage.CoverageStatus> value)`
`Coverage`	`setSubrogation(boolean value)`
`Coverage`	`setSubrogationElement(BooleanType value)`
`Coverage`	`setSubscriber(Reference value)`
`Coverage`	`setSubscriberId(String value)`
`Coverage`	`setSubscriberIdElement(StringType value)`
`Coverage`	`setSubscriberTarget(Resource value)`
`Coverage`	`setType(CodeableConcept value)`
`protected Coverage`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

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

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
  - identifier
```
protected List<Identifier> identifier
```
    A unique identifier assigned to this coverage.
  - status
```
protected Enumeration<Coverage.CoverageStatus> status
```
    The status of the resource instance.
  - type
```
protected CodeableConcept type
```
    The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
  - policyHolder
```
protected Reference policyHolder
```
    The party who 'owns' the insurance policy.
  - policyHolderTarget
```
protected Resource policyHolderTarget
```
    The actual object that is the target of the reference (The party who 'owns' the insurance policy.)
  - subscriber
```
protected Reference subscriber
```
    The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
  - subscriberTarget
```
protected Resource subscriberTarget
```
    The actual object that is the target of the reference (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
  - subscriberId
```
protected StringType subscriberId
```
    The insurer assigned ID for the Subscriber.
  - beneficiary
```
protected Reference beneficiary
```
    The party who benefits from the insurance coverage; the patient when products and/or services are provided.
  - beneficiaryTarget
```
protected Patient beneficiaryTarget
```
    The actual object that is the target of the reference (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
  - dependent
```
protected StringType dependent
```
    A unique identifier for a dependent under the coverage.
  - relationship
```
protected CodeableConcept relationship
```
    The relationship of beneficiary (patient) to the subscriber.
  - period
```
protected Period period
```
    Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
  - payor
```
protected List<Reference> payor
```
    The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
  - payorTarget
```
protected List<Resource> payorTarget
```
    The actual objects that are the target of the reference (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)
  - class_
```
protected List<Coverage.ClassComponent> class_
```
    A suite of underwriter specific classifiers.
  - order
```
protected PositiveIntType order
```
    The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
  - network
```
protected StringType network
```
    The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
  - costToBeneficiary
```
protected List<Coverage.CostToBeneficiaryComponent> costToBeneficiary
```
    A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
  - subrogation
```
protected BooleanType subrogation
```
    When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
  - contract
```
protected List<Reference> contract
```
    The policy(s) which constitute this insurance coverage.
  - contractTarget
```
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
```
    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
  - SP_PAYOR
```
public static final String SP_PAYOR
```
    Search parameter: payor
    Description: The identity of the insurer or party paying for services
    Type: reference
    Path: Coverage.payor
    
    See Also:
    
    Constant Field Values
  - PAYOR
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PAYOR
```
    Fluent Client search parameter constant for payor
    Description: The identity of the insurer or party paying for services
    Type: reference
    Path: Coverage.payor
  - INCLUDE_PAYOR
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PAYOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:payor".
  - SP_SUBSCRIBER
```
public static final String SP_SUBSCRIBER
```
    Search parameter: subscriber
    Description: Reference to the subscriber
    Type: reference
    Path: Coverage.subscriber
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBSCRIBER
```
    Fluent Client search parameter constant for subscriber
    Description: Reference to the subscriber
    Type: reference
    Path: Coverage.subscriber
  - INCLUDE_SUBSCRIBER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSCRIBER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:subscriber".
  - SP_BENEFICIARY
```
public static final String SP_BENEFICIARY
```
    Search parameter: beneficiary
    Description: Covered party
    Type: reference
    Path: Coverage.beneficiary
    
    See Also:
    
    Constant Field Values
  - BENEFICIARY
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BENEFICIARY
```
    Fluent Client search parameter constant for beneficiary
    Description: Covered party
    Type: reference
    Path: Coverage.beneficiary
  - INCLUDE_BENEFICIARY
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_BENEFICIARY
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:beneficiary".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Retrieve coverages for a patient
    Type: reference
    Path: Coverage.beneficiary
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Retrieve coverages for a patient
    Type: reference
    Path: Coverage.beneficiary
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:patient".
  - SP_CLASS_VALUE
```
public static final String SP_CLASS_VALUE
```
    Search parameter: class-value
    Description: Value of the class (eg. Plan number, group number)
    Type: string
    Path: Coverage.class.value
    
    See Also:
    
    Constant Field Values
  - CLASS_VALUE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam CLASS_VALUE
```
    Fluent Client search parameter constant for class-value
    Description: Value of the class (eg. Plan number, group number)
    Type: string
    Path: Coverage.class.value
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: The kind of coverage (health plan, auto, Workers Compensation)
    Type: token
    Path: Coverage.type
    
    See Also:
    
    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_DEPENDENT
```
public static final String SP_DEPENDENT
```
    Search parameter: dependent
    Description: Dependent number
    Type: string
    Path: Coverage.dependent
    
    See Also:
    
    Constant Field Values
  - DEPENDENT
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam DEPENDENT
```
    Fluent Client search parameter constant for dependent
    Description: Dependent number
    Type: string
    Path: Coverage.dependent
  - SP_CLASS_TYPE
```
public static final String SP_CLASS_TYPE
```
    Search parameter: class-type
    Description: Coverage class (eg. plan, group)
    Type: token
    Path: Coverage.class.type
    
    See Also:
    
    Constant Field Values
  - CLASS_TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CLASS_TYPE
```
    Fluent Client search parameter constant for class-type
    Description: Coverage class (eg. plan, group)
    Type: token
    Path: Coverage.class.type
  - SP_POLICY_HOLDER
```
public static final String SP_POLICY_HOLDER
```
    Search parameter: policy-holder
    Description: Reference to the policyholder
    Type: reference
    Path: Coverage.policyHolder
    
    See Also:
    
    Constant Field Values
  - POLICY_HOLDER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam POLICY_HOLDER
```
    Fluent Client search parameter constant for policy-holder
    Description: Reference to the policyholder
    Type: reference
    Path: Coverage.policyHolder
  - INCLUDE_POLICY_HOLDER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_POLICY_HOLDER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:policy-holder".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: The status of the Coverage
    Type: token
    Path: Coverage.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The status of the Coverage
    Type: token
    Path: Coverage.status
- Constructor Detail
  - Coverage
```
public Coverage()
```
    Constructor
  - Coverage
```
public Coverage(Enumeration<Coverage.CoverageStatus> status,
                Reference beneficiary)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (A unique identifier assigned to this coverage.)
  - setIdentifier
```
public Coverage setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Coverage addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getStatusElement
```
public Enumeration<Coverage.CoverageStatus> getStatusElement()
```
    Returns:
    
    status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Coverage setStatusElement(Enumeration<Coverage.CoverageStatus> value)
```
    Parameters:
    
    value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Coverage.CoverageStatus getStatus()
```
    Returns:
    
    The status of the resource instance.
  - setStatus
```
public Coverage setStatus(Coverage.CoverageStatus value)
```
    Parameters:
    
    value - The status of the resource instance.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Coverage setType(CodeableConcept value)
```
    Parameters:
    
    value - type (The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.)
  - getPolicyHolder
```
public Reference getPolicyHolder()
```
    Returns:
    
    policyHolder (The party who 'owns' the insurance policy.)
  - hasPolicyHolder
```
public boolean hasPolicyHolder()
```
  - setPolicyHolder
```
public Coverage setPolicyHolder(Reference value)
```
    Parameters:
    
    value - policyHolder (The party who 'owns' the insurance policy.)
  - getPolicyHolderTarget
```
public Resource getPolicyHolderTarget()
```
    Returns:
    
    policyHolder The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who 'owns' the insurance policy.)
  - setPolicyHolderTarget
```
public Coverage setPolicyHolderTarget(Resource value)
```
    Parameters:
    
    value - policyHolder The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The party who 'owns' the insurance policy.)
  - getSubscriber
```
public Reference getSubscriber()
```
    Returns:
    
    subscriber (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
  - hasSubscriber
```
public boolean hasSubscriber()
```
  - setSubscriber
```
public Coverage setSubscriber(Reference value)
```
    Parameters:
    
    value - subscriber (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
  - getSubscriberTarget
```
public Resource getSubscriberTarget()
```
    Returns:
    
    subscriber The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
  - setSubscriberTarget
```
public Coverage setSubscriberTarget(Resource 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 has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
  - getSubscriberIdElement
```
public StringType getSubscriberIdElement()
```
    Returns:
    
    subscriberId (The insurer assigned ID for the Subscriber.). This is the underlying object with id, value and extensions. The accessor "getSubscriberId" gives direct access to the value
  - hasSubscriberIdElement
```
public boolean hasSubscriberIdElement()
```
  - hasSubscriberId
```
public boolean hasSubscriberId()
```
  - setSubscriberIdElement
```
public Coverage setSubscriberIdElement(StringType value)
```
    Parameters:
    
    value - subscriberId (The insurer assigned ID for the Subscriber.). This is the underlying object with id, value and extensions. The accessor "getSubscriberId" gives direct access to the value
  - getSubscriberId
```
public String getSubscriberId()
```
    Returns:
    
    The insurer assigned ID for the Subscriber.
  - setSubscriberId
```
public Coverage setSubscriberId(String value)
```
    Parameters:
    
    value - The insurer assigned ID for the Subscriber.
  - getBeneficiary
```
public Reference getBeneficiary()
```
    Returns:
    
    beneficiary (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
  - hasBeneficiary
```
public boolean hasBeneficiary()
```
  - setBeneficiary
```
public Coverage setBeneficiary(Reference value)
```
    Parameters:
    
    value - beneficiary (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
  - getBeneficiaryTarget
```
public Patient getBeneficiaryTarget()
```
    Returns:
    
    beneficiary The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
  - setBeneficiaryTarget
```
public Coverage setBeneficiaryTarget(Patient value)
```
    Parameters:
    
    value - beneficiary The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
  - getDependentElement
```
public StringType 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(StringType 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 String getDependent()
```
    Returns:
    
    A unique identifier for a dependent under the coverage.
  - setDependent
```
public Coverage setDependent(String value)
```
    Parameters:
    
    value - A unique identifier for a dependent under the coverage.
  - getRelationship
```
public CodeableConcept getRelationship()
```
    Returns:
    
    relationship (The relationship of beneficiary (patient) to the subscriber.)
  - hasRelationship
```
public boolean hasRelationship()
```
  - setRelationship
```
public Coverage setRelationship(CodeableConcept value)
```
    Parameters:
    
    value - relationship (The relationship of beneficiary (patient) to the subscriber.)
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public Coverage setPeriod(Period value)
```
    Parameters:
    
    value - period (Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.)
  - getPayor
```
public List<Reference> getPayor()
```
    Returns:
    
    payor (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)
  - setPayor
```
public Coverage setPayor(List<Reference> thePayor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasPayor
```
public boolean hasPayor()
```
  - addPayor
```
public Reference addPayor()
```
  - addPayor
```
public Coverage addPayor(Reference t)
```
  - getPayorFirstRep
```
public Reference getPayorFirstRep()
```
    Returns:
    
    The first repetition of repeating field payor, creating it if it does not already exist
  - getPayorTarget
```
@Deprecated
public List<Resource> getPayorTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getClass_
```
public List<Coverage.ClassComponent> getClass_()
```
    Returns:
    
    class_ (A suite of underwriter specific classifiers.)
  - setClass_
```
public Coverage setClass_(List<Coverage.ClassComponent> theClass_)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasClass_
```
public boolean hasClass_()
```
  - addClass_
```
public Coverage.ClassComponent addClass_()
```
  - addClass_
```
public Coverage addClass_(Coverage.ClassComponent t)
```
  - getClass_FirstRep
```
public Coverage.ClassComponent getClass_FirstRep()
```
    Returns:
    
    The first repetition of repeating field class_, creating it if it does not already exist
  - getOrderElement
```
public PositiveIntType getOrderElement()
```
    Returns:
    
    order (The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.). This is the underlying object with id, value and extensions. The accessor "getOrder" gives direct access to the value
  - hasOrderElement
```
public boolean hasOrderElement()
```
  - hasOrder
```
public boolean hasOrder()
```
  - setOrderElement
```
public Coverage setOrderElement(PositiveIntType value)
```
    Parameters:
    
    value - order (The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.). This is the underlying object with id, value and extensions. The accessor "getOrder" gives direct access to the value
  - getOrder
```
public int getOrder()
```
    Returns:
    
    The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
  - setOrder
```
public Coverage setOrder(int value)
```
    Parameters:
    
    value - The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
  - getNetworkElement
```
public StringType getNetworkElement()
```
    Returns:
    
    network (The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.). This is the underlying object with id, value and extensions. The accessor "getNetwork" gives direct access to the value
  - hasNetworkElement
```
public boolean hasNetworkElement()
```
  - hasNetwork
```
public boolean hasNetwork()
```
  - setNetworkElement
```
public Coverage setNetworkElement(StringType value)
```
    Parameters:
    
    value - network (The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.). This is the underlying object with id, value and extensions. The accessor "getNetwork" gives direct access to the value
  - getNetwork
```
public String getNetwork()
```
    Returns:
    
    The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
  - setNetwork
```
public Coverage setNetwork(String value)
```
    Parameters:
    
    value - The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
  - getCostToBeneficiary
```
public List<Coverage.CostToBeneficiaryComponent> getCostToBeneficiary()
```
    Returns:
    
    costToBeneficiary (A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.)
  - setCostToBeneficiary
```
public Coverage setCostToBeneficiary(List<Coverage.CostToBeneficiaryComponent> theCostToBeneficiary)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCostToBeneficiary
```
public boolean hasCostToBeneficiary()
```
  - addCostToBeneficiary
```
public Coverage.CostToBeneficiaryComponent addCostToBeneficiary()
```
  - addCostToBeneficiary
```
public Coverage addCostToBeneficiary(Coverage.CostToBeneficiaryComponent t)
```
  - getCostToBeneficiaryFirstRep
```
public Coverage.CostToBeneficiaryComponent getCostToBeneficiaryFirstRep()
```
    Returns:
    
    The first repetition of repeating field costToBeneficiary, creating it if it does not already exist
  - getSubrogationElement
```
public BooleanType getSubrogationElement()
```
    Returns:
    
    subrogation (When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.). This is the underlying object with id, value and extensions. The accessor "getSubrogation" gives direct access to the value
  - hasSubrogationElement
```
public boolean hasSubrogationElement()
```
  - hasSubrogation
```
public boolean hasSubrogation()
```
  - setSubrogationElement
```
public Coverage setSubrogationElement(BooleanType value)
```
    Parameters:
    
    value - subrogation (When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.). This is the underlying object with id, value and extensions. The accessor "getSubrogation" gives direct access to the value
  - getSubrogation
```
public boolean getSubrogation()
```
    Returns:
    
    When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
  - setSubrogation
```
public Coverage setSubrogation(boolean value)
```
    Parameters:
    
    value - When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
  - getContract
```
public List<Reference> getContract()
```
    Returns:
    
    contract (The policy(s) which constitute this insurance coverage.)
  - setContract
```
public Coverage setContract(List<Reference> theContract)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContract
```
public boolean hasContract()
```
  - addContract
```
public Reference addContract()
```
  - addContract
```
public Coverage addContract(Reference t)
```
  - getContractFirstRep
```
public Reference getContractFirstRep()
```
    Returns:
    
    The first repetition of repeating field contract, creating it if it does not already exist
  - getContractTarget
```
@Deprecated
public List<Contract> getContractTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addContractTarget
```
@Deprecated
public Contract addContractTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Coverage copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Coverage dst)
```
  - typedCopy
```
protected Coverage typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Coverage

Nested Class Summary

Field Summary

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

Fields inherited from class org.hl7.fhir.r4.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.r4.model.DomainResource

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

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

Methods inherited from class org.hl7.fhir.r4.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

identifier

status

type

policyHolder

policyHolderTarget

subscriber

subscriberTarget

subscriberId

beneficiary

beneficiaryTarget

dependent

relationship

period

payor

payorTarget

class_

order

network

costToBeneficiary

subrogation

contract

contractTarget

SP_IDENTIFIER

IDENTIFIER

SP_PAYOR

PAYOR

INCLUDE_PAYOR

SP_SUBSCRIBER

SUBSCRIBER

INCLUDE_SUBSCRIBER

SP_BENEFICIARY

BENEFICIARY

INCLUDE_BENEFICIARY

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_CLASS_VALUE

CLASS_VALUE

SP_TYPE

TYPE

SP_DEPENDENT

DEPENDENT

SP_CLASS_TYPE

CLASS_TYPE

SP_POLICY_HOLDER

POLICY_HOLDER

INCLUDE_POLICY_HOLDER

SP_STATUS

STATUS

Constructor Detail

Coverage

Coverage

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

hasStatusElement

hasStatus