Documents

Get a document by ID

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Responses

200Success

text/html; charset=utf-8

get

/api/patients/{patientId}/documents/{documentId}

HTTPcURLJavaScriptPython

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

200Success

{
  "success": true,
  "data": {},
  "error": {
    "message": "text",
    "code": "text",
    "details": {}
  }
}

Get documents by patient ID

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

patientIdstringOptional

Unique identifier for the patient

Example: 12345

personIdnumberOptional

Unique identifier for the user who updated the document

Example: 12345

updatedByIdstringOptional

Unique identifier for the user who updated the document

Example: 12345

updatedByPersonIdnumberOptional

Unique identifier for the user who updated the document

Example: 12345

labelIdnumber[]Optional

Unique identifier for the label

Example: 12345

fileIdinteger[]Optional

Unique identifier for the file

Example: 12345

pathstringOptional

Path of the document

Example: surveys

statusstring · enumOptional

Status of the document

Default: DRAFTExample: DRAFTPossible values:

uploadToS3booleanOptional

Upload to S3

Example: true

organizationIdanyOptional

Organization ID

Example: 12345

namestringOptional

Search documents by name (case-insensitive partial match)

Example: patient_report

populationTagsnumber[]Optional

Population tags

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

requestingUserRolesstring[]Optional

Requesting user's roles

Default: []Example: ["OWNER","MEMBER"]

sortFieldstringOptional

Sort field

Example: name

sortOrderstring · enumOptional

Sort order

Example: ASCPossible values:

pageNumberinteger · min: 1Optional

Page number

Example: 1

pageSizeinteger · min: 1Optional

Page size

Example: 10

searchKeystringOptional

Search key

Example: search

Responses

200Success

text/html; charset=utf-8

get

/api/patients/{patientId}/documents

HTTPcURLJavaScriptPython

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

200Success

{
  "success": true,
  "data": {},
  "error": {
    "message": "text",
    "code": "text",
    "details": {}
  }
}

Create a document for a patient

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Query parameters

patientIdstringOptional

Unique identifier for the patient

Example: 12345

personIdnumberOptional

Unique identifier for the user who updated the document

Example: 12345

updatedByIdstringOptional

Unique identifier for the user who updated the document

Example: 12345

updatedByPersonIdnumberOptional

Unique identifier for the user who updated the document

Example: 12345

labelIdnumber[]Optional

Unique identifier for the label

Example: 12345

fileIdinteger[]Optional

Unique identifier for the file

Example: 12345

pathstringOptional

Path of the document

Example: surveys

statusstring · enumOptional

Status of the document

Default: DRAFTExample: DRAFTPossible values:

uploadToS3booleanOptional

Upload to S3

Example: true

organizationIdanyOptional

Organization ID

Example: 12345

namestringOptional

Search documents by name (case-insensitive partial match)

Example: patient_report

populationTagsnumber[]Optional

Population tags

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

requestingUserRolesstring[]Optional

Requesting user's roles

Default: []Example: ["OWNER","MEMBER"]

sortFieldstringOptional

Sort field

Example: name

sortOrderstring · enumOptional

Sort order

Example: ASCPossible values:

pageNumberinteger · min: 1Optional

Page number

Example: 1

pageSizeinteger · min: 1Optional

Page size

Example: 10

searchKeystringOptional

Search key

Example: search

Body

application/json

updatedByIdanyRequired

Unique identifier for the user who updated the document

Example: 12345

openTeleSessionIdstringOptional

Unique identifier for the open tele session

Example: 12345

attributesstring · jsonOptional

Attributes of the document

Default: {}

labelIdanyRequired

Unique identifier for the label

Example: 12345

statusstring · enumRequired

Status of the document

Default: DRAFTExample: DRAFTPossible values:

appointmentIdnumberOptional

Unique identifier for the appointment

Example: 12345

surveyResponseIdintegerOptional

Survey response ID associated with this document

Example: 12345

Responses

200Success

text/html; charset=utf-8

post

/api/patients/{patientId}/documents

HTTPcURLJavaScriptPython

POST /api/patients/{patientId}/documents 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: 485

{
  "file": {
    "id": 123,
    "name": "example.txt",
    "description": "example.txt",
    "cloudId": "121/0081905e-c201-4277-8fda-8ad296573f581737719364614",
    "resource": {},
    "mimeType": "application/pdf",
    "personId": 123,
    "documentLabelId": 123,
    "externalId": "ext123",
    "attributes": {},
    "archived": true,
    "labels": {},
    "relatedFiles": {},
    "updatedBy": {}
  },
  "updatedById": 12345,
  "openTeleSessionId": "12345",
  "attributes": {},
  "labelId": 12345,
  "status": "DRAFT",
  "appointmentId": 12345,
  "visibleToRoles": [
    "MEMBER"
  ],
  "surveyResponseId": 12345
}

200Success

{
  "success": true,
  "data": {},
  "error": {
    "message": "text",
    "code": "text",
    "details": {}
  }
}