http://hl7.org/fhir/StructureDefinition/SearchParameter|5.0.0

A search parameter that defines a named search item that can be used to search/filter on a resource.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
description: A search parameter that defines a named search item that can be used to search/filter on a resource.
derivation: specialization
name: SearchParameter
type: SearchParameter
elements:
  constraint: {isModifier: false, short: FHIRPath expression that constraints the usage of this SearchParamete, mustSupport: false, isSummary: false, index: 24}
  description: {isModifier: false, short: Natural language description of the search parameter, mustSupport: false, isSummary: true, index: 13}
  date: {isModifier: false, short: Date last changed, mustSupport: false, isSummary: true, index: 10}
  expression: {isModifier: false, short: FHIRPath expression that extracts the values, mustSupport: false, isSummary: false, index: 22}
  modifier:
    isModifier: false
    short: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
    mustSupport: false
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0'}
    isSummary: false
    index: 29
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), mustSupport: false, isSummary: true, index: 11}
  multipleAnd: {isModifier: false, short: Allow multiple parameters (and), mustSupport: false, meaningWhenMissing: 'If not declared, then it is up to server discretion whether multiple ''and'' repetitions are allowed', isSummary: false, index: 27}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for search parameter (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 15
  derivedFrom: {isModifier: false, short: Original definition for the search parameter, mustSupport: false, isSummary: false, index: 7}
  purpose: {isModifier: false, short: Why this search parameter is defined, mustSupport: false, isSummary: false, index: 16}
  multipleOr: {isModifier: false, short: Allow multiple values per parameter (or), mustSupport: false, meaningWhenMissing: 'If not declared, then it is up to server discretion whether multiple ''or'' repetitions are allowed', isSummary: false, index: 26}
  name: {isModifier: false, short: Name for this search parameter (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 18}
  useContext: {isModifier: false, short: The context that the content is intended to support, mustSupport: false, array: true, isSummary: true, index: 14}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 17}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  type:
    isModifier: false
    short: number | date | string | token | reference | composite | quantity | uri | special
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-param-type|5.0.0'}
    isSummary: true
    index: 21
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 9}
  component:
    isModifier: false
    short: For Composite resources to define the parts
    mustSupport: false
    array: true
    isSummary: false
    index: 31
    elements:
      definition: {isModifier: false, short: Defines how the part works, mustSupport: false, isSummary: false, index: 32}
      expression: {isModifier: false, short: Subexpression relative to main expression, mustSupport: false, isSummary: false, index: 33}
    required: [expression, definition]
  title: {isModifier: false, short: Name for this search parameter (human friendly), mustSupport: false, isSummary: true, index: 6}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 8
  chain: {isModifier: false, short: Chained names supported, mustSupport: false, array: true, isSummary: false, index: 30}
  processingMode:
    isModifier: false
    short: normal | phonetic | other
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-processingmode|5.0.0'}
    isSummary: false
    index: 23
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/SearchParameter', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this search parameter, represented as a URI (globally unique)
    mustSupport: false
    isSummary: true
    index: 0
  code: {isModifier: false, short: Recommended name for parameter in search url, mustSupport: false, isSummary: true, index: 19}
  identifier: {isModifier: false, short: Additional identifier for the search parameter (business identifier), mustSupport: false, array: true, isSummary: true, index: 1}
  comparator:
    isModifier: false
    short: eq | ne | gt | lt | ge | le | sa | eb | ap
    mustSupport: false
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-comparator|5.0.0'}
    isSummary: false
    index: 28
  target:
    isModifier: false
    short: Types of resource (if a resource reference)
    mustSupport: false
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0'}
    isSummary: false
    index: 25
  base:
    min: 1
    isModifier: false
    short: The resource type(s) this search parameter applies to
    index: 20
    mustSupport: false
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/version-independent-all-resource-types|5.0.0'}
    isSummary: true
  version: {isModifier: false, short: Business version of the search parameter, mustSupport: false, isSummary: true, index: 2}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 12}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/SearchParameter
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [url, base, name, status, type, code, description]