NookalInstall

Overview

This node integrates with the Nookal practice management system via its GraphQL API, allowing users to manage healthcare-related data such as patients, appointments, practitioners, and locations. Specifically, the Appointment - Get operation retrieves detailed information about a single appointment by its ID.

Common scenarios for this node include:

• Fetching appointment details to display or process in workflows.
• Integrating appointment data into other systems or automations.
• Verifying appointment status or timing before triggering further actions.

For example, a clinic might use this node to automatically retrieve appointment details when a patient checks in, enabling real-time updates to their internal systems.

Properties

Output

The output JSON contains detailed information about the requested appointment, including:

• id: Appointment unique identifier.
• startTime: Start time of the appointment.
• endTime: End time of the appointment.
• type: Type/category of the appointment.
• status: Current status (e.g., scheduled, cancelled).
• notes: Any notes associated with the appointment.
• patient: Object containing patient's id, firstName, and lastName.
• practitioner: Object containing practitioner's id, firstName, and lastName.
• location: Object containing location's id and name.
• createdAt: Timestamp when the appointment was created.
• updatedAt: Timestamp when the appointment was last updated.

The node does not output binary data for this operation.

Example output snippet:

{
  "appointment": {
    "id": "12345",
    "startTime": "2024-06-01T09:00:00Z",
    "endTime": "2024-06-01T09:30:00Z",
    "type": "Consultation",
    "status": "Scheduled",
    "notes": "Patient requested wheelchair access",
    "patient": {
      "id": "p1",
      "firstName": "John",
      "lastName": "Doe"
    },
    "practitioner": {
      "id": "pr1",
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "location": {
      "id": "loc1",
      "name": "Main Clinic"
    },
    "createdAt": "2024-05-20T12:00:00Z",
    "updatedAt": "2024-05-25T15:00:00Z"
  }
}

Dependencies

• Requires an active connection to the Nookal practice management system via an OAuth2 API credential.
• The node uses the Nookal GraphQL API endpoint to perform queries.
• Proper API authentication credentials must be configured in n8n prior to using this node.

Troubleshooting

• Invalid ID error: If the provided appointment ID does not exist or is malformed, the API may return an error or empty result. Verify the ID is correct.
• Authentication errors: Ensure that the OAuth2 API credentials are valid and have not expired.
• Network issues: Connectivity problems can cause request failures; check network access to the Nookal API.
• JSON parsing errors: If custom queries or variables are used elsewhere, ensure JSON syntax is correct.

If the node throws an error like Unknown appointment operation, it indicates an unsupported operation name was specified.

Links and References

• Nookal API Documentation (for detailed API schema and usage)
• GraphQL Basics (to understand query structure)
• n8n OAuth2 Credentials Setup