Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.SearchParameter

class HS.FHIR.DTL.vR4.Model.Resource.SearchParameter extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Search parameter for a resource.

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 = SearchParameter;
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 = SearchParameter;
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 base as list of %String (MAXLEN = 1000000, XMLNAME = "base", XMLPROJECTION = "ELEMENT") [ Required ];
code

The resource type(s) this search parameter applies to.

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

Property methods: baseBuildValueArray(), baseCollectionToDisplay(), baseCollectionToOdbc(), baseDisplayToCollection(), baseDisplayToLogical(), baseGet(), baseGetObject(), baseGetObjectId(), baseGetSwizzled(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseOdbcToCollection(), baseSet(), baseSetObject(), baseSetObjectId()
property chain as list of %String (MAXLEN = 1000000, XMLNAME = "chain", XMLPROJECTION = "ELEMENT");
string

Chained names supported.

Property methods: chainBuildValueArray(), chainCollectionToDisplay(), chainCollectionToOdbc(), chainDisplayToCollection(), chainDisplayToLogical(), chainGet(), chainGetObject(), chainGetObjectId(), chainGetSwizzled(), chainIsValid(), chainLogicalToDisplay(), chainLogicalToOdbc(), chainNormalize(), chainOdbcToCollection(), chainSet(), chainSetObject(), chainSetObjectId()
property code as %String (MAXLEN = 1000000, XMLNAME = "code", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

Code used in URL.

any FHIR4 code from any ValueSet may be used.

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property comparator as list of %String (MAXLEN = 1000000, XMLNAME = "comparator", XMLPROJECTION = "ELEMENT");
code

eq | ne | gt | lt | ge | le | sa | eb | ap

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

Property methods: comparatorBuildValueArray(), comparatorCollectionToDisplay(), comparatorCollectionToOdbc(), comparatorDisplayToCollection(), comparatorDisplayToLogical(), comparatorGet(), comparatorGetObject(), comparatorGetObjectId(), comparatorGetSwizzled(), comparatorIsValid(), comparatorLogicalToDisplay(), comparatorLogicalToOdbc(), comparatorNormalize(), comparatorOdbcToCollection(), comparatorSet(), comparatorSetObject(), comparatorSetObjectId()
property component as list of HS.FHIR.DTL.vR4.Model.Element.SearchParameter.component (XMLNAME = "component", XMLPROJECTION = "ELEMENT");
BackboneElement

For Composite resources to define the parts.

Property methods: componentBuildValueArray(), componentCollectionToDisplay(), componentCollectionToOdbc(), componentDisplayToCollection(), componentGet(), componentGetObject(), componentGetObjectId(), componentGetSwizzled(), componentIsValid(), componentOdbcToCollection(), componentSet(), componentSetObject(), componentSetObjectId()
property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property derivedFrom as %String (MAXLEN = 1000000, XMLNAME = "derivedFrom", XMLPROJECTION = "ATTRIBUTE");
canonical

Original definition for the search parameter.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: derivedFromDisplayToLogical(), derivedFromGet(), derivedFromIsValid(), derivedFromLogicalToDisplay(), derivedFromLogicalToOdbc(), derivedFromNormalize(), derivedFromSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE") [ Required ];
markdown

Natural language description of the search parameter.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property expression as %String (MAXLEN = 1000000, XMLNAME = "expression", XMLPROJECTION = "ATTRIBUTE");
string

FHIRPath expression that extracts the values.

Property methods: expressionDisplayToLogical(), expressionGet(), expressionIsValid(), expressionLogicalToDisplay(), expressionLogicalToOdbc(), expressionNormalize(), expressionSet()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for search parameter (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property modifier as list of %String (MAXLEN = 1000000, XMLNAME = "modifier", XMLPROJECTION = "ELEMENT");
code

missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType

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

Property methods: modifierBuildValueArray(), modifierCollectionToDisplay(), modifierCollectionToOdbc(), modifierDisplayToCollection(), modifierDisplayToLogical(), modifierExtensionBuildValueArray(), modifierExtensionCollectionToDisplay(), modifierExtensionCollectionToOdbc(), modifierExtensionDisplayToCollection(), modifierExtensionGet(), modifierExtensionGetObject(), modifierExtensionGetObjectId(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionOdbcToCollection(), modifierExtensionSet(), modifierExtensionSetObject(), modifierExtensionSetObjectId(), modifierGet(), modifierGetObject(), modifierGetObjectId(), modifierGetSwizzled(), modifierIsValid(), modifierLogicalToDisplay(), modifierLogicalToOdbc(), modifierNormalize(), modifierOdbcToCollection(), modifierSet(), modifierSetObject(), modifierSetObjectId()
property multipleAnd as %Boolean (XMLNAME = "multipleAnd", XMLPROJECTION = "ATTRIBUTE");
boolean

Allow multiple parameters (and)

Property methods: multipleAndDisplayToLogical(), multipleAndGet(), multipleAndIsValid(), multipleAndLogicalToDisplay(), multipleAndLogicalToXSD(), multipleAndNormalize(), multipleAndSet(), multipleAndXSDToLogical()
property multipleOr as %Boolean (XMLNAME = "multipleOr", XMLPROJECTION = "ATTRIBUTE");
boolean

Allow multiple values per parameter (or)

Property methods: multipleOrDisplayToLogical(), multipleOrGet(), multipleOrIsValid(), multipleOrLogicalToDisplay(), multipleOrLogicalToXSD(), multipleOrNormalize(), multipleOrSet(), multipleOrXSDToLogical()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

Name for this search parameter (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this search parameter is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property target as list of %String (MAXLEN = 1000000, XMLNAME = "target", XMLPROJECTION = "ELEMENT");
code

Types of resource (if a resource reference)

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

Property methods: targetBuildValueArray(), targetCollectionToDisplay(), targetCollectionToOdbc(), targetDisplayToCollection(), targetDisplayToLogical(), targetGet(), targetGetObject(), targetGetObjectId(), targetGetSwizzled(), targetIsValid(), targetLogicalToDisplay(), targetLogicalToOdbc(), targetNormalize(), targetOdbcToCollection(), targetSet(), targetSetObject(), targetSetObjectId()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
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: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri

Canonical identifier for this search parameter, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the search parameter.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
property xpath as %String (MAXLEN = 1000000, XMLNAME = "xpath", XMLPROJECTION = "ATTRIBUTE");
string

XPath that extracts the values.

Property methods: xpathDisplayToLogical(), xpathGet(), xpathIsValid(), xpathLogicalToDisplay(), xpathLogicalToOdbc(), xpathNormalize(), xpathSet(), xpathUsageDisplayToLogical(), xpathUsageGet(), xpathUsageIsValid(), xpathUsageLogicalToDisplay(), xpathUsageLogicalToOdbc(), xpathUsageNormalize(), xpathUsageSet()
property xpathUsage as %String (MAXLEN = 1000000, XMLNAME = "xpathUsage", XMLPROJECTION = "ATTRIBUTE");
code

normal | phonetic | nearby | distance | other

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

Property methods: xpathUsageDisplayToLogical(), xpathUsageGet(), xpathUsageIsValid(), xpathUsageLogicalToDisplay(), xpathUsageLogicalToOdbc(), xpathUsageNormalize(), xpathUsageSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab