obscyro

Api / Concepts

/v1/concepts/{code}

Look up SNOMED concept metadata and the preferred display term.

GET/v1/concepts/{code}

Returns metadata and the preferred display term for a single SNOMED concept. Resolution prefers the shortest active synonym; if none exists, the FSN is returned.

Path parameters

Parameters

  • codestringrequired

    A numeric SCTID. Must match the regex ^\d+$.

Response

Concept found
{
  "code": "22298006",
  "active": true,
  "effectiveTime": 20020131,
  "definitionStatus": "defined",
  "preferredTerm": "Myocardial infarction"
}

Response body

  • codestringoptional
    The SCTID you asked for, echoed back.
  • activebooleanoptional
    Whether the concept is still in the active SNOMED edition. Inactive concepts are returned but flagged.
  • effectiveTimeintegeroptional
    SNOMED effectiveTime stamp, in YYYYMMDD form, of the most recent change.
  • definitionStatusstringoptional
    One of primitive or defined.
  • preferredTermstring | nulloptional
    Shortest active synonym, falling back to FSN. null if the concept has no active descriptions.

Examples

curl https://api.obscyro.com/v1/concepts/22298006 \
  -H "Authorization: Bearer $OBS_KEY"

Validating a code

Use GET to check whether a SCTID exists and retrieve its metadata. A 404 CONCEPT_NOT_FOUND means the code is absent from the loaded SNOMED edition. A lightweight HEAD existence check (no response body) is planned for a future release.

Errors

  • VALIDATION_ERROR

    code is not a numeric SCTID.

  • INVALID_API_KEY

    Missing or invalid bearer token.

  • CONCEPT_NOT_FOUND

    No concept with this SCTID exists in the SNOMED edition.

  • RATE_LIMITED

    Per-minute rate limit exceeded for this key.