This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - 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 JSON (canonical form + also see JSON Format Specification)
Definition for Code SystemSearchModifierCode
{ "resourceType" : "CodeSystem", "id" : "search-modifier-code", "meta" : { "lastUpdated" : "2023-03-01T23:03:57.298+11:00", "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"] }, "text" : { "status" : "generated", "div" : "<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><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><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><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><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><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><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><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><td style=\"white-space:nowrap\">of-type<a name=\"search-modifier-code-of-type\"> </a></td><td>Of Type</td><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>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode" : "trial-use" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 3 }], "url" : "http://hl7.org/fhir/search-modifier-code", "identifier" : [{ "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.4.640" }, { "use" : "old", "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.1.625" }, { "use" : "old", "system" : "urn:ietf:rfc:3986", "value" : "urn:oid:2.16.840.1.113883.4.642.2.92" }], "version" : "5.0.0-draft-final", "name" : "SearchModifierCode", "title" : "Search Modifier Code", "status" : "active", "experimental" : false, "date" : "2021-01-05T10:01:24+11:00", "publisher" : "HL7 (FHIR Project)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }, { "system" : "email", "value" : "fhir@lists.hl7.org" }] }], "description" : "A supported modifier for a search parameter.", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001", "display" : "World" }] }], "caseSensitive" : true, "valueSet" : "http://hl7.org/fhir/ValueSet/search-modifier-code", "content" : "complete", "concept" : [{ "code" : "missing", "display" : "Missing", "definition" : "The search parameter returns resources that have a value or not." }, { "code" : "exact", "display" : "Exact", "definition" : "The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents)." }, { "code" : "contains", "display" : "Contains", "definition" : "The search parameter returns resources that include the supplied parameter value anywhere within the field being searched." }, { "code" : "not", "display" : "Not", "definition" : "The search parameter returns resources that do not contain a match." }, { "code" : "text", "display" : "Text", "definition" : "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." }, { "code" : "in", "display" : "In", "definition" : "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." }, { "code" : "not-in", "display" : "Not In", "definition" : "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." }, { "code" : "below", "display" : "Below", "definition" : "The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships)." }, { "code" : "above", "display" : "Above", "definition" : "The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships)." }, { "code" : "type", "display" : "Type", "definition" : "The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.)." }, { "code" : "identifier", "display" : "Identifier", "definition" : "The search parameter applies to the identifier on the resource, not the reference." }, { "code" : "of-type", "display" : "Of Type", "definition" : "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." }, { "code" : "code-text", "display" : "Code Text", "definition" : "Tests whether the textual display value in a resource (e.g., CodeableConcept.text, Coding.display, or Reference.display) matches the supplied parameter value." }, { "code" : "text-advanced", "display" : "Text Advanced", "definition" : "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." }, { "code" : "iterate", "display" : "Iterate", "definition" : "The search parameter indicates an inclusion directive (_include, _revinclude) that is applied to an included resource instead of the matching resource." }] }
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 R5 hl7.fhir.core#5.0.0-draft-final generated on Wed, Mar 1, 2023 23:05+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change