Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.CoverageEligibilityRequest extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

CoverageEligibilityRequest resource.

Property Inventory


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 = CoverageEligibilityRequest;
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 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 = 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.


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

Creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property enterer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");


Practitioner | PractitionerRole

Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property facility as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "facility", XMLPROJECTION = "ELEMENT");

Servicing facility.


Property methods: facilityGet(), facilityGetSwizzled(), facilityIsValid(), facilityNewObject(), facilitySet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for coverage eligiblity request.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property insurance as list of (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");

Patient insurance information.

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property insurer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurer", XMLPROJECTION = "ELEMENT") [ Required ];

Coverage issuer.


Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property item as list of HS.FHIR.DTL.vR4.Model.Element.CoverageEligibilityRequest.item (XMLNAME = "item", XMLPROJECTION = "ELEMENT");

Item to be evaluated for eligibiity.

Property methods: itemBuildValueArray(), itemCollectionToDisplay(), itemCollectionToOdbc(), itemDisplayToCollection(), itemGet(), itemGetObject(), itemGetObjectId(), itemGetSwizzled(), itemIsValid(), itemOdbcToCollection(), itemSet(), itemSetObject(), itemSetObjectId()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

Intended recipient of products and services.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property priority as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");

Desired processing priority.

any FHIR4 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.vR4.Model.Base.Reference (XMLNAME = "provider", XMLPROJECTION = "ELEMENT");

Party responsible for the request.

Practitioner | PractitionerRole | Organization

Property methods: providerGet(), providerGetSwizzled(), providerIsValid(), providerNewObject(), providerSet()
property purpose as list of %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ELEMENT") [ Required ];

auth-requirements | benefits | discovery | validation

eligibilityrequest-purpose|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend eligibilityrequest-purpose|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: purposeBuildValueArray(), purposeCollectionToDisplay(), purposeCollectionToOdbc(), purposeDisplayToCollection(), purposeDisplayToLogical(), purposeGet(), purposeGetObject(), purposeGetObjectId(), purposeGetSwizzled(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeOdbcToCollection(), purposeSet(), purposeSetObject(), purposeSetObjectId()
property servicedDate as %String (MAXLEN = 1000000, XMLNAME = "servicedDate", XMLPROJECTION = "ATTRIBUTE");

Estimated date or dates of service.

Property methods: servicedDateDisplayToLogical(), servicedDateGet(), servicedDateIsValid(), servicedDateLogicalToDisplay(), servicedDateLogicalToOdbc(), servicedDateNormalize(), servicedDateSet()
property servicedPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "servicedPeriod", XMLPROJECTION = "ELEMENT");

Estimated date or dates of service.

Property methods: servicedPeriodGet(), servicedPeriodGetSwizzled(), servicedPeriodIsValid(), servicedPeriodNewObject(), servicedPeriodSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

active | cancelled | draft | entered-in-error

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supportingInfo as list of HS.FHIR.DTL.vR4.Model.Element.CoverageEligibilityRequest.supportingInfo (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");

Supporting information.

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab