Skip to main content


class HS.FHIR.DTL.vR4.Model.Element.CompartmentDefinition.resource extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

How a resource is related to the compartment.

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 = CompartmentDefinition.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 = CompartmentDefinition.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 code as %String (MAXLEN = 1000000, XMLNAME = "code", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Name of resource type.

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

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property documentation as %String (MAXLEN = 1000000, XMLNAME = "documentation", XMLPROJECTION = "ATTRIBUTE");

Additional documentation about the resource and compartment.

Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property param as list of %String (MAXLEN = 1000000, XMLNAME = "param", XMLPROJECTION = "ELEMENT");

Search Parameter Name, or chained parameters.

Property methods: paramBuildValueArray(), paramCollectionToDisplay(), paramCollectionToOdbc(), paramDisplayToCollection(), paramDisplayToLogical(), paramGet(), paramGetObject(), paramGetObjectId(), paramGetSwizzled(), paramIsValid(), paramLogicalToDisplay(), paramLogicalToOdbc(), paramNormalize(), paramOdbcToCollection(), paramSet(), paramSetObject(), paramSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab