HIhint
Supplements

Create Patient Supplement

Changed on
post/provider/patients/{patient_id}/supplements

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/patients/{patient_id}/supplements
  • Auth
    API key in header AUTHORIZATION

Path parameters

patient_idstring required

Unique Patient ID

Request body

product_namestring required

The name of the supplement.

strengthstring

The strength of the supplement.

strength_uomstring

The unit of measure for the strength.

quantityinteger

The quantity of the supplement.

sig_textstring

The dosage and usage directions for the supplement (e.g. "Take 1 capsule daily with food").

integration_record_idstring
integration_error_messagestring
integration_web_linkstring

Response

Successful response

idstring
created_atstring date-time
product_namestring
quantitystring
sig_textstring
strengthstring
strength_uomstring
updated_atstring date-time

Changes

  • c9bda0d2dd87Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status