Release v1.0.0

Author: alexanderkiel

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v1.0.0
+
+### Enhancements
+
+* Implement Summary Mode for all Resources ([#199](https://github.com/samply/blaze/issues/199))
+
+### Security
+
+* Remove CORS Header ([#2691](https://github.com/samply/blaze/issues/2691))
+
+### Bugfixes
+
+* Fix missing Value Access in Some DateTime Types ([#2686](https://github.com/samply/blaze/issues/2686))
+
+The full changelog can be found [here](https://github.com/samply/blaze/milestone/85?closed=1).
+
 ## v0.34.0
 
 ### Notes

Dockerfile

@@ -9,7 +9,7 @@ RUN apt-get update && \
     rm -rf /var/lib/apt/lists/
 
 RUN mkdir -p /app/data && chown 1001:1001 /app/data
-COPY target/blaze-0.34.0-standalone.jar /app/
+COPY target/blaze-1.0.0-standalone.jar /app/
 
 WORKDIR /app
 USER 1001
@@ -22,4 +22,4 @@ ENV RESOURCE_DB_DIR="/app/data/resource"
 ENV ADMIN_INDEX_DB_DIR="/app/data/admin-index"
 ENV ADMIN_TRANSACTION_DB_DIR="/app/data/admin-transaction"
 
-CMD ["java", "-jar",  "blaze-0.34.0-standalone.jar"]
+CMD ["java", "-jar",  "blaze-1.0.0-standalone.jar"]

README.md

@@ -7,21 +7,30 @@
 [![Latest Release](https://img.shields.io/github/v/release/samply/blaze?color=1874a7)][5]
 [![Docs](https://img.shields.io/badge/Docs-blue.svg)](https://samply.github.io/blaze)
 
-A FHIR® Store with internal, fast CQL Evaluation Engine
+A FHIR® Server with internal, fast CQL Evaluation Engine
 
 ## Goal
 
-The goal of this project is to provide a FHIR® Store with an internal CQL Evaluation Engine which is able to answer population wide aggregate queries in a timely manner to enable interactive, online queries.
+The goal of this project is to provide a FHIR® Server with an internal CQL Evaluation Engine which is able to answer population wide aggregate queries in a timely manner to enable interactive, online queries over millions of patients.
 
 ## Demo
 
 A demo installation can be found [here](https://blaze.life.uni-leipzig.de/fhir) (user/password: demo).
 
 ## State
 
-Blaze is widely used in the [Medical Informatics Initiative](https://www.medizininformatik-initiative.de) in Germany and in [Biobanks](https://www.bbmri-eric.eu) across Europe. A 1.0 version is expected in the next months.
+Blaze is stable and widely used in the [Medical Informatics Initiative](https://www.medizininformatik-initiative.de) in Germany and in [Biobanks](https://www.bbmri-eric.eu) across Europe.
 
-Latest release: [v0.34.0][5]
+Latest release: [v1.0.0][5]
+
+## Key Features
+
+* Implements large parts of the [FHIR® R4 API][1]
+* Contains a fast [CQL Evaluation Engine][17]
+* Supports the operations [$evaluate-measure][2], [$everything][13], [$validate-code][14], [$expand][15] amongst others
+* Offers [terminology services][16] including LOINC and SNOMED CT
+* Scales horizontally via [Distributed Storage Variant][18]
+* Comes with a modern [Web Frontend][19]
 
 ## Documentation
 
@@ -51,12 +60,21 @@ http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
+[1]: <https://samply.github.io/blaze/api.html>
+[2]: <https://samply.github.io/blaze/api/operation/measure-evaluate-measure.html>
 [3]: <https://cql.hl7.org/tests.html>
 [4]: <https://alexanderkiel.gitbook.io/blaze/deployment>
-[5]: <https://github.com/samply/blaze/releases/tag/v0.34.0>
+[5]: <https://github.com/samply/blaze/releases/tag/v1.0.0>
 [6]: <https://www.yourkit.com/java/profiler/>
 [7]: <https://www.yourkit.com/.net/profiler/>
 [8]: <https://www.yourkit.com/youmonitor/>
 [9]: <https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning#block-cache-size>
 [10]: <https://github.com/facebook/rocksdb/wiki/RocksDB-Basics#multi-threaded-compactions>
 [12]: <https://touchstone.aegis.net/touchstone/conformance/history?suite=FHIR4-0-1-Basic-Server&supportedOnly=true&suiteType=HL7_FHIR_SERVER&ownedBy=ALL&ps=10&published=true&pPass=0&strSVersion=6&format=ALL>
+[13]: <https://samply.github.io/blaze/api/operation/patient-everything.html>
+[14]: <https://samply.github.io/blaze/api/operation/code-system-validate-code.html>
+[15]: <https://samply.github.io/blaze/api/operation/value-set-expand.html>
+[16]: <https://samply.github.io/blaze/terminology-service.html>
+[17]: <https://samply.github.io/blaze/cql-queries.html>
+[18]: <https://samply.github.io/blaze/deployment/distributed-backend.html>
+[19]: <https://samply.github.io/blaze/frontend.html>

build.clj

@@ -5,7 +5,7 @@
    [java.time LocalDate]))
 
 (def lib 'samply/blaze)
-(def version "0.34.0")
+(def version "1.0.0")
 (def class-dir "target/classes")
 (def basis (b/create-basis {:project "deps.edn"}))
 (def uber-file (format "target/%s-%s-standalone.jar" (name lib) version))

docs/.vitepress/config.ts

@@ -40,7 +40,7 @@ export default defineConfig({
 		nav: [
 			{ text: 'Home', link: '/' },
 			{
-				text: 'v0.34.0',
+				text: 'v1.0.0',
 				items: [
 					{
 						text: 'Changelog',
@@ -163,7 +163,7 @@ export default defineConfig({
 			{
 				text: 'Usage',
 				items: [
-					{ text: 'Frontend', link: '/frontend' },
+					{ text: 'Web Frontend', link: '/frontend' },
 					{ text: 'Importing Data', link: '/importing-data' },
 					{ text: 'Sync Data', link: '/data-sync' },
 					{ text: 'Conformance', link: '/conformance' },

docs/api.md

@@ -162,8 +162,8 @@ Blaze has to generate absolute URLs of its own in links and Location headers. By
 
 Besides the static `BASE_URL` setting, Blaze also respects the reverse proxy headers X-Forwarded-Host, X-Forwarded-Proto and [Forwarded][4] to generate its base URL dynamically.
 
-[1]: <https://www.hl7.org/fhir/http.html>
-[2]: <https://www.hl7.org/fhir/capabilitystatement.html>
+[1]: <https://hl7.org/fhir/R4/http.html>
+[2]: <https://hl7.org/fhir/R4/capabilitystatement.html>
 [3]: <https://github.com/samply/blaze/issues>
 [4]: <https://datatracker.ietf.org/doc/html/rfc7239>
 [5]: <https://hl7.org/fhir/http.html#capabilities>

docs/api/interaction/history-instance.md

@@ -10,9 +10,9 @@ The return content is a Bundle with type set to `history` containing the version
 
 ## Search Result Parameters
 
-| Name       | Description                                      |
-|------------|--------------------------------------------------|
-| `_summary` | `true`, `data`, `count` and `false` is supported |
+| Name       | Since | Description                               |
+|------------|-------|-------------------------------------------|
+| `_summary` | 1.0.0 | `true`, `count` and `false` are supported |
 
 ## Large Histories
 

docs/api/interaction/history-system.md

@@ -10,9 +10,9 @@ The return content is a Bundle with type set to `history` containing the version
 
 ## Search Result Parameters
 
-| Name       | Description                                      |
-|------------|--------------------------------------------------|
-| `_summary` | `true`, `data`, `count` and `false` is supported |
+| Name       | Since | Description                               |
+|------------|-------|-------------------------------------------|
+| `_summary` | 1.0.0 | `true`, `count` and `false` are supported |
 
 ## Large Histories
 

docs/api/interaction/history-type.md

@@ -10,9 +10,9 @@ The return content is a Bundle with type set to `history` containing the version
 
 ## Search Result Parameters
 
-| Name       | Description                                      |
-|------------|--------------------------------------------------|
-| `_summary` | `true`, `data`, `count` and `false` is supported |
+| Name       | Since | Description                               |
+|------------|-------|-------------------------------------------|
+| `_summary` | 1.0.0 | `true`, `count` and `false` are supported |
 
 ## Large Histories
 

docs/api/interaction/search-system.md

@@ -6,9 +6,9 @@ GET [base]?param1=value&...
 
 ## Search Result Parameters
 
-| Name       | Description                                      |
-|------------|--------------------------------------------------|
-| `_summary` | `true`, `data`, `count` and `false` is supported |
+| Name       | Since | Description                               |
+|------------|-------|-------------------------------------------|
+| `_summary` | 1.0.0 | `true`, `count` and `false` are supported |
 
 ## Paging
 

docs/api/interaction/search-type.md

@@ -7,17 +7,17 @@ POST [base]/[type]/_search
 
 ## Search Result Parameters
 
-| Name             | Description                                                     |
-|------------------|-----------------------------------------------------------------|
-| `_sort`          | see Sorting                                                     |
-| `_count`         | the default page size is 50 and the maximum page size is 10.000 |
-| `_include`       | supported, except the wildcard `*`                              |
-| `_revinclude`    | supported, except the wildcard `*`                              |
-| `_summary`       | `true`, `data`, `count` and `false` is supported                |
-| `_total`         | `accurate` is supported                                         |
-| `_elements`      | fully supported                                                 |
-| `_contained`     | not supported                                                   |
-| `_containedType` | not supported                                                   |
+| Name             | Since | Description                                                     |
+|------------------|-------|-----------------------------------------------------------------|
+| `_sort`          |       | see Sorting                                                     |
+| `_count`         |       | the default page size is 50 and the maximum page size is 10.000 |
+| `_include`       |       | supported, except the wildcard `*`                              |
+| `_revinclude`    |       | supported, except the wildcard `*`                              |
+| `_summary`       | 1.0.0 | `true`, `count` and `false` are supported                       |
+| `_total`         |       | `accurate` is supported                                         |
+| `_elements`      |       | fully supported                                                 |
+| `_contained`     |       | not supported                                                   |
+| `_containedType` |       | not supported                                                   |
 
 ## _profile
 

docs/deployment.md

@@ -10,14 +10,32 @@ docker run -d --name blaze -p 8080:8080 samply/blaze:1.0
 
 ## Verification <Badge type="warning" text="Since 1.0" />
 
-For container images, we use [cosign][cosign] to sign images. This allows users to confirm the image was built by the
+For container images, we use [cosign][1] to sign images. This allows users to confirm the image was built by the
 expected CI pipeline and has not been modified after publication.
 
 ```sh
 cosign verify "samply/blaze:1.0" \
   --certificate-identity-regexp "https://github.com/samply/blaze/.*" \
   --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
-  --certificate-github-workflow-ref="refs/tags/v1.0.0"
+  --certificate-github-workflow-ref="refs/tags/v1.0.0" \
+  -o text
+```
+
+The expected output is:
+
+```text
+Verification for index.docker.io/samply/blaze:1.0
+The following checks were performed on each of these signatures:
+  - The cosign claims were validated
+  - Existence of the claims in the transparency log was verified offline
+  - The code-signing certificate was verified using trusted certificate authority certificates
+Certificate subject: https://github.com/samply/blaze/.github/workflows/build.yml@refs/...
+Certificate issuer URL: https://token.actions.githubusercontent.com
+GitHub Workflow Trigger: pull_request
+GitHub Workflow SHA: <SHA>
+GitHub Workflow Name: Build
+GitHub Workflow Repository: samply/blaze
+GitHub Workflow Ref: refs/...
 ```
 
 ## Production
@@ -31,3 +49,5 @@ For production ready deployments, there are three options:
 ## Configuration
 
 Configuration is based on environment variables and documented in the [Configuration](deployment/environment-variables.md) section.
+
+[1]: <https://docs.sigstore.dev/cosign/signing/overview/>

docs/deployment/standalone-backend.md

@@ -27,7 +27,7 @@ Blaze should log something like this:
 2023-06-09T08:30:30.126Z b45689460ff3 main INFO [blaze.core:67] - JVM version: 17.0.7
 2023-06-09T08:30:30.126Z b45689460ff3 main INFO [blaze.core:68] - Maximum available memory: 1738 MiB
 2023-06-09T08:30:30.126Z b45689460ff3 main INFO [blaze.core:69] - Number of available processors: 2
-2023-06-09T08:30:30.126Z b45689460ff3 main INFO [blaze.core:70] - Successfully started 🔥 Blaze version 0.34.0 in 9.0 seconds
+2023-06-09T08:30:30.126Z b45689460ff3 main INFO [blaze.core:70] - Successfully started 🔥 Blaze version 1.0.0 in 9.0 seconds
 ```
 
 In order to test connectivity, query the health endpoint:
@@ -47,7 +47,7 @@ that should return:
 ```json
 {
   "name": "Blaze",
-  "version": "0.34.0"
+  "version": "1.0.0"
 }
 ```
 

docs/frontend.md

@@ -1,4 +1,4 @@
-# Frontend (Web UI)
+# Web Frontend
 
 Blaze comes with a Web UI that provides a user friendly view on the FHIR data and and administrative UI.