CLI

FHIRPACK also provides a CLI for easy and quick data exploration.

The CLI can be invoked by using python -m fhirpack.cli or fp once FHIRPACK has been installed.

> fp --help                                
Usage: fp [OPTIONS]

  The pack for your FHIR server.

Options:
  --version               Show the version and exit.
  -s, --source TEXT       URL of the FHIR server or path to json files.
  -e, --environment TEXT  Path to Dotenv file containing configurations.
  -d, --destination TEXT  Location of the output.
  -o, --operation TEXT    Operations to retrieve data.
  -p, --params TEXT       Provide additional search parameters.
  -v, --verbose           Print results in verbose format.
  -h, --help              Show this message and exit.

CLI usage is analogous to the general fhirpack dataflow.

Python	CLI
pack.getPatients(["1"])	fp -o "getPatients 1"
pack.getPatients(["1", "181", "525"])	fp -o "getPatients 1, 181, 525"
PACK(envFile=".env.example").getPatients(["1"])	fp -e .env.example -o "getPatients 1"
pack.getPatients(searchParams={}).gatherSimplePaths(["name.family"])	fp -o "getPatients" -p all -o "gatherSimplePaths name.family"
pack.getPatients(searchParams={"family":"Koepp"})	fp -o "getPatients" -p "family = Koepp"

⚠️ Operations spanning multiple spaces have to be quoted.