JAjane
Medications

Create a medication

Changed on

Create a new medication record for a patient

post/api/2026-01-01/medical-record/medications

Request

  • Base URL
    https://jdpdocsdemo.jane.qa
  • URL
    https://jdpdocsdemo.jane.qa/api/2026-01-01/medical-record/medications
  • Auth
    OAuth 2
    Authorization code: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/auth?response_type=code&resource=https://jdpdocsdemo.jane.qa&prompt=consent
    Token URL: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/token scopes: medications:create

Request body

Response

The medication was created

idstring uuid required

UUIDv7 identifier for the medication

patient_idstring uuid required

Reference to the patient

practitioner_idstring uuid nullable

Reference to the practitioner

practitioner_namestring nullable

Full name of the documenting practitioner; null when no staff is associated

encounter_idstring uuid nullable

Reference to the encounter where medication was prescribed (optional)

dose_formstring nullable

Pharmaceutical form (tablet, capsule, suspension, etc.) (optional)

routestring nullable

Route of administration (oral, IV, topical, etc.) (optional)

frequencystring nullable

Textual frequency (daily, bid, etc.) (optional)

quantityinteger nullable

Number of units (e.g., tablets, capsules) dispensed

period_startstring date nullable

When the medication course starts (optional)

period_endstring date nullable

Planned end date (if any) (optional)

instructionsstring nullable

Free-text administration instructions for the patient (optional)

status'active' | 'inactive' | 'pending' required

Lifecycle state of the medication

source'prescribed' | 'patient_reported' | 'external_provider' | 'clinic_practitioner' required

Origin of record – prescribed (from practitioner), patient_reported (self-reported), external_provider (prescribed by outside clinic/doctor), or clinic_practitioner (recommended by the clinician)

external_provider_type'family_doctor_gp' | 'specialist' | 'pharmacist' | 'nd' | 'other' | 'null' nullable

Type of external provider; present when source is external_provider

change_reasonstring nullable

Selected reason for status change (e.g., adverse_reaction, completed, patient_request)

prescription_valid_untilstring date nullable

Expiry date after which repeats aren't valid (optional)

prescription_refillsinteger nullable

Allowed refill count (optional)

prescription_days_supplyinteger nullable

Number of days that the dispensed medication is intended to last (optional)

prescription_reasonstring nullable

Clinical indication or problem being treated (optional)

created_atstring date-time required

When the medication record was created

updated_atstring date-time required

When the medication record was last updated

Changes

  • 01798f613a5eRevision changes
    • breaking

      removed the enum value prescribed of the request property //

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new clinic_practitioner enum value to the response property for the response status

    • warning

      added the new external_provider enum value to the response property for the response status

    • warning

      added the new pending enum value to the response property for the response status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new clinic_practitioner enum value to the request property //

    • info

      added the new external_provider enum value to the request property //

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status