HS.FHIRModel.R4.Coverage
class HS.FHIRModel.R4.Coverage extends HS.FHIRModel.FHIRClassSuper
******************************************* Coverage generated class schema
*****************************************
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Property Inventory
- _dependent
- _implicitRules
- _language
- _network
- _order
- _status
- _subrogation
- _subscriberId
- beneficiary
- class
- contained
- contract
- costToBeneficiary
- dependent
- extension
- fhirID
- identifier
- implicitRules
- language
- meta
- modifierExtension
- network
- order
- payor
- period
- policyHolder
- relationship
- resourceType
- status
- subrogation
- subscriber
- subscriberId
- text
- type
Method Inventory
- IncludeBeneficiary()
- IncludeClass()
- IncludeContained()
- IncludeContract()
- IncludeCostToBeneficiary()
- IncludeExtension()
- IncludeIdentifier()
- IncludeMeta()
- IncludeModifierExtension()
- IncludePayor()
- IncludePeriod()
- IncludePolicyHolder()
- IncludeRelationship()
- IncludeSubscriber()
- IncludeText()
- IncludeType()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 _dependent as HS.FHIRModel.R4.Element;
Extensions for dependent
Property methods: _dependentGet(), _dependentGetSwizzled(), _dependentIsValid(), _dependentNewObject(), _dependentSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _network as HS.FHIRModel.R4.Element;
Extensions for network
Property methods: _networkGet(), _networkGetSwizzled(), _networkIsValid(), _networkNewObject(), _networkSet()
property _order as HS.FHIRModel.R4.Element;
Extensions for order
Property methods: _orderGet(), _orderGetSwizzled(), _orderIsValid(), _orderNewObject(), _orderSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _subrogation as HS.FHIRModel.R4.Element;
Extensions for subrogation
Property methods: _subrogationGet(), _subrogationGetSwizzled(), _subrogationIsValid(), _subrogationNewObject(), _subrogationSet()
property _subscriberId as HS.FHIRModel.R4.Element;
Extensions for subscriberId
Property methods: _subscriberIdGet(), _subscriberIdGetSwizzled(), _subscriberIdIsValid(), _subscriberIdNewObject(), _subscriberIdSet()
property beneficiary as HS.FHIRModel.R4.Reference [ Required ];
The party who benefits from the insurance coverage; the patient when
products and/or services are provided.
Property methods: beneficiaryGet(), beneficiaryGetSwizzled(), beneficiaryIsValid(), beneficiaryNewObject(), beneficiarySet()
property class as HS.FHIRModel.R4.CoverageX.SeqOfCoverageXClass;
A suite of underwriter specific classifiers.
Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property contract as HS.FHIRModel.R4.SeqOfReference;
The policy(s) which constitute this insurance coverage.
Property methods: contractGet(), contractGetSwizzled(), contractIsValid(), contractNewObject(), contractSet()
property costToBeneficiary as HS.FHIRModel.R4.CoverageX.SeqOfCoverageXCostToBeneficiary;
A suite of codes indicating the cost category and associated amount
which have been detailed in the policy and may have been included
on the health card.
Property methods: costToBeneficiaryGet(), costToBeneficiaryGetSwizzled(), costToBeneficiaryIsValid(), costToBeneficiaryNewObject(), costToBeneficiarySet()
property dependent as %String;
A unique identifier for a dependent under the coverage.
Property methods: dependentDisplayToLogical(), dependentGet(), dependentIsValid(), dependentLogicalToDisplay(), dependentLogicalToOdbc(), dependentNormalize(), dependentSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A unique identifier assigned to this coverage.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property network as %String;
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: networkDisplayToLogical(), networkGet(), networkIsValid(), networkLogicalToDisplay(), networkLogicalToOdbc(), networkNormalize(), networkSet()
property order as %Integer;
The order of applicability of this coverage relative to other coverages
which are currently in force. Note, there may be gaps in the numbering
and this does not imply primary, secondary etc. as the specific
positioning of coverages depends upon the episode of care.
Property methods: orderDisplayToLogical(), orderGet(), orderIsValid(), orderLogicalToDisplay(), orderNormalize(), orderSet(), orderXSDToLogical()
property payor as HS.FHIRModel.R4.SeqOfReference [ Required ];
The program or plan underwriter or payor including both insurance
and non-insurance agreements, such as patient-pay agreements.
Property methods: payorGet(), payorGetSwizzled(), payorIsValid(), payorNewObject(), payorSet()
property period as HS.FHIRModel.R4.Period;
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.FHIRModel.R4.Reference;
The party who 'owns' the insurance policy.
Property methods: policyHolderGet(), policyHolderGetSwizzled(), policyHolderIsValid(), policyHolderNewObject(), policyHolderSet()
property relationship as HS.FHIRModel.R4.CodeableConcept;
The relationship of beneficiary (patient) to the subscriber.
Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
property resourceType as %String [ InitialExpression = "Coverage" , Required ];
This is a Coverage resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
The status of the resource instance.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subrogation as %Boolean;
When 'subrogation=true' this insurance instance has been included
not for adjudication but to provide insurers with the details to
recover costs.
Property methods: subrogationDisplayToLogical(), subrogationGet(), subrogationIsValid(), subrogationLogicalToDisplay(), subrogationLogicalToXSD(), subrogationNormalize(), subrogationSet(), subrogationXSDToLogical()
property subscriber as HS.FHIRModel.R4.Reference;
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(), subscriberIsValid(), subscriberNewObject(), subscriberSet()
property subscriberId as %String;
The insurer assigned ID for the Subscriber.
Property methods: subscriberIdDisplayToLogical(), subscriberIdGet(), subscriberIdIsValid(), subscriberIdLogicalToDisplay(), subscriberIdLogicalToOdbc(), subscriberIdNormalize(), subscriberIdSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIRModel.R4.CodeableConcept;
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
method IncludeBeneficiary()
method IncludeClass()
method IncludeContained()
method IncludeContract()
method IncludeCostToBeneficiary()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludePayor()
method IncludePeriod()
method IncludePolicyHolder()
method IncludeRelationship()
method IncludeSubscriber()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Coverage
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()