OpenMetadata/openmetadata-docs/content/v1.9.x-SNAPSHOT/connectors/database/epic/yaml.md

title	description	slug	Collate
Run the Epic FHIR Connector Externally	Configure Epic FHIR ingestion using YAML to automate FHIR resource metadata collection.	/connectors/database/epic/yaml	true

{% connectorDetailsHeader name="Epic FHIR" stage="BETA" platform="Collate" availableFeatures=["Metadata"] unavailableFeatures=["Data Profiler", "Data Quality", "dbt", "Lineage", "Column-level Lineage", "Query Usage", "Owners", "Tags", "Sample Data", "Reverse Metadata (Collate Only)", "Auto-Classification", "Stored Procedures"] / %}

In this section, we provide guides and references to use the Epic FHIR connector.

Configure and schedule Epic metadata workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

{% partial file="/v1.9/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/epic/yaml"} /%}

{% partial file="/v1.9/connectors/external-ingestion-deployment.md" /%}

Requirements

To run the Epic ingestion, install the Python package:

pip3 install "openmetadata-ingestion[epic]"

Metadata Ingestion

All connectors are defined as JSON Schemas.
Here you can find the structure to create a connection to Epic.

The ingestion workflow itself follows the general workflow schema.

1. Define the YAML Config

This is a minimal sample config for Epic:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

fhirServerUrl: Base URL of the Epic FHIR server.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

fhirVersion: FHIR specification version supported (R4, STU3, or DSTU2).

{% /codeInfo %}

{% codeInfo srNumber=3 %}

databaseName: Optional name for the database in OpenMetadata. Defaults to epic.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

schemaFilterPattern / tableFilterPattern: Regex filters to limit which FHIR resource categories (schemas) or resource types (tables) are ingested.

{% /codeInfo %}

{% partial file="/v1.9/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.9/connectors/yaml/workflow-config-def.md" /%}

{% /codeInfoContainer %}

{% codeBlock fileName="epic_sample.yaml" %}

source:
  type: epic
  serviceName: epic_fhir
  serviceConnection:
    config:
      type: Epic
      fhirServerUrl: https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4
      fhirVersion: R4
      # Optional:
      # databaseName: epic

# Optional filters
sourceConfig:
  config:
    # schemaFilterPattern:
    #   includes:
    #     - Clinical
    #   excludes:
    #     - Archived
    # tableFilterPattern:
    #   includes:
    #     - Patient
    #   excludes:
    #     - ".*Test.*"

sink:
  type: metadata-rest
  config: {}

{% /codeBlock %}

{% /codePreview %}