Launch pipeline API

Use the Launch Pipeline API to start a pipeline from an external application or automation tool.

You can launch a pipeline by providing the required pipeline parameters or by using a predefined pipeline template.

When you launch a pipeline, the pipeline ID and status is returned.

Load pipeline API Request

This table shows the parameters for a load pipeline API request:


Parameter	Without template	With template
`pipeline_type`	Required	Optional
`pipeline_description`	Required	Optional
`patient_group_id`	Required	Optional
`databaseName`	Required	Optional
`dataSourceName`	Required	Optional
`template_name`	Not applicable	Required
`since_date`	Optional (Azure and HealthLake date sources only)	Optional

If you use a template, the values that you provide in the API request replace the corresponding template values.

Load Pipeline Sample Values

Use this example to launch a load pipeline by providing the required parameters in the request body:

{
 "pipeline_type": "load",
 "pipeline_description": "LOAD API test",
 "patient_group_id": "pgid",
 "databaseName": "dbname",
 "dataSourceName": "dsname",
 "since_date": "2025-06-01"
 }

Use this example to launch a load pipeline by using a predefined template:

{
 "pipeline_type": "load",
 "pipeline_description": "LOAD API test",
 "patient_group_id": "pgid",
 "databaseName": "dbname",
 "dataSourceName": "dsname",
 "since_date": "2025-06-01"
 }

Calculate pipeline API Request

This table shows the parameters for a calculate pipeline API request:


Parameter	Without template	With template
`pipeline_type`	Required	Optional
`patient_group_id`	Required	Optional
`databaseName`	Required	Optional
`measure_list`	Required	Optional
`startDate`	Required	Optional
`endDate`	Required	Optional
`template_name`	Not applicable	Required
`pipeline_description`	Optional	Optional

Measure identifiers are client-specific and depend on the measure pack installed in the tenant.

If you use a template, the values that you provide in the API request replace the corresponding template values. If you specify a template, the pipeline_type of the template must match the pipeline_type in the request. Otherwise, the API returns a 400 response.

Calculate Pipeline Sample Values

Use this example to launch a calculate pipeline by providing the required parameters in the request body:

{
 "pipeline_type": "calculate",
 "pipeline_description": "API test",
 "patient_group_id": "pgid",
 "databaseName": "dbname",
 "measure_list": "CMS122v12,InforDQ-CNT-v01",
 "startDate": "2026-01-01",
 "endDate": "2026-12-31"
}

Use this example to launch a calculate pipeline by using a predefined template:

{
 "pipeline_type": "calculate",
 "pipeline_description": "API test",
 "template_name": "templatename"
 }

Response codes for Launch Pipeline API

This table shows the response codes for the Launch Pipeline API:


Code	Description
202	Request accepted. The pipeline is launched or queued.
400	Invalid request.
401	Authentication failed or is missing.
403	Access denied.
404	API path not found.
429	Calculation quota exceeded.
500	Unexpected server error.
507	Storage quota exceeded.