Skip to main content

Parse FHIR query string

Project description

A library to parse FHIR query strings.

  • Validates type and returns correct object

  • Built-in search parameters from FHIR standard

  • Supports modifiers, prefixes, and chains

Usage

from fhir_parse_qs import Search

# supported endpoints
Search.supported --> [...]

# simple use
search = Search('Patient', 'name=bob') # Search(<endpoint>, <query_string>)

# endpoint
search.endpoint --> 'Patient'

# all the namedtuples
search.parsed --> [FHIRSearch(...)]

# index as key; each parameter/value pair gets parsed into a namedtuple
search[0] --> FHIRSearch(...)
search[0].modifier --> None
search[0].prefix --> None
search[0].value --> 'bob'
search[0].parameter --> 'name'
search[0].type_ --> 'string'
search[0].chain --> None

# act like dict with parameter as key
search['name'] --> FHIRSearch(...) #list if non-unique parameter

# iterate over the parameter/value pairs
for x in search:
     print(x) --> FHIRSearch(...)

# ignores and logs unrecognized parameters
search = Search('Patient', 'random=test')
search.error --> [...]

# supports chains (list of lists)
search = Search('Observation', 'patient.name=peter')
search[0].parameter --> 'name' # last parameter in chain
search[0].value --> 'peter'
search[0].chain --> [[FHIRChain(...), FHIRChain(...)], ...]
search[0].chain[0][0].endpoint = 'Observation'
search[0].chain[0][0].target = 'patient'
search[0].chain[0][0].ttype = 'reference'
search[0].chain[0][1].endpoint = 'Patient'
search[0].chain[0][1].target = 'name'
search[0].chain[0][1].ttype = 'string'

# return control parameters (eg, _sort, _count, etc)
search.control --> [...]

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

fhir_parse_qs-0.6.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

fhir_parse_qs-0.6.0-py2.py3-none-any.whl (3.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fhir_parse_qs-0.6.0.tar.gz.

File metadata

  • Download URL: fhir_parse_qs-0.6.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for fhir_parse_qs-0.6.0.tar.gz
Algorithm Hash digest
SHA256 7eeeef9ae6d7a54ac7f7d67fed53c7dc72cd6fbdb8eae541faf1be7892934cc3
MD5 3235e688743047cffb9d07cb81f672e3
BLAKE2b-256 dbc8a2715781be3bd65a2209e964dbcdb49648f2f2f39fc82805d960fb71542e

See more details on using hashes here.

Provenance

File details

Details for the file fhir_parse_qs-0.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: fhir_parse_qs-0.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.1

File hashes

Hashes for fhir_parse_qs-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 13c729d2a68b9b9410ca0a7303656279a89b342051a7c237f3ba4c94aa63cb35
MD5 e7c8e9858efbfc15815ac9bac63bb00d
BLAKE2b-256 4fd8a61af6ab95b009140692ddb9615c223c1c82352ea6108a1f44cd5692d94c

See more details on using hashes here.

Provenance

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