Assessment response

Get assessments of a patient with pagination

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

assessmentIdintegerOptional

ID of the assessment

Example: 1

assessmentNamestringOptional

Name of the assessment

Example: Math Assessment

assessmentNameFilterModestring · enumOptional

Filter mode for assessment name

Default: exactExample: exactPossible values:

assessmentTitlestringOptional

Title of the assessment

Example: Final Exam

assessmentTitleFilterModestring · enumOptional

Filter mode for assessment title

Default: exactExample: partialPossible values:

isConsentbooleanOptional

Flag to include assessment that are consents

Example: true

pageNumberintegerOptional

Page number for pagination

Default: 1Example: 1

appointmentIdintegerOptional

ID of the appointment

Default: 1Example: 1

pageSizeintegerOptional

Page size for pagination

Default: 10Example: 10

statusstring[]Optional

Status of the assessment

Default: []Example: ["active","inactive"]

orderBystringOptional

Field to order by

Example: createdAt

orderDirectionstringOptional

Direction of ordering

Default: ascExample: desc

mapResSchemaWithPlatformbooleanOptional

Flag to identify the version

Example: true

populationTagsnumber[]Optional

List of tags to filter assessments

Default: []Example: [1,2,3]

Responses

200Success

application/json

get

/api/patients/{patientId}/assessment-response

HTTPcURLJavaScriptPython

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

200Success

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 100,
  "totalPages": 10,
  "assessments": []
}

Create an assessment response

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

finalSubmissionbooleanOptional

idstringOptional

ID of the assessment input

Example: 12345

patientIdstringRequired

ID of the patient

Example: 12345

assessmentNamestringOptional

Name of the assessment

Example: General Health

assessmentIdstringOptional

ID of the assessment

Example: 54321

surveyNamestringOptional

Name of the survey

Example: Health Survey

surveyIdstringOptional

ID of the survey

Example: 09876

assessmentResponseObjectobjectOptional

Object containing assessment responses

Default: {}

attributesobjectOptional

Additional attributes

Default: {}

statusstringOptional

Status of the assessment

Default: pendingExample: completed

consumerEpisodeIntakeIdnumberOptional

appointmentIdnumberOptional

Appointment ID associated with the assessment

Example: 1

updatedByobjectOptional

Body

application/json

idstringOptional

ID of the assessment input

Example: 12345

patientIdstringRequired

ID of the patient

Example: 12345

assessmentNamestringOptional

Name of the assessment

Example: General Health

assessmentIdstringOptional

ID of the assessment

Example: 54321

surveyNamestringOptional

Name of the survey

Example: Health Survey

surveyIdstringOptional

ID of the survey

Example: 09876

assessmentResponseObjectobjectOptional

Object containing assessment responses

Default: {}

attributesobjectOptional

Additional attributes

Default: {}

statusstringOptional

Status of the assessment

Default: pendingExample: completed

consumerEpisodeIntakeIdnumberOptional

appointmentIdnumberOptional

Appointment ID associated with the assessment

Example: 1

updatedByobjectOptional

Responses

200Success

application/json

post

/api/patients/{patientId}/assessment-response

HTTPcURLJavaScriptPython

POST /api/patients/{patientId}/assessment-response?patientId=12345 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: 339

{
  "id": "12345",
  "patientId": "12345",
  "assessmentName": "General Health",
  "assessmentId": "54321",
  "surveyName": "Health Survey",
  "surveyId": "09876",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {
      "id": "provider1"
    }
  ],
  "attributes": {},
  "status": "completed",
  "consumerEpisodeIntakeId": 1,
  "appointmentId": 1,
  "updatedBy": {}
}

200Success

{
  "id": "1",
  "patientId": "1",
  "assessmentName": "General Health",
  "assessmentTitle": "General Health Assessment",
  "assessmentId": "A123",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "completedAt": "2023-01-03T00:00:00Z",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {}
  ],
  "assessmentQuestionnaireObject": {},
  "assessmentQuestionnaire": [],
  "attributes": {},
  "assessmentItemAnswers": [],
  "files": {},
  "personId": 1,
  "appointmentId": 1,
  "person": {}
}

Get a specific assessment response of a patient

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Query parameters

assessmentIdintegerOptional

ID of the assessment

Example: 1

assessmentNamestringOptional

Name of the assessment

Example: Math Assessment

assessmentNameFilterModestring · enumOptional

Filter mode for assessment name

Default: exactExample: exactPossible values:

assessmentTitlestringOptional

Title of the assessment

Example: Final Exam

assessmentTitleFilterModestring · enumOptional

Filter mode for assessment title

Default: exactExample: partialPossible values:

isConsentbooleanOptional

Flag to include assessment that are consents

Example: true

pageNumberintegerOptional

Page number for pagination

Default: 1Example: 1

appointmentIdintegerOptional

ID of the appointment

Default: 1Example: 1

pageSizeintegerOptional

Page size for pagination

Default: 10Example: 10

statusstring[]Optional

Status of the assessment

Default: []Example: ["active","inactive"]

orderBystringOptional

Field to order by

Example: createdAt

orderDirectionstringOptional

Direction of ordering

Default: ascExample: desc

mapResSchemaWithPlatformbooleanOptional

Flag to identify the version

Example: true

populationTagsnumber[]Optional

List of tags to filter assessments

Default: []Example: [1,2,3]

Responses

200Success

application/json

get

/api/patients/{patientId}/assessment-response/{assessmentResponseId}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "1",
  "patientId": "1",
  "assessmentName": "General Health",
  "assessmentTitle": "General Health Assessment",
  "assessmentId": "A123",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "completedAt": "2023-01-03T00:00:00Z",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {}
  ],
  "assessmentQuestionnaireObject": {},
  "assessmentQuestionnaire": [],
  "attributes": {},
  "assessmentItemAnswers": [],
  "files": {},
  "personId": 1,
  "appointmentId": 1,
  "person": {}
}

Update an assessment response

put

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Query parameters

finalSubmissionbooleanOptional

assessmentIdintegerOptional

ID of the assessment

Example: 1

assessmentNamestringOptional

Name of the assessment

Example: Math Assessment

assessmentNameFilterModestring · enumOptional

Filter mode for assessment name

Default: exactExample: exactPossible values:

assessmentTitlestringOptional

Title of the assessment

Example: Final Exam

assessmentTitleFilterModestring · enumOptional

Filter mode for assessment title

Default: exactExample: partialPossible values:

isConsentbooleanOptional

Flag to include assessment that are consents

Example: true

pageNumberintegerOptional

Page number for pagination

Default: 1Example: 1

appointmentIdintegerOptional

ID of the appointment

Default: 1Example: 1

pageSizeintegerOptional

Page size for pagination

Default: 10Example: 10

statusstring[]Optional

Status of the assessment

Default: []Example: ["active","inactive"]

orderBystringOptional

Field to order by

Example: createdAt

orderDirectionstringOptional

Direction of ordering

Default: ascExample: desc

mapResSchemaWithPlatformbooleanOptional

Flag to identify the version

Example: true

populationTagsnumber[]Optional

List of tags to filter assessments

Default: []Example: [1,2,3]

Body

application/json

idstringOptional

ID of the assessment input

Example: 12345

patientIdstringRequired

ID of the patient

Example: 12345

assessmentNamestringOptional

Name of the assessment

Example: General Health

assessmentIdstringOptional

ID of the assessment

Example: 54321

surveyNamestringOptional

Name of the survey

Example: Health Survey

surveyIdstringOptional

ID of the survey

Example: 09876

assessmentResponseObjectobjectOptional

Object containing assessment responses

Default: {}

attributesobjectOptional

Additional attributes

Default: {}

statusstringOptional

Status of the assessment

Default: pendingExample: completed

consumerEpisodeIntakeIdnumberOptional

appointmentIdnumberOptional

Appointment ID associated with the assessment

Example: 1

updatedByobjectOptional

Responses

200Success

application/json

put

/api/patients/{patientId}/assessment-response/{assessmentResponseId}

HTTPcURLJavaScriptPython

PUT /api/patients/{patientId}/assessment-response/{assessmentResponseId} 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: 339

{
  "id": "12345",
  "patientId": "12345",
  "assessmentName": "General Health",
  "assessmentId": "54321",
  "surveyName": "Health Survey",
  "surveyId": "09876",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {
      "id": "provider1"
    }
  ],
  "attributes": {},
  "status": "completed",
  "consumerEpisodeIntakeId": 1,
  "appointmentId": 1,
  "updatedBy": {}
}

200Success

{
  "id": "1",
  "patientId": "1",
  "assessmentName": "General Health",
  "assessmentTitle": "General Health Assessment",
  "assessmentId": "A123",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "completedAt": "2023-01-03T00:00:00Z",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {}
  ],
  "assessmentQuestionnaireObject": {},
  "assessmentQuestionnaire": [],
  "attributes": {},
  "assessmentItemAnswers": [],
  "files": {},
  "personId": 1,
  "appointmentId": 1,
  "person": {}
}

Create an assessment response

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Query parameters

finalSubmissionbooleanOptional

Responses

200Success

application/json

post

/api/patients/{patientId}/assessment-response/{assessmentId}

HTTPcURLJavaScriptPython

POST /api/patients/{patientId}/assessment-response/{assessmentId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "1",
  "patientId": "1",
  "assessmentName": "General Health",
  "assessmentTitle": "General Health Assessment",
  "assessmentId": "A123",
  "status": "Completed",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z",
  "completedAt": "2023-01-03T00:00:00Z",
  "assessmentResponse": [],
  "assessmentResponseObject": {},
  "assignedServiceProviders": [
    {}
  ],
  "assessmentQuestionnaireObject": {},
  "assessmentQuestionnaire": [],
  "attributes": {},
  "assessmentItemAnswers": [],
  "files": {},
  "personId": 1,
  "appointmentId": 1,
  "person": {}
}