Interface SearchParameter

interface SearchParameter {
    _base?: Element[];
    _chain?: Element[];
    _code?: Element;
    _comparator?: Element[];
    _date?: Element;
    _derivedFrom?: Element;
    _description?: Element;
    _experimental?: Element;
    _expression?: Element;
    _implicitRules?: Element;
    _language?: Element;
    _modifier?: Element[];
    _multipleAnd?: Element;
    _multipleOr?: Element;
    _name?: Element;
    _publisher?: Element;
    _purpose?: Element;
    _status?: Element;
    _target?: Element[];
    _type?: Element;
    _url?: Element;
    _version?: Element;
    _xpath?: Element;
    _xpathUsage?: Element;
    base: code[];
    chain?: string[];
    code: code;
    comparator?: code[];
    component?: SearchParameterComponent[];
    contact?: ContactDetail[];
    contained?: ConcreteType[];
    date?: dateTime;
    derivedFrom?: canonical;
    description: markdown;
    experimental?: boolean;
    expression?: string;
    extension?: Extension[];
    id?: id;
    implicitRules?: uri;
    jurisdiction?: CodeableConcept[];
    language?: code;
    meta?: Meta;
    modifier?: code[];
    modifierExtension?: Extension[];
    multipleAnd?: boolean;
    multipleOr?: boolean;
    name: string;
    publisher?: string;
    purpose?: markdown;
    resourceType: "SearchParameter";
    status: code;
    target?: code[];
    text?: Narrative;
    type: code;
    url: uri;
    useContext?: UsageContext[];
    version?: string;
    xpath?: string;
    xpathUsage?: code;
}

Properties

_base? _chain? _code? _comparator? _date? _derivedFrom? _description? _experimental? _expression? _implicitRules? _language? _modifier? _multipleAnd? _multipleOr? _name? _publisher? _purpose? _status? _target? _type? _url? _version? _xpath? _xpathUsage? base chain? code comparator? component? contact? contained? date? derivedFrom? description experimental? expression? extension? id? implicitRules? jurisdiction? language? meta? modifier? modifierExtension? multipleAnd? multipleOr? name publisher? purpose? resourceType status target? text? type url useContext? version? xpath? xpathUsage?

Properties

Optional_base

_base?: Element[]

The resource type(s) this search parameter applies to

Optional_chain

_chain?: Element[]

Chained names supported

Optional_code

_code?: Element

Code used in URL

Optional_comparator

_comparator?: Element[]

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

Optional_date

_date?: Element

Date last changed

Optional_derivedFrom

_derivedFrom?: Element

Original definition for the search parameter

Optional_description

_description?: Element

Natural language description of the search parameter

Optional_experimental

_experimental?: Element

For testing purposes, not real usage

Optional_expression

_expression?: Element

FHIRPath expression that extracts the values

Optional_implicitRules

_implicitRules?: Element

A set of rules under which this content was created

Optional_language

_language?: Element

Language of the resource content

Optional_modifier

_modifier?: Element[]

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

Optional_multipleAnd

_multipleAnd?: Element

Allow multiple parameters (and)

Optional_multipleOr

_multipleOr?: Element

Allow multiple values per parameter (or)

Optional_name

_name?: Element

Name for this search parameter (computer friendly)

Optional_publisher

_publisher?: Element

Name of the publisher (organization or individual)

Optional_purpose

_purpose?: Element

Why this search parameter is defined

Optional_status

_status?: Element

draft | active | retired | unknown

Optional_target

_target?: Element[]

Types of resource (if a resource reference)

Optional_type

_type?: Element

number | date | string | token | reference | composite | quantity | uri | special

Optional_url

_url?: Element

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

Optional_version

_version?: Element

Business version of the search parameter

Optional_xpath

_xpath?: Element

XPath that extracts the values

Optional_xpathUsage

_xpathUsage?: Element

normal | phonetic | nearby | distance | other

base

base: code[]

The resource type(s) this search parameter applies to

Optionalchain

chain?: string[]

Chained names supported

code

code: code

Code used in URL

Optionalcomparator

comparator?: code[]

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

Optionalcomponent

component?: SearchParameterComponent[]

For Composite resources to define the parts

Optionalcontact

contact?: ContactDetail[]

Contact details for the publisher

Optionalcontained

contained?: ConcreteType[]

Contained, inline Resources

Optionaldate

date?: dateTime

Date last changed

OptionalderivedFrom

derivedFrom?: canonical

Original definition for the search parameter

description

description: markdown

Natural language description of the search parameter

Optionalexperimental

experimental?: boolean

For testing purposes, not real usage

Optionalexpression

expression?: string

FHIRPath expression that extracts the values

Optionalextension

extension?: Extension[]

Additional content defined by implementations

Optionalid

id?: id

Logical id of this artifact

OptionalimplicitRules

implicitRules?: uri

A set of rules under which this content was created

Optionaljurisdiction

jurisdiction?: CodeableConcept[]

Intended jurisdiction for search parameter (if applicable)

Optionallanguage

language?: code

Language of the resource content

Optionalmeta

meta?: Meta

Metadata about the resource

Optionalmodifier

modifier?: code[]

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

OptionalmodifierExtension

modifierExtension?: Extension[]

Extensions that cannot be ignored

OptionalmultipleAnd

multipleAnd?: boolean

Allow multiple parameters (and)

OptionalmultipleOr

multipleOr?: boolean

Allow multiple values per parameter (or)

name

name: string

Name for this search parameter (computer friendly)

Optionalpublisher

publisher?: string

Name of the publisher (organization or individual)

Optionalpurpose

purpose?: markdown

Why this search parameter is defined

resourceType

resourceType

status

status: code

draft | active | retired | unknown

Optionaltarget

target?: code[]

Types of resource (if a resource reference)

Optionaltext

text?: Narrative

Text summary of the resource, for human interpretation

type

type: code

number | date | string | token | reference | composite | quantity | uri | special

url

url: uri

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

OptionaluseContext

useContext?: UsageContext[]

The context that the content is intended to support

Optionalversion

version?: string

Business version of the search parameter

Optionalxpath

xpath?: string

XPath that extracts the values

OptionalxpathUsage

xpathUsage?: code

normal | phonetic | nearby | distance | other

Settings

Member Visibility

On This Page

Properties