obscyro

Getting Started / Quickstart

Quickstart

From zero to your first normalized concept in under a minute.

1. Get a key

Mint an API key by signing up or via the CLI (npm run create-key). Export it:

export OBS_KEY="obs_live_AbCDef12_GhIjKl34..."

2. Normalize free text

The most common first call is POST /v1/normalize. It takes a clinical phrase and returns ranked SNOMED candidates.

POST/v1/normalize
curl -X POST https://api.obscyro.com/v1/normalize \
  -H "Authorization: Bearer $OBS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"acute MI","limit":3}'

3. Inspect the response

{
  "matches": [
    {
      "code": "22298006",
      "term": "Myocardial infarction",
      "conceptName": "Myocardial infarction",
      "confidence": 0.94,
      "matchType": "fts"
    },
    {
      "code": "57054005",
      "term": "Acute myocardial infarction",
      "conceptName": "Acute myocardial infarction",
      "confidence": 0.88,
      "matchType": "fts"
    }
  ]
}

Each match carries a matchType (exact, fts, or trigram) so you can choose how strict to be in your application.

Next steps