Skip to main content


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

Details of a Health Insurance product/plan provided by an organization.

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

Product administrator.


Property methods: administeredByGet(), administeredByGetSwizzled(), administeredByIsValid(), administeredByNewObject(), administeredBySet()
property alias as list of %String (MAXLEN = 1000000, XMLNAME = "alias", XMLPROJECTION = "ELEMENT");

Alternate names.

Property methods: aliasBuildValueArray(), aliasCollectionToDisplay(), aliasCollectionToOdbc(), aliasDisplayToCollection(), aliasDisplayToLogical(), aliasGet(), aliasGetObject(), aliasGetObjectId(), aliasGetSwizzled(), aliasIsValid(), aliasLogicalToDisplay(), aliasLogicalToOdbc(), aliasNormalize(), aliasOdbcToCollection(), aliasSet(), aliasSetObject(), aliasSetObjectId()
property contact as list of (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact for the product.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property coverage as list of HS.FHIR.DTL.vR4.Model.Element.InsurancePlan.coverage (XMLNAME = "coverage", XMLPROJECTION = "ELEMENT");

Coverage details.

Property methods: coverageBuildValueArray(), coverageCollectionToDisplay(), coverageCollectionToOdbc(), coverageDisplayToCollection(), coverageGet(), coverageGetObject(), coverageGetObjectId(), coverageGetSwizzled(), coverageIsValid(), coverageOdbcToCollection(), coverageSet(), coverageSetObject(), coverageSetObjectId()
property coverageArea as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "coverageArea", XMLPROJECTION = "ELEMENT");

Where product applies.


Property methods: coverageAreaBuildValueArray(), coverageAreaCollectionToDisplay(), coverageAreaCollectionToOdbc(), coverageAreaDisplayToCollection(), coverageAreaGet(), coverageAreaGetObject(), coverageAreaGetObjectId(), coverageAreaGetSwizzled(), coverageAreaIsValid(), coverageAreaOdbcToCollection(), coverageAreaSet(), coverageAreaSetObject(), coverageAreaSetObjectId()
property endpoint as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");

Technical endpoint.


Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for Product.

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

Official name.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property network as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "network", XMLPROJECTION = "ELEMENT");

What networks are Included.


Property methods: networkBuildValueArray(), networkCollectionToDisplay(), networkCollectionToOdbc(), networkDisplayToCollection(), networkGet(), networkGetObject(), networkGetObjectId(), networkGetSwizzled(), networkIsValid(), networkOdbcToCollection(), networkSet(), networkSetObject(), networkSetObjectId()
property ownedBy as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "ownedBy", XMLPROJECTION = "ELEMENT");

Plan issuer.


Property methods: ownedByGet(), ownedByGetSwizzled(), ownedByIsValid(), ownedByNewObject(), ownedBySet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

When the product is available.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property plan as list of HS.FHIR.DTL.vR4.Model.Element.InsurancePlan.plan (XMLNAME = "plan", XMLPROJECTION = "ELEMENT");

Plan details.

Property methods: planBuildValueArray(), planCollectionToDisplay(), planCollectionToOdbc(), planDisplayToCollection(), planGet(), planGetObject(), planGetObjectId(), planGetSwizzled(), planIsValid(), planOdbcToCollection(), planSet(), planSetObject(), planSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

draft | active | retired | unknown

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property type as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Kind of product.

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

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab