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

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.EnrollmentRequest

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 EnrollmentRequest
extends DomainResource
```
This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`coverage` Reference to the program or plan identification, underwriter or payor.
`protected Coverage`	`coverageTarget` The actual object that is the target of the reference (Reference to the program or plan identification, underwriter or payor.)
`protected DateTimeType`	`created` The date when this resource was created.
`protected List<Identifier>`	`identifier` The Response business identifier.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`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_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected Reference`	`organization` The organization which is responsible for the services rendered to the patient.
`protected Organization`	`organizationTarget` The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)
`protected Coding`	`originalRuleset` The style (standard) and version of the original material which was converted into this resource.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Reference`	`provider` The practitioner who is responsible for the services rendered to the patient.
`protected Practitioner`	`providerTarget` The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
`protected Coding`	`relationship` The relationship of the patient to the subscriber.
`protected Coding`	`ruleset` The version of the style of resource contents.
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Reference`	`subject` Patient Resource.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Patient`	`subjectTarget` The actual object that is the target of the reference (Patient Resource.)
`protected Reference`	`target` The Insurer who is target of the request.
`protected Organization`	`targetTarget` The actual object that is the target of the reference (The Insurer who is target of the request.)

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

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

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

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

Constructor Summary

Constructors
Constructor and Description
`EnrollmentRequest()` Constructor
`EnrollmentRequest(Reference subject, Reference coverage, Coding relationship)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`EnrollmentRequest`	`addIdentifier(Identifier t)`
`EnrollmentRequest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getCoverage()`
`Coverage`	`getCoverageTarget()`
`Date`	`getCreated()`
`DateTimeType`	`getCreatedElement()`
`List<Identifier>`	`getIdentifier()`
`Reference`	`getOrganization()`
`Organization`	`getOrganizationTarget()`
`Coding`	`getOriginalRuleset()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Reference`	`getProvider()`
`Practitioner`	`getProviderTarget()`
`Coding`	`getRelationship()`
`ResourceType`	`getResourceType()`
`Coding`	`getRuleset()`
`Reference`	`getSubject()`
`Patient`	`getSubjectTarget()`
`Reference`	`getTarget()`
`Organization`	`getTargetTarget()`
`boolean`	`hasCoverage()`
`boolean`	`hasCreated()`
`boolean`	`hasCreatedElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasOrganization()`
`boolean`	`hasOriginalRuleset()`
`boolean`	`hasProvider()`
`boolean`	`hasRelationship()`
`boolean`	`hasRuleset()`
`boolean`	`hasSubject()`
`boolean`	`hasTarget()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`EnrollmentRequest`	`setCoverage(Reference value)`
`EnrollmentRequest`	`setCoverageTarget(Coverage value)`
`EnrollmentRequest`	`setCreated(Date value)`
`EnrollmentRequest`	`setCreatedElement(DateTimeType value)`
`EnrollmentRequest`	`setOrganization(Reference value)`
`EnrollmentRequest`	`setOrganizationTarget(Organization value)`
`EnrollmentRequest`	`setOriginalRuleset(Coding value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`EnrollmentRequest`	`setProvider(Reference value)`
`EnrollmentRequest`	`setProviderTarget(Practitioner value)`
`EnrollmentRequest`	`setRelationship(Coding value)`
`EnrollmentRequest`	`setRuleset(Coding value)`
`EnrollmentRequest`	`setSubject(Reference value)`
`EnrollmentRequest`	`setSubjectTarget(Patient value)`
`EnrollmentRequest`	`setTarget(Reference value)`
`EnrollmentRequest`	`setTargetTarget(Organization value)`
`protected EnrollmentRequest`	`typedCopy()`

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

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

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

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

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

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

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

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

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    The Response business identifier.
  - ruleset
```
protected Coding ruleset
```
    The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - originalRuleset
```
protected Coding originalRuleset
```
    The style (standard) and version of the original material which was converted into this resource.
  - created
```
protected DateTimeType created
```
    The date when this resource was created.
  - target
```
protected Reference target
```
    The Insurer who is target of the request.
  - targetTarget
```
protected Organization targetTarget
```
    The actual object that is the target of the reference (The Insurer who is target of the request.)
  - provider
```
protected Reference provider
```
    The practitioner who is responsible for the services rendered to the patient.
  - providerTarget
```
protected Practitioner providerTarget
```
    The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
  - organization
```
protected Reference organization
```
    The organization which is responsible for the services rendered to the patient.
  - organizationTarget
```
protected Organization organizationTarget
```
    The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.)
  - subject
```
protected Reference subject
```
    Patient Resource.
  - subjectTarget
```
protected Patient subjectTarget
```
    The actual object that is the target of the reference (Patient Resource.)
  - coverage
```
protected Reference coverage
```
    Reference to the program or plan identification, underwriter or payor.
  - coverageTarget
```
protected Coverage coverageTarget
```
    The actual object that is the target of the reference (Reference to the program or plan identification, underwriter or payor.)
  - relationship
```
protected Coding relationship
```
    The relationship of the patient to the subscriber.
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The party to be enrolled
    Type: reference
    Path: EnrollmentRequest.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The party to be enrolled
    Type: reference
    Path: EnrollmentRequest.subject
  - 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 "EnrollmentRequest:patient".
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: The party to be enrolled
    Type: reference
    Path: EnrollmentRequest.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The party to be enrolled
    Type: reference
    Path: EnrollmentRequest.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "EnrollmentRequest:subject".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: The business identifier of the Enrollment
    Type: token
    Path: EnrollmentRequest.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 business identifier of the Enrollment
    Type: token
    Path: EnrollmentRequest.identifier
- Constructor Detail
  - EnrollmentRequest
```
public EnrollmentRequest()
```
    Constructor
  - EnrollmentRequest
```
public EnrollmentRequest(Reference subject,
                         Reference coverage,
                         Coding relationship)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (The Response business identifier.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (The Response business identifier.)
  - addIdentifier
```
public EnrollmentRequest addIdentifier(Identifier t)
```
  - getRuleset
```
public Coding getRuleset()
```
    Returns:
    
    ruleset (The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)
  - hasRuleset
```
public boolean hasRuleset()
```
  - setRuleset
```
public EnrollmentRequest setRuleset(Coding value)
```
    Parameters:
    
    value - ruleset (The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.)
  - getOriginalRuleset
```
public Coding getOriginalRuleset()
```
    Returns:
    
    originalRuleset (The style (standard) and version of the original material which was converted into this resource.)
  - hasOriginalRuleset
```
public boolean hasOriginalRuleset()
```
  - setOriginalRuleset
```
public EnrollmentRequest setOriginalRuleset(Coding value)
```
    Parameters:
    
    value - originalRuleset (The style (standard) and version of the original material which was converted into this resource.)
  - getCreatedElement
```
public DateTimeType getCreatedElement()
```
    Returns:
    
    created (The date when this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
  - hasCreatedElement
```
public boolean hasCreatedElement()
```
  - hasCreated
```
public boolean hasCreated()
```
  - setCreatedElement
```
public EnrollmentRequest setCreatedElement(DateTimeType value)
```
    Parameters:
    
    value - created (The date when this resource was created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
  - getCreated
```
public Date getCreated()
```
    Returns:
    
    The date when this resource was created.
  - setCreated
```
public EnrollmentRequest setCreated(Date value)
```
    Parameters:
    
    value - The date when this resource was created.
  - getTarget
```
public Reference getTarget()
```
    Returns:
    
    target (The Insurer who is target of the request.)
  - hasTarget
```
public boolean hasTarget()
```
  - setTarget
```
public EnrollmentRequest setTarget(Reference value)
```
    Parameters:
    
    value - target (The Insurer who is target of the request.)
  - getTargetTarget
```
public Organization getTargetTarget()
```
    Returns:
    
    target 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 Insurer who is target of the request.)
  - setTargetTarget
```
public EnrollmentRequest setTargetTarget(Organization value)
```
    Parameters:
    
    value - target 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 Insurer who is target of the request.)
  - getProvider
```
public Reference getProvider()
```
    Returns:
    
    provider (The practitioner who is responsible for the services rendered to the patient.)
  - hasProvider
```
public boolean hasProvider()
```
  - setProvider
```
public EnrollmentRequest setProvider(Reference value)
```
    Parameters:
    
    value - provider (The practitioner who is responsible for the services rendered to the patient.)
  - getProviderTarget
```
public Practitioner getProviderTarget()
```
    Returns:
    
    provider 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 practitioner who is responsible for the services rendered to the patient.)
  - setProviderTarget
```
public EnrollmentRequest setProviderTarget(Practitioner value)
```
    Parameters:
    
    value - provider 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 practitioner who is responsible for the services rendered to the patient.)
  - getOrganization
```
public Reference getOrganization()
```
    Returns:
    
    organization (The organization which is responsible for the services rendered to the patient.)
  - hasOrganization
```
public boolean hasOrganization()
```
  - setOrganization
```
public EnrollmentRequest setOrganization(Reference value)
```
    Parameters:
    
    value - organization (The organization which is responsible for the services rendered to the patient.)
  - getOrganizationTarget
```
public Organization getOrganizationTarget()
```
    Returns:
    
    organization 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 organization which is responsible for the services rendered to the patient.)
  - setOrganizationTarget
```
public EnrollmentRequest setOrganizationTarget(Organization value)
```
    Parameters:
    
    value - organization 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 organization which is responsible for the services rendered to the patient.)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Patient Resource.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public EnrollmentRequest setSubject(Reference value)
```
    Parameters:
    
    value - subject (Patient Resource.)
  - getSubjectTarget
```
public Patient getSubjectTarget()
```
    Returns:
    
    subject 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. (Patient Resource.)
  - setSubjectTarget
```
public EnrollmentRequest setSubjectTarget(Patient value)
```
    Parameters:
    
    value - subject 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. (Patient Resource.)
  - getCoverage
```
public Reference getCoverage()
```
    Returns:
    
    coverage (Reference to the program or plan identification, underwriter or payor.)
  - hasCoverage
```
public boolean hasCoverage()
```
  - setCoverage
```
public EnrollmentRequest setCoverage(Reference value)
```
    Parameters:
    
    value - coverage (Reference to the program or plan identification, underwriter or payor.)
  - getCoverageTarget
```
public Coverage getCoverageTarget()
```
    Returns:
    
    coverage 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. (Reference to the program or plan identification, underwriter or payor.)
  - setCoverageTarget
```
public EnrollmentRequest setCoverageTarget(Coverage value)
```
    Parameters:
    
    value - coverage 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. (Reference to the program or plan identification, underwriter or payor.)
  - getRelationship
```
public Coding getRelationship()
```
    Returns:
    
    relationship (The relationship of the patient to the subscriber.)
  - hasRelationship
```
public boolean hasRelationship()
```
  - setRelationship
```
public EnrollmentRequest setRelationship(Coding value)
```
    Parameters:
    
    value - relationship (The relationship of the patient to the subscriber.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public EnrollmentRequest copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected EnrollmentRequest 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 EnrollmentRequest

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

ruleset

originalRuleset

created

target

targetTarget

provider

providerTarget

organization

organizationTarget

subject

subjectTarget

coverage

coverageTarget

relationship

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_IDENTIFIER

IDENTIFIER

Constructor Detail

EnrollmentRequest

EnrollmentRequest

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getRuleset

hasRuleset

setRuleset

getOriginalRuleset

hasOriginalRuleset

setOriginalRuleset

getCreatedElement

hasCreatedElement

hasCreated

setCreatedElement

getCreated

setCreated

getTarget

hasTarget

setTarget

getTargetTarget

setTargetTarget

getProvider

hasProvider

setProvider

getProviderTarget

setProviderTarget

getOrganization

hasOrganization

setOrganization

getOrganizationTarget

setOrganizationTarget

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget