description: The SQLQuery profile represents a SQL query that runs against ViewDefinition\ntables. It bundles the SQL, dependencies, and parameters for sharing and\nversioning.
package_name: io.health-samurai.core.r4b
derivation: constraint
name: SQLQuery
type: Library
elements:
  type:
    pattern:
      type: CodeableConcept
      value:
        coding:
        - {code: sql-query, system: 'https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes'}
    index: 0
  relatedArtifact:
    mustSupport: true
    index: 1
    elements:
      type: {short: depends-on for ViewDefinition references, mustSupport: true, index: 2}
      label:
        short: Table name used in SQL query
        constraint:
          sql-name:
            human: "Name is limited to letters, numbers, or underscores and cannot start with an\nunderscore -- i.e. with a regular expression of: ^[A-Za-z][A-Za-z0-9_]*$ \n\n\nThis makes it usable as table names in a wide variety of databases."
            source: https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery
            severity: error
            expression: empty() or matches('^[A-Za-z][A-Za-z0-9_]*$')
        mustSupport: true
        index: 3
      resource: {short: Canonical URL of ViewDefinition, mustSupport: true, index: 4}
    required: [resource, label]
  parameter:
    mustSupport: true
    index: 5
    elements:
      name: {mustSupport: true, index: 6}
      use: {short: in (query parameters are always input), mustSupport: true, index: 7}
      type: {mustSupport: true, index: 8}
    required: [name]
  content:
    mustSupport: true
    index: 9
    extensions:
      sqlText: {url: 'https://sql-on-fhir.org/ig/StructureDefinition/sql-text', min: 0, max: 1, type: Extension, short: Plain-text SQL for readability, mustSupport: true, index: 10}
    elements:
      extension:
        type: Extension
        short: Plain-text SQL for readability
        mustSupport: true
        url: https://sql-on-fhir.org/ig/StructureDefinition/sql-text
        index: 10
        slicing:
          slices:
            sqlText:
              match: {}
              schema: {type: Extension, short: Plain-text SQL for readability, mustSupport: true, url: 'https://sql-on-fhir.org/ig/StructureDefinition/sql-text', index: 10}
              min: 0
              max: 1
      contentType:
        short: application/sql or application/sql;dialect=...
        binding: {strength: example, valueSet: 'https://sql-on-fhir.org/ig/ValueSet/AllSQLContentTypeCodes'}
        mustSupport: true
        index: 11
      data: {short: SQL query (base64-encoded), mustSupport: true, index: 12}
    required: [contentType, data]
package_version: 0.2605.0
class: profile
kind: resource
url: https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery
base: http://hl7.org/fhir/StructureDefinition/Library
version: 0.2605.0
required: [content]