.. _insights:

Mapping insights
================

.. note::
    Mapping insights is a feature available as a RESTful API or within openFHIR Atlas (a user interface for openFHIR, example: https://open-fhir.com/portal)

Introduction
____________

Determining the correctness of your mappings and verifying that a specific mapping (including nested or extended mappings) produces the desired output can be challenging. To address this, mapping insights offer a comprehensive overview of all mappings performed during each request. This overview includes details on which mappings were applied, what data was mapped, and how the mapping process was carried out.

Enabling
________

To enable mapping insights, you need to configure the following properties:

``-e openfhir.insights.enabled=true``

``-e openfhir.insights.store-payload=true``

Considerations
______________

!! Enabling `openfhir.insights.store-payload` feature means openFHIR engine will store request and response of the mapping. This is stored as-is and is with this version of openFHIR not yet anonymized, meaning openFHIR is now persisting clinical data. This is a feature that should be turned off for production.