Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.SearchParameter

class HS.FHIR.DTL.vDSTU2.Model.Resource.SearchParameter extends HS.FHIR.DTL.vDSTU2.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 %String (MAXLEN = 1000000, XMLNAME = "base", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

The resource type this search parameter applies to.

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

Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property code as %String (MAXLEN = 1000000, XMLNAME = "code", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

Code used in URL.

any FHIR2 code from any ValueSet may be used.

Property methods: codeDisplayToLogical(), codeGet(), codeIsValid(), codeLogicalToDisplay(), codeLogicalToOdbc(), codeNormalize(), codeSet()
property contact as list of HS.FHIR.DTL.vDSTU2.Model.Element.SearchParameter.contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
BackboneElement

Contact details of 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

Publication Date(/time)

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

Documentation for search parameter.

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

If for testing purposes, not real usage.

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

Informal name for this search parameter.

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 requirements as %String (MAXLEN = 1000000, XMLNAME = "requirements", XMLPROJECTION = "ATTRIBUTE");
string

Why this search parameter is defined.

Property methods: requirementsDisplayToLogical(), requirementsGet(), requirementsIsValid(), requirementsLogicalToDisplay(), requirementsLogicalToOdbc(), requirementsNormalize(), requirementsSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

draft | active | retired

conformance-resource-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend conformance-resource-status 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 is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend resource-types 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

search-param-type is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend search-param-type 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

Absolute URL used to reference this search parameter.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
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 is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend search-xpath-usage 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