README
¶
blazectl
blazectl is a command line tool to control your FHIR® server. blazectl also works with Blaze.
Currently, you can upload transaction bundles from a directory, download and count resources.
Installation
blazectl is written in Go. All you need is a single binary which is available for Linux, macOS and Windows.
Linux
-
Download the latest release with the command:
curl -LO https://github.com/samply/blazectl/releases/download/v0.14.0/blazectl-0.14.0-linux-amd64.tar.gz -
Untar the binary:
tar xzf blazectl-0.14.0-linux-amd64.tar.gz -
Move the binary in to your PATH.
sudo mv ./blazectl /usr/local/bin/blazectl -
Test to ensure the version you installed is up-to-date:
blazectl --version
macOS - Intel
-
Download the latest release with the command:
curl -LO https://github.com/samply/blazectl/releases/download/v0.14.0/blazectl-0.14.0-darwin-amd64.tar.gz -
Untar the binary:
tar xzf blazectl-0.14.0-darwin-amd64.tar.gz -
Move the binary in to your PATH.
sudo mv ./blazectl /usr/local/bin/blazectl -
Test to ensure the version you installed is up-to-date:
blazectl --version
macOS - Apple Silicon
-
Download the latest release with the command:
curl -LO https://github.com/samply/blazectl/releases/download/v0.14.0/blazectl-0.14.0-darwin-arm64.tar.gz -
Untar the binary:
tar xzf blazectl-0.14.0-darwin-arm64.tar.gz -
Move the binary in to your PATH.
sudo mv ./blazectl /usr/local/bin/blazectl -
Test to ensure the version you installed is up-to-date:
blazectl --version
Linux - arm64
-
Download the latest release with the command:
curl -LO https://github.com/samply/blazectl/releases/download/v0.14.0/blazectl-0.14.0-linux-arm64.tar.gz -
Untar the binary:
tar xzf blazectl-0.14.0-linux-arm64.tar.gz -
Move the binary in to your PATH.
sudo mv ./blazectl /usr/local/bin/blazectl -
Test to ensure the version you installed is up-to-date:
blazectl --version
Windows
-
Download the latest release here
-
Unzip the binary.
-
Add the binary in to your PATH.
-
Test to ensure the version you downloaded is up-to-date:
blazectl --version
Usage
$ blazectl
blazectl is a command line tool to control your FHIR® server.
Currently you can upload transaction bundles from a directory, download
and count resources and evaluate measures.
Usage:
blazectl [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
count-resources Counts all resources by type
download Download FHIR resources in NDJSON format
evaluate-measure Evaluates a Measure
help Help about any command
upload Upload transaction bundles
Flags:
--certificate-authority string path to a cert file for the certificate authority
-h, --help help for blazectl
-k, --insecure allow insecure server connections when using SSL
--no-progress don't show progress bar
--password string password information for basic authentication
--token string bearer token for authentication
--user string user information for basic authentication
-v, --version version for blazectl
Use "blazectl [command] --help" for more information about a command.
Upload
You can use the upload command to upload transaction bundles to your server. Currently, JSON (.json), gzip compressed JSON (.json.gz), bzip2 compressed JSON (.json.bz2) and NDJSON (.ndjson) files are supported. If you don't have any transaction bundles, you can generate some with SyntheaTM.
Assuming the URL of your FHIR server is http://localhost:8080/fhir, in order to upload run:
blazectl --server http://localhost:8080/fhir upload my/bundles
You will see a progress bar with an estimated ETA during upload. After the upload, a statistic inspired by vegeta will be printed:
Starting Upload to http://localhost:8080/fhir ...
Uploads [total, concurrency] 362, 4
Success [ratio] 100 %
Duration [total] 1m42s
Requ. Latencies [mean, 50, 95, 99, max] 826ms, 534ms, 2.71s, 3.85s 6.467s
Proc. Latencies [mean, 50, 95, 99, max] 710ms, 526ms, 2.041s, 2.739s 4.133s
Bytes In [total, mean] 5.10 MiB, 14.59 KiB
Bytes Out [total, mean] 61.74 MiB, 176.59 KiB
Status Codes [code:count] 200:362
The statistics have the following meaning:
- Uploads - the total number of files uploaded with the given concurrency
- Success - the success rate (possible errors will be printed under the statistics)
- Duration - the total duration of the upload
- Requ. Latencies - mean, max and percentiles of the duration of whole requests including networks transfers
- Proc. Latencies - mean, max and percentiles of the duration of the server processing time excluding networks transfers
- Bytes In - total and mean number of bytes returned by the server
- Bytes Out - total and mean number of bytes send by blazectl
- Status Codes - a list of status code frequencies. Will show non-200 status codes if they happen.
Download
You can use the download command to download bundles from the server. Downloaded bundles are stored within an NDJSON file. This operation is non-destructive on your site, i.e. if the specified NDJSON file already exists then it won't be overwritten.
Use the download command as follows:
blazectl --server http://localhost:8080/fhir download Patient \
--query "gender=female" \
--output-file ~/Downloads/Patients.ndjson
Next to the mandatory FHIR resource type you can also optionally specify a valid FHIR search query to limit downloaded resources. The query must not start with a ? char.
With the flag --use-post you can ensure that the FHIR search query specified with --query is send as POST request in the body.
Using POST can have two benefits, first if the query string is too large for URL's, it will still fir in the body. Second if the query string contains sensitive information like IDAT's it will be less likely end up in log files, because URL's are often logged but bodies not.
The next links are still traversed with GET. The FHIR server is supposed to not expose any sensitive query params in the URL and also keep the URL short enough.
As soon as the download has finished you will be shown a download statistics overview that looks something like this:
Pages [total] 184
Resources [total] 1835
Resources/Page [min, mean, max] 5, 9, 10
Duration [total] 371ms
Requ. Latencies [mean, 50, 95, 99, max] 1ms, 1ms, 2ms, 2ms, 3ms
Proc. Latencies [mean, 50, 95, 99, max] 1ms, 1ms, 1ms, 2ms, 3ms
Bytes In [total, mean] 1.22 MiB, 6.82 KiB
The statistics have the following meaning:
- Pages - total number of pages requested from the server to retrieve resources
- Resources - total number of downloaded resources
- Resources/Page - minimum, mean and maximum number of resources over all pages
- Duration - total duration of the download
- Requ. Latencies - mean, max and percentiles of the duration of whole requests including networks transfers
- Proc. Latencies - mean, max and percentiles of the duration of the server processing time excluding network transfers
- Bytes In - total and mean number of bytes returned by the server
Count Resources
The count-resources command is useful to see how many resources a FHIR server stores by resource type. The resource counting is done by first fetching the capability statement of the server. After that blazectl will perform a search-type interaction with query parameter _summary set to count on every resource type which supports that interaction using one batch request. Bundle.total will be used as resource count.
You can run:
blazectl --server http://localhost:8080/fhir count-resources
It will return:
Count all resources on http://localhost:8080/fhir ...
AllergyIntolerance : 7297
CarePlan : 49818
Claim : 689111
Condition : 116688
DiagnosticReport : 193141
Encounter : 540542
ExplanationOfBenefit : 540542
Goal : 39857
ImagingStudy : 11212
Immunization : 187987
MedicationAdministration : 6400
MedicationRequest : 148569
Observation : 2689215
Organization : 52645
Patient : 16875
Practitioner : 52647
Procedure : 418310
Similar Software
- VonkLoader - can also upload transaction bundles but needs .NET SDK
- Synthea Uploader - no parallel uploads
License
Copyright 2019 - 2024 The Samply Community
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories