Skip to main content

HS.FHIR.vSTU3.Model.Resource.SearchParameter

deprecated class HS.FHIR.vSTU3.Model.Resource.SearchParameter extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A search parameter that defines a named search item that can be used to search/filter on a resource.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method 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 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.

Properties

property base as list of HS.FHIR.vSTU3.Model.Base.ResourceType (XMLNAME = "base", XMLPROJECTION = "ELEMENT");
The base resource type(s) that this search parameter can be used against.
Property methods: baseBuildValueArray(), baseCollectionToDisplay(), baseCollectionToOdbc(), baseDisplayToCollection(), baseGet(), baseGetObject(), baseGetObjectId(), baseGetSwizzled(), baseIsValid(), baseOdbcToCollection(), baseSet(), baseSetObject(), baseSetObjectId()
property chain as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "chain", XMLPROJECTION = "ELEMENT");
Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
Property methods: chainBuildValueArray(), chainCollectionToDisplay(), chainCollectionToOdbc(), chainDisplayToCollection(), chainGet(), chainGetObject(), chainGetObjectId(), chainGetSwizzled(), chainIsValid(), chainOdbcToCollection(), chainSet(), chainSetObject(), chainSetObjectId()
property code as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
The code used in the URL or the parameter name in a parameters resource for this search parameter.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property comparator as list of HS.FHIR.vSTU3.Model.Base.SearchComparator (XMLNAME = "comparator", XMLPROJECTION = "ELEMENT");
Comparators supported for the search parameter.
Property methods: comparatorBuildValueArray(), comparatorCollectionToDisplay(), comparatorCollectionToOdbc(), comparatorDisplayToCollection(), comparatorGet(), comparatorGetObject(), comparatorGetObjectId(), comparatorGetSwizzled(), comparatorIsValid(), comparatorOdbcToCollection(), comparatorSet(), comparatorSetObject(), comparatorSetObjectId()
property component as list of HS.FHIR.vSTU3.Model.Resource.SearchParameter.Component (XMLNAME = "component", XMLPROJECTION = "ELEMENT");
Used to define the parts of a composite search parameter.
Property methods: componentBuildValueArray(), componentCollectionToDisplay(), componentCollectionToOdbc(), componentDisplayToCollection(), componentGet(), componentGetObject(), componentGetObjectId(), componentGetSwizzled(), componentIsValid(), componentOdbcToCollection(), componentSet(), componentSetObject(), componentSetObjectId()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property derivedFrom as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "derivedFrom", XMLPROJECTION = "ELEMENT");
Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
Property methods: derivedFromGet(), derivedFromGetSwizzled(), derivedFromIsValid(), derivedFromNewObject(), derivedFromSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT") [ Required ];
A free text natural language description of the search parameter from a consumer's perspective. and how it used.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property expression as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "expression", XMLPROJECTION = "ELEMENT");
A FHIRPath expression that returns a set of elements for the search parameter.
Property methods: expressionGet(), expressionGetSwizzled(), expressionIsValid(), expressionNewObject(), expressionSet()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the search parameter is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property modifier as list of HS.FHIR.vSTU3.Model.Base.SearchModifierCode (XMLNAME = "modifier", XMLPROJECTION = "ELEMENT");
A modifier supported for the search parameter.
Property methods: modifierBuildValueArray(), modifierCollectionToDisplay(), modifierCollectionToOdbc(), modifierDisplayToCollection(), modifierExtensionBuildValueArray(), modifierExtensionCollectionToDisplay(), modifierExtensionCollectionToOdbc(), modifierExtensionDisplayToCollection(), modifierExtensionGet(), modifierExtensionGetObject(), modifierExtensionGetObjectId(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionOdbcToCollection(), modifierExtensionSet(), modifierExtensionSetObject(), modifierExtensionSetObjectId(), modifierGet(), modifierGetObject(), modifierGetObjectId(), modifierGetSwizzled(), modifierIsValid(), modifierOdbcToCollection(), modifierSet(), modifierSetObject(), modifierSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the search parameter.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this search parameter is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this search parameter. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property target as list of HS.FHIR.vSTU3.Model.Base.ResourceType (XMLNAME = "target", XMLPROJECTION = "ELEMENT");
Types of resource (if a resource is referenced).
Property methods: targetBuildValueArray(), targetCollectionToDisplay(), targetCollectionToOdbc(), targetDisplayToCollection(), targetGet(), targetGetObject(), targetGetObjectId(), targetGetSwizzled(), targetIsValid(), targetOdbcToCollection(), targetSet(), targetSetObject(), targetSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.SearchParamType (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type of value a search parameter refers to, and how the content is interpreted.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT") [ Required ];
An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()
property xpath as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "xpath", XMLPROJECTION = "ELEMENT");
An XPath expression that returns a set of elements for the search parameter.
Property methods: xpathGet(), xpathGetSwizzled(), xpathIsValid(), xpathNewObject(), xpathSet(), xpathUsageGet(), xpathUsageGetSwizzled(), xpathUsageIsValid(), xpathUsageNewObject(), xpathUsageSet()
property xpathUsage as HS.FHIR.vSTU3.Model.Base.XPathUsageType (XMLNAME = "xpathUsage", XMLPROJECTION = "ELEMENT");
How the search parameter relates to the set of elements returned by evaluating the xpath query.
Property methods: xpathUsageGet(), xpathUsageGetSwizzled(), xpathUsageIsValid(), xpathUsageNewObject(), xpathUsageSet()

Methods

deprecated method SetBase(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "base" property.
deprecated method SetChain(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "chain" property.
deprecated method SetCode(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetComparator(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "comparator" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetDerivedFrom(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "derivedFrom" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetExperimental(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "experimental" property.
deprecated method SetExpression(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "expression" property.
deprecated method SetJurisdiction(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "jurisdiction" property.
deprecated method SetModifier(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "modifier" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPublisher(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "publisher" property.
deprecated method SetPurpose(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "purpose" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetTarget(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "target" property.
deprecated method SetType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.
deprecated method SetUrl(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "url" property.
deprecated method SetVersion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "version" property.
deprecated method SetXpath(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "xpath" property.
deprecated method SetXpathUsage(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "xpathUsage" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab