Huma Medications API
The Medications API from Huma — 10 operation(s) for medications.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/huma-medications-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Huma Platform Medications API
version: 1.0.0
description: Huma Platform
servers:
- url: https://workspace-gcp-uk.api.huma.com/api/integration/v1
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Medications
paths:
/api/extensions/v1/user/{user_id}/medication:
post:
operationId: api_extensions_v1_user_medication_create_[create_medication]
summary: Create Medication
parameters:
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateMedicationRequestObjectV2DRF'
required: true
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ResultIdResponseObjectDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/{medication_id}/calendar:
get:
operationId: api_extensions_v1_user_medication_calendar_retrieve_[retrieve_a_medication_calendar]
summary: Retrieve A Medication Calendar
parameters:
- in: query
name: connectedModule
schema:
type: string
- in: query
name: deploymentId
schema:
type: string
- in: query
name: endDateTime
schema:
type: string
format: date-time
required: true
- in: query
name: hideMealBased
schema:
type: boolean
- in: query
name: logOverride
schema:
type: boolean
- in: query
name: medicationId
schema:
type: string
- in: path
name: medication_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
- in: query
name: startDateTime
schema:
type: string
format: date-time
required: true
- in: query
name: user
schema:
type: string
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationCalendarResponseDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/{medication_id}/log:
post:
operationId: api_extensions_v1_user_medication_log_create_[create_medication_log]
summary: Create Medication Log
parameters:
- in: path
name: medication_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateMedicationLogRequestObjectDRF'
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ListIdResponseObjectDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/{medication_id}/notes:
get:
operationId: api_extensions_v1_user_medication_notes_retrieve_[retrieve_a_medication_notes]
summary: Retrieve A Medication Notes
parameters:
- in: path
name: medication_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationNotesResponseDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/calendar:
get:
operationId: api_extensions_v1_user_medication_calendar_retrieve_[retrieve_medication_calendar]
summary: Retrieve Medication Calendar
parameters:
- in: query
name: connectedModule
schema:
type: string
- in: query
name: deploymentId
schema:
type: string
- in: query
name: endDateTime
schema:
type: string
format: date-time
required: true
- in: query
name: hideMealBased
schema:
type: boolean
- in: query
name: logOverride
schema:
type: boolean
- in: query
name: startDateTime
schema:
type: string
format: date-time
required: true
- in: query
name: user
schema:
type: string
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationCalendarResponseDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/history/search:
get:
operationId: api_extensions_v1_user_medication_history_search_retrieve_[retrieve_medications_history]
summary: Retrieve Medications History
parameters:
- in: query
name: deploymentId
schema:
type: string
- in: query
name: limit
schema:
type: integer
- in: query
name: searchWithUserType
schema:
type: string
- in: query
name: seen
schema:
type: boolean
- in: query
name: skip
schema:
type: integer
- in: query
name: userId
schema:
type: string
- in: query
name: userType
schema:
type: string
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationHistoryResponseV2DRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/history/seen:
post:
operationId: api_extensions_v1_user_medication_history_seen_create_[update_medication_history_as_seen]
summary: Update Medication History As Seen
parameters:
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListIdResponseObjectDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/logs:
get:
operationId: api_extensions_v1_user_medication_logs_retrieve_[retrieve_medication_logs]
summary: Retrieve Medication Logs
parameters:
- in: query
name: endDateTime
schema:
type: string
format: date-time
- in: query
name: moduleConfigId
schema:
type: string
- in: query
name: moduleId
schema:
type: string
- in: query
name: startDateTime
schema:
type: string
format: date-time
- in: query
name: status
schema:
type: string
- in: query
name: userId
schema:
type: string
required: true
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MedicationLogsResponseDRF'
description: ''
/api/extensions/v1/user/{user_id}/medication/search:
get:
operationId: api_extensions_v1_user_medication_search_retrieve_[retrieve_medications]
summary: Retrieve Medications
parameters:
- in: query
name: deploymentId
schema:
type: string
- in: query
name: enabled
schema:
type: boolean
- in: query
name: grouped
schema:
type: boolean
- in: query
name: hideMealBased
schema:
type: boolean
- in: query
name: limit
schema:
type: integer
- in: query
name: skip
schema:
type: integer
- in: query
name: user
schema:
type: string
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
description: No response body
/api/extensions/v1/user/{user_id}/medication/unseen:
get:
operationId: api_extensions_v1_user_medication_unseen_retrieve_[retrieve_unseen_medication_results]
summary: Retrieve Unseen Medication Results
parameters:
- in: query
name: deployment
schema:
type: string
- in: query
name: limit
schema:
type: integer
- in: query
name: moduleConfigId
schema:
type: string
- in: query
name: skip
schema:
type: integer
- in: query
name: userId
schema:
type: string
- in: path
name: user_id
schema:
type: string
pattern: ^[a-f0-9]{24}$
required: true
tags:
- Medications
security:
- JWT Auth: []
- Hawk Auth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveUnseenMedicationResultsResponseDRF'
description: ''
components:
schemas:
OffBoardingReasonsDRF:
type: object
properties:
reasons:
type: array
items:
$ref: '#/components/schemas/ReasonDRF'
otherReason:
type: boolean
UIWidgetDRF:
type: object
properties:
order:
type: integer
enabled:
type: boolean
config:
type: object
additionalProperties: {}
type:
type: string
id:
type: string
required:
- config
- order
- type
DeploymentStatsDRF:
type: object
properties:
completedCount:
$ref: '#/components/schemas/StatDRF'
completedTask:
$ref: '#/components/schemas/StatDRF'
consentedCount:
$ref: '#/components/schemas/StatDRF'
enrolledCount:
$ref: '#/components/schemas/StatDRF'
patientCount:
$ref: '#/components/schemas/StatDRF'
updateDateTime:
type: string
format: date-time
ModuleConfigDRF:
type: object
properties:
id:
type: string
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
moduleId:
type: string
moduleName:
type: string
shortModuleName:
type: string
status:
type: string
order:
type: integer
configBody:
type: object
additionalProperties: {}
about:
type: string
footnote:
$ref: '#/components/schemas/FootnoteDRF'
schedule:
$ref: '#/components/schemas/ModuleScheduleDRF'
ragThresholds:
type: array
items:
$ref: '#/components/schemas/RagThresholdDRF'
learnArticleIds:
type: array
items:
type: string
learnArticles:
type: array
items:
type: object
additionalProperties: {}
version:
type: integer
staticEvent:
$ref: '#/components/schemas/StaticEventDRF'
notificationData:
$ref: '#/components/schemas/NotificationDataDRF'
localizationPrefix:
type: string
goal:
$ref: '#/components/schemas/ModuleGoalDTODRF'
goalEnabled:
type: boolean
feedback:
$ref: '#/components/schemas/FeedbackConfigDRF'
feedbackTexts:
type: array
items:
$ref: '#/components/schemas/FeedbackTextsDRF'
readOnly:
type: boolean
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- moduleId
SurgeryDetailItemDRF:
type: object
properties:
key:
type: string
value:
type: string
order:
type: integer
required:
- key
- value
RecentFlagsDRF:
type: object
properties:
red:
type: integer
amber:
type: integer
green:
type: integer
gray:
type: integer
MedicationCalendarResponseDRF:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MedicationScheduleEventDRF'
medications:
type: array
items:
$ref: '#/components/schemas/MedicationDetailsDRF'
UserStatsDRF:
type: object
properties:
taskCompliance:
$ref: '#/components/schemas/TaskComplianceDRF'
studyProgress:
$ref: '#/components/schemas/StudyProgressDRF'
FeaturesDRF:
type: object
properties:
appMenu:
type: array
items:
type: string
appointment:
type: boolean
carePlanDailyAdherence:
type: boolean
offBoarding:
type: boolean
personalDocuments:
type: boolean
patientPersonalization:
$ref: '#/components/schemas/PatientPersonalizationDRF'
proxy:
type: boolean
surgeryDateRule:
$ref: '#/components/schemas/SurgeryDateRuleDRF'
labels:
type: boolean
portal:
type: object
additionalProperties: {}
offBoardingReasons:
$ref: '#/components/schemas/OffBoardingReasonsDRF'
moveUserReasons:
$ref: '#/components/schemas/MoveUserReasonsDRF'
messaging:
$ref: '#/components/schemas/MessagingDRF'
hideAppSupport:
type: boolean
summaryReport:
$ref: '#/components/schemas/SummaryReportDRF'
linkInvites:
type: boolean
classB:
type: boolean
deviceIntegration:
$ref: '#/components/schemas/DeviceIntegrationDRF'
customAppConfig:
type: object
additionalProperties: {}
improvedOnboarding:
type: boolean
timeline:
type: boolean
profilePicture:
type: boolean
unitsIsHidden:
type: boolean
dataDownloadIsHidden:
type: boolean
labelIsHidden:
type: boolean
ifuIsHidden:
type: boolean
videoAdapter:
type: string
mealBasedModules:
type: array
items:
type: string
email:
$ref: '#/components/schemas/EmailConfigDRF'
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
SsoDRF:
type: object
properties:
name:
type: string
org:
type: string
info:
$ref: '#/components/schemas/SsoInfoDRF'
TimeDurationDRF:
type: object
properties:
startTime:
type: string
endTime:
type: string
required:
- endTime
- startTime
SurgeryDetailsDRF:
type: object
properties:
operationType:
$ref: '#/components/schemas/SurgeryDetailDRF'
implantType:
$ref: '#/components/schemas/SurgeryDetailDRF'
roboticAssistance:
$ref: '#/components/schemas/SurgeryDetailDRF'
PAMIntegrationConfigDRF:
type: object
properties:
submitSurveyURI:
type: string
enrollUserURI:
type: string
clientExtID:
type: string
clientPassKeyEncrypted:
type: string
subgroupExtID:
type: string
required:
- clientExtID
- clientPassKeyEncrypted
- enrollUserURI
- subgroupExtID
- submitSurveyURI
UnseenFlagsDRF:
type: object
properties:
red:
type: integer
amber:
type: integer
green:
type: integer
gray:
type: integer
ManagerNotificationsDRF:
type: object
properties:
demographicsChange:
type: boolean
UITabDRF:
type: object
properties:
order:
type: integer
id:
type: string
screenId:
type: string
name:
type: string
type:
type: string
description:
type: string
icon:
type: string
status:
type: string
background:
$ref: '#/components/schemas/BackgroundDRF'
widgets:
type: array
items:
$ref: '#/components/schemas/UIWidgetDRF'
extras:
type: object
additionalProperties: {}
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
required:
- background
- icon
- name
- order
- status
DeploymentLevelConfigurationDRF:
type: object
properties:
targetConsentedMonthly:
type: integer
targetConsented:
type: integer
day0Anchor:
type: string
targetCompleted:
type: integer
CaptureChangeDRF:
type: object
properties:
old:
type: string
new:
type: string
required:
- new
- old
DeviceIntegrationDRF:
type: object
properties:
enabled:
type: boolean
UnseenResultDTODRF:
type: object
properties:
id:
type: string
userId:
type: string
deploymentId:
type: string
moduleId:
type: string
moduleConfigId:
type: string
primitiveName:
type: string
extra:
type: object
additionalProperties: {}
flags:
$ref: '#/components/schemas/UnseenFlagsDRF'
source:
type: string
startDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
required:
- deploymentId
- flags
- moduleId
- primitiveName
- userId
FileFieldDRF:
type: object
properties:
fileId:
type: string
required:
- fileId
UserLabelDRF:
type: object
properties:
labelId:
type: string
assignedBy:
type: string
assignDateTime:
type: string
format: date-time
PeriodProgressDRF:
type: object
properties:
taskCompliance:
type: number
format: double
startDateTime:
type: string
format: date-time
openQueriesAmount:
type: integer
passedDueDateFormsAmount:
type: integer
passedDatesCounter:
type: array
items:
$ref: '#/components/schemas/PassedDueDateEventsAmountDRF'
LabelDRF:
type: object
properties:
id:
type: string
text:
type: string
authorId:
type: string
createDateTime:
type: string
format: date-time
updatedBy:
type: string
updateDateTime:
type: string
format: date-time
isStatic:
type: boolean
operations:
type: array
items:
type: string
BackgroundDRF:
type: object
properties:
value:
type: string
type:
type: string
required:
- type
- value
PassedDueDateEventsAmountDRF:
type: object
properties:
endDateTime:
type: string
format: date-time
amount:
type: integer
SdkConfigDRF:
type: object
properties:
sdkApiUrl:
type: string
accessKey:
type: string
secretKey:
type: string
teamId:
type: string
partnerId:
type: string
ThresholdRangeDRF:
type: object
properties:
minValue:
type: number
format: double
maxValue:
type: number
format: double
exactValueStr:
type: string
IntegrationDeviceDRF:
type: object
properties:
model:
type: string
modelName:
type: string
displayName:
type: string
manufacturer:
$ref: '#/components/schemas/DeviceManufacturerDRF'
moduleIds:
type: array
items:
type: string
backgroundSync:
type: boolean
supportedMedications:
type: object
additionalProperties: {}
required:
- manufacturer
- model
KeyActionConfigDRF:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
deltaFromTriggerTime:
type: string
durationFromTrigger:
type: string
durationIso:
type: string
instanceExpiresIn:
type: string
type:
type: string
trigger:
type: string
notifyEvery:
type: string
numberOfNotifications:
type: integer
learnArticleId:
type: string
learnArticle:
type: object
additionalProperties: {}
moduleId:
type: string
moduleConfigId:
type: string
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- deltaFromTriggerTime
- durationIso
- trigger
- type
BuilderDRF:
type: object
properties:
tabs:
type: array
items:
$ref: '#/components/schemas/UITabDRF'
SsoInfoDRF:
type: object
properties:
clientId:
type: string
clientSecret:
type: string
discoveryUrl:
type: string
redirectUri:
type: string
xmlsecBinary:
type: string
entityid:
type: string
service:
type: object
additionalProperties: {}
metadata:
type: object
additionalProperties: {}
keyFile:
type: string
certFile:
type: string
encryptionKeypairs:
type: array
items:
type: object
additionalProperties: {}
organization:
type: object
additionalProperties: {}
contactPerson:
type: object
additionalProperties: {}
certificateCrt:
type: string
samlMetadataXml:
type: string
privateKey:
type: string
required:
- clientId
- clientSecret
- discoveryUrl
- redirectUri
MedicationHistoryV2DTODRF:
type: object
properties:
id:
type: string
userId:
type: string
deploymentId:
type: string
medicationId:
type: string
medicationName:
type: string
changeType:
type: string
userType:
type: string
seen:
type: boolean
reason:
$ref: '#/components/schemas/MedicationReasonUpdatedDRF'
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
regimen:
$ref: '#/components/schemas/RegimenChangeDRF'
required:
- changeType
- deploymentId
- medicationId
- medicationName
- userId
- userType
EmailTemplateDRF:
type: object
properties:
name:
type: string
subject:
type: string
template:
type: string
required:
- name
- template
PatientPersonalizationDRF:
type: object
properties:
rag:
type: boolean
goal:
type: boolean
DeviceManufacturerDRF:
type: object
properties:
name:
type: string
displayName:
type: string
sdkKey:
type: string
sdkConfig:
$ref: '#/components/schemas/SdkConfigDRF'
required:
- name
CodingDRF:
type: object
properties:
code:
type: string
display:
type: string
system:
type: string
required:
- code
- display
- system
ConsentDRF:
type: object
properties:
id:
type: string
enabled:
type: string
review:
$ref: '#/components/schemas/ConsentReviewDRF'
revision:
type: integer
additionalConsentQuestions:
type: array
items:
$ref: '#/components/schemas/AdditionalConsentQuestionDRF'
signature:
$ref: '#/components/schemas/ConsentSignatureDRF'
sections:
type: array
items:
$ref: '#/components/schemas/ConsentSectionDRF'
instituteName:
type: string
instituteFullName:
type: string
instituteTextDetails:
type: string
admissionText:
type: string
createDateTime:
type: string
format: date-time
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
required:
- enabled
DeploymentInfoDRF:
type: object
properties:
id:
type: string
name:
type: string
code:
type: string
draftId:
type: string
status:
type: string
required:
- id
- name
AdditionalContactDetailsDRF:
type: object
properties:
altContactNumber:
type: string
regularContactName:
type: string
regularContactNumber:
type: string
emergencyContactName:
type: string
emergencyContactNumber:
type: string
TaskComplianceDRF:
type: object
properties:
current:
type: integer
total:
type: integer
due:
type: integer
updateDateTime:
type: string
format: date-time
percentage:
type: integer
DeviceDetailsDRF:
type: object
properties:
uuid:
type: string
serialNumber:
type: string
modelName:
type: string
manufacturer:
type: string
required:
- manufacturer
- modelName
- uuid
MoveUserReasonsDRF:
type: object
properties:
reasons:
type: array
items:
$ref: '#/components/schemas/ReasonDRF'
otherReason:
type: boolean
AuthorisedRepDRF:
type: object
properties:
iconObject:
$ref: '#/components/schemas/S3ObjectDRF'
addressTitle:
type: string
address:
type: string
showBuildNumber:
type: boolean
required:
- address
- addressTitle
- iconObject
- showBuildNumber
StaticEventDRF:
type: object
properties:
enabled:
type: boolean
isoDuration:
type: string
title:
type: string
description:
type: string
required:
- description
- enabled
- title
SecurityDRF:
type: object
properties:
mfaRequired:
type: boolean
appLockRequired:
type: boolean
required:
- appLockRequired
- mfaRequired
FootnoteDRF:
type: object
properties:
enabled:
type: boolean
text:
type: string
LocalizableFields:
type: array
items:
type: string
title: ' localizablefields'
OnboardingModuleConfigDTODRF:
type: object
properties:
id:
type: string
onboardingId:
type: string
preloadNeeded:
type: boolean
status:
type: string
configBody:
type: object
additionalProperties: {}
order:
type: integer
version:
type: integer
versionString:
type: string
userTypes:
type: array
items:
type: string
organizationId:
type: string
reason:
type: string
deploymentIds:
type: array
items:
type: string
versionInt:
type: object
additionalProperties: {}
updateDateTime:
type: string
format: date-time
createDateTime:
type: string
format: date-time
required:
- onboardingId
- order
MedicationDetailsDRF:
type: object
properties:
medicationId:
type: string
history:
type: array
items:
$ref: '#/components/schemas/MedicationHistoryItemDRF'
adherences:
type: array
items:
$re
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-medications-api-openapi.yml