Healthcareservice
Fetching surveys associated with a specific healthcare service in the Bingli API allows users to retrieve all surveys linked to that service, along with details such as status and creation date.
API Environments
Bingli provides multiple environments for different use cases:
- Production EU:
https://fhir-gateway.api.bingli.eu/tenant-api/survey/healthcareservice/ - Acceptance EU:
https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/healthcareservice/ - Production US:
https://fhir-gateway.api.bingli.us/tenant-api/survey/healthcareservice/
Fetching Surveys for a Healthcare Service
GET - Fetch Surveys by Healthcare Service ID
Endpoint
https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/healthcareservice/{HEALTHCARE-SERVICE-ID}
Description
This endpoint retrieves all surveys associated with a specific healthcare service, identified by the healthCareServiceId. Optional query parameters allow filtering by status and date range.
Request Details
Headers
| Key | Value |
|---|---|
| Authorization | Bearer JWTTOKEN |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
healthCareServiceId | string (UUID) (path) | The unique identifier for the healthcare service. Required. |
surveyProgression | string (query) | Filter surveys by status (optional). Available values: none, new, inProgress, finished, exported, interrupted, locked, completed, archived, patientSubmitted. |
from | string (date-time) (query) | Start date for filtering surveys (optional). |
to | string (date-time) (query) | End date for filtering surveys (optional). |
cURL Request
curl --location 'https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/healthcareservice/{HEALTHCARE-SERVICE-ID}' \
--header 'Authorization: Bearer <TOKEN>'
Example Response
[
{
"surveyId": "930ec50f-85df-49ae-81c4-3555fde43bd7",
"status": "inProgress",
"createdAt": "2025-02-11T11:52:05.496214Z"
},
{
"surveyId": "d4fddcfb-2e1d-4096-b84d-7e1eae098d72",
"status": "new",
"createdAt": "2025-02-11T11:38:59.849992Z",
"patientId": "8993b0ef-7c89-4b66-b1e1-ac636f8cc170"
}
]
Conclusion
Fetching surveys for a healthcare service enables structured data retrieval, allowing users to track survey statuses and associated timestamps. Optional filtering by status and date range provides flexibility in querying results. For further details, refer to the Bingli API Documentation or contact support@mybingli.com.