Skip to main content

HS.FHIR.vSTU3.Model.Resource.Coverage

deprecated class HS.FHIR.vSTU3.Model.Resource.Coverage extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Financial instrument which may be used to reimburse or pay for health care products and services.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method 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 = Coverage;
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.

Properties

property beneficiary as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "beneficiary", XMLPROJECTION = "ELEMENT");
The party who benefits from the insurance coverage., the patient when services are provided.
Property methods: beneficiaryGet(), beneficiaryGetSwizzled(), beneficiaryIsValid(), beneficiaryNewObject(), beneficiarySet()
property contract as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "contract", XMLPROJECTION = "ELEMENT");
The policy(s) which constitute this insurance coverage.
Property methods: contractBuildValueArray(), contractCollectionToDisplay(), contractCollectionToOdbc(), contractDisplayToCollection(), contractGet(), contractGetObject(), contractGetObjectId(), contractGetSwizzled(), contractIsValid(), contractOdbcToCollection(), contractSet(), contractSetObject(), contractSetObjectId()
property dependent as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "dependent", XMLPROJECTION = "ELEMENT");
A unique identifier for a dependent under the coverage.
Property methods: dependentGet(), dependentGetSwizzled(), dependentIsValid(), dependentNewObject(), dependentSet()
property grouping as HS.FHIR.vSTU3.Model.Resource.Coverage.Grouping (XMLNAME = "grouping", XMLPROJECTION = "ELEMENT");
A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
Property methods: groupingGet(), groupingGetSwizzled(), groupingIsValid(), groupingNewObject(), groupingSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property network as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "network", XMLPROJECTION = "ELEMENT");
The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property order as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "order", XMLPROJECTION = "ELEMENT");
The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
Property methods: orderGet(), orderGetSwizzled(), orderIsValid(), orderNewObject(), orderSet()
property payor as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "payor", XMLPROJECTION = "ELEMENT");
The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
Property methods: payorBuildValueArray(), payorCollectionToDisplay(), payorCollectionToOdbc(), payorDisplayToCollection(), payorGet(), payorGetObject(), payorGetObjectId(), payorGetSwizzled(), payorIsValid(), payorOdbcToCollection(), payorSet(), payorSetObject(), payorSetObjectId()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property policyHolder as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "policyHolder", XMLPROJECTION = "ELEMENT");
The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.
Property methods: policyHolderGet(), policyHolderGetSwizzled(), policyHolderIsValid(), policyHolderNewObject(), policyHolderSet()
property relationship as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");
The relationship of beneficiary (patient) to the subscriber.
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property sequence as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "sequence", XMLPROJECTION = "ELEMENT");
An optional counter for a particular instance of the identified coverage which increments upon each renewal.
Property methods: sequenceGet(), sequenceGetSwizzled(), sequenceIsValid(), sequenceNewObject(), sequenceSet()
property status as HS.FHIR.vSTU3.Model.Base.FinancialResourceStatusCodes (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
The status of the resource instance.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subscriber as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subscriber", XMLPROJECTION = "ELEMENT");
The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
Property methods: subscriberGet(), subscriberGetSwizzled(), subscriberIdGet(), subscriberIdGetSwizzled(), subscriberIdIsValid(), subscriberIdNewObject(), subscriberIdSet(), subscriberIsValid(), subscriberNewObject(), subscriberSet()
property subscriberId as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "subscriberId", XMLPROJECTION = "ELEMENT");
The insurer assigned ID for the Subscriber.
Property methods: subscriberIdGet(), subscriberIdGetSwizzled(), subscriberIdIsValid(), subscriberIdNewObject(), subscriberIdSet()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetBeneficiary(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "beneficiary" property.
deprecated method SetContract(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "contract" property.
deprecated method SetDependent(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "dependent" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetNetwork(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "network" property.
deprecated method SetOrder(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "order" property.
deprecated method SetPayor(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "payor" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPolicyHolder(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "policyHolder" property.
deprecated method SetRelationship(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "relationship" property.
deprecated method SetSequence(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "sequence" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubscriber(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subscriber" property.
deprecated method SetSubscriberId(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subscriberId" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab