Programs

Get patient program

get

Retrieves the program information for a specific patient

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

programNamestringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/patients/{patientId}/programs/{programName}

HTTPcURLJavaScriptPython

GET /api/patients/{patientId}/programs/{programName} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "name": "text",
  "title": "text",
  "description": "text",
  "status": "text",
  "currentPhase": "text"
}

Update patient program

put

Updates the program status for a specific patient

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

patientIdstringRequiredPattern: [^\/#\?]+?

programNamestringRequiredPattern: [^\/#\?]+?

Body

application/json

assignedbooleanRequired

statusstringRequired

Responses

200

Successful response

application/json

put

/api/patients/{patientId}/programs/{programName}

HTTPcURLJavaScriptPython

PUT /api/patients/{patientId}/programs/{programName} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "assigned": true,
  "status": "text"
}

200

Successful response