n8n-nodes-1health

n8n community node for 1Health API integration - manage patients and healthcare data.

Publishing the Node to npm

Follow these steps to publish the custom node to npm and make it available for installation in n8n.

Prerequisites

• Node.js and npm installed
• An npm account (create one at npmjs.com if you don't have one)
• Access to the n8n-nodes-1health repository

Step 1: Login to npm

1. Open your terminal or command prompt
2. Navigate to the project directory:

   cd n8n-nodes-1health

3. Login to npm using your npm account credentials:

   npm login

4. Enter your npm username, password, and email when prompted
5. If you have two-factor authentication enabled, enter the OTP code
6. You should see a success message: Logged in as <your-username> on https://registry.npmjs.org/

Step 2: Publish to npm

1. Ensure you're in the project root directory
2. Build the project (this is automatically run before publish due to prepublishOnly script):

   npm run build

3. Publish the package to npm:

   npm publish

4. If successful, you'll see a message indicating the package has been published
5. Verify the publication by visiting: https://www.npmjs.com/package/n8n-nodes-1health

Note: The prepublishOnly script in package.json automatically runs the build process before publishing, so the TypeScript code is compiled to JavaScript in the dist folder.

Step 3: Install the Node in n8n

After publishing to npm, you can install the custom node in your n8n instance.

1. Open your n8n application (either self-hosted or n8n cloud)
2. Log in to your n8n account
3. Navigate to Settings (usually found in the top-right menu or sidebar)
4. Click on Community Nodes (or Community depending on your n8n version)
5. In the Install Community Node section, enter the package name:

   n8n-nodes-1health

6. Click Install or Add button
7. Wait for the installation to complete (n8n will download and install the package from npm)
8. You may need to refresh the page or restart n8n for the changes to take effect

Step 4: Verify Installation

1. After installation, go back to the main n8n workflow editor
2. Click on the + button to add a new node (or use the node palette)
3. Look for 1Health in the left sidebar under the nodes list
4. You should see the 1Health node available for use
5. You can now drag and drop the node into your workflow

Using the Node

Setting Up Credentials

Before using the 1Health node, you need to configure your API credentials:

1. Add a 1Health node to your workflow
2. Click on the node to open its settings
3. Click on Credentials dropdown
4. Select Create New Credential or use existing credentials
5. Enter your:
   • Base URL: Your 1Health API base URL
   • API Key: Your 1Health API key
6. Click Save to store the credentials

Available Operations

The 1Health node supports the following operations:

Patient Operations

• Find Patient Full Text: Search patients by firstName, lastName, or birthDate
• Find or Create Person: Find or create a person (requires firstName, lastName, and birthDate)

Organization Operations

• Find Organization: Search for organizations
• Find Organization GraphQL: Search organizations using GraphQL

Development

Building the Project

npm run build

This compiles TypeScript to JavaScript and copies necessary files to the dist folder.

Watching for Changes

npm run build:watch

This will automatically rebuild when you make changes to the source files.

Local Development

npm run dev

This builds the project and starts n8n with your custom node loaded.

Version Management

When updating the package:

1. Update the version in package.json (following semantic versioning)
2. Build the project: npm run build
3. Publish: npm publish

Troubleshooting

Node Not Appearing in n8n

• Ensure the package was published successfully to npm
• Check that you installed the correct package name: n8n-nodes-1health
• Try refreshing the n8n page or restarting the n8n service
• Check n8n logs for any installation errors

Build Errors

• Ensure all dependencies are installed: npm install
• Check that TypeScript is properly configured in tsconfig.json
• Verify all required files are present in the dist folder after building

Publishing Errors

• Verify you're logged in: npm whoami
• Check that the package name is available and you have publish rights
• Ensure the version number is incremented from the previous publish
• Check npm registry: npm config get registry (should be https://registry.npmjs.org/)

Support

For issues, questions, or contributions, please visit:

• GitHub Repository: https://github.com/1health-io/n8n-nodes-1health
• 1Health Documentation: https://docs.1health.io/

License

MIT