Skip to main content


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

Insurance or medical plan or a payment agreement.

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


property beneficiary as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "beneficiary", XMLPROJECTION = "ELEMENT") [ Required ];

Plan beneficiary.


Property methods: beneficiaryGet(), beneficiaryGetSwizzled(), beneficiaryIsValid(), beneficiaryNewObject(), beneficiarySet()
property class as list of HS.FHIR.DTL.vR4.Model.Element.Coverage.class (XMLNAME = "class", XMLPROJECTION = "ELEMENT");

Additional coverage classifications.

Property methods: classBuildValueArray(), classCollectionToDisplay(), classCollectionToOdbc(), classDisplayToCollection(), classGet(), classGetObject(), classGetObjectId(), classGetSwizzled(), classIsValid(), classOdbcToCollection(), classSet(), classSetObject(), classSetObjectId()
property contract as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "contract", XMLPROJECTION = "ELEMENT");

Contract details.


Property methods: contractBuildValueArray(), contractCollectionToDisplay(), contractCollectionToOdbc(), contractDisplayToCollection(), contractGet(), contractGetObject(), contractGetObjectId(), contractGetSwizzled(), contractIsValid(), contractOdbcToCollection(), contractSet(), contractSetObject(), contractSetObjectId()
property costToBeneficiary as list of HS.FHIR.DTL.vR4.Model.Element.Coverage.costToBeneficiary (XMLNAME = "costToBeneficiary", XMLPROJECTION = "ELEMENT");

Patient payments for services/products.

Property methods: costToBeneficiaryBuildValueArray(), costToBeneficiaryCollectionToDisplay(), costToBeneficiaryCollectionToOdbc(), costToBeneficiaryDisplayToCollection(), costToBeneficiaryGet(), costToBeneficiaryGetObject(), costToBeneficiaryGetObjectId(), costToBeneficiaryGetSwizzled(), costToBeneficiaryIsValid(), costToBeneficiaryOdbcToCollection(), costToBeneficiarySet(), costToBeneficiarySetObject(), costToBeneficiarySetObjectId()
property dependent as %String (MAXLEN = 1000000, XMLNAME = "dependent", XMLPROJECTION = "ATTRIBUTE");

Dependent number.

Property methods: dependentDisplayToLogical(), dependentGet(), dependentIsValid(), dependentLogicalToDisplay(), dependentLogicalToOdbc(), dependentNormalize(), dependentSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for the coverage.

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");

Insurer network.

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

Relative order of the coverage.

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

Issuer of the policy.

Organization | Patient | RelatedPerson

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

Coverage start and end dates.

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

Owner of the policy.

Patient | RelatedPerson | Organization

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

Beneficiary relationship to the subscriber.

subscriber-relationship is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in subscriber-relationship, you may formally EXTEND subscriber-relationship to add codes to it.

Property methods: relationshipGet(), relationshipGetSwizzled(), relationshipIsValid(), relationshipNewObject(), relationshipSet()
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 subrogation as %Boolean (XMLNAME = "subrogation", XMLPROJECTION = "ATTRIBUTE");

Reimbursement to insurer.

Property methods: subrogationDisplayToLogical(), subrogationGet(), subrogationIsValid(), subrogationLogicalToDisplay(), subrogationLogicalToXSD(), subrogationNormalize(), subrogationSet(), subrogationXSDToLogical()
property subscriber as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subscriber", XMLPROJECTION = "ELEMENT");

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");

ID assigned to the subscriber.

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

Coverage category such as medical or accident.

coverage-type is the PREFERRED FHIR4 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