Skip to main content
FHIR CodeSystem read for OMOP vocabularies

Overview

Returns a single CodeSystem resource by its FHIR id. OMOPHub recognizes two ID shapes:
  1. Per-vocabulary stub IDs - short lowercase slugs (loinc, snomed, rxnorm, icd-10-cm, …) that map 1:1 to canonical FHIR system URIs. These return content: "not-present" stubs with metadata only.
  2. Unified OMOP release IDs - the release-specific FHIR id (e.g. omop-v20250827) for the omnibus OMOP CodeSystem that covers every supported vocabulary under one URL. These return the full CodeSystem resource with all OMOP property definitions.

Path Parameters

string
default:"r4"
string
OMOP vocabulary release; defaults to the active release.
string
Header alternative to vocab_release; the header takes precedence.
FHIR wire version (r4, r4b, r5, or r6).
string
required
Per-vocabulary CodeSystem ID, FHIR release ID, or OMOPHub release string.

Request

Per-vocabulary stub

Unified OMOP release

Use the metadata endpoint to discover the current release ID, or call CodeSystem search with url=https://fhir-terminology.ohdsi.org to fetch the unified resource via the canonical URL.

Response (per-vocabulary stub)

Response Fields

string
Always CodeSystem.
string
Stable CodeSystem resource ID.
string
Canonical system URI.
string | null
OMOP release for the unified resource.
string
Machine-readable name.
string
Human-readable title.
string
Publication status.
boolean
Whether this resource is experimental.
string | null
Release date for the unified resource.
string
Vocabulary publisher.
string
CodeSystem description.
string
Content mode; currently not-present.
array
Unified-resource OMOP property definitions (code, description, and type).
Instance reads return a bare CodeSystem resource, not a Bundle. Only search-type queries wrap results in a Bundle.

Response (unified OMOP release)

The full response lists every OMOP property and relationship type the server supports - see $lookup properties in the overview for the complete set.

Why two shapes?

OMOPHub serves all 120+ vocabularies from a single unified backend. The per-vocab stubs are thin FHIR-conformant views over that backend, added so clients like HAPI and EHRbase can discover http://loinc.org as a first-class CodeSystem instead of having to know the OMOP omnibus URL. Both shapes resolve to the same concept data; pick whichever matches your client’s expectations.

Errors

See Also