Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.vDSTU2.Model.Resource.SearchParameter

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "base") [ Required ];
The base resource type that this search parameter refers to.
Property methods: baseGet(), baseGetSwizzled(), baseIsValid(), baseNewObject(), baseSet()
property code as HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "code") [ 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 contact as list of HS.FHIR.vDSTU2.Model.Resource.SearchParameter.Contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contacts 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.vDSTU2.Model.Datatype.DateTime (XMLNAME = "date") [ SqlFieldName = _date ];
The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, 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 description as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "description") [ Required ];
A description of the search parameters and how it used.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property experimental as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "experimental");
A flag to indicate that this search parameter definition 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 name as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "name") [ Required ];
A free text natural language name identifying the search parameter.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "publisher");
The name of the individual or organization that published the search parameter.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property requirements as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "requirements");
The Scope and Usage that this search parameter was created to meet.
Property methods: requirementsGet(), requirementsGetSwizzled(), requirementsIsValid(), requirementsNewObject(), requirementsSet()
property status as HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "status");
The status of this search parameter definition.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property target as list of HS.FHIR.vDSTU2.Model.Datatype.Code (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.vDSTU2.Model.Datatype.Code (XMLNAME = "type") [ 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.vDSTU2.Model.Datatype.Uri (XMLNAME = "url") [ Required ];
An absolute URL 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.
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property xpath as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "xpath");
An XPath expression that returns a set of elements for the search parameter.
Property methods: xpathGet(), xpathGetSwizzled(), xpathIsValid(), xpathNewObject(), xpathSet()
property xpathUsage as HS.FHIR.vDSTU2.Model.Base.XPathUsageType (XMLNAME = "xpathUsage");
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.
Set method for the "base" 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 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 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 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 SetRequirements(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 "requirements" 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 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