HS.FHIRMeta.SearchParam

serial class HS.FHIRMeta.SearchParam extends %Library.SerialObject

Property Inventory

code
datatypes
definition
expression
fhirPath
id
isMultiValue
name
otherParams
resourceType
target
type
variantTypes

Method Inventory

ToString()
fromSerial()
getParamSet()
nextOther()
toSerial()

Properties

property code as %String (MAXLEN = 64);

code is the case sensitive value to use in the HTTP query parameter for this Search Parameter. It may not match the SearchParameter.code of the definition if we needed to disambiguate between other SearchParmeters with the same code value.

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()

property datatypes as %List;

$List of allowable data types for the values of this searchParameter

Property methods: datatypesGet(), datatypesIsValid(), datatypesLogicalToOdbc(), datatypesOdbcToLogical(), datatypesSet()

property definition as %String (MAXLEN = 2000);

the canonical URL for this search param. e.g. http://hl7.org/fhir/us/core/SearchParameter/us-core-race|3.1.0

Property methods: definitionDisplayToLogical(), definitionGet(), definitionIsValid(), definitionLogicalToDisplay(), definitionLogicalToOdbc(), definitionNormalize(), definitionSet()

property expression as %List;

$List of access steps

Property methods: expressionGet(), expressionIsValid(), expressionLogicalToOdbc(), expressionOdbcToLogical(), expressionSet()

property fhirPath as %String (MAXLEN = 500);

The full FHIRPath expression for this parameter

Property methods: fhirPathDisplayToLogical(), fhirPathGet(), fhirPathIsValid(), fhirPathLogicalToDisplay(), fhirPathLogicalToOdbc(), fhirPathNormalize(), fhirPathSet()

property id as %String (MAXLEN = 64);

SearchParameter.id value - used to disambiguate between search parameters that might have the same code. Regex: [A-Za-z0-9\-\.]{1,64}

Property methods: idDisplayToLogical(), idGet(), idIsValid(), idLogicalToDisplay(), idLogicalToOdbc(), idNormalize(), idSet()

property isMultiValue as %Boolean;

True if this field could have multiple values (because some property within its target path is an array)

Property methods: isMultiValueDisplayToLogical(), isMultiValueGet(), isMultiValueIsValid(), isMultiValueLogicalToDisplay(), isMultiValueNormalize(), isMultiValueSet()

property name as %String (MAXLEN = 254);

The name used in the URL name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

property otherParams as %List;

If this search parameter can match the value of multiple properties, then this is a $List of the additional serialized parameters in the set

Property methods: otherParamsGet(), otherParamsIsValid(), otherParamsLogicalToOdbc(), otherParamsOdbcToLogical(), otherParamsSet()

property resourceType as %String;

The resource that this parameter applies to

Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()

property target as %List;

For 'reference' parameters: $List of allowable reference targets For 'composite' parameters: $List of component parameter names

Property methods: targetGet(), targetIsValid(), targetLogicalToOdbc(), targetOdbcToLogical(), targetSet()

property type as %String;

Type of search parameter

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

property variantTypes as %List;

$List of allowable data types if the datatype is "variant"

Property methods: variantTypesGet(), variantTypesIsValid(), variantTypesLogicalToOdbc(), variantTypesOdbcToLogical(), variantTypesSet()

Methods

method ToString() as %String

classmethod fromSerial(ser)

method getParamSet(Output paramSet)

method nextOther(ByRef index As %Integer, Output searchParam As SearchParam) as %Boolean

method toSerial() as %String

Serialized Search Parameter if there are multiple sources All elements in this chain are OR'd together in a query

Subclasses

HS.FHIRServer.SearchParam