Endpoints

Results Endpoint

Retrieve conversion results for jobs that have succeeded.

Overview

The Results endpoint allows you to download the results for jobs with a success status. Structured FHIR or JSON results are returned in the response body by default, and you can optionally request a temporary download URL instead by setting presigned=true. PDF results are available only through a presigned download URL, so presigned=true is required for them.

Endpoint Details

URL: GET /api/v1/results/{job_id}

Request Parameters

Headers

Path Parameters

Query Parameters (optional)

Request Examples

curl -X GET "https://platform.curiflow.com/api/v1/results/job-uuid-12345" 
  -H "X-Client-Id: your-client-id" 
  -H "X-Client-Secret: your-client-secret"

const jobId = 'job-uuid-12345';
const response = await fetch(`https://platform.curiflow.com/api/v1/results/${jobId}`, {
	method: 'GET',
	headers: {
		'X-Client-Id': 'your-client-id',
		'X-Client-Secret': 'your-client-secret'
	}
});

const result = await response.json();

import requests

job_id = "job-uuid-12345"
url = f"https://platform.curiflow.com/api/v1/results/{job_id}"
headers = {
    "X-Client-Id": "your-client-id",
    "X-Client-Secret": "your-client-secret"
}

response = requests.get(url, headers=headers)
result = response.json()

With presigned URL

Add presigned=true to receive a temporary download URL. This is the required retrieval pattern for PDF results, and an optional pattern for structured FHIR or JSON results:

curl -X GET "https://platform.curiflow.com/api/v1/results/job-uuid-12345?presigned=true" 
  -H "X-Client-Id: your-client-id" 
  -H "X-Client-Secret: your-client-secret"

const jobId = 'job-uuid-12345';
const response = await fetch(`https://platform.curiflow.com/api/v1/results/${jobId}?presigned=true`, {
	method: 'GET',
	headers: {
		'X-Client-Id': 'your-client-id',
		'X-Client-Secret': 'your-client-secret'
	}
});

const { presigned_url } = await response.json();
// GET presigned_url to download the result file (FHIR/JSON or PDF); URL expires in 5 minutes

import requests

job_id = "job-uuid-12345"
url = f"https://platform.curiflow.com/api/v1/results/{job_id}"
headers = {
    "X-Client-Id": "your-client-id",
    "X-Client-Secret": "your-client-secret"
}

response = requests.get(url, headers=headers, params={"presigned": True})
result = response.json()
# GET result["presigned_url"] to download the result file (FHIR/JSON or PDF); URL expires in 5 minutes

Response Format

Success Response (200 OK) - structured result in response body

{
	"message": "Results retrieved successfully",
	"fhir_data": {
		"resourceType": "Bundle",
		"type": "collection",
		"entry": [
			{
				"resource": {
					"resourceType": "Patient",
					"id": "patient-123",
					"name": [
						{
							"family": "Doe",
							"given": ["John"]
						}
					]
				}
			}
		]
	}
}

Success Response (200 OK) - with presigned=true

When presigned=true, the response contains a time-limited download URL. Use it with a simple GET to download the result file. The URL expires in 5 minutes. PDF results are always returned this way.

{
	"message": "Presigned download URL generated successfully",
	"presigned_url": "https://s3.amazonaws.com/bucket/..."
}

Response Fields

FHIR Bundle Structure

The fhir_data field contains a FHIR Bundle with the following structure:

Common FHIR Resources

The conversion process typically generates these FHIR resources:

• Patient - Patient demographic information
• Encounter - Healthcare encounters and visits
• Condition - Diagnoses and medical conditions
• Medication - Medications and prescriptions
• Observation - Lab results and vital signs
• Procedure - Medical procedures performed

Status and Error Codes

Best Practices

1. Job Completion: Only call this endpoint after confirming the job status is success
2. Presigned URL: Use presigned=true for large results or when you prefer to download the result file; use the URL within 5 minutes. PDF results require presigned=true.
3. Data Processing: Parse and validate the result according to your application needs
4. Security: Keep your client credentials secure

Next Steps

After retrieving results:

• Process the result: Parse the FHIR Bundle and extract relevant resources, or download the result file via the presigned URL and then process it
• Store Results: Save the result to your database, EHR system, or document store
• Validate Data: Ensure the result meets your quality standards