API MedicationPats
See Medications for additional information.
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See MedicationPat Database Schema.
MedicationPats GET (single)
Version Added: 25.4.14
Gets a single medicationpat.
MedicationPatNum: Required in the URL.
Example Request:
GET /medicationpats/45
Example Response:
{
"MedicationPatNum": 45,
"PatNum": "234",
"medName": "Metformin",
"MedicationNum": 12,
"PatNote": "500mg, taken twice a day.",
"DateStart": "2000-06-20",
"DateStop": "0001-01-01",
"ProvNum": 1
}
200 OK
404 NotFound (with explanation)
MedicationPats GET (multiple)
Version Added: 21.3
Gets a list of medicationpats.
PatNum: (Optional after version 25.4.14) Get all medicationpats for a single patient.
includeDiscontinued: (Added in version 25.4.14) Optional, either "true" or "false". Set "true" to show discontinued medicationpats. Any medicationpat with a DateStop that is not "0001-01-01" will be considered discontinued if DateStop is prior to the current date. Default "false".
Example Request:
GET /medicationpats?PatNum=234
Example Response:
[
{
"MedicationPatNum": 45,
"PatNum": "234",
"medName": "Metformin",
"MedicationNum": 12,
"PatNote": "500mg, taken twice a day.",
"DateStart": "2000-06-20",
"DateStop": "0001-01-01",
"ProvNum": 1
},
etc...
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
MedicationPats POST
Version Added: 21.3
Attaches a medication to a patient.
PatNum: Required.
MedicationNum: FK to medication.MedicationNum.
PatNote: Optional.
DateStart: Optional. String in "yyyy-MM-dd" format. The date the medication will start for this patient. Default "0001-01-01".
DateStop: Optional. String in "yyyy-MM-dd" format. The date the medication will end for this patient. Default "0001-01-01".
ProvNum: Optional. FK to provider.ProvNum. Default 0.
Example Requests:
POST /medicationpats
{
"PatNum": 234,
"MedicationNum": 4
}
or
{
"PatNum": 234,
"MedicationNum": 4
"PatNote": "1000mg, taken twice a day.",
"DateStart": "2025-11-22",
"DateStop": "2026-01-15",
"ProvNum": 1
}
Example Response:
{
"MedicationPatNum": 46,
"PatNum": 234,
"medName": "Acetaminophen",
"MedicationNum": 4,
"PatNote": "1000mg, taken twice a day.",
"DateTStamp": "2025-12-24 10:05:20",
"DateStart": "2025-11-22",
"DateStop": "2026-01-15",
"ProvNum": 1
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
MedicationPats PUT
Version Added: 22.1
Updates a medicationpat.
MedicationPatNum: Required in the URL.
PatNote: Optional. Overwrites existing note.
DateStart: Optional. String in "yyyy-MM-dd" format.
DateStop: Optional. String in "yyyy-MM-dd" format.
ProvNum: Optional. FK to provider.ProvNum. Can be 0.
Example Request:
PUT /medicationpats/46
{
"PatNote": "750mg, taken twice a day.",
"DateStart": "2025-11-25",
"DateStop": "0001-01-01",
"ProvNum": 0
}
Example Response:
{
"MedicationPatNum": 46,
"PatNum": 234,
"medName": "Acetaminophen",
"MedicationNum": 4,
"PatNote": ""750mg, taken twice a day.",
"DateTStamp": "2025-12-24 10:09:47",
"DateStart": "2025-11-25",
"DateStop": "0001-01-01",
"ProvNum": 0
}
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
MedicationPats DELETE
Version Added: 22.1
Deletes a medicationpat.
MedicationPatNum: Required in URL.
Example Request:
DELETE /medicationpats/46
Example Response:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)