API Overview

Modules

• exceptions
• filters
• hl7
• loaders
• parsers
• renderers
• tags
• utils

Classes

• exceptions.RenderingError: Raised when there is a rendering error
• hl7.FhirDtmPrecision: FhirDtmPrecision A precision associated with a FHIR DTM
• hl7.Hl7DtmPrecision: FhirDtmPrecision A precision associated with a HL7 DTM
• hl7.Hl7ParsedDtm: Hl7ParsedDtm The parsed DTM
• loaders.CachingTemplateSystemLoader: TemplateSystemLoader that caches parsed templates in memory.
• loaders.TemplateSystemLoader: TemplateSystemLoader allows templates to be loaded from a primary and optionally secondary
• parsers.ParseXmlOpts: ParseXmlOpts(cdata_key: str = '_', encoding: str = 'utf-8')
• renderers.BaseFhirRenderer: Base renderer. Supports rendering data to FHIR
• renderers.CcdaRenderer: Consolidated CDA document renderer
• renderers.FhirRendererDefaults: The Renderer Defaults
• renderers.Stu3FhirRenderer: Stu3 Fhir to Fhir renderer
• tags.EvaluateNode: Parse tree node for the built-in "evaluate" tag.
• tags.EvaluateTag: The "evaluate" tag.
• tags.MergeDiffNode: Parse tree node for the "mergeDiff" tag.
• tags.MergeDiffTag: The "mergeDiff" tag.

Functions

• exceptions.fail: fail Raises the provided exception
• filters.add_hyphens_date: Convert the hl7 v2 dtm to a FHIR hl7 v3 dtm with day precision
• filters.batch_render: batch_render Render the given batch data with the supplied template passing
• filters.date: date Format the given input date with the provided format
• filters.format_as_date_time: Convert the hl7 v2 dtm to a FHIR hl7 v3 dtm
• filters.generate_uuid: Generate a UUID using the sha256 hash of the given data string
• filters.get_ccda_section_by_template_id: get_ccda_section_by_template_id Get the section that matches one
• filters.get_first_ccda_sections_by_template_id: get_first_ccda_sections_by_template_id Get the sections that match the given
• filters.get_property: get_property Get the codified property mapping from the code_mapping global in
• filters.gzip: Compress the string using zlib base64 encoding the output
• filters.mapping_filter: Raise a FilterValueError if the left value is not mapping-like.
• filters.match: Find all / match the regex in data
• filters.now: The current date time in UTC as a FHIR hl7 v3 dtm
• filters.register_filters: register_filters Registers the given filters with the supplied Environment. Will not
• filters.sha1_hash: Compute the sha1 hash for the string
• filters.str_arg: Return val as an str or default if val is none or empty
• filters.to_array: Convert the given object to a list
• filters.to_json_string: Serialize the given object to json
• filters.transform_narrative: transform_narrative transform the given narrative text
• hl7.get_ccda_component3: get_ccda_component3 Gets the POCD_MT000040.Component3
• hl7.get_ccda_section: get_ccda_section Gets the POCD_MT000040.Section
• hl7.get_component3_section_templateId: get_component3_section_template_id Gets the templateId
• hl7.get_fhir_entry_key: get_fhir_entry_key Gets the unique key for the given FHIR
• hl7.get_template_id_key: get_template_id_key Gets a key for the given template id
• hl7.hl7_to_fhir_dtm: hl7_to_fhir_dtm Converts the given hl7 dtm to an ISO equivalent string optionally
• hl7.is_template_id: is_template_id Determines if the given id matches the specified template id
• hl7.parse_fhir: parse_fhir Parses the given json input string to a FHIR object. In
• hl7.parse_hl7_dtm: parse_hl7_dtm Parse the given hl7 input string to a Hl7ParsedDtm
• hl7.to_fhir_dtm: to_fhir_dtm Converts the given datetime to an ISO equivalent string optionally
• loaders.make_template_system_loader: make_template_system_loader A TemplateSystemLoader factory
• loaders.read_text: read_text Reads the text from the given filename using the Environment's
• parsers.parse_json: parse_json Parses the JSON string using a JSON 5 compliant decoder
• parsers.parse_xml: parse_xml Parses the xml imput string or text/binary IO to a dict
• parsers.parse_xml_filter: parse_xml_filter Determines if the element should be filtered or not
• renderers.make_environment: Factory for creating rendering environments with builtin configurations.
• renderers.render_files_to_dir: render_files_to_dir Renders the files from the given directory to the specified output
• renderers.render_to_dir: render_to_dir Renders the given file to the specified output directory using the
• tags.register_tags: register_tags Adds the given tags to the Environment as long as a tag
• utils.blank_str_to_empty: blank_str_to_empty returns the given string if it's not blank, otherwise, empty
• utils.del_empty_dirs_quietly: del_empty_dirs_quietly Quietly deletes any empty sub directories within
• utils.del_path_quietly: del_path_quietly Quietly deletes a path ignoring any errors that
• utils.etree_element_to_str: etree_element_to_str Serializes the document node to a string
• utils.etree_to_str: etree_to_str Serializes the document tree to a string
• utils.is_undefined_none_or_blank: is_undefined_none_or_blank returns whether the object is undefined,
• utils.is_undefined_or_none: is_undefined_or_none returns whether the object is undefined or
• utils.join_strs: join_strs conditionally joins two strings depending on if they are both
• utils.join_subpath: join_subpath Joins the parts from the child relative to the parent
• utils.load_xslt: load_xslt Loads the provided xslt stylesheet
• utils.merge_dict: merge_dict Merges the key/value pair mappings similarly to
• utils.mkdir: mkdir wrapper around Path.mkdir forwarding additional keyword args
• utils.parse_etree: parse_etree Parses the provided xml into a document tree
• utils.read_text: read_text Reads the given data using the supplied encoding if the data
• utils.sanitize_str: sanitize_str trims leading / trailing spaces replacing line endings and
• utils.tail: tail Reads the tail from the given file like object
• utils.to_list_or_empty: to_list_or_empty returns the object as a list if its a list or not empty
• utils.transform_xml_str: transform_xml_str Transforms the provided xml string using the specified xslt object
• utils.walk_path: walk_path wrapper around os.walk to semi bridge the gap of path.walk

---

This file was automatically generated via lazydocs.