Search Resource Type

The FHIR search operation allows you to search for resources of a specific type that match certain search criteria. This is done using an HTTP GET request to the endpoint corresponding to the resource type with query parameters.

CLI

Search for Patient resources using the Haste Health CLI:

haste-health api search-type Patient "name=Smith"

This command searches for Patient resources with family name "Smith".

You can also search without parameters to get all resources of a type:

haste-health api search-type Patient

TypeScript

Search for Patient resources using the TypeScript client:

import { AsynchronousClient } from '@haste-health/client';
import { R4 } from '@haste-health/fhir-types/versions';
import { Patient } from '@haste-health/fhir-types/r4/types';

// Assuming you have a configured client
const client: AsynchronousClient<{}> = /* ... */;

const searchResults = await client.search_type<typeof R4, 'Patient'>(
  {},
  R4,
  'Patient',
  'name=Smith'
);

console.log('Total matches:', searchResults.total);
console.log('Patients found:', searchResults.resources);

// You can also use parsed parameters
import { parseQuery } from '@haste-health/client/url';

const searchWithParsed = await client.search_type<typeof R4, 'Patient'>(
  {},
  R4,
  'Patient',
  parseQuery('name=Smith')
);

cURL

Search for Patient resources using cURL:

curl -X GET "https://api.haste.health/w/[tenant]/[project]/api/v1/fhir/Patient?name=Smith&birthdate=ge1980-01-01" \
     -H "Content-Type: application/fhir+json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Replace [tenant] with your tenant name and [project] with your project ID.

_include

_include=Type:param[:TargetType] follows a reference on each matched resource and adds the referenced resource to the bundle:

haste-health api search-type Observation "_include=Observation:subject"

Every entry carries search.mode: match for the resources you searched for, include for what _include added — so a client can tell them apart. Includes are deduplicated (the same referenced resource is never added twice), capped at 1,000 added resources per search, and a dangling reference (one that no longer resolves) is silently skipped rather than failing the search.

Add :iterate to follow references one hop further, out of what the first hop already included:

haste-health api search-type Observation "_include=Observation:subject&_include:iterate=Patient:organization"

_revinclude (following references inward — "resources that point at my matches") is not yet implemented.

_elements and _summary

_elements=field1,field2 returns only the named top-level fields (plus a resource's always-present elements); _summary=true|text|count returns the SMART-defined summary subset, the narrative only, or just a match count. Both apply only to the resources you searched for — anything added by _include is returned in full, since trimming a reference's target defeats the reason you asked for it.

haste-health api search-type Patient "_elements=name,birthDate"

Error Handling

If there are any issues with the request (e.g., invalid search parameters), the server will respond with an appropriate error status code and include an OperationOutcome resource in the response body.

HTTP/1.1 400 Bad Request
Content-Type: application/fhir+json

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "diagnostics": "Invalid search parameter: unknown_param"
    }
  ]
}