Tutorials
Welcome to the CareConnect API tutorials! These step-by-step guides will help you get started with integrating CareConnect APIs into your applications.
Getting Started
Our tutorials are designed to take you from initial setup through advanced integration patterns. Whether you're new to FHIR APIs or an experienced developer, these guides provide practical examples and best practices.
Available Tutorials
Postman Tutorials
Learn to interact with CareConnect FHIR APIs using Postman, a popular API testing tool. These tutorials include environment setup, authentication, and request examples.
- Postman Shared Environment Setup - Configure Postman environments for multiple CareConnect APIs
- Service Base URLs - Discover available FHIR services and endpoints
- Patient Access API - Access patient data with OAuth 2.0 authentication
- Practitioner Access API - Retrieve practitioner information and schedules
- System Access API - System-to-system integration for healthcare applications
- Provider Directory API - Search and retrieve provider directory information
- User Access Brands API - Access brand and organization data
Tutorial Structure
Each tutorial follows a consistent structure to help you learn effectively:
- Prerequisites - What you need before starting
- Environment Setup - Configuring your development environment
- Authentication - Setting up secure API access
- API Requests - Step-by-step request examples
- Troubleshooting - Common issues and solutions
- Next Steps - Related tutorials and advanced topics
Before You Begin
Prerequisites
- CareConnect Account - Contact Netsmart to set up your developer account and obtain API credentials
- API Tool - Download Postman or use your preferred API testing tool
- FHIR Knowledge - Basic understanding of FHIR R4 concepts is helpful
Getting API Access
To use CareConnect APIs, you'll need:
- Tenant ID - Your unique CareConnect tenant identifier
- Client Credentials - OAuth 2.0 client ID and secret for authentication
- API Endpoints - Base URLs for Preview and Production environments
Contact Netsmart support to obtain these credentials and configure your API access.
Need Help?
If you encounter issues while following these tutorials:
- Check the Troubleshooting section in each tutorial
- Review the API Documentation for detailed reference information
- Contact Netsmart support for assistance with credentials or API access
What's Next?
After completing the tutorials, explore:
- API Reference - Detailed documentation for all CareConnect APIs
- Authentication Guide - Advanced authentication patterns and security best practices
Start with the Postman Shared Environment Setup tutorial to configure your development environment, then choose the API tutorial that matches your integration needs.