FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3

Codesystem-filter-operator.json

Vocabulary Work Group Maturity Level : N/A Ballot Standards Status : Informative

Raw JSON ( canonical form + also see JSON Format Specification )

Definition for Code System FilterOperator 

{
  "resourceType": "CodeSystem",
  "id": "filter-operator",
  "meta": {
    "lastUpdated": "2019-10-24T11:53:00+11:00"

  "resourceType" : "CodeSystem",
  "id" : "filter-operator",
  "meta" : {
    "lastUpdated" : "2019-11-01T09:29:23.356+11:00"

  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"

  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"

  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Informative"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "vocab"
    }
  ],
  "url": "http://hl7.org/fhir/filter-operator",
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:2.16.840.1.113883.4.642.1.472"

  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"

  },
  "version": "3.0.2",
  "name": "FilterOperator",
  "status": "draft",
  "experimental": false,
  "date": "2019-10-24T11:53:00+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The kind of operation to perform as a part of a property based filter.",
  "caseSensitive": true,
  "valueSet": "http://hl7.org/fhir/ValueSet/filter-operator",
  "content": "complete",
  "concept": [
    {
      "code": "=",
      "display": "Equals",
      "definition": "The specified property of the code equals the provided value."
    },
    {
      "code": "is-a",
      "display": "Is A (by subsumption)",
      "definition": "Includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, including the provided concept itself (i.e. include child codes)"
    },
    {
      "code": "descendent-of",
      "display": "Descendent Of (by subsumption)",
      "definition": "Includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, excluding the provided concept itself (i.e. include child codes)"
    },
    {
      "code": "is-not-a",
      "display": "Not (Is A) (by subsumption)",
      "definition": "The specified property of the code does not have an is-a relationship with the provided value."
    },
    {
      "code": "regex",
      "display": "Regular Expression",
      "definition": "The specified property of the code  matches the regex specified in the provided value."
    },
    {
      "code": "in",
      "display": "In Set",
      "definition": "The specified property of the code is in the set of codes or concepts specified in the provided value (comma separated list)."
    },
    {
      "code": "not-in",
      "display": "Not in Set",
      "definition": "The specified property of the code is not in the set of codes or concepts specified in the provided value (comma separated list)."
    },
    {
      "code": "generalizes",
      "display": "Generalizes (by Subsumption)",
      "definition": "Includes all concept ids that have a transitive is-a relationship from the concept Id provided as the value, including the provided concept itself (e.g. include parent codes)"

  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/filter-operator",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.479"
  }],
  "version" : "4.0.1",
  "name" : "FilterOperator",
  "title" : "FilterOperator",
  "status" : "active",
  "experimental" : false,
  "date" : "2019-11-01T09:29:23+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"

    },
    {
      "code": "exists",
      "display": "Exists",
      "definition": "The specified property of the code has at least one value (if the specified value is true; if the specified value is false, then matches when the specified property of the code has no values)"
    }
  ]

      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "The kind of operation to perform as a part of a property based filter.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/filter-operator",
  "content" : "complete",
  "concept" : [{
    "code" : "=",
    "display" : "Equals",
    "definition" : "The specified property of the code equals the provided value."
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
      "valueString" : "The definition of is-a is that all the properties of the value are true for the specified property of the code, which means that a code has an is-a relationship with itself. To exclude the root code, use descendent-of"
    }],
    "code" : "is-a",
    "display" : "Is A (by subsumption)",
    "definition" : "Includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, including the provided concept itself (include descendant codes and self)."
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
      "valueString" : "The definition of is-a is that all the properties of the value are true for the specified property of the code. \n\nSpelling note: \"descendant\" is a more correct spelling, but the spelling \"descendent\" is maintained in the code for backwards compatibility reasons"
    }],
    "code" : "descendent-of",
    "display" : "Descendent Of (by subsumption)",
    "definition" : "Includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, excluding the provided concept itself i.e. include descendant codes only)."
  },
  {
    "code" : "is-not-a",
    "display" : "Not (Is A) (by subsumption)",
    "definition" : "The specified property of the code does not have an is-a relationship with the provided value."
  },
  {
    "code" : "regex",
    "display" : "Regular Expression",
    "definition" : "The specified property of the code  matches the regex specified in the provided value."
  },
  {
    "code" : "in",
    "display" : "In Set",
    "definition" : "The specified property of the code is in the set of codes or concepts specified in the provided value (comma separated list)."
  },
  {
    "code" : "not-in",
    "display" : "Not in Set",
    "definition" : "The specified property of the code is not in the set of codes or concepts specified in the provided value (comma separated list)."
  },
  {
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
      "valueString" : "The definition of is-a is that all the properties of the value are true for the specified property of the code, which means that a code has an is-a relationship with itself. To exclude the root code, add it explicitly to as an exclude"
    }],
    "code" : "generalizes",
    "display" : "Generalizes (by Subsumption)",
    "definition" : "Includes all concept ids that have a transitive is-a relationship from the concept Id provided as the value, including the provided concept itself (i.e. include ancestor codes and self)."
  },
  {
    "code" : "exists",
    "display" : "Exists",
    "definition" : "The specified property of the code has at least one value (if the specified value is true; if the specified value is false, then matches when the specified property of the code has no values)."
  }]

}

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.