Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); GitHub - openCoreEMR/oce-cli-import-codes: Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR · GitHub
Skip to content

Repository files navigation

OpenCoreEMR Codes Import CLI

A standalone CLI tool for importing standardized medical code tables (RXNORM, SNOMED, ICD, CQM_VALUESET) into OpenEMR. Designed for Docker/Kubernetes deployments with efficient file mounting and reuse across multiple installations.

License: GPL v3PHP Version

Features

  • Standalone CLI tool - No need to modify OpenEMR core files
  • Composer installable - Easy installation and updates
  • Auto-detection - Automatically detects code type from filename
  • Non-interactive - Runs without user prompts for automation
  • Progress feedback - Real-time progress bars and status updates
  • Docker/Kubernetes optimized - Perfect for containerized deployments
  • Multi-site support - Import codes across multiple OpenEMR sites
  • Dry-run capability - Test imports without database changes
  • Comprehensive logging - Track imports with revision/version info
  • Error handling - Automatic cleanup on failures

Supported Code Types

Code TypeDescriptionSource
RXNORMRxNorm drug terminologyNLM
SNOMEDSNOMED CT clinical terminology (RF1)NLM
SNOMED_RF2SNOMED CT clinical terminology (RF2)NLM
ICD9ICD-9-CM diagnosis codesCMS
ICD10ICD-10-CM/PCS codesCMS
CQM_VALUESETClinical Quality Measures value setseCQI

Installation

Download PHAR (Recommended)

Download the latest PHAR release:

# Download the PHAR
curl -L -o oce-import-codes.phar https://github.com/opencoreemr/oce-cli-import-codes/releases/latest/download/oce-import-codes.phar
# Make executable
chmod +x oce-import-codes.phar
# Optional: Move to PATH
sudo mv oce-import-codes.phar /usr/local/bin/oce-import-codes

Via Composer

composer require opencoreemr/oce-cli-import-codes

Build from Source

git clone https://github.com/opencoreemr/oce-cli-import-codes.git
cd oce-cli-import-codes
composer install
php -d phar.readonly=0 build.php

Quick Start

# Using PHAR (recommended) - auto-detects RXNORM from filename
./oce-import-codes.phar /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr
# Or if installed to PATH
oce-import-codes /path/to/SnomedCT_USEditionRF2_PRODUCTION_20240301T120000Z.zip --openemr-path=/var/www/openemr
# Override auto-detection if needed
oce-import-codes /path/to/custom-name.zip --code-type=SNOMED --openemr-path=/var/www/openemr
# ICD10 with cleanup - auto-detects from filename
oce-import-codes /path/to/icd10cm_order_2024.txt.zip \
--openemr-path=/var/www/openemr \
--cleanup
# Dry run to test
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --dry-run
# Force import even if already loaded
oce-import-codes /path/to/RxNorm_full_01012024.zip --openemr-path=/var/www/openemr --force

Usage

Command Syntax

oce-import-codes [OPTIONS] <file-path>

Auto-Detection: The tool automatically detects the code type from the filename. If detection fails, you can manually specify the code type using --code-type.

Skip Behavior: By default, the tool checks if a code package with the same type, version, revision date, and file checksum has already been imported. If found, it will skip the import to avoid duplicates. Use --force to override this behavior and import anyway.

Arguments

ArgumentDescriptionRequired
file-pathPath to the code archive fileYes

Options

OptionDescriptionDefault
--code-typeOverride auto-detected code type (RXNORM|SNOMED|SNOMED_RF2|ICD9|ICD10|CQM_VALUESET)Auto-detect
--openemr-pathPath to OpenEMR installation/var/www/localhost/htdocs/openemr
--siteOpenEMR site namedefault
--windowsUse Windows processing (RXNORM only)false
--us-extensionImport as US extension (SNOMED only)false
--revisionRevision date (YYYY-MM-DD format)Auto-detect
--code-versionVersion string for trackingAuto-detect
--dry-runTest without database changesfalse
--cleanupRemove temp files after importfalse
--temp-dirCustom temporary directory-
--forceForce import even if same version appears loadedfalse

Docker/Kubernetes Deployment

Docker Example

FROM openemr/openemr:latest
# Install the CLI toolRUN composer global require opencoreemr/oce-cli-import-codes
# Mount point for code filesVOLUME ["/var/lib/openemr/codes"]
# Import scriptCOPY import-codes.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/import-codes.sh

File Requirements

Directory Structure

Mount your code files to a consistent location:

/var/lib/openemr/codes/
├── rxnorm/
│ └── RxNorm_full_MMDDYYYY.zip
├── snomed/
│ ├── SnomedCT_InternationalRF2_PRODUCTION_YYYYMMDD.zip
│ └── SnomedCT_RF1Release_INT_YYYYMMDD.zip
├── icd10/
│ ├── icd10cm_order_YYYY.txt.zip
│ └── icd10pcs_order_YYYY.txt.zip
└── cqm/
└── EP_EC_AH_CMS_ValueSets_v*.xml.zip

File Sizes & Update Frequency

Code TypeCompressed SizeExtracted SizeUpdate Frequency
RXNORM~200MB~2GBMonthly
SNOMED~300MB~1.5GBBiannual
ICD-10~15MB~50MBAnnual
CQM ValueSets~50MB~200MBAnnual

Multi-Site Import

Troubleshooting

Common Issues

  1. OpenEMR not found

    Error: OpenEMR globals.php not found
    
    • Verify --openemr-path points to correct installation
    • Ensure OpenEMR is properly installed
  2. Permission errors

    Error: Temporary directory is not writable
    
    • Check write permissions on temp directory
    • Use --temp-dir to specify writable location
  3. Database connection failed

    Error: OpenEMR database configuration not found
    
    • Verify OpenEMR database configuration
    • Ensure site configuration is correct
  4. Import function not found

    Error: OpenEMR rxnorm_import function not available
    
    • Verify OpenEMR version compatibility
    • Check that library/standard_tables_capture.inc.php exists

Debug Mode

Run with verbose output to see detailed information:

oce-import-codes RXNORM /path/to/file.zip --openemr-path=/var/www/openemr -v

Log Files

Check OpenEMR logs for detailed error information:

  • OpenEMR logs: /var/log/openemr/
  • PHP error logs: Usually in /var/log/php/
  • Apache/Nginx error logs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the GPL-3.0-or-later License - see the LICENSE file for details.

Support

Changelog

See CHANGELOG.md for version history.


Made with ❤️ by OpenCoreEMR Inc

About

Symfony CLI for loading vocabs into OpenEMR, by OpenCoreEMR

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages