Requests

Get Medications Requests

get

Retrieves all medications requests which requires patient information or medication data in the query params

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

consumerIdanyOptional

The consumer id of the medication request

Example: 1

consumerExternalIdanyOptional

The consumer external id of the medication request

Example: 550e8400-e29b-41d4-a716-446655440000

statusanyOptional

The status of the medication request

Example: ACTIVE

medicationIdanyOptional

The medication id of the medication request

Example: 1

medicationExternalIdanyOptional

The medication external id of the medication request

Example: 550e8400-e29b-41d4-a716-446655440000

serviceProviderExternalIdanyOptional

The service provider external id of the medication request

Example: 550e8400-e29b-41d4-a716-446655440000

serviceProviderIdanyOptional

The service provider id of the medication request

Example: 1

organizationIdanyOptional

The organization id of the medication request

Example: 1

intentanyOptional

The intent of the medication request

Example: ORDER

priorityanyOptional

The priority of the medication request

Example: ROUTINE

Responses

200Success

application/json

get

/api/medications/requests

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": 1,
    "medicationId": 1,
    "consumerId": 1,
    "requesterId": 1,
    "status": "ACTIVE",
    "intent": "ORDER",
    "priority": "ASAP",
    "authoredOn": "2021-01-01",
    "reasonCode": "1234567890",
    "reasonReference": "1234567890",
    "note": "This is a note",
    "dosageInstruction": {
      "id": 1,
      "sequence": 1,
      "text": "Take 1 tablet by mouth"
    },
    "dispenseRequest": {
      "id": 1,
      "quantity": 1,
      "quantityUnit": "tablet"
    },
    "medication": {
      "id": 1,
      "display": "Metformin"
    },
    "externalId": "1234567890",
    "attributes": {
      "extraValue": "extraValue",
      "extraValue2": "extraValue2"
    },
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  }
]

Create medication request

post

Creates a new medication request/prescription

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

consumerIdnumberRequired

Patient/Consumer ID

Example: 1

consumerExternalIdanyOptional

Patient/Consumer External ID

Example: 123

externalIdanyOptional

Medication Request External ID

Example: 123

serviceProviderIdnumberRequired

Service Provider ID

Example: 1

serviceProviderExternalIdstringRequired

Service Provider External ID

Example: 123

medicationIdnumberRequired

Medication ID

Example: 1

medicationExternalIdanyOptional

Medication External ID

Example: 123

intentstring · enumOptional

Request intent

Example: ORDERPossible values:

prioritystring · enumOptional

Request priority

Example: ROUTINEPossible values:

statusstring · enumOptional

Request status

Example: ACTIVEPossible values:

reasonCodestringOptional

Reason for request

Example: Type 2 Diabetes

reasonReferencestringOptional

Reference to condition

Example: Condition/123

attributesobjectOptional

Additional attributes

Example: {"medicationId":1,"consumerId":1,"serviceProviderId":1}

notestringOptional

Additional notes

Example: Take with food

dosageInstructionobjectOptional

dispenseRequestobjectOptional

organizationIdanyOptional

The organization id of the medication request

Example: 1

Responses

200Success

application/json

post

/api/medications/requests

HTTPcURLJavaScriptPython

POST /api/medications/requests 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: 441

{
  "consumerId": 1,
  "consumerExternalId": "123",
  "externalId": "123",
  "serviceProviderId": 1,
  "serviceProviderExternalId": "123",
  "medicationId": 1,
  "medicationExternalId": "123",
  "intent": "ORDER",
  "priority": "ROUTINE",
  "status": "ACTIVE",
  "reasonCode": "Type 2 Diabetes",
  "reasonReference": "Condition/123",
  "attributes": {
    "medicationId": 1,
    "consumerId": 1,
    "serviceProviderId": 1
  },
  "note": "Take with food",
  "dosageInstruction": {},
  "dispenseRequest": {},
  "organizationId": 1
}

200Success

{
  "id": 1,
  "medicationId": 1,
  "consumerId": 1,
  "requesterId": 1,
  "status": "ACTIVE",
  "intent": "ORDER",
  "priority": "ASAP",
  "authoredOn": "2021-01-01",
  "reasonCode": "1234567890",
  "reasonReference": "1234567890",
  "note": "This is a note",
  "dosageInstruction": {
    "id": 1,
    "sequence": 1,
    "text": "Take 1 tablet by mouth"
  },
  "dispenseRequest": {
    "id": 1,
    "quantity": 1,
    "quantityUnit": "tablet"
  },
  "medication": {
    "id": 1,
    "display": "Metformin"
  },
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01"
}

Get request by ID

get

Retrieves a specific medication request 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/requests/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": 1,
  "medicationId": 1,
  "consumerId": 1,
  "requesterId": 1,
  "status": "ACTIVE",
  "intent": "ORDER",
  "priority": "ASAP",
  "authoredOn": "2021-01-01",
  "reasonCode": "1234567890",
  "reasonReference": "1234567890",
  "note": "This is a note",
  "dosageInstruction": {
    "id": 1,
    "sequence": 1,
    "text": "Take 1 tablet by mouth"
  },
  "dispenseRequest": {
    "id": 1,
    "quantity": 1,
    "quantityUnit": "tablet"
  },
  "medication": {
    "id": 1,
    "display": "Metformin"
  },
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01"
}

Update request

put

Updates an existing medication request

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

externalIdstringOptional

idnumberOptional

statusstring · enumOptionalPossible values:

prioritystring · enumOptionalPossible values:

notestringOptional

dispenseRequestobjectOptional

attributesobjectOptional

Additional attributes

Example: {"medicationId":1,"consumerId":1,"serviceProviderId":1}

organizationIdanyOptional

The organization id of the medication request

Example: 1

Responses

200Success

application/json

put

/api/medications/requests/{id}

HTTPcURLJavaScriptPython

PUT /api/medications/requests/{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: 190

{
  "externalId": "text",
  "id": 1,
  "status": "ACTIVE",
  "priority": "ROUTINE",
  "note": "text",
  "dispenseRequest": {},
  "attributes": {
    "medicationId": 1,
    "consumerId": 1,
    "serviceProviderId": 1
  },
  "organizationId": 1
}

200Success

{
  "id": 1,
  "medicationId": 1,
  "consumerId": 1,
  "requesterId": 1,
  "status": "ACTIVE",
  "intent": "ORDER",
  "priority": "ASAP",
  "authoredOn": "2021-01-01",
  "reasonCode": "1234567890",
  "reasonReference": "1234567890",
  "note": "This is a note",
  "dosageInstruction": {
    "id": 1,
    "sequence": 1,
    "text": "Take 1 tablet by mouth"
  },
  "dispenseRequest": {
    "id": 1,
    "quantity": 1,
    "quantityUnit": "tablet"
  },
  "medication": {
    "id": 1,
    "display": "Metformin"
  },
  "externalId": "1234567890",
  "attributes": {
    "extraValue": "extraValue",
    "extraValue2": "extraValue2"
  },
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01"
}