Skip to main content

FHIR Shorthand Validator unshortens fsh input and validates all defined instances against their profiles.

Project description

FHIR Shorthand Validator

https://img.shields.io/pypi/v/fsh-validator.svg https://img.shields.io/travis/glichtner/fsh-validator.svg Documentation Status Updates

FHIR Shorthand Validator (fsh-validator) unshortens fsh input and validates all defined instances against their profiles.

fsh-validator is an interface to SUSHI and the HL7 FHIR Validator running the following workflow: 1. Run SUSHI to unshorten fsh files to structure definitions, instances, value sets etc. 2. Detect all defined profiles, valuesets and instances. 3. Validate all defined instances using the official HL7 FHIR Validator against their profiles.

Quickstart

Install the latest fsh-validator:

pip install -U fsh-validator

Or directly from github repository:

pip install -U git+https://github.com/glichtner/fsh-validator

Run fsh-validator in your fsh project path:

$ fsh-validator --all

Parameters

usage: fsh-validator [-h] [--all] [--subdir SUBDIR] [--validator-path PATH_VALIDATOR] [--verbose] [--no-sushi] [--log-path LOG_PATH] [filename [filename ...]]

positional arguments:
  filename              fsh file names (basename only - no path)

optional arguments:
  -h, --help            show this help message and exit
  --all                 if set, all detected profiles will be validated
  --subdir SUBDIR       Specifies the subdirectory (relative to input/fsh/) in which to search for profiles if --all is set
  --validator-path PATH_VALIDATOR
                        path to validator
  --verbose             Be verbose
  --no-sushi            Do not run sushi before validating
  --log-path LOG_PATH   log file path - if supplied, log files will be written

Examples

Example call to validate a *single* profile

$ cd ExampleIG/
$ fsh-validator input/fsh/p-thoracic-drainage.fsh

Example call to validate *all* profiles

The following call validates all profiles in the subdirectory “vaccination/” and writes the results of the validation log files in the directory logs/.

$ cd ExampleIG/
$ fsh-validator --all --subdir vaccination/ --log-path logs/

This is equivalent to calling:

$ fsh-validator input/fsh/vaccination/*.fsh --log-path logs/

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.2 (2021-10-25)

  • Added requirements to setup.py

0.1.1 (2021-10-25)

  • Fix python package

0.1.0 (2021-10-25)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fsh-validator-0.1.2.tar.gz (19.7 kB view hashes)

Uploaded Source

Built Distribution

fsh_validator-0.1.2-py2.py3-none-any.whl (13.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page