Skip to main content

HS.FHIR.DTL.vR4.Model.Datatype.ParameterDefinition

class HS.FHIR.DTL.vR4.Model.Datatype.ParameterDefinition extends HS.FHIR.DTL.vR4.Model.Base.Element

Definition of a parameter to a module.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 = ParameterDefinition;
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 XMLPROJECTION = ELEMENT;
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 = ParameterDefinition;
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 documentation as %String (MAXLEN = 1000000, XMLNAME = "documentation", XMLPROJECTION = "ATTRIBUTE");
string

A brief description of the parameter.

Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property max as %String (MAXLEN = 1000000, XMLNAME = "max", XMLPROJECTION = "ATTRIBUTE");
string

Maximum cardinality (a number of *)

Property methods: maxDisplayToLogical(), maxGet(), maxIsValid(), maxLogicalToDisplay(), maxLogicalToOdbc(), maxNormalize(), maxSet()
property min as %Integer (XMLNAME = "min", XMLPROJECTION = "ATTRIBUTE");
integer

Minimum cardinality.

Property methods: minDisplayToLogical(), minGet(), minIsValid(), minLogicalToDisplay(), minNormalize(), minSet(), minXSDToLogical()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
code

Name used to access the parameter value.

any FHIR4 code from any ValueSet may be used.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property profile as %String (MAXLEN = 1000000, XMLNAME = "profile", XMLPROJECTION = "ATTRIBUTE");
canonical

What profile the value is expected to be.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: profileDisplayToLogical(), profileGet(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

What type of value.

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

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property use as %String (MAXLEN = 1000000, XMLNAME = "use", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

in | out

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

Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab