Discovery
What exists, and who this token is. Most of this group answers without a credential, which makes it the quickest way to confirm a short code instead of guessing it. Taught in The terminology service.
What this server declares it supports
The FHIR capability statement. The first call when wiring any FHIR terminology client.
Keep from the response: the capability statement
Answers without a credential. What you see is what is published publicly, so an emptier list than you expected is scope rather than absence.
What this server declares it supports › Responses
Returns the capability statement.
The code system catalogue
Authenticated callers see their organisation's systems. Anonymous callers see only what is published publicly, so a system you expect may be invisible rather than missing.
Keep from the response: short_code, id
Answers without a credential. What you see is what is published publicly, so an emptier list than you expected is scope rather than absence.
query Parameters
page_sizeResults per page. A sync that reads only page one ships a fraction of a vocabulary and looks like it worked.
pagePage number. Follow next in the response rather than computing this.
The code system catalogue › Responses
Returns short_code, id.
The version ladder, and the pin
Returns {pin_mode, pinned_version, serving, pin_warning, versions}. serving is the version_id that ?version=serving resolves to, or null when nothing is servable — the fastest answer to "what will I actually get?". Each row carries is_serving and is_head_draft.
version_id is a display label and its numbering is not monotonic across mint paths: never sort on it and never read recency into it. Ordering is by an internal sequence where the version model has one, else by creation time. Use is_serving, not the first row.
Keep from the response: serving, pin_mode, pin_warning
path Parameters
systemThe code system, addressed by its short code (recommended) or its numeric id.
Resolution is pk-first: a value that looks numeric is tried as an id, and falls through to the code column when no row matches, so an all-digits short code is still reachable. Codes are matched case-insensitively after an exact miss. The one ambiguity — a short code identical to some other row's id — resolves to the id.
Example: IDENTIFIER-TYPES.
The version ladder, and the pin › Responses
Returns serving, pin_mode, pin_warning.
What binds to this system
Which value sets and concept maps depend on it. Check before assuming a system can be retired.
path Parameters
systemThe code system, addressed by its short code (recommended) or its numeric id.
Resolution is pk-first: a value that looks numeric is tried as an id, and falls through to the code column when no row matches, so an all-digits short code is still reachable. Codes are matched case-insensitively after an exact miss. The one ambiguity — a short code identical to some other row's id — resolves to the id.
Example: IDENTIFIER-TYPES.
What binds to this system › Responses
Success.