Search API

Search the current workspace

Search patients and appointments in the current workspace.

POST/v1/search

capability search.query · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

querystringrequired
bodymin length 1max length 200
kinds"patient" | "appointment"[]
bodydefault ["patient","appointment"]min items 1max items 2
limitinteger
bodydefault 20min 1max 50

Response

Successful responses use Dawn's data envelope.

dataSearchResponserequired
- hitsobject[]required
  - kind"patient" | "appointment"required
  - resourceIdstring<uuid>required
  - titlestringrequired
    min length 1
  - subtitlestring | nullrequired
  - scorenumberrequired
    min 0
- mode"lexical" | "hybrid"required
metaobject

Errors

Error responses use the shared error envelope.

422The search query is invalid.
503Search is temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["search.query"]({
  "query": "Ada",
  "kinds": ["patient", "appointment"],
  "limit": 20,
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": {
    "hits": [
      {
        "kind": "patient",
        "resourceId": "11111111-1111-4111-8111-111111111111",
        "title": "Ada Lovelace",
        "subtitle": null,
        "score": 0.98
      }
    ],
    "mode": "lexical"
  },
  "meta": {}
}