
Class CoverageEligibilityRequest
- 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic enumstatic classstatic enumstatic classstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DateTimeTypeThe date when this resource was created.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for createdprotected ReferencePerson who created the request.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for entererprotected ResourceThe actual object that is the target of the reference (Person who created the request.)protected ReferenceFacility where the services are intended to be provided.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for facilityprotected LocationThe actual object that is the target of the reference (Facility where the services are intended to be provided.)protected List<Identifier> A unique identifier assigned to this coverage eligiblity request.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.Financial instruments for reimbursement for the health care products and services.protected ReferenceThe Insurer who issued the coverage in question and is the recipient of the request.protected OrganizationThe actual object that is the target of the reference (The Insurer who issued the coverage in question and is the recipient of the request.)protected List<CoverageEligibilityRequest.DetailsComponent> Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.protected ReferenceThe party who is the beneficiary of the supplied coverage and for whom eligibility is sought.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PatientThe actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)protected CodeableConceptWhen the requestor expects the processor to complete processing.protected ReferenceThe provider which is responsible for the request.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for providerprotected ResourceThe actual object that is the target of the reference (The provider which is responsible for the request.)Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.protected TypeThe date or dates when the enclosed suite of services were performed or completed.static final StringSearch parameter: createdstatic final StringSearch parameter: entererstatic final StringSearch parameter: facilitystatic final StringSearch parameter: identifierstatic final StringSearch parameter: patientstatic final StringSearch parameter: providerstatic final StringSearch parameter: statusThe status of the resource instance.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorCoverageEligibilityRequest(Enumeration<CoverageEligibilityRequest.EligibilityRequestStatus> status, Reference patient, DateTimeType created, Reference insurer) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddItem()copy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getItem()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasItem()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setCreated(Date value) setCreatedElement(DateTimeType value) setEnterer(Reference value) setEntererTarget(Resource value) setFacility(Reference value) setFacilityTarget(Location value) setIdentifier(List<Identifier> theIdentifier) setInsurance(List<CoverageEligibilityRequest.InsuranceComponent> theInsurance) setInsurer(Reference value) setInsurerTarget(Organization value) setPatient(Reference value) setPatientTarget(Patient value) setPriority(CodeableConcept value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setProvider(Reference value) setProviderTarget(Resource value) setServiced(Type value) setSupportingInfo(List<CoverageEligibilityRequest.SupportingInformationComponent> theSupportingInfo) protected CoverageEligibilityRequestMethods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
A unique identifier assigned to this coverage eligiblity request. -
status
The status of the resource instance. -
priority
When the requestor expects the processor to complete processing. -
purpose
Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified. -
patient
The party who is the beneficiary of the supplied coverage and for whom eligibility is sought. -
patientTarget
The actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.) -
serviced
The date or dates when the enclosed suite of services were performed or completed. -
created
The date when this resource was created. -
enterer
Person who created the request. -
entererTarget
The actual object that is the target of the reference (Person who created the request.) -
provider
The provider which is responsible for the request. -
providerTarget
The actual object that is the target of the reference (The provider which is responsible for the request.) -
insurer
The Insurer who issued the coverage in question and is the recipient of the request. -
insurerTarget
The actual object that is the target of the reference (The Insurer who issued the coverage in question and is the recipient of the request.) -
facility
Facility where the services are intended to be provided. -
facilityTarget
The actual object that is the target of the reference (Facility where the services are intended to be provided.) -
supportingInfo
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. -
insurance
Financial instruments for reimbursement for the health care products and services. -
item
Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor. -
SP_IDENTIFIER
Search parameter: identifierDescription: The business identifier of the Eligibility
Type: token
Path: CoverageEligibilityRequest.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The business identifier of the Eligibility
Type: token
Path: CoverageEligibilityRequest.identifier
-
SP_PROVIDER
Search parameter: providerDescription: The reference to the provider
Type: reference
Path: CoverageEligibilityRequest.provider
- See Also:
-
PROVIDER
Fluent Client search parameter constant for providerDescription: The reference to the provider
Type: reference
Path: CoverageEligibilityRequest.provider
-
INCLUDE_PROVIDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CoverageEligibilityRequest:provider". -
SP_PATIENT
Search parameter: patientDescription: The reference to the patient
Type: reference
Path: CoverageEligibilityRequest.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The reference to the patient
Type: reference
Path: CoverageEligibilityRequest.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CoverageEligibilityRequest:patient". -
SP_CREATED
Search parameter: createdDescription: The creation date for the EOB
Type: date
Path: CoverageEligibilityRequest.created
- See Also:
-
CREATED
Fluent Client search parameter constant for createdDescription: The creation date for the EOB
Type: date
Path: CoverageEligibilityRequest.created
-
SP_ENTERER
Search parameter: entererDescription: The party who is responsible for the request
Type: reference
Path: CoverageEligibilityRequest.enterer
- See Also:
-
ENTERER
Fluent Client search parameter constant for entererDescription: The party who is responsible for the request
Type: reference
Path: CoverageEligibilityRequest.enterer
-
INCLUDE_ENTERER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CoverageEligibilityRequest:enterer". -
SP_FACILITY
Search parameter: facilityDescription: Facility responsible for the goods and services
Type: reference
Path: CoverageEligibilityRequest.facility
- See Also:
-
FACILITY
Fluent Client search parameter constant for facilityDescription: Facility responsible for the goods and services
Type: reference
Path: CoverageEligibilityRequest.facility
-
INCLUDE_FACILITY
Constant for fluent queries to be used to add include statements. Specifies the path value of "CoverageEligibilityRequest:facility". -
SP_STATUS
Search parameter: statusDescription: The status of the EligibilityRequest
Type: token
Path: CoverageEligibilityRequest.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of the EligibilityRequest
Type: token
Path: CoverageEligibilityRequest.status
-
-
Constructor Details
-
CoverageEligibilityRequest
public CoverageEligibilityRequest()Constructor -
CoverageEligibilityRequest
public CoverageEligibilityRequest(Enumeration<CoverageEligibilityRequest.EligibilityRequestStatus> status, Reference patient, DateTimeType created, Reference insurer) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(A unique identifier assigned to this coverage eligiblity request.)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
public CoverageEligibilityRequest setStatusElement(Enumeration<CoverageEligibilityRequest.EligibilityRequestStatus> 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
- Returns:
- The status of the resource instance.
-
setStatus
public CoverageEligibilityRequest setStatus(CoverageEligibilityRequest.EligibilityRequestStatus value) - Parameters:
value- The status of the resource instance.
-
getPriority
- Returns:
priority(When the requestor expects the processor to complete processing.)
-
hasPriority
-
setPriority
- Parameters:
value-priority(When the requestor expects the processor to complete processing.)
-
getPurpose
- Returns:
purpose(Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.)
-
setPurpose
public CoverageEligibilityRequest setPurpose(List<Enumeration<CoverageEligibilityRequest.EligibilityRequestPurpose>> thePurpose) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPurpose
-
addPurposeElement
- Returns:
purpose(Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.)
-
addPurpose
public CoverageEligibilityRequest addPurpose(CoverageEligibilityRequest.EligibilityRequestPurpose value) - Parameters:
value-purpose(Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.)
-
hasPurpose
- Parameters:
value-purpose(Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.)
-
getPatient
- Returns:
patient(The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)
-
hasPatient
-
setPatient
- Parameters:
value-patient(The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)
-
getPatientTarget
- Returns:
patientThe 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 is the beneficiary of the supplied coverage and for whom eligibility is sought.)
-
setPatientTarget
- Parameters:
value-patientThe 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 is the beneficiary of the supplied coverage and for whom eligibility is sought.)
-
getServiced
- Returns:
serviced(The date or dates when the enclosed suite of services were performed or completed.)
-
getServicedDateType
- Returns:
serviced(The date or dates when the enclosed suite of services were performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedDateType
-
getServicedPeriod
- Returns:
serviced(The date or dates when the enclosed suite of services were performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedPeriod
-
hasServiced
-
setServiced
- Parameters:
value-serviced(The date or dates when the enclosed suite of services were performed or completed.)
-
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
-
hasCreated
-
setCreatedElement
- 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
- Returns:
- The date when this resource was created.
-
setCreated
- Parameters:
value- The date when this resource was created.
-
getEnterer
- Returns:
enterer(Person who created the request.)
-
hasEnterer
-
setEnterer
- Parameters:
value-enterer(Person who created the request.)
-
getEntererTarget
- Returns:
entererThe 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. (Person who created the request.)
-
setEntererTarget
- Parameters:
value-entererThe 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. (Person who created the request.)
-
getProvider
- Returns:
provider(The provider which is responsible for the request.)
-
hasProvider
-
setProvider
- Parameters:
value-provider(The provider which is responsible for the request.)
-
getProviderTarget
- Returns:
providerThe 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 provider which is responsible for the request.)
-
setProviderTarget
- Parameters:
value-providerThe 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 provider which is responsible for the request.)
-
getInsurer
- Returns:
insurer(The Insurer who issued the coverage in question and is the recipient of the request.)
-
hasInsurer
-
setInsurer
- Parameters:
value-insurer(The Insurer who issued the coverage in question and is the recipient of the request.)
-
getInsurerTarget
- Returns:
insurerThe 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 issued the coverage in question and is the recipient of the request.)
-
setInsurerTarget
- Parameters:
value-insurerThe 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 issued the coverage in question and is the recipient of the request.)
-
getFacility
- Returns:
facility(Facility where the services are intended to be provided.)
-
hasFacility
-
setFacility
- Parameters:
value-facility(Facility where the services are intended to be provided.)
-
getFacilityTarget
- Returns:
facilityThe 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. (Facility where the services are intended to be provided.)
-
setFacilityTarget
- Parameters:
value-facilityThe 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. (Facility where the services are intended to be provided.)
-
getSupportingInfo
- Returns:
supportingInfo(Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.)
-
setSupportingInfo
public CoverageEligibilityRequest setSupportingInfo(List<CoverageEligibilityRequest.SupportingInformationComponent> theSupportingInfo) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo, creating it if it does not already exist
-
getInsurance
- Returns:
insurance(Financial instruments for reimbursement for the health care products and services.)
-
setInsurance
public CoverageEligibilityRequest setInsurance(List<CoverageEligibilityRequest.InsuranceComponent> theInsurance) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInsurance
-
addInsurance
-
addInsurance
-
getInsuranceFirstRep
- Returns:
- The first repetition of repeating field
insurance, creating it if it does not already exist
-
getItem
- Returns:
item(Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.)
-
setItem
public CoverageEligibilityRequest setItem(List<CoverageEligibilityRequest.DetailsComponent> theItem) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasItem
-
addItem
-
addItem
-
getItemFirstRep
- Returns:
- The first repetition of repeating field
item, creating it if it does not already exist
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-