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