Terminology
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative |
Raw XML ( canonical form + also see XML Format Specification )
Definition for Code SystemSearchModifierCode
<?xml version="1.0" encoding="UTF-8"?> <CodeSystem xmlns="http://hl7.org/fhir"> <id value="search-modifier-code"/> <meta><lastUpdated value="2022-09-10T04:52:37.223+10:00"/> <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> This code system <code> http://hl7.org/fhir/search-modifier-code</code> defines the following codes: </p> <table class="codes"><tr><td style="white-space:nowrap"><b> Code</b></td><td><b> Display</b></td><td><b> Definition</b></td></tr><tr><td style="white-space:nowrap">missing<a name="search-modifier-code-missing"> </a></td><td> Missing</td><td> The search parameter returns resources that have a value or not.</td></tr><tr><td style="white-space:nowrap">exact<a name="search-modifier-code-exact"> </a></td><td> Exact</td>The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).<td> The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).</td> </tr><tr><td style="white-space:nowrap">contains<a name="search-modifier-code-contains"> </a></td><td> Contains</td>The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.<td> The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.</td> </tr><tr><td style="white-space:nowrap">not<a name="search-modifier-code-not"> </a></td><td> Not</td><td> The search parameter returns resources that do not contain a match.</td></tr><tr><td style="white-space:nowrap">text<a name="search-modifier-code-text"> </a></td><td> Text</td>The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.text.<td> 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.</td> </tr><tr><td style="white-space:nowrap">in<a name="search-modifier-code-in"> </a></td><td> In</td>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.<td> 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.</td> </tr><tr><td style="white-space:nowrap">not-in<a name="search-modifier-code-not-in"> </a></td><td> Not In</td>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.<td> 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.</td> </tr><tr><td style="white-space:nowrap">below<a name="search-modifier-code-below"> </a></td><td> Below</td><td> The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).</td></tr><tr><td style="white-space:nowrap">above<a name="search-modifier-code-above"> </a></td><td> Above</td>The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).<td> The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).</td> </tr><tr><td style="white-space:nowrap">type<a name="search-modifier-code-type"> </a></td><td> Type</td>The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).<td> The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).</td> </tr><tr><td style="white-space:nowrap">identifier<a name="search-modifier-code-identifier"> </a></td><td> Identifier</td><td> The search parameter applies to the identifier on the resource, not the reference.</td></tr><tr>ofType<td style="white-space:nowrap">of-type <a name="search-modifier-code-of-type"> </a> </td><td> Of Type</td>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.<td> 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.</td> </tr> <tr> <td style="white-space:nowrap">code-text <a name="search-modifier-code-code-text"> </a> </td> <td> Code Text</td> <td> Tests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value.</td> </tr> <tr> <td style="white-space:nowrap">text-advanced <a name="search-modifier-code-text-advanced"> </a> </td> <td> Text Advanced</td> <td> 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.</td> </tr> <tr> <td style="white-space:nowrap">iterate <a name="search-modifier-code-iterate"> </a> </td> <td> Iterate</td> <td> The search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource.</td> </tr></table></div> </text> <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="trial-use"/> </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><version value="5.0.0-ballot"/> <name value="SearchModifierCode"/> <title value="SearchModifierCode"/> <status value="draft"/> <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"/>The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).<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"/>The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.<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"/>The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.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"/>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.<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"/>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.<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"/>The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).<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"/>The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).<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"/>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.<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 >
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:50+1000.
04:54+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change