Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

HS.FHIR.DTL.vSTU3.Model.Resource.EligibilityRequest

class HS.FHIR.DTL.vSTU3.Model.Resource.EligibilityRequest extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

The EligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an EligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

Property Inventory

benefitCategory
benefitSubCategory
businessArrangement
coverage
created
enterer
facility
identifier
insurer
organization
patient
priority
provider
servicedDate
servicedPeriod
status

Parameters

parameter ELEMENTQUALIFIED = 1;

Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = EligibilityRequest;

Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

parameter XMLPROJECTION = ELEMENT;

parameter XMLSEQUENCE = 1;

Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

parameter XMLTYPE = EligibilityRequest;

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 benefitCategory as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "benefitCategory", XMLPROJECTION = "ELEMENT");

CodeableConcept

Type of services covered.

any FHIR3 code may be used; benefit-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: benefitCategoryGet(), benefitCategoryGetSwizzled(), benefitCategoryIsValid(), benefitCategoryNewObject(), benefitCategorySet()

property benefitSubCategory as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "benefitSubCategory", XMLPROJECTION = "ELEMENT");

CodeableConcept

Detailed services covered within the type.

any FHIR3 code may be used; benefit-subcategory shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: benefitSubCategoryGet(), benefitSubCategoryGetSwizzled(), benefitSubCategoryIsValid(), benefitSubCategoryNewObject(), benefitSubCategorySet()

property businessArrangement as %String (MAXLEN = 1000000, XMLNAME = "businessArrangement", XMLPROJECTION = "ATTRIBUTE");

string

Business agreement.

Property methods: businessArrangementDisplayToLogical(), businessArrangementGet(), businessArrangementIsValid(), businessArrangementLogicalToDisplay(), businessArrangementLogicalToOdbc(), businessArrangementNormalize(), businessArrangementSet()

property coverage as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "coverage", XMLPROJECTION = "ELEMENT");

Reference

Insurance or medical plan.

Coverage

Property methods: coverageGet(), coverageGetSwizzled(), coverageIsValid(), coverageNewObject(), coverageSet()

property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");

dateTime

Creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()

property enterer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");

Reference

Author.

Practitioner

Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()

property facility as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "facility", XMLPROJECTION = "ELEMENT");

Reference

Servicing Facility.

Location

Property methods: facilityGet(), facilityGetSwizzled(), facilityIsValid(), facilityNewObject(), facilitySet()

property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

Business Identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()

property insurer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "insurer", XMLPROJECTION = "ELEMENT");

Reference

Target.

Organization

Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()

property organization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");

Reference

Responsible organization.

Organization

Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()

property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");

Reference

The subject of the Products and Services.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()

property priority as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");

CodeableConcept

Desired processing priority.

any FHIR3 code may be used; process-priority shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()

property provider as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT");

Reference

Responsible practitioner.

Practitioner

Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()

property servicedDate as %String (MAXLEN = 1000000, XMLNAME = "servicedDate", XMLPROJECTION = "ATTRIBUTE");

date

Estimated date or dates of Service.

Property methods: servicedDateDisplayToLogical(), servicedDateGet(), servicedDateIsValid(), servicedDateLogicalToDisplay(), servicedDateLogicalToOdbc(), servicedDateNormalize(), servicedDateSet()

property servicedPeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "servicedPeriod", XMLPROJECTION = "ELEMENT");

Period

Estimated date or dates of Service.

Property methods: servicedPeriodGet(), servicedPeriodGetSwizzled(), servicedPeriodIsValid(), servicedPeriodNewObject(), servicedPeriodSet()

property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

code

active | cancelled | draft | entered-in-error

fm-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend fm-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

Feedback