The FHIR Command Line Tool. FHIR client, FHIR Package management, JSON-XML Conversion, Resource resolving, Bundling, Quality Control, Query Language, Package Publication Simplifier.net project access and synchronization, Validation, Bulk Validation, Snapshot generation.
$ dotnet add package Firely.TerminalArchive:
zip (<files>) --output <value> --shape <value> --zipname <value> | Saves all stack entries to a zip file
unzip <path> --disk | Extracts zip to the stack or disk
FHIR Client:
read (<source>) <record> | Reads a resource from the given server.
get <url> | Does a FHIR http get on a URL
search <source> <type> --pages <value> --split <arguments>... | Searches for resources on the given server.
post <source> | Posts a resource to the given server
put <source> (<file>) | Updates a resource to the given server
Files:
file delete <filter> --forsure | Deletes all files that match a FHIRpath filter
file list <filter> | Lists all files that match a FHIRpath filter
GenerateCommands:
yaml-gen <file> --types --output <value> | Generate resources with YAML. EXPERIMENTAL
Inflation:
snapshot Creates a snapshot from a StructureDefinition
expand Expands a ValueSet
inflate --package <value> --snapshot --expand --force | Creates snapshots/expands ValueSets for a project or package
deflate --package <value> | Remove snapshots/expansions for project or package
inflate-cache Creates snapshots/expansions in all packages in the current cache
Meta commands:
spec (<value>) --project --list | Select the FHIR specification version to work with.
output (<level>) --levels
Packages:
versions <pkgname> --raw | Lists all available versions of the package on the server
cache --location | Lists all globally installed packages
semver <pkgname> (<pkgversion>) --list | Tests if the specific version can be resolved
source (<url>) --npm --insecure | Shows or sets the package server url.
install <package> (<version>) --here --file --private | Downloads and installs a package.
uninstall <pkgname> | Removes a package from the local context (package.json)
contents <filename> | Displays the contents from a package
init (<pkgname>) (<version>) | Generates a FHIR package manifest
restore Restores all packages referenced in this folders package file
dependencies Show direct package dependencies of current scope
canonicals (<pkgname>) (<version>) | Lists canonicals from resources in a package or scope.
find (<value>) --spec <value> --name <value> --canonical <value> | Searches for packages(s) by name or canonical
publish-package <filename> | Publish a package to the package server (licensed)
Publishing:
bake (<script>) --input <value> --output <value> --clean | Publishes to a given folder
pack (<folder>) --name <value> | Creates a FHIR package from a folder
template (<name>) --bake --check | Generates a script from a template.
Scripting:
path delete <path> --all | Deletes nodes from a FHIR resource
select <fhirpath> --file <value> --output <value> --types | Prints the values from the fhirpath expression
predicate <expression> | Evaluates a FHIRPath expression (true/false) for the top of the stack
query (<script>) --file <value> --output <value> --source <value> | Runs an FQL script
Scope:
scope (<pkgname>) (<version>) | Lists packages in scope for this folder context
resolve <canonical> | Resolves a canonical url to a resource and pushes it on the stack
read <record> | Reads a resource by providing type/id
FHIR Servers:
server list Lists the configured server aliases
server add <alias> <url> --default --format <value> | Adds a new server alias
server update <alias> (<url>) --default --format <value> | Updates the server details for an alias
server delete <alias> | Deletes the given server alias
server default (<alias>) | Gets or sets the default server
server authorize
<alias> <method> user=<value> password=<value> | Add (basic) authentication header
server remove-headers
<alias> | Removes all customer http headers
server header <alias> <key> <value> | set a custom http header
server details <alias>
Simplifier:
project archive --output <value> | Creates an archive from the current project
project info --details | Gets the Simplifier project key for your folder.
project status Shows the status of the project.
project clone <urlkey> (<name>) | Clones a project from Simplifier.net in a sub folder.
project link <urlkey> --strategy <value> | Links your folder with a project on Simplifier.net.
project sync Synchronizes your folder with the project on Simplifier.net.
project pull Pulls all changes from the project on Simplifier.net to your folder.
project push Pushes all changes from your folder to the project on Simplifier.net.
project repair <urlkey> | Repairs the link between your folder and a project on Simplifier.net.
project unlink Removes the link between your folder and the project on Simplifier.net.
login email=<value> password=<value> --agent <value> | (Re)authorizes you in Simplifier.net
logout Clears the credentials for Simplifier.net
projects --details | Shows your Simplifier.net projects
license List the features in your license
doc <canonical> | Brings you to the documentation page of the resource with that canonical
Stack:
push (<files>) --filter <value> | Pushes matching files or server resources on the stack
pop (<count>) | Drops the top resource from the stack
dup Duplicates the top resource from the stack
swap Swaps the top 2 elements on the stack.
show (<path>) --types --output <value> | Displays a resource tree from a file or the top of the stack
stack (<fql>) | Lists the items on the stack
save (<filename>) --all --json --xml | Saves resource(s) on stack to disk
bundle (<files>) --take <value> | Takes all resources on the stack and puts them into a single bundle
split --all | Splits the bundle on the top of the stack into separate resources
peek Displays the top item on the stack
clear Clears the stack
filter (<expression>) --category <value> | Filters the stack on matching FhirPath expressions
reverse Reverses the order of all resources on the stack
sort <expression> --descending | Sorts the stack based on the expression
Quality Control:
validate (<file>) --terminologyserver <value> --profile <value> --push --vnext | Validates a FHIR resource
check (<series>) (<rule>) --list --details | Checks the quality of your project (licensed)
Help:
help (<args>...) | Provides this help list or detailed help about a command