Skip to main content

Module canonical

Module canonical 

Source
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 than OUTPUT_FORMAT_VALUE_SET: it omits fhir, 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 LibraryTypesCodes system. 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 plain ViewDefinition token instead.
LIBRARY_TYPES_CODE_SYSTEM
Library.type.coding.system fixed 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-text extension carrying plain-text SQL alongside the base64 Attachment.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.