Class CoverageEligibilityResponse.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.CoverageEligibilityResponse.Builder
-
- Enclosing class:
- CoverageEligibilityResponse
public static class CoverageEligibilityResponse.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CoverageEligibilityResponse
build()
Build theCoverageEligibilityResponse
CoverageEligibilityResponse.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.CoverageEligibilityResponse.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.CoverageEligibilityResponse.Builder
created(DateTime created)
The date this resource was created.CoverageEligibilityResponse.Builder
disposition(java.lang.String disposition)
Convenience method for settingdisposition
.CoverageEligibilityResponse.Builder
disposition(String disposition)
A human readable description of the status of the adjudication.CoverageEligibilityResponse.Builder
error(java.util.Collection<CoverageEligibilityResponse.Error> error)
Errors encountered during the processing of the request.CoverageEligibilityResponse.Builder
error(CoverageEligibilityResponse.Error... error)
Errors encountered during the processing of the request.CoverageEligibilityResponse.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.CoverageEligibilityResponse.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.CoverageEligibilityResponse.Builder
form(CodeableConcept form)
A code for the form to be used for printing the content.protected CoverageEligibilityResponse.Builder
from(CoverageEligibilityResponse coverageEligibilityResponse)
CoverageEligibilityResponse.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.CoverageEligibilityResponse.Builder
identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this coverage eligiblity request.CoverageEligibilityResponse.Builder
identifier(Identifier... identifier)
A unique identifier assigned to this coverage eligiblity request.CoverageEligibilityResponse.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.CoverageEligibilityResponse.Builder
insurance(java.util.Collection<CoverageEligibilityResponse.Insurance> insurance)
Financial instruments for reimbursement for the health care products and services.CoverageEligibilityResponse.Builder
insurance(CoverageEligibilityResponse.Insurance... insurance)
Financial instruments for reimbursement for the health care products and services.CoverageEligibilityResponse.Builder
insurer(Reference insurer)
The Insurer who issued the coverage in question and is the author of the response.CoverageEligibilityResponse.Builder
language(Code language)
The base language in which the resource is written.CoverageEligibilityResponse.Builder
meta(Meta meta)
The metadata about the resource.CoverageEligibilityResponse.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.CoverageEligibilityResponse.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.CoverageEligibilityResponse.Builder
outcome(RemittanceOutcome outcome)
The outcome of the request processing.CoverageEligibilityResponse.Builder
patient(Reference patient)
The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.CoverageEligibilityResponse.Builder
preAuthRef(java.lang.String preAuthRef)
Convenience method for settingpreAuthRef
.CoverageEligibilityResponse.Builder
preAuthRef(String preAuthRef)
A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.CoverageEligibilityResponse.Builder
purpose(java.util.Collection<EligibilityResponsePurpose> 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.CoverageEligibilityResponse.Builder
purpose(EligibilityResponsePurpose... 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.CoverageEligibilityResponse.Builder
request(Reference request)
Reference to the original request resource.CoverageEligibilityResponse.Builder
requestor(Reference requestor)
The provider which is responsible for the request.CoverageEligibilityResponse.Builder
serviced(java.time.LocalDate serviced)
Convenience method for settingserviced
with choice type Date.CoverageEligibilityResponse.Builder
serviced(Element serviced)
The date or dates when the enclosed suite of services were performed or completed.CoverageEligibilityResponse.Builder
status(EligibilityResponseStatus status)
The status of the resource instance.CoverageEligibilityResponse.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.protected void
validate(CoverageEligibilityResponse coverageEligibilityResponse)
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public CoverageEligibilityResponse.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public CoverageEligibilityResponse.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public CoverageEligibilityResponse.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public CoverageEligibilityResponse.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public CoverageEligibilityResponse.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public CoverageEligibilityResponse.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public CoverageEligibilityResponse.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public CoverageEligibilityResponse.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public CoverageEligibilityResponse.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public CoverageEligibilityResponse.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public CoverageEligibilityResponse.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
identifier
public CoverageEligibilityResponse.Builder identifier(Identifier... identifier)
A unique identifier assigned to this coverage eligiblity request.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Business Identifier for coverage eligiblity request- Returns:
- A reference to this Builder instance
-
identifier
public CoverageEligibilityResponse.Builder identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this coverage eligiblity request.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Business Identifier for coverage eligiblity request- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public CoverageEligibilityResponse.Builder status(EligibilityResponseStatus status)
The status of the resource instance.This element is required.
- Parameters:
status
- active | cancelled | draft | entered-in-error- Returns:
- A reference to this Builder instance
-
purpose
public CoverageEligibilityResponse.Builder purpose(EligibilityResponsePurpose... 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
purpose
- auth-requirements | benefits | discovery | validation- Returns:
- A reference to this Builder instance
-
purpose
public CoverageEligibilityResponse.Builder purpose(java.util.Collection<EligibilityResponsePurpose> 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
purpose
- auth-requirements | benefits | discovery | validation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
patient
public CoverageEligibilityResponse.Builder patient(Reference patient)
The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.This element is required.
Allowed resource types for this reference:
- Parameters:
patient
- Intended recipient of products and services- Returns:
- A reference to this Builder instance
-
serviced
public CoverageEligibilityResponse.Builder serviced(java.time.LocalDate serviced)
Convenience method for settingserviced
with choice type Date.- Parameters:
serviced
- Estimated date or dates of service- Returns:
- A reference to this Builder instance
- See Also:
serviced(Element)
-
serviced
public CoverageEligibilityResponse.Builder serviced(Element serviced)
The date or dates when the enclosed suite of services were performed or completed.This is a choice element with the following allowed types:
- Parameters:
serviced
- Estimated date or dates of service- Returns:
- A reference to this Builder instance
-
created
public CoverageEligibilityResponse.Builder created(DateTime created)
The date this resource was created.This element is required.
- Parameters:
created
- Response creation date- Returns:
- A reference to this Builder instance
-
requestor
public CoverageEligibilityResponse.Builder requestor(Reference requestor)
The provider which is responsible for the request.Allowed resource types for this reference:
- Parameters:
requestor
- Party responsible for the request- Returns:
- A reference to this Builder instance
-
request
public CoverageEligibilityResponse.Builder request(Reference request)
Reference to the original request resource.This element is required.
Allowed resource types for this reference:
- Parameters:
request
- Eligibility request reference- Returns:
- A reference to this Builder instance
-
outcome
public CoverageEligibilityResponse.Builder outcome(RemittanceOutcome outcome)
The outcome of the request processing.This element is required.
- Parameters:
outcome
- queued | complete | error | partial- Returns:
- A reference to this Builder instance
-
disposition
public CoverageEligibilityResponse.Builder disposition(java.lang.String disposition)
Convenience method for settingdisposition
.- Parameters:
disposition
- Disposition Message- Returns:
- A reference to this Builder instance
- See Also:
disposition(org.linuxforhealth.fhir.model.type.String)
-
disposition
public CoverageEligibilityResponse.Builder disposition(String disposition)
A human readable description of the status of the adjudication.- Parameters:
disposition
- Disposition Message- Returns:
- A reference to this Builder instance
-
insurer
public CoverageEligibilityResponse.Builder insurer(Reference insurer)
The Insurer who issued the coverage in question and is the author of the response.This element is required.
Allowed resource types for this reference:
- Parameters:
insurer
- Coverage issuer- Returns:
- A reference to this Builder instance
-
insurance
public CoverageEligibilityResponse.Builder insurance(CoverageEligibilityResponse.Insurance... insurance)
Financial instruments for reimbursement for the health care products and services.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
insurance
- Patient insurance information- Returns:
- A reference to this Builder instance
-
insurance
public CoverageEligibilityResponse.Builder insurance(java.util.Collection<CoverageEligibilityResponse.Insurance> insurance)
Financial instruments for reimbursement for the health care products and services.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
insurance
- Patient insurance information- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
preAuthRef
public CoverageEligibilityResponse.Builder preAuthRef(java.lang.String preAuthRef)
Convenience method for settingpreAuthRef
.- Parameters:
preAuthRef
- Preauthorization reference- Returns:
- A reference to this Builder instance
- See Also:
preAuthRef(org.linuxforhealth.fhir.model.type.String)
-
preAuthRef
public CoverageEligibilityResponse.Builder preAuthRef(String preAuthRef)
A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.- Parameters:
preAuthRef
- Preauthorization reference- Returns:
- A reference to this Builder instance
-
form
public CoverageEligibilityResponse.Builder form(CodeableConcept form)
A code for the form to be used for printing the content.- Parameters:
form
- Printed form identifier- Returns:
- A reference to this Builder instance
-
error
public CoverageEligibilityResponse.Builder error(CoverageEligibilityResponse.Error... error)
Errors encountered during the processing of the request.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
error
- Processing errors- Returns:
- A reference to this Builder instance
-
error
public CoverageEligibilityResponse.Builder error(java.util.Collection<CoverageEligibilityResponse.Error> error)
Errors encountered during the processing of the request.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
error
- Processing errors- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public CoverageEligibilityResponse build()
Build theCoverageEligibilityResponse
Required elements:
- status
- purpose
- patient
- created
- request
- outcome
- insurer
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
CoverageEligibilityResponse
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid CoverageEligibilityResponse per the base specification
-
validate
protected void validate(CoverageEligibilityResponse coverageEligibilityResponse)
-
from
protected CoverageEligibilityResponse.Builder from(CoverageEligibilityResponse coverageEligibilityResponse)
-
-