> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cail.health/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cail.health/_mcp/server. # Get a pathway by identifier GET https://staging.cail.health/v1/plan-definitions/{id} Returns the full pathway row including the FHIR PlanDefinition resource and embedded decision tree (server-flattened to the request locale). Operator-only. Use this endpoint when authoring pathway content or inspecting a specific version. For member runtime, use the active-pathway endpoint. Reference: https://docs.cail.health/api-references/api-reference/understand-coverage/get ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: cail-api version: 1.0.0 paths: /v1/plan-definitions/{id}: get: operationId: get summary: Get a pathway by identifier description: >- Returns the full pathway row including the FHIR PlanDefinition resource and embedded decision tree (server-flattened to the request locale). Operator-only. Use this endpoint when authoring pathway content or inspecting a specific version. For member runtime, use the active-pathway endpoint. tags: - subpackage_understandCoverage parameters: - name: id in: path description: Stable identifier of the pathway. required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The pathway row. content: application/json: schema: $ref: '#/components/schemas/PlanDefinitionDetail' servers: - url: https://staging.cail.health description: https://staging.cail.health components: schemas: PlanDefinitionDetailStatus: type: string enum: - draft - active - retired description: Lifecycle status. title: PlanDefinitionDetailStatus PlanDefinitionDetail: type: object properties: id: type: string description: Stable identifier of the pathway. jurisdictionId: type: string description: Stable identifier of the jurisdiction the pathway is scoped to. organizationId: type: string description: >- Stable identifier of the operating organisation that owns the pathway. url: type: string description: Canonical URL for the pathway. version: type: string description: Semantic version assigned by the pathway authors. name: type: string description: Machine-readable name. title: type: string description: Human-readable title. status: $ref: '#/components/schemas/PlanDefinitionDetailStatus' description: Lifecycle status. versionId: type: number format: double description: >- Monotonically-increasing version number for optimistic locking on draft updates. lastUpdated: type: string description: ISO 8601 timestamp of the most recent update. resource: type: object additionalProperties: description: Any type description: >- The FHIR R4 PlanDefinition resource as published, including the decision-tree extension nodes flattened to the request locale. Treat as a standard FHIR PlanDefinition; see the FHIR R4 specification for the field-level structure. required: - id - jurisdictionId - organizationId - url - version - name - title - status - versionId - lastUpdated - resource title: PlanDefinitionDetail securitySchemes: auth0Bearer: type: http scheme: bearer ``` ## Examples **Response** ```json { "id": "a1b2c3d4-e5f6-4789-9abc-def012345678", "jurisdictionId": "jur_uk_eng", "organizationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "url": "https://api.cail.health/pathways/acute-respiratory", "version": "2.4.0", "name": "acute-respiratory", "title": "Acute respiratory triage", "status": "active", "versionId": 7, "lastUpdated": "2026-05-12T09:14:00.000Z", "resource": { "resourceType": "PlanDefinition", "id": "a1b2c3d4-e5f6-4789-9abc-def012345678", "status": "active", "title": "Acute respiratory triage" } } ``` **SDK Code** ```python An active pathway with its FHIR resource import requests url = "https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript An active pathway with its FHIR resource const url = 'https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go An active pathway with its FHIR resource package main import ( "fmt" "net/http" "io" ) func main() { url := "https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby An active pathway with its FHIR resource require 'uri' require 'net/http' url = URI("https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java An active pathway with its FHIR resource import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678") .header("Authorization", "Bearer ") .asString(); ``` ```php An active pathway with its FHIR resource request('GET', 'https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp An active pathway with its FHIR resource using RestSharp; var client = new RestClient("https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift An active pathway with its FHIR resource import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://staging.cail.health/v1/plan-definitions/a1b2c3d4-e5f6-4789-9abc-def012345678")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```