FHIR IG analytics| Package | org.sql-on-fhir.ig |
| Resource Type | ImplementationGuide |
| Id | ImplementationGuide-org.sql-on-fhir.ig.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/index.html |
| URL | https://sql-on-fhir.org/ig/ImplementationGuide/org.sql-on-fhir.ig |
| Version | 2.1.0-pre |
| Status | draft |
| Date | 2026-02-04T07:56:19+00:00 |
| Name | SQLonFHIR |
| Title | SQL on FHIR |
| Realm | uv |
| Description | A specification for defining portable views of FHIR data that can be easily queried using tools such as SQL. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide org.sql-on-fhir.ig
The official URL for this implementation guide is:
https://sql-on-fhir.org/ig/ImplementationGuide/org.sql-on-fhir.ig
A specification for defining portable views of FHIR data that can be easily queried using tools such as SQL.
FHIR
FHIRsmith{
"resourceType": "ImplementationGuide",
"id": "org.sql-on-fhir.ig",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "https://sql-on-fhir.org/ig/ImplementationGuide/org.sql-on-fhir.ig",
"version": "2.1.0-pre",
"name": "SQLonFHIR",
"title": "SQL on FHIR",
"status": "draft",
"date": "2026-02-04T07:56:19+00:00",
"publisher": "SQL on FHIR Working Group",
"contact": [
{
"name": "SQL on FHIR Working Group",
"telecom": [
{
"system": "url",
"value": "https://sql-on-fhir.org"
}
]
}
],
"description": "A specification for defining portable views of FHIR data that can be easily queried using tools such as SQL.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"packageId": "org.sql-on-fhir.ig",
"license": "CC0-1.0",
"fhirVersion": [
"5.0.0"
],
"dependsOn": [
{
"id": "hl7tx",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment",
"valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology"
}
],
"uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId": "hl7.terminology.r5",
"version": "7.0.1"
},
{
"id": "hl7_fhir_uv_extensions_r5",
"uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions",
"packageId": "hl7.fhir.uv.extensions.r5",
"version": "5.2.0"
}
],
"definition": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency",
"valueCode": "hl7.fhir.uv.tools.r5#0.9.0"
}
],
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/AllSQLDialectCodes"
},
"name": "All SQL Dialect Codes",
"description": "ValueSet of all codes from SQL Dialect Codes codesystem",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/ConditionFlat"
},
"name": "ConditionFlat",
"description": "A simple view for flattening a Condition resource. Some of the\nmore commonly used fields are included in this flat view. A notable point\nis flattening of `category.coding` fields with one `forEach` construct as\nFHIRPath will take care of handling of nested arrays.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/EncounterFlat"
},
"name": "EncounterFlat",
"description": "A simple view for flattening an Encounter resource. Some of the\nmore commonly used fields are included in this flat view. Note this is valid\nfor an R4 Encounter resource but not R5 (hence the `fhirVersion`).",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/ExportStatusCodes"
},
"name": "Export Status Code System",
"description": "Export status codes for SQL on FHIR.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/ExportStatusCodes"
},
"name": "Export Status Codes",
"description": "ValueSet of all codes from Export Status Codes codesystem",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
}
],
"reference": {
"reference": "ValueSet/OutputFormatCodes"
},
"name": "Output Format Codes",
"description": "ValueSet of all codes from Output Format Codes codesystem",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/OutputFormatCodes"
},
"name": "Output Format Codes",
"description": "Output format codes for SQL on FHIR.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/PatientAddresses"
},
"name": "PatientAddresses",
"description": "An example of unnesting patient addresses into multiple\nrows.\n\nThis view uses `forEach` to indicate we are unrolling these into separate rows. \nThe `join` function is used to create a single address line.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/PatientAndContactAddressUnion"
},
"name": "PatientAndContactAddressUnion",
"description": "An example of unnesting patient addresses and contact addresss\ninto multiple rows, which are unioned together into a single table.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/PatientDemographics"
},
"name": "PatientDemographics",
"description": "A minimal example of a patient demographics view.\nThis view uses the first 'official' patient name for our demographics table.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:logical"
}
],
"reference": {
"reference": "StructureDefinition/ShareableViewDefinition"
},
"name": "Shareable View Definition",
"description": "A profile for View Definitions intended to be shared between multiple systems. This requires that \nthe View Definition have a defined URL and name. It also requires declaration of the FHIR version \nthat the view is intended to be executed over, and the FHIR type of each column. This ensures \nconsistent interpretation of the view across different view runner implementations.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/ShareablePatientDemographics"
},
"name": "ShareablePatientDemographics",
"description": "Creates the same view as the 'PatientDemographics' example, but applies both the\nShareableViewDefinition and TabularViewDefinition profiles.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ShareableViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/SQLDialectCodes"
},
"name": "SQL Dialects Code System",
"description": "SQL dialects",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
}
],
"reference": {
"reference": "CodeSystem/LibraryTypesCodes"
},
"name": "SQL Library Types Code System",
"description": "Library types for SQL on FHIR.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
}
],
"reference": {
"reference": "Library/SqlOnFhirExample"
},
"name": "SQL on FHIR Example",
"description": "SQL query library example demonstrating converting SQL to FHIR Library with basic annotations that can assist in generating the properties for this FHIR Library.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
}
],
"reference": {
"reference": "StructureDefinition/SQLQuery"
},
"name": "SQL Query Library",
"description": "A profile for FHIR Library used to represent a single logical SQL query,\npossibly with multiple SQL dialects.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:logical"
}
],
"reference": {
"reference": "StructureDefinition/TabularViewDefinition"
},
"name": "Tabular View Definition",
"description": "A profile for View Definitions where each resulting field must contain only a simple scalar value.\nThis is sometimes referred to as 'CSV Mode', but applies to any system that explicitly constrains \nits views or tables to tabular data.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Library"
}
],
"reference": {
"reference": "Library/UniquePatientAddressesQuery"
},
"name": "UniquePatientAddressesQuery",
"description": "A SQL query that defines a query to retrieve unique patient addresses.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-logical",
"valueString": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format",
"valueCode": "application/fhir+json"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Binary"
}
],
"reference": {
"reference": "Binary/UsCoreBloodPressures"
},
"name": "UsCoreBloodPressures",
"description": "A simple view of blood pressure observations, with separate columns for \nsystolic and diastolic values.",
"isExample": true,
"profile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:logical"
}
],
"reference": {
"reference": "StructureDefinition/ViewDefinition"
},
"name": "View Definition",
"description": "A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion \ncriteria are defined by FHIRPath expressions.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
}
],
"reference": {
"reference": "OperationDefinition/ViewDefinitionExport"
},
"name": "ViewDefinition Export",
"description": "Export a view definition. User can provide view definition references and/or resources as part of the input parameters.",
"isExample": false
},
{
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
}
],
"reference": {
"reference": "OperationDefinition/ViewDefinitionRun"
},
"name": "ViewDefinition Run",
"description": "Execute a view definition against supplied or server data.",
"isExample": false
}
],
"page": {
"sourceUrl": "toc.html",
"name": "toc.html",
"title": "Table of Contents",
"generation": "html",
"page": [
{
"sourceUrl": "index.html",
"name": "index.html",
"title": "Home",
"generation": "markdown"
},
{
"sourceUrl": "contributing.html",
"name": "contributing.html",
"title": "Contributing",
"generation": "markdown"
},
{
"sourceUrl": "functional-model.html",
"name": "functional-model.html",
"title": "Functional Model",
"generation": "markdown"
},
{
"sourceUrl": "glossary.html",
"name": "glossary.html",
"title": "Glossary",
"generation": "markdown"
},
{
"sourceUrl": "operations.html",
"name": "operations.html",
"title": "Operations",
"generation": "markdown"
},
{
"sourceUrl": "operations-capability.html",
"name": "operations-capability.html",
"title": "Operations Capability",
"generation": "markdown"
},
{
"sourceUrl": "operations-materialize.html",
"name": "operations-materialize.html",
"title": "Operations Materialize",
"generation": "markdown"
}
]
},
"parameter": [
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "copyrightyear"
},
"value": "2023+"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "releaselabel"
},
"value": "release"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "excludettl"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-test"
},
"value": "tests"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "autoload-resources"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/capabilities"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/examples"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/extensions"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/models"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/operations"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/profiles"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/vocabulary"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/maps"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/testing"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "input/history"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-resource"
},
"value": "fsh-generated/resources"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "template/config"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-pages"
},
"value": "input/images"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "template/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-liquid"
},
"value": "input/liquid"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-qa"
},
"value": "temp/qa"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-temp"
},
"value": "temp/pages"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-output"
},
"value": "output"
},
{
"code": {
"system": "http://hl7.org/fhir/guide-parameter-code",
"code": "path-tx-cache"
},
"value": "input-cache/txcache"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-suppressed-warnings"
},
"value": "input/ignoreWarnings.txt"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "path-history"
},
"value": "https://sql-on-fhir.org/ig/history.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-html"
},
"value": "template-page.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "template-md"
},
"value": "template-page-md.html"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-contact"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-context"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-copyright"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-jurisdiction"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-license"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-publisher"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-version"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "apply-wg"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "active-tables"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "fmm-definition"
},
"value": "http://hl7.org/fhir/versions.html#maturity"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "propagate-status"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "excludelogbinaryformat"
},
"value": "true"
},
{
"code": {
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters",
"code": "tabbed-snapshots"
},
"value": "true"
}
]
}
}