View raw Markdown
type: codesystemcodesystem: search-modifier-code

Search Modifier Code

Concepts

CodeDisplayDefinition
missingMissingThe search parameter returns resources that have a value or not.
exactExactThe search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).
containsContainsThe search parameter returns resources that include the supplied parameter value anywhere within the field being searched.
notNotThe search parameter returns resources that do not contain a match.
textTextThe search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, Identifier.type.text, or Reference.display.
inInThe search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.
not-inNot InThe search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set.
belowBelowThe search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).
aboveAboveThe search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).
typeTypeThe search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).
identifierIdentifierThe search parameter applies to the identifier on the resource, not the reference.
of-typeOf TypeThe search parameter has the format system
code-textCode TextTests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value.
text-advancedText AdvancedTests whether the value in a resource matches the supplied parameter value using advanced text handling that searches text associated with the code/value - e.g., CodeableConcept.text, Coding.display, or Identifier.type.text.
iterateIterateThe search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource.

CodeSystem XML

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="search-modifier-code"/>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/>
  </extension>
  <url value="http://hl7.org/fhir/search-modifier-code"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.4.640"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.625"/>
  </identifier>
  <identifier>
    <use value="old"/>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.2.92"/>
  </identifier>
  <version value="6.0.0"/>
  <name value="SearchModifierCode"/>
  <title value="Search Modifier Code"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2021-01-05T10:01:24+11:00"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="A supported modifier for a search parameter."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/search-modifier-code"/>
  <content value="complete"/>
  <concept>
    <code value="missing"/>
    <display value="Missing"/>
    <definition value="The search parameter returns resources that have a value or not."/>
  </concept>
  <concept>
    <code value="exact"/>
    <display value="Exact"/>
    <definition value="The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents)."/>
  </concept>
  <concept>
    <code value="contains"/>
    <display value="Contains"/>
    <definition value="The search parameter returns resources that include the supplied parameter value anywhere within the field being searched."/>
  </concept>
  <concept>
    <code value="not"/>
    <display value="Not"/>
    <definition value="The search parameter returns resources that do not contain a match."/>
  </concept>
  <concept>
    <code value="text"/>
    <display value="Text"/>
    <definition value="The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, Identifier.type.text, or Reference.display."/>
  </concept>
  <concept>
    <code value="in"/>
    <display value="In"/>
    <definition value="The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set."/>
  </concept>
  <concept>
    <code value="not-in"/>
    <display value="Not In"/>
    <definition value="The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set."/>
  </concept>
  <concept>
    <code value="below"/>
    <display value="Below"/>
    <definition value="The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships)."/>
  </concept>
  <concept>
    <code value="above"/>
    <display value="Above"/>
    <definition value="The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships)."/>
  </concept>
  <concept>
    <code value="type"/>
    <display value="Type"/>
    <definition value="The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.)."/>
  </concept>
  <concept>
    <code value="identifier"/>
    <display value="Identifier"/>
    <definition value="The search parameter applies to the identifier on the resource, not the reference."/>
  </concept>
  <concept>
    <code value="of-type"/>
    <display value="Of Type"/>
    <definition value="The search parameter has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code, and match if any of the type codes match. All 3 parts must be present."/>
  </concept>
  <concept>
    <code value="code-text"/>
    <display value="Code Text"/>
    <definition value="Tests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value."/>
  </concept>
  <concept>
    <code value="text-advanced"/>
    <display value="Text Advanced"/>
    <definition value="Tests whether the value in a resource matches the supplied parameter value using advanced text handling that searches text associated with the code/value - e.g., CodeableConcept.text, Coding.display, or Identifier.type.text."/>
  </concept>
  <concept>
    <code value="iterate"/>
    <display value="Iterate"/>
    <definition value="The search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource."/>
  </concept>
</CodeSystem>