Skip to main content

HS.FHIRModel.R4.CoverageEligibilityRequest

class HS.FHIRModel.R4.CoverageEligibilityRequest extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CoverageEligibilityRequest generated class schema
*****************************************
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_COVERAGEELIGIBILITYREQUEST;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _created as HS.FHIRModel.R4.Element;
Extensions for created
Property methods: _createdGet(), _createdGetSwizzled(), _createdIsValid(), _createdNewObject(), _createdSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _purpose as HS.FHIRModel.R4.SeqOfElement;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _servicedDate as HS.FHIRModel.R4.Element;
Extensions for servicedDate
Property methods: _servicedDateGet(), _servicedDateGetSwizzled(), _servicedDateIsValid(), _servicedDateNewObject(), _servicedDateSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property created as %String;
The date when this resource was created.
Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property enterer as HS.FHIRModel.R4.Reference;
Person who created the request.
Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property facility as HS.FHIRModel.R4.Reference;
Facility where the services are intended to be provided.
Property methods: facilityGet(), facilityGetSwizzled(), facilityIsValid(), facilityNewObject(), facilitySet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A unique identifier assigned to this coverage eligiblity request.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
Financial instruments for reimbursement for the health care products and services.
Property methods: insuranceGet(), insuranceGetSwizzled(), insuranceIsValid(), insuranceNewObject(), insuranceSet()
property insurer as HS.FHIRModel.R4.Reference [ Required ];
The Insurer who issued the coverage in question and is the recipient of the request.
Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.
Property methods: itemGet(), itemGetSwizzled(), itemIsValid(), itemNewObject(), itemSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property patient as HS.FHIRModel.R4.Reference [ Required ];
The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property priority as HS.FHIRModel.R4.CodeableConcept;
When the requestor expects the processor to complete processing.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property provider as HS.FHIRModel.R4.Reference;
The provider which is responsible for the request.
Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property purpose as %String (VALUELIST = ",auth-requirements,benefits,discovery,validation");
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.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resourceType as %String [ InitialExpression = "CoverageEligibilityRequest" , Required ];
This is a CoverageEligibilityRequest resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property servicedDate as %String;
The date or dates when the enclosed suite of services were performed or completed.
Property methods: servicedDateDisplayToLogical(), servicedDateGet(), servicedDateIsValid(), servicedDateLogicalToDisplay(), servicedDateLogicalToOdbc(), servicedDateNormalize(), servicedDateSet()
property servicedPeriod as HS.FHIRModel.R4.Period;
The date or dates when the enclosed suite of services were performed or completed.
Property methods: servicedPeriodGet(), servicedPeriodGetSwizzled(), servicedPeriodIsValid(), servicedPeriodNewObject(), servicedPeriodSet()
property status as %String;
The status of the resource instance.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
Property methods: supportingInfoGet(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoNewObject(), supportingInfoSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeContained()
method IncludeEnterer()
method IncludeExtension()
method IncludeFacility()
method IncludeIdentifier()
method IncludeInsurance()
method IncludeInsurer()
method IncludeItem()
method IncludeMeta()
method IncludeModifierExtension()
method IncludePatient()
method IncludePriority()
method IncludeProvider()
method IncludeServicedPeriod()
method IncludeSupportingInfo()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab