Skip to main content

HS.FHIRModel.R4.SearchParameter

class HS.FHIRModel.R4.SearchParameter extends HS.FHIRModel.FHIRClassSuper

*****************************************
** SearchParameter generated class schema
*****************************************
A search parameter that defines a named search item that can be used to search/filter on a resource.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 HS.FHIRModel.R4.SeqOfElement;
Extensions for base
Property methods: _baseGet(), _baseGetSwizzled(), _baseIsValid(), _baseNewObject(), _baseSet()
property _chain as HS.FHIRModel.R4.SeqOfElement;
Extensions for chain
Property methods: _chainGet(), _chainGetSwizzled(), _chainIsValid(), _chainNewObject(), _chainSet()
property _code as HS.FHIRModel.R4.Element;
Extensions for code
Property methods: _codeGet(), _codeGetSwizzled(), _codeIsValid(), _codeNewObject(), _codeSet()
property _comparator as HS.FHIRModel.R4.SeqOfElement;
Extensions for comparator
Property methods: _comparatorGet(), _comparatorGetSwizzled(), _comparatorIsValid(), _comparatorNewObject(), _comparatorSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _expression as HS.FHIRModel.R4.Element;
Extensions for expression
Property methods: _expressionGet(), _expressionGetSwizzled(), _expressionIsValid(), _expressionNewObject(), _expressionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _modifier as HS.FHIRModel.R4.SeqOfElement;
Extensions for modifier
Property methods: _modifierGet(), _modifierGetSwizzled(), _modifierIsValid(), _modifierNewObject(), _modifierSet()
property _multipleAnd as HS.FHIRModel.R4.Element;
Extensions for multipleAnd
Property methods: _multipleAndGet(), _multipleAndGetSwizzled(), _multipleAndIsValid(), _multipleAndNewObject(), _multipleAndSet()
property _multipleOr as HS.FHIRModel.R4.Element;
Extensions for multipleOr
Property methods: _multipleOrGet(), _multipleOrGetSwizzled(), _multipleOrIsValid(), _multipleOrNewObject(), _multipleOrSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _target as HS.FHIRModel.R4.SeqOfElement;
Extensions for target
Property methods: _targetGet(), _targetGetSwizzled(), _targetIsValid(), _targetNewObject(), _targetSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property _xpath as HS.FHIRModel.R4.Element;
Extensions for xpath
Property methods: _xpathGet(), _xpathGetSwizzled(), _xpathIsValid(), _xpathNewObject(), _xpathSet()
property _xpathUsage as HS.FHIRModel.R4.Element;
Extensions for xpathUsage
Property methods: _xpathUsageGet(), _xpathUsageGetSwizzled(), _xpathUsageIsValid(), _xpathUsageNewObject(), _xpathUsageSet()
property base as HS.FHIRModel.R4.SeqOfString;
The base resource type(s) that this search parameter can be used against.
Property methods: baseGet(), baseGetSwizzled(), baseIsValid(), baseNewObject(), baseSet()
property chain as HS.FHIRModel.R4.SeqOfString;
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: chainGet(), chainGetSwizzled(), chainIsValid(), chainNewObject(), chainSet()
property code as %String;
The code used in the URL or the parameter name in a parameters resource for this search parameter.
Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property comparator as %String (VALUELIST = ",eq,ne,gt,lt,ge,le,sa,eb,ap");
Comparators supported for the search parameter.
Property methods: comparatorDisplayToLogical(), comparatorGet(), comparatorIsValid(), comparatorLogicalToDisplay(), comparatorLogicalToOdbc(), comparatorNormalize(), comparatorSet()
Used to define the parts of a composite search parameter.
Property methods: componentGet(), componentGetSwizzled(), componentIsValid(), componentNewObject(), componentSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property date as %String;
The date (and optionally time) when the search parameter was published. The date must change 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: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property derivedFrom as %String;
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: derivedFromDisplayToLogical(), derivedFromGet(), derivedFromIsValid(), derivedFromLogicalToDisplay(), derivedFromLogicalToOdbc(), derivedFromNormalize(), derivedFromSet()
property description as %String;
And how it used.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean;
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: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property expression as %String;
A FHIRPath expression that returns a set of elements for the search parameter.
Property methods: expressionDisplayToLogical(), expressionGet(), expressionIsValid(), expressionLogicalToDisplay(), expressionLogicalToOdbc(), expressionNormalize(), expressionSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the search parameter is intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifier as %String (VALUELIST = ",missing,exact,contains,not,text,in,not-in,below,above,type,identifier,ofType");
A modifier supported for the search parameter.
Property methods: modifierDisplayToLogical(), modifierGet(), modifierIsValid(), modifierLogicalToDisplay(), modifierLogicalToOdbc(), modifierNormalize(), modifierSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property multipleAnd as %Boolean;
Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
Property methods: multipleAndDisplayToLogical(), multipleAndGet(), multipleAndIsValid(), multipleAndLogicalToDisplay(), multipleAndLogicalToXSD(), multipleAndNormalize(), multipleAndSet(), multipleAndXSDToLogical()
property multipleOr as %Boolean;
Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
Property methods: multipleOrDisplayToLogical(), multipleOrGet(), multipleOrIsValid(), multipleOrLogicalToDisplay(), multipleOrLogicalToXSD(), multipleOrNormalize(), multipleOrSet(), multipleOrXSDToLogical()
property name as %String;
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: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String;
The name of the organization or individual that published the search parameter.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this search parameter is needed and why it has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resourceType as %String [ InitialExpression = "SearchParameter" , Required ];
This is a SearchParameter resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this search parameter. Enables tracking the life-cycle of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property target as HS.FHIRModel.R4.SeqOfString;
Types of resource (if a resource is referenced).
Property methods: targetGet(), targetGetSwizzled(), targetIsValid(), targetNewObject(), targetSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as %String (VALUELIST = ",number,date,string,token,reference,composite,quantity,uri,special");
The type of value that a search parameter may contain, and how the content is interpreted.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String;
An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
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: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
property xpath as %String;
An XPath expression that returns a set of elements for the search parameter.
Property methods: xpathDisplayToLogical(), xpathGet(), xpathIsValid(), xpathLogicalToDisplay(), xpathLogicalToOdbc(), xpathNormalize(), xpathSet()
property xpathUsage as %String (VALUELIST = ",normal,phonetic,nearby,distance,other");
How the search parameter relates to the set of elements returned by evaluating the xpath query.
Property methods: xpathUsageDisplayToLogical(), xpathUsageGet(), xpathUsageIsValid(), xpathUsageLogicalToDisplay(), xpathUsageLogicalToOdbc(), xpathUsageNormalize(), xpathUsageSet()

Methods

method IncludeBase()
method IncludeChain()
method IncludeComponent()
method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeTarget()
method IncludeText()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab