The FHIR Bulk Import API enables external data portals to securely import FHIR DocumentReference files into a user’s project on the platform, using OAuth 2.0 authentication.
This import process triggers the platform’s automatic FHIR metadata scraping service, which organizes metadata from the FHIR server into key-value pairs.
These key-value pairs are then associated with the corresponding FHIR DocumentReference file, making it easy to manage and access structured health data within the user's project.
Key features
- OAuth 2.0 Authentication: Secure access to the API via OAuth 2.0, ensuring that data portals can import files on behalf of users without compromising security.
- FHIR Metadata Scraping: Once a FHIR DocumentReference is imported, the platform automatically scrapes metadata from the FHIR server, using a predefined schema that matches the specific server configuration.
- Structured Data Integration: The scraped metadata is packed into key-value pairs and attached to the imported FHIR DocumentReference file, enabling efficient data management within the user’s project.
- Scalable Import: The API supports bulk imports, allowing multiple DocumentReference files to be submitted in one request.
Prerequisites
To use the FHIR Bulk Import API, users must first:
- Sign Up: Users or external data portals need to sign up to obtain API access.
- Obtain OAuth 2.0 Credentials: Upon signup, users will receive a client ID and client secret, which are necessary to authenticate API requests.
How it works
- Authorization: Data portals must authenticate using OAuth 2.0 before making any API requests.
- Import Request: After authentication, a bulk import request is submitted via the API, including FHIR DocumentReference files to be imported into the user’s project.
- Automatic Metadata Scraping: Once the FHIR DocumentReference files are uploaded, the platform scrapes metadata from the associated FHIR server based on a predefined schema.
- Data Organization: The metadata is formatted into key-value pairs and attached to the corresponding file in the user's project, allowing for easy retrieval and management.
Authentication
All API calls require OAuth 2.0 authentication. External data portals acting on behalf of a user will need to include the following headers in their requests:
- Authorization: Bearer token obtained via OAuth 2.0.
- X-SBG-Advance-Access: A special header for advance access permissions.
Use Case scenarios
- Healthcare Portals: Securely transfer health records in FHIR format to a centralized platform for analysis or integration with other datasets.
- Research Projects: Bulk import FHIR DocumentReference files into research projects for systematic metadata management and retrieval.
- Data Aggregators: Import large datasets from multiple FHIR servers while maintaining structured metadata for downstream analysis.