DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Search-param-type.json

Raw JSON (canonical form)

Definition for Value SetSearchParamType

{
  "resourceType": "ValueSet",
  "id": "search-param-type",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.4.642.2.9"
    }
  ],
  "url": "http://hl7.org/fhir/vs/search-param-type",
  "version": "0.5.0",
  "name": "SearchParamType",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Data types allowed to be used for search parameters",
  "status": "draft",
  "experimental": false,
  "date": "2015-04-03T14:24:32+11:00",
  "define": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
        "valueUri": "urn:oid:2.16.840.1.113883.4.642.1.9"
      }
    ],
    "system": "http://hl7.org/fhir/search-param-type",
    "caseSensitive": true,
    "concept": [
      {
        "code": "number",
        "display": "Number",
        "definition": "Search parameter SHALL be a number (a whole number, or a decimal)."
      },
      {
        "code": "date",
        "display": "Date/DateTime",
        "definition": "Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported."
      },
      {
        "code": "string",
        "display": "String",
        "definition": "Search parameter is a simple string, like a name part. Search is case-insensitive and accent-insensitive. May match just the start of a string. String parameters may contain spaces."
      },
      {
        "code": "token",
        "display": "Token",
        "definition": "Search parameter on a coded element or identifier. May be used to search through the text, displayname, code and code/codesystem (for codes) and label, system and key (for identifier). Its value is either a string or a pair of namespace and value, separated by a \"|\", depending on the modifier used."
      },
      {
        "code": "reference",
        "display": "Reference",
        "definition": "A reference to another resource."
      },
      {
        "code": "composite",
        "display": "Composite",
        "definition": "A composite search parameter that combines a search on two values together."
      },
      {
        "code": "quantity",
        "display": "Quantity",
        "definition": "A search parameter that searches on a quantity."
      },
      {
        "code": "uri",
        "display": "URI",
        "definition": "A search parameter that searches on a URI (RFC 3986)."
      }
    ]
  }
}

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.