Class Coverage

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Coverage
    extends BaseResource
    implements ca.uhn.fhir.model.api.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 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.TokenClientParam PLAN
        Fluent Client search parameter constant for plan

        Description: A plan or policy identifier
        Type: token
        Path: Coverage.plan

      • SP_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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.TokenClientParam GROUP
        Fluent Client search parameter constant for group

        Description: Group identifier
        Type: token
        Path: Coverage.group

      • DEPENDENT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam DEPENDENT
        Fluent Client search parameter constant for dependent

        Description: Dependent number
        Type: token
        Path: Coverage.dependent

      • SEQUENCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SEQUENCE
        Fluent Client search parameter constant for sequence

        Description: Sequence number
        Type: token
        Path: Coverage.sequence

      • INCLUDE_ISSUER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ISSUER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Coverage:issuer".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.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.

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

      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        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 ca.uhn.fhir.model.primitive.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. This method may 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​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may 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​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may 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​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: A unique identifier for a dependent under the coverage.

      • setDependent

        public Coverage setDependent​(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

        Definition: An optional counter for a particular instance of the identified coverage which increments upon each renewal.

      • setSequence

        public Coverage setSequence​(ca.uhn.fhir.model.primitive.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<ResourceReferenceDtgetContract()
        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.

      • 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 ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource