Skip to main content

HS.FHIR.vSTU3.Model.Base.ParameterDefinition

deprecated class HS.FHIR.vSTU3.Model.Base.ParameterDefinition extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
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 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.

Properties

property documentation as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
A brief discussion of what the parameter is for and how it is used by the module.
Property methods: documentationGet(), documentationGetSwizzled(), documentationIsValid(), documentationNewObject(), documentationSet()
property max as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "max", XMLPROJECTION = "ELEMENT");
The maximum number of times this element is permitted to appear in the request or response.
Property methods: maxGet(), maxGetSwizzled(), maxIsValid(), maxNewObject(), maxSet()
property min as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "min", XMLPROJECTION = "ELEMENT");
The minimum number of times this parameter SHALL appear in the request or response.
Property methods: minGet(), minGetSwizzled(), minIsValid(), minNewObject(), minSet()
property name as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property profile as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "profile", XMLPROJECTION = "ELEMENT");
If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Property methods: profileGet(), profileGetSwizzled(), profileIsValid(), profileNewObject(), profileSet()
property type as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type of the parameter.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property use as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "use", XMLPROJECTION = "ELEMENT") [ Required ];
Whether the parameter is input or output for the module.
Property methods: useGet(), useGetSwizzled(), useIsValid(), useNewObject(), useSet()

Methods

deprecated method SetDocumentation(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "documentation" property.
deprecated method SetMax(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "max" property.
deprecated method SetMin(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "min" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetProfile(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "profile" property.
deprecated method SetType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.
deprecated method SetUse(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "use" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab