Expand description
Canonical URLs published by the SQL on FHIR implementation guide.
Edition 3 (3.0.0-ballot) moved the guide to HL7 stewardship, and a change
of stewardship reissues every canonical URL it publishes. The base changed
from https://sql-on-fhir.org/ig to IG_CANONICAL_BASE, and the package
identifier from org.sql-on-fhir.ig to hl7.fhir.uv.sql-on-fhir.
ViewDefinition is the one exception. It became an additional resource
rather than a logical model, so it carries a canonical in the core FHIR
namespace (VIEW_DEFINITION_STRUCTURE_DEFINITION) following the
convention for a resource incubated outside core — not one under this
guide’s base.
The 2.0.0-era URLs are kept alongside as LEGACY_* so resources authored
against the previous release still parse. Version 2.0.0 remains published at
its original canonical, and the two releases install side by side, so a
reader accepting both is correct against either.
Constants§
- EXPORT_
OUTPUT_ FORMAT_ VALUE_ SET - Output formats bound by
$sql-export. Narrower thanOUTPUT_FORMAT_VALUE_SET: it omitsfhir, which only a run can produce. - EXPORT_
STATUS_ VALUE_ SET - States an asynchronous export passes through.
- IG_
CANONICAL_ BASE - Canonical base for every artifact this guide publishes, except ViewDefinition itself.
- IG_
PACKAGE_ ID - FHIR package identifier for the guide.
- LEGACY_
IG_ CANONICAL_ BASE - Canonical base used by version 2.0.0 and the pre-ballot continuous build.
- LEGACY_
LIBRARY_ TYPES_ CODE_ SYSTEM - Pre-ballot
LibraryTypesCodessystem. Accepted on read for back-compat. - LEGACY_
VIEW_ DEFINITION_ STRUCTURE_ DEFINITION - ViewDefinition’s 2.0.0 canonical, when it was a logical model. Instances
authored against 2.0.0 carried this string in
resourceType; 3.0.0 instances carry the plainViewDefinitiontoken instead. - LIBRARY_
TYPES_ CODE_ SYSTEM Library.type.coding.systemfixed by the SQLQuery and SQLView profiles.- OUTPUT_
FORMAT_ VALUE_ SET - Output formats bound by
$sql-run(csv,ndjson,parquet,json,fhir). - SQL_
EXPORT_ OPERATION_ DEFINITION $sql-export— asynchronous export of one or more subjects as a single job.- SQL_
QUERY_ PROFILE - The SQLQuery profile on
Library. - SQL_
RUN_ OPERATION_ DEFINITION $sql-run— synchronous evaluation of a single subject.- SQL_
TEXT_ EXTENSION - The
sql-textextension carrying plain-text SQL alongside the base64Attachment.data. - SQL_
VIEW_ PROFILE - The SQLView profile on
Library. - VIEW_
DEFINITION_ STRUCTURE_ DEFINITION - ViewDefinition’s StructureDefinition, in the core FHIR namespace because it is an additional resource rather than an artifact of this guide.