FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageio.health-samurai.core.r5
Resource TypeStructureDefinition
IdStructureDefinition-search.json
FHIR VersionR5

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "description": "Custom search parameter definition resource for Aidbox.",
  "derivation": "specialization",
  "fhirVersion": "5.0.0",
  "name": "Search",
  "abstract": false,
  "type": "Search",
  "resourceType": "StructureDefinition",
  "status": "active",
  "id": "Search",
  "kind": "resource",
  "url": "http://health-samurai.io/fhir/core/StructureDefinition/Search",
  "version": "0.2602.2",
  "differential": {
    "element": [
      {
        "id": "Search",
        "path": "Search",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Search._source",
        "path": "Search._source",
        "short": "System Property. DO NOT USE IT.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.resource",
        "path": "Search.resource",
        "short": "Reference to the resource type this search applies to. ResourceType is always Entity",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "Search.name",
        "path": "Search.name",
        "short": "Name of the search parameter.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.where",
        "path": "Search.where",
        "short": "SQL to use in the WHERE expression. Supports `{{table}}` and `{{param}}`.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.order-by",
        "path": "Search.order-by",
        "short": "SQL to use in the ORDER BY expression. Supports {{table}} and {{param}}. Note that it is used only when _sort=<name> present in the query.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.format",
        "path": "Search.format",
        "short": "Replaces `?` with the actual value provided in the search query. Useful to use in ILIKE SQL expression.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.module",
        "path": "Search.module",
        "short": "Module that this search belongs to.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.param-parser",
        "path": "Search.param-parser",
        "short": "Parse value as string, identifier, or reference.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-372",
            "severity": "error",
            "expression": "%context.subsetOf('token' | 'reference')",
            "human": "Type must be one of: token, reference"
          }
        ]
      },
      {
        "id": "Search.multi",
        "path": "Search.multi",
        "short": "If you set multi = 'array', parameters will be coerced as PostgreSQL array.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-373",
            "severity": "error",
            "expression": "%context.subsetOf('array')",
            "human": "Collection must be: array"
          }
        ]
      },
      {
        "id": "Search.token-sql",
        "path": "Search.token-sql",
        "short": "SQL templates for token parameter handling.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "Search.token-sql.text",
        "path": "Search.token-sql.text",
        "short": "SQL template for text search.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.token-sql.both",
        "path": "Search.token-sql.both",
        "short": "SQL template when both system and code are provided.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.token-sql.only-system",
        "path": "Search.token-sql.only-system",
        "short": "SQL template when only system is provided.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.token-sql.only-code",
        "path": "Search.token-sql.only-code",
        "short": "SQL template when only code is provided.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.token-sql.text-format",
        "path": "Search.token-sql.text-format",
        "short": "Format for text search.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Search.token-sql.no-system",
        "path": "Search.token-sql.no-system",
        "short": "SQL template when no system is provided.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}