Skip to main content

HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter

class HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Parameters for the operation/query.

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 = OperationDefinition.parameter;
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 = OperationDefinition.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 binding as HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter.binding (XMLNAME = "binding", XMLPROJECTION = "ELEMENT");
BackboneElement

ValueSet details if this is coded.

Property methods: bindingGet(), bindingGetSwizzled(), bindingIsValid(), bindingNewObject(), bindingSet()
property documentation as %String (MAXLEN = 1000000, XMLNAME = "documentation", XMLPROJECTION = "ATTRIBUTE");
string

Description of meaning/use.

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

Maximum Cardinality (a number or *)

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

Minimum Cardinality.

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

Name in Parameters.parameter.name or in URL.

any FHIR4 code from any ValueSet may be used.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property part as list of HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter (XMLNAME = "part", XMLPROJECTION = "ELEMENT");
OperationDefinition:parameter

Parts of a nested Parameter.

Property methods: partBuildValueArray(), partCollectionToDisplay(), partCollectionToOdbc(), partDisplayToCollection(), partGet(), partGetObject(), partGetObjectId(), partGetSwizzled(), partIsValid(), partOdbcToCollection(), partSet(), partSetObject(), partSetObjectId()
property referencedFrom as list of HS.FHIR.DTL.vR4.Model.Element.OperationDefinition.parameter.referencedFrom (XMLNAME = "referencedFrom", XMLPROJECTION = "ELEMENT");
BackboneElement

References to this parameter.

Property methods: referencedFromBuildValueArray(), referencedFromCollectionToDisplay(), referencedFromCollectionToOdbc(), referencedFromDisplayToCollection(), referencedFromGet(), referencedFromGetObject(), referencedFromGetObjectId(), referencedFromGetSwizzled(), referencedFromIsValid(), referencedFromOdbcToCollection(), referencedFromSet(), referencedFromSetObject(), referencedFromSetObjectId()
property searchType as %String (MAXLEN = 1000000, XMLNAME = "searchType", XMLPROJECTION = "ATTRIBUTE");
code

number | date | string | token | reference | composite | quantity | uri | special

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

Property methods: searchTypeDisplayToLogical(), searchTypeGet(), searchTypeIsValid(), searchTypeLogicalToDisplay(), searchTypeLogicalToOdbc(), searchTypeNormalize(), searchTypeSet()
property targetProfile as list of %String (MAXLEN = 1000000, XMLNAME = "targetProfile", XMLPROJECTION = "ELEMENT");
canonical

If type is Reference | canonical, allowed targets

TO DO: Unrecognized value type for the FHIR4 model

Property methods: targetProfileBuildValueArray(), targetProfileCollectionToDisplay(), targetProfileCollectionToOdbc(), targetProfileDisplayToCollection(), targetProfileDisplayToLogical(), targetProfileGet(), targetProfileGetObject(), targetProfileGetObjectId(), targetProfileGetSwizzled(), targetProfileIsValid(), targetProfileLogicalToDisplay(), targetProfileLogicalToOdbc(), targetProfileNormalize(), targetProfileOdbcToCollection(), targetProfileSet(), targetProfileSetObject(), targetProfileSetObjectId()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE");
code

What type this parameter has.

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