Skip to main content

HS.FHIRModel.R4.OperationDefinitionX.Parameter

class HS.FHIRModel.R4.OperationDefinitionX.Parameter extends HS.FHIRModel.FHIRClassSuper

*****************************************
** OperationDefinitionX.Parameter generated class schema
*****************************************
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_OPERATIONDEFINITIONX_PARAMETER;
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 _searchType as HS.FHIRModel.R4.Element;
Extensions for searchType
Property methods: _searchTypeGet(), _searchTypeGetSwizzled(), _searchTypeIsValid(), _searchTypeNewObject(), _searchTypeSet()
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()
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
Property methods: bindingGet(), bindingGetSwizzled(), bindingIsValid(), bindingNewObject(), bindingSet()
property documentation as %String;
Describes the meaning or use of this parameter.
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 modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
The name of used to identify the parameter.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
The parts of a nested Parameter.
Property methods: partGet(), partGetSwizzled(), partIsValid(), partNewObject(), partSet()
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
Property methods: referencedFromGet(), referencedFromGetSwizzled(), referencedFromIsValid(), referencedFromNewObject(), referencedFromSet()
property searchType as %String (VALUELIST = ",number,date,string,token,reference,composite,quantity,uri,special");
How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
Property methods: searchTypeDisplayToLogical(), searchTypeGet(), searchTypeIsValid(), searchTypeLogicalToDisplay(), searchTypeLogicalToOdbc(), searchTypeNormalize(), searchTypeSet()
property targetProfile as HS.FHIRModel.R4.SeqOfString;
Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
Property methods: targetProfileGet(), targetProfileGetSwizzled(), targetProfileIsValid(), targetProfileNewObject(), targetProfileSet()
property type as %String;
The type for this parameter.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property use as %String (VALUELIST = ",in,out");
Whether this is an input or an output parameter.
Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Methods

method IncludeBinding()
method IncludeExtension()
method IncludeModifierExtension()
method IncludePart()
method IncludeReferencedFrom()
method IncludeTargetProfile()
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