Assign template to cohort

POST

cohorts

{cohort_id}

templates

import olira

olira.init(api_key="YOUR_API_KEY")
assignment = olira.assign_cohort_template(
    cohort_id="68582e4a0a0b3c1234567890",
    summary_type="symptom_overview",
)
print(assignment.id)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var assignment = OliraModule.AssignCohortTemplate(
    cohortId: "68582e4a0a0b3c1234567890",
    summaryType: "symptom_overview");
Console.WriteLine(assignment.Id);

POST /v1/cohorts/68582e4a0a0b3c1234567890/templates
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "summary_type": "symptom_overview"
}

CohortTemplateAssignment(
    id="68582e4a0a0b3c0987654321",
    summary_type="symptom_overview",
    template_id="68582e4a0a0b3c1111111111",
    cohort_id="68582e4a0a0b3c1234567890",
    assigned_at="2026-06-25T10:30:00Z",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

olira.assign_cohort_template(
    cohort_id: str,
    summary_type: str,
) -> CohortTemplateAssignment

OliraModule.AssignCohortTemplate(
    string cohortId,
    string summaryType,
)  // -> CohortTemplateAssignment

Requires scope: api:manage-patients Patients in the cohort will have this summary type included in their effective template set. Snapshot documents are seeded for existing patients in the background.

Parameters

str

required

Olira-assigned cohort id.

str

required

Summary type slug (e.g. symptom_overview).

Returns

CohortTemplateAssignment

str

Assignment id.

str

Assigned summary type slug.

str

Resolved template id at assignment time.

str

Cohort id.

str | None

ISO 8601 assignment timestamp.

Raises

Exception	When
`AuthError`	HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
`ValidationError`	HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
`ServerError`	HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
`RateLimitError`	HTTP 429 — rate limited; check retry_after (seconds).
`NetworkError`	Connection timeout, DNS failure, or read error after retries.

import olira

olira.init(api_key="YOUR_API_KEY")
assignment = olira.assign_cohort_template(
    cohort_id="68582e4a0a0b3c1234567890",
    summary_type="symptom_overview",
)
print(assignment.id)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var assignment = OliraModule.AssignCohortTemplate(
    cohortId: "68582e4a0a0b3c1234567890",
    summaryType: "symptom_overview");
Console.WriteLine(assignment.Id);

POST /v1/cohorts/68582e4a0a0b3c1234567890/templates
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "summary_type": "symptom_overview"
}

CohortTemplateAssignment(
    id="68582e4a0a0b3c0987654321",
    summary_type="symptom_overview",
    template_id="68582e4a0a0b3c1111111111",
    cohort_id="68582e4a0a0b3c1234567890",
    assigned_at="2026-06-25T10:30:00Z",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

import olira

olira.init(api_key="YOUR_API_KEY")
assignment = olira.assign_cohort_template(
    cohort_id="68582e4a0a0b3c1234567890",
    summary_type="symptom_overview",
)
print(assignment.id)

using Olira;

OliraModule.Init(apiKey: "YOUR_API_KEY");
var assignment = OliraModule.AssignCohortTemplate(
    cohortId: "68582e4a0a0b3c1234567890",
    summaryType: "symptom_overview");
Console.WriteLine(assignment.Id);

POST /v1/cohorts/68582e4a0a0b3c1234567890/templates
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "summary_type": "symptom_overview"
}

CohortTemplateAssignment(
    id="68582e4a0a0b3c0987654321",
    summary_type="symptom_overview",
    template_id="68582e4a0a0b3c1111111111",
    cohort_id="68582e4a0a0b3c1234567890",
    assigned_at="2026-06-25T10:30:00Z",
)

{
  "error": true,
  "status_code": 401,
  "error_type": "authentication_error",
  "message": "Could not validate credentials",
  "details": [
    {
      "type": "authentication_error",
      "message": "Could not validate credentials"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 403,
  "error_type": "authorization_error",
  "message": "Insufficient OAuth scope for this endpoint",
  "details": [
    {
      "type": "authorization_error",
      "message": "Insufficient OAuth scope for this endpoint"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 404,
  "error_type": "not_found_error",
  "message": "Patient not found",
  "details": [
    {
      "type": "not_found_error",
      "message": "Patient not found"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 422,
  "error_type": "validation_error",
  "message": "Request validation failed (1 error)",
  "details": [
    {
      "type": "missing",
      "message": "Field required",
      "field": "patient_id",
      "location": ["body", "patient_id"],
      "input_value": null
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 429,
  "error_type": "server_error",
  "message": "Rate limit exceeded",
  "details": [
    {
      "type": "rate_limit",
      "message": "Too many requests; retry after backoff"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

{
  "error": true,
  "status_code": 500,
  "error_type": "internal_server_error",
  "message": "An internal server error occurred",
  "details": [
    {
      "type": "internal_server_error",
      "message": "An unexpected error occurred while processing your request"
    }
  ],
  "timestamp": "2026-05-06T12:00:00+00:00"
}

Log types

SDK

Assign template to cohort

Parameters

Returns

Raises

​Parameters

​Returns

​Raises

Parameters

Returns

Raises