Skip to main content

HS.FHIRModel.R4.ParameterDefinition

class HS.FHIRModel.R4.ParameterDefinition extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ParameterDefinition generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 HS.FHIRModel.R4.Element;
Extensions for documentation
Property methods: _documentationGet(), _documentationGetSwizzled(), _documentationIsValid(), _documentationNewObject(), _documentationSet()
property _max as HS.FHIRModel.R4.Element;
Extensions for max
Property methods: _maxGet(), _maxGetSwizzled(), _maxIsValid(), _maxNewObject(), _maxSet()
property _min as HS.FHIRModel.R4.Element;
Extensions for min
Property methods: _minGet(), _minGetSwizzled(), _minIsValid(), _minNewObject(), _minSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _use as HS.FHIRModel.R4.Element;
Extensions for use
Property methods: _useGet(), _useGetSwizzled(), _useIsValid(), _useNewObject(), _useSet()
property documentation as %String;
A brief discussion of what the parameter is for and how it is used by the module.
Property methods: documentationDisplayToLogical(), documentationGet(), documentationIsValid(), documentationLogicalToDisplay(), documentationLogicalToOdbc(), documentationNormalize(), documentationSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property max as %String;
The maximum number of times this element is permitted to appear in the request or response.
Property methods: maxDisplayToLogical(), maxGet(), maxIsValid(), maxLogicalToDisplay(), maxLogicalToOdbc(), maxNormalize(), maxSet()
property min as %Integer;
The minimum number of times this parameter SHALL appear in the request or response.
Property methods: minDisplayToLogical(), minGet(), minIsValid(), minLogicalToDisplay(), minNormalize(), minSet(), minXSDToLogical()
property name as %String;
The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property profile as %String;
If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Property methods: profileDisplayToLogical(), profileGet(), profileIsValid(), profileLogicalToDisplay(), profileLogicalToOdbc(), profileNormalize(), profileSet()
property type as %String;
The type of the parameter.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property use as %String;
Whether the parameter is input or output for the module.
Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Methods

method IncludeExtension()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab