Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.CoverageEligibilityResponse

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

CoverageEligibilityResponse resource.

Property Inventory

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 = CoverageEligibilityResponse;
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 = CoverageEligibilityResponse;
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 %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Response creation date.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property disposition as %String (MAXLEN = 1000000, XMLNAME = "disposition", XMLPROJECTION = "ATTRIBUTE");
string

Disposition Message.

Property methods: dispositionDisplayToLogical(), dispositionGet(), dispositionIsValid(), dispositionLogicalToDisplay(), dispositionLogicalToOdbc(), dispositionNormalize(), dispositionSet()
property error as list of HS.FHIR.DTL.vR4.Model.Element.CoverageEligibilityResponse.error (XMLNAME = "error", XMLPROJECTION = "ELEMENT");
BackboneElement

Processing errors.

Property methods: errorBuildValueArray(), errorCollectionToDisplay(), errorCollectionToOdbc(), errorDisplayToCollection(), errorGet(), errorGetObject(), errorGetObjectId(), errorGetSwizzled(), errorIsValid(), errorOdbcToCollection(), errorSet(), errorSetObject(), errorSetObjectId()
property form as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "form", XMLPROJECTION = "ELEMENT");
CodeableConcept

Printed form identifier.

any FHIR4 code may be used; forms shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: formGet(), formGetSwizzled(), formIsValid(), formNewObject(), formSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

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 HS.FHIR.DTL.vR4.Model.Element.CoverageEligibilityResponse.insurance (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
BackboneElement

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 ];
Reference

Coverage issuer.

Organization

Property methods: insurerGet(), insurerGetSwizzled(), insurerIsValid(), insurerNewObject(), insurerSet()
property outcome as %String (MAXLEN = 1000000, XMLNAME = "outcome", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

queued | complete | error | partial

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

Property methods: outcomeDisplayToLogical(), outcomeGet(), outcomeIsValid(), outcomeLogicalToDisplay(), outcomeLogicalToOdbc(), outcomeNormalize(), outcomeSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Intended recipient of products and services.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property preAuthRef as %String (MAXLEN = 1000000, XMLNAME = "preAuthRef", XMLPROJECTION = "ATTRIBUTE");
string

Preauthorization reference.

Property methods: preAuthRefDisplayToLogical(), preAuthRefGet(), preAuthRefIsValid(), preAuthRefLogicalToDisplay(), preAuthRefLogicalToOdbc(), preAuthRefNormalize(), preAuthRefSet()
property purpose as list of %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ELEMENT") [ Required ];
code

auth-requirements | benefits | discovery | validation

eligibilityresponse-purpose|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend eligibilityresponse-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 request as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Eligibility request reference.

CoverageEligibilityRequest

Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestSet()
property requestor as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requestor", XMLPROJECTION = "ELEMENT");
Reference

Party responsible for the request.

Practitioner | PractitionerRole | Organization

Property methods: requestorGet(), requestorGetSwizzled(), requestorIsValid(), requestorNewObject(), requestorSet()
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.vR4.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") [ Required ];
code

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()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab