Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Base.Resource extends %Library.RegisteredObject, HS.FHIR.DTL.Util.XML.Adapter, HS.FHIR.DTL.Util.JSON.Adapter, %XML.Adaptor

The base definition for all resources.

Property Inventory

Method 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 = Resource;
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 = Resource;
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 id as %String (MAXLEN = 1000000, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");

Logical id of this artifact.

Property methods: idDisplayToLogical(), idGet(), idIsValid(), idLogicalToDisplay(), idLogicalToOdbc(), idNormalize(), idSet()
property implicitRules as %String (MAXLEN = 1000000, XMLNAME = "implicitRules", XMLPROJECTION = "ATTRIBUTE");

A set of rules under which this content was created.

Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String (MAXLEN = 1000000, XMLNAME = "language", XMLPROJECTION = "ATTRIBUTE");

Language of the resource content.

Language RFC 5646 is the REQUIRED IETF specification for the FHIR2 code values that may be used.

Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIR.DTL.vDSTU2.Model.Base.Meta (XMLNAME = "meta", XMLPROJECTION = "ELEMENT");

Metadata about the resource.

Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property newResource as list of HS.FHIR.DTL.vDSTU2.Model.Base.Resource;
Generated property, not a FHIR element: Storage space for 'contained' resources that are actually separate from the parent, and need to be serialized as separate objects.
Property methods: newResourceBuildValueArray(), newResourceCollectionToDisplay(), newResourceCollectionToOdbc(), newResourceDisplayToCollection(), newResourceGet(), newResourceGetObject(), newResourceGetObjectId(), newResourceGetSwizzled(), newResourceIsValid(), newResourceOdbcToCollection(), newResourceSet(), newResourceSetObject(), newResourceSetObjectId()
property newResourceReference as %String;
Generated property, not a FHIR element: Storage space for the location the corresponding newResource entry reference should be stored in after adding it to a repository
Property methods: newResourceReferenceDisplayToLogical(), newResourceReferenceGet(), newResourceReferenceIsValid(), newResourceReferenceLogicalToDisplay(), newResourceReferenceLogicalToOdbc(), newResourceReferenceNormalize(), newResourceReferenceSet()
property primitiveExtension as list of HS.FHIR.DTL.vDSTU2.Model.Base.Extension;
Generated property, not a FHIR element: Storage space for extensions of any elements that have a primitive data type.
Property methods: primitiveExtensionBuildValueArray(), primitiveExtensionCollectionToDisplay(), primitiveExtensionCollectionToOdbc(), primitiveExtensionDisplayToCollection(), primitiveExtensionGet(), primitiveExtensionGetObject(), primitiveExtensionGetObjectId(), primitiveExtensionGetSwizzled(), primitiveExtensionIsValid(), primitiveExtensionOdbcToCollection(), primitiveExtensionSet(), primitiveExtensionSetObject(), primitiveExtensionSetObjectId()
property resourceType as %String [ Calculated ];
Generated property, not a FHIR element: returns the resource type for the resource object.
Property methods: resourceTypeDisplayToLogical(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize()


method resourceTypeGet() as %String

Inherited Members

Inherited Methods


FeedbackOpens in a new tab