Benefits and rates

The 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 benefit node code.

Which version of the artefact this read serves.

• serving — the version the artefact currently resolves to: the author's or regulator's MANUAL pin if one is set, otherwise the newest released version effective today. This is what an integration should send.
• a released version's version_id (v1.0.0) or its numeric id — exactly that frozen release. Only released versions are honoured; an unknown or unreleased reference falls back to the working copy with a warning rather than failing.
• draft — the pending draft, for reviewers. Requires the reviewer permission.

Omitted, what you get depends on the artefact: the working copy including drafts while it is unpinned, or the pinned version if an owner has set one. That is what an authoring client wants and the opposite of what a consumer wants — the problem is not that it is always live, but that you cannot tell which you got.

One exception to serving meaning frozen, and it is silent: a code system release predating the content-versioning backfill carries no ordinal, so the read serves the live working copy at 200 with no signal in the body or headers. Detect it on the artefact instead — a released version whose ladder row has sequence: null has no frozen content to serve.

A pinned read is cacheable indefinitely (Cache-Control: immutable); an unversioned one is no-cache, because its content changes on release with no write to the rows it would be cached on.

The 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.

Which version of the artefact this read serves.

• serving — the version the artefact currently resolves to: the author's or regulator's MANUAL pin if one is set, otherwise the newest released version effective today. This is what an integration should send.
• a released version's version_id (v1.0.0) or its numeric id — exactly that frozen release. Only released versions are honoured; an unknown or unreleased reference falls back to the working copy with a warning rather than failing.
• draft — the pending draft, for reviewers. Requires the reviewer permission.

Omitted, what you get depends on the artefact: the working copy including drafts while it is unpinned, or the pinned version if an owner has set one. That is what an authoring client wants and the opposite of what a consumer wants — the problem is not that it is always live, but that you cannot tell which you got.

One exception to serving meaning frozen, and it is silent: a code system release predating the content-versioning backfill carries no ordinal, so the read serves the live working copy at 200 with no signal in the body or headers. Detect it on the artefact instead — a released version whose ladder row has sequence: null has no frozen content to serve.

A pinned read is cacheable indefinitely (Cache-Control: immutable); an unversioned one is no-cache, because its content changes on release with no write to the rows it would be cached on.

The panel id.

The panel id.

The code to resolve.

The scheme to price against.

The benefit node to price.