SQL on FHIR
2.1.0-pre - release
SQL on FHIR - Local Development build (v2.1.0-pre) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://sql-on-fhir.org/ig/StructureDefinition/SQLQuery | Version: 2.1.0-pre | |||
Draft as of 2025-07-31 | Computable Name: SQLQuery |
A profile for FHIR Library used to represent a single logical SQL query, possibly with multiple SQL dialects.
Purpose:
The FHIR Library represents the SQL expression as a content attachment. If there are multiple dialects specified for the single logical query, each will have a separate attachment.
The dialect may specified using a mime-type parameter dialect
. For example:
Content-Type: application/sql; dialect=sql-2
The permitted values for dialect can be found the All SQL Dialect Codes valueset.
The attachment.data
is a Base64-encoded string, per the FHIR specification. The
library may include relatedArtifacts to refer to ViewDefinition dependencies or
other resources that relate to the query.
Conformance Summary:
SQLonFHIR#query-library
).contentType
.Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system |
![]() ![]() ![]() |
1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: cnl-0, sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
Library.type | extensible | Pattern Value: sql-queryhttp://hl7.org/fhir/ValueSet/library-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: cnl-0, sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | Type of individual the library content is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the library | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the library was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
![]() ![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Library.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Library.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm From the FHIR Standard | |
Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
Library.type | extensible | Pattern Value: sql-queryhttp://hl7.org/fhir/ValueSet/library-type From the FHIR Standard | |
Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types From the FHIR Standard | |
Library.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | |
Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Library.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
This structure is derived from Library
Differential View
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system |
![]() ![]() ![]() |
1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Required Pattern: At least the following | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: cnl-0, sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
Library.type | extensible | Pattern Value: sql-queryhttp://hl7.org/fhir/ValueSet/library-type From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Library | Represents a library of quality improvement components Constraints: cnl-0, sql-must-be-sql-expressions, sql-dialect-must-be-in-dialect-code-system | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) Constraints: cnl-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://sql-on-fhir.org/ig/CodeSystem/LibraryTypesCodes | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: sql-query | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | Type of individual the library content is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the library | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the library was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
![]() ![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Library.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Library.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm From the FHIR Standard | |
Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 From the FHIR Standard | |
Library.type | extensible | Pattern Value: sql-queryhttp://hl7.org/fhir/ValueSet/library-type From the FHIR Standard | |
Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types From the FHIR Standard | |
Library.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | |
Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Library.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sql-dialect-must-be-in-dialect-code-system | error | Library | The dialect specified in the content attachment must match one of the codes in the AllSQLDialectCodes ValueSet. : content.where(contentType.contains('dialect')).contentType.select(substring(indexOf('dialect=') + 8) memberOf('https://sql-on-fhir.org/ig/ValueSet/AllSQLDialectCodes')).allTrue() | |
sql-must-be-sql-expressions | error | Library | The content of the Library must be SQL expressions. : content.contentType.startsWith('application/sql') |
This structure is derived from Library
Other representations of profile: CSV, Excel, Schematron