Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.Coverage

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

Financial instrument which may be used to reimburse or pay for health care products and services.

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 = 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 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 = Coverage;
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 beneficiary as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "beneficiary", XMLPROJECTION = "ELEMENT");
Reference

Plan Beneficiary.

Patient

Property methods: beneficiaryGet(), beneficiaryGetSwizzled(), beneficiaryIsValid(), beneficiaryNewObject(), beneficiarySet()
property contract as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "contract", XMLPROJECTION = "ELEMENT");
Reference

Contract details.

Contract

Property methods: contractBuildValueArray(), contractCollectionToDisplay(), contractCollectionToOdbc(), contractDisplayToCollection(), contractGet(), contractGetObject(), contractGetObjectId(), contractGetSwizzled(), contractIsValid(), contractOdbcToCollection(), contractSet(), contractSetObject(), contractSetObjectId()
property dependent as %String (MAXLEN = 1000000, XMLNAME = "dependent", XMLPROJECTION = "ATTRIBUTE");
string

Dependent number.

Property methods: dependentDisplayToLogical(), dependentGet(), dependentIsValid(), dependentLogicalToDisplay(), dependentLogicalToOdbc(), dependentNormalize(), dependentSet()
property grouping as HS.FHIR.DTL.vSTU3.Model.Element.Coverage.grouping (XMLNAME = "grouping", XMLPROJECTION = "ELEMENT");
BackboneElement

Additional coverage classifications.

Property methods: groupingGet(), groupingGetSwizzled(), groupingIsValid(), groupingNewObject(), groupingSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

The primary coverage ID.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property network as %String (MAXLEN = 1000000, XMLNAME = "network", XMLPROJECTION = "ATTRIBUTE");
string

Insurer network.

Property methods: networkDisplayToLogical(), networkGet(), networkIsValid(), networkLogicalToDisplay(), networkLogicalToOdbc(), networkNormalize(), networkSet()
property order as %Integer (XMLNAME = "order", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Relative order of the coverage.

Property methods: orderDisplayToLogical(), orderGet(), orderIsValid(), orderLogicalToDisplay(), orderNormalize(), orderSet(), orderXSDToLogical()
property payor as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "payor", XMLPROJECTION = "ELEMENT");
Reference

Identifier for the plan or agreement issuer.

Organization | Patient | RelatedPerson

Property methods: payorBuildValueArray(), payorCollectionToDisplay(), payorCollectionToOdbc(), payorDisplayToCollection(), payorGet(), payorGetObject(), payorGetObjectId(), payorGetSwizzled(), payorIsValid(), payorOdbcToCollection(), payorSet(), payorSetObject(), payorSetObjectId()
property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Coverage start and end dates.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property policyHolder as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "policyHolder", XMLPROJECTION = "ELEMENT");
Reference

Owner of the policy.

Patient | RelatedPerson | Organization

Property methods: policyHolderGet(), policyHolderGetSwizzled(), policyHolderIsValid(), policyHolderNewObject(), policyHolderSet()
property relationship as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "relationship", XMLPROJECTION = "ELEMENT");
CodeableConcept

Beneficiary relationship to the Subscriber.

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

Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property sequence as %String (MAXLEN = 1000000, XMLNAME = "sequence", XMLPROJECTION = "ATTRIBUTE");
string

The plan instance or sequence counter.

Property methods: sequenceDisplayToLogical(), sequenceGet(), sequenceIsValid(), sequenceLogicalToDisplay(), sequenceLogicalToOdbc(), sequenceNormalize(), sequenceSet()
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()
property subscriber as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subscriber", XMLPROJECTION = "ELEMENT");
Reference

Subscriber to the policy.

Patient | RelatedPerson

Property methods: subscriberGet(), subscriberGetSwizzled(), subscriberIdDisplayToLogical(), subscriberIdGet(), subscriberIdIsValid(), subscriberIdLogicalToDisplay(), subscriberIdLogicalToOdbc(), subscriberIdNormalize(), subscriberIdSet(), subscriberIsValid(), subscriberNewObject(), subscriberSet()
property subscriberId as %String (MAXLEN = 1000000, XMLNAME = "subscriberId", XMLPROJECTION = "ATTRIBUTE");
string

ID assigned to the Subscriber.

Property methods: subscriberIdDisplayToLogical(), subscriberIdGet(), subscriberIdIsValid(), subscriberIdLogicalToDisplay(), subscriberIdLogicalToOdbc(), subscriberIdNormalize(), subscriberIdSet()
property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of coverage such as medical or accident.

coverage-type is the PREFERRED FHIR3 ValueSet for codes, but if you need to express meanings not found in coverage-type, you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab