Administrations

Get administrations

get

Retrieves all medication administrations which requires patient information in the query params

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

medicationRequestIdnumberOptional

The medication request id to filter by

Example: 1

medicationRequestExternalIdstringOptional

The medication request external id to filter by

Example: external-id

statusstring · enumOptional

The status to filter by

Example: IN_PROGRESSPossible values:

occurrenceDateTimestring · jsonOptional

The occurrence date time to filter by

Example: {"startDate":"2025-01-01T00:00:00Z","endDate":"2025-01-01T00:00:00Z"}

recordedDateTimestring · jsonOptional

The recorded date time to filter by

Example: {"startDate":"2025-01-01T00:00:00Z","endDate":"2025-01-01T00:00:00Z"}

medicationIdnumberOptional

The medication id to filter by

Example: 1

medicationExternalIdstringOptional

The medication external id to filter by

Example: external-id

consumerIdanyOptional

The consumer id to filter by

Example: 1

consumerExternalIdstringOptional

The consumer external id to filter by

Example: external-id

organizationIdanyOptional

The organization id to filter by

Example: 1

sortBystringOptional

The field to sort by

Example: startDate

sortOrderstring · enumRequired

The order to sort by

Example: ascPossible values:

pageNumbernumberOptional

The page number to filter by

Example: 1

pageSizenumberOptional

The page size to filter by

Example: 10

Responses

200Success

application/json

get

/api/medications/administrations

HTTPcURLJavaScriptPython

GET /api/medications/administrations?sortOrder=asc HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 50
}

Create medication administration

post

Creates a new medication administration

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

medicationRequestIdnumberOptional

The medication request id to filter by

Example: 1

medicationRequestExternalIdstringOptional

The medication request external id to filter by

Example: external-id

statusstring · enumRequired

The status of the medication administration

Example: IN_PROGRESSPossible values:

occurrenceDateTimeone ofRequired

The occurrence date time of the medication administration

Example: 2025-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

recordedDateTimeone ofOptional

The recorded date time of the medication administration

Example: 2025-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

notestringOptional

The note of the medication administration

Example: Administered 10mg of medication

medicationIdnumberOptional

The medication id of the medication administration

Example: 1

medicationExternalIdstringOptional

The medication external id of the medication administration

Example: external-id

consumerIdnumberOptional

The consumer id of the medication administration

Example: 1

consumerExternalIdstringOptional

The consumer external id to filter by

Example: external-id

dosageDetailsanyRequired

The dosage details of the medication administration

Example: {"medicationRequestId":1,"status":"IN_PROGRESS","occurrenceDateTime":"2025-01-01T00:00:00Z"}

attributesanyOptional

The attributes of the medication administration

Example: {"key":"value"}

organizationIdanyOptional

The organization id of the medication administration

Example: 1

Responses

200Success

application/json

post

/api/medications/administrations

HTTPcURLJavaScriptPython

POST /api/medications/administrations 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: 480

{
  "medicationRequestId": 1,
  "medicationRequestExternalId": "external-id",
  "status": "IN_PROGRESS",
  "occurrenceDateTime": "2025-01-01T00:00:00Z",
  "recordedDateTime": "2025-01-01T00:00:00Z",
  "note": "Administered 10mg of medication",
  "medicationId": 1,
  "medicationExternalId": "external-id",
  "consumerId": 1,
  "consumerExternalId": "external-id",
  "dosageDetails": {
    "medicationRequestId": 1,
    "status": "IN_PROGRESS",
    "occurrenceDateTime": "2025-01-01T00:00:00Z"
  },
  "attributes": {
    "key": "value"
  },
  "organizationId": 1
}

200Success

{
  "id": 1,
  "medicationRequestId": 1,
  "status": "COMPLETED",
  "occurrenceDateTime": "2026-02-06T10:48:23.284Z",
  "recordedDateTime": "2026-02-06T10:48:23.284Z",
  "note": "Administered 10mg of medication",
  "medicationId": 1,
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "consumerId": 1,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "dosageDetails": {
    "id": 1,
    "text": "Administered 10mg of medication"
  },
  "medicationRequest": {
    "id": 1,
    "medicationId": 1
  },
  "medication": {
    "id": 1,
    "name": "Medication 1"
  }
}

Get administration by ID

get

Retrieves a specific medication administration by ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

get

/api/medications/administrations/{id}

HTTPcURLJavaScriptPython

GET /api/medications/administrations/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "medicationRequestId": 1,
  "status": "COMPLETED",
  "occurrenceDateTime": "2026-02-06T10:48:23.284Z",
  "recordedDateTime": "2026-02-06T10:48:23.284Z",
  "note": "Administered 10mg of medication",
  "medicationId": 1,
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "consumerId": 1,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "dosageDetails": {
    "id": 1,
    "text": "Administered 10mg of medication"
  },
  "medicationRequest": {
    "id": 1,
    "medicationId": 1
  },
  "medication": {
    "id": 1,
    "name": "Medication 1"
  }
}

Update administration

put

Updates an existing medication administration

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

medicationRequestIdnumberOptional

The medication request id to filter by

Example: 1

medicationRequestExternalIdstringOptional

The medication request external id to filter by

Example: external-id

statusstring · enumRequired

The status of the medication administration

Example: IN_PROGRESSPossible values:

occurrenceDateTimeone ofRequired

The occurrence date time of the medication administration

Example: 2025-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

recordedDateTimeone ofOptional

The recorded date time of the medication administration

Example: 2025-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

notestringOptional

The note of the medication administration

Example: Administered 10mg of medication

medicationIdnumberOptional

The medication id of the medication administration

Example: 1

medicationExternalIdstringOptional

The medication external id of the medication administration

Example: external-id

consumerIdnumberOptional

The consumer id of the medication administration

Example: 1

consumerExternalIdstringOptional

The consumer external id to filter by

Example: external-id

dosageDetailsanyRequired

The dosage details of the medication administration

Example: {"medicationRequestId":1,"status":"IN_PROGRESS","occurrenceDateTime":"2025-01-01T00:00:00Z"}

attributesanyOptional

The attributes of the medication administration

Example: {"key":"value"}

organizationIdanyOptional

The organization id of the medication administration

Example: 1

Responses

200Success

application/json

put

/api/medications/administrations/{id}

HTTPcURLJavaScriptPython

PUT /api/medications/administrations/{id} 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: 480

{
  "medicationRequestId": 1,
  "medicationRequestExternalId": "external-id",
  "status": "IN_PROGRESS",
  "occurrenceDateTime": "2025-01-01T00:00:00Z",
  "recordedDateTime": "2025-01-01T00:00:00Z",
  "note": "Administered 10mg of medication",
  "medicationId": 1,
  "medicationExternalId": "external-id",
  "consumerId": 1,
  "consumerExternalId": "external-id",
  "dosageDetails": {
    "medicationRequestId": 1,
    "status": "IN_PROGRESS",
    "occurrenceDateTime": "2025-01-01T00:00:00Z"
  },
  "attributes": {
    "key": "value"
  },
  "organizationId": 1
}

200Success

{
  "id": 1,
  "medicationRequestId": 1,
  "status": "COMPLETED",
  "occurrenceDateTime": "2026-02-06T10:48:23.284Z",
  "recordedDateTime": "2026-02-06T10:48:23.284Z",
  "note": "Administered 10mg of medication",
  "medicationId": 1,
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "consumerId": 1,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "dosageDetails": {
    "id": 1,
    "text": "Administered 10mg of medication"
  },
  "medicationRequest": {
    "id": 1,
    "medicationId": 1
  },
  "medication": {
    "id": 1,
    "name": "Medication 1"
  }
}