POST api/v{version}/laboratory/{laboratoryId}/add-medication
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| laboratoryId | integer |
Required |
|
| version | string |
None. |
Body Parameters
AddMedicationFromEMRFormat| Name | Description | Type | Additional information |
|---|---|---|---|
| PatID | string |
None. |
|
| PatMrnID | string |
Required |
|
| PatEncCsnID | string |
None. |
|
| OrderMedID | string |
None. |
|
| OrderingDate | string |
None. |
|
| StartDate | string |
Required |
|
| EndDate | string |
None. |
|
| MedicationID | string |
None. |
|
| MedicationName | string |
Required |
|
| Sig | string |
None. |
|
| Quantity | decimal number |
None. |
|
| DiscreteDose | string |
Required |
|
| DoseUnitName | string |
Required |
|
| MedForm | string |
Required |
|
| FreqName | string |
Required |
|
| MedRouteName | string |
Required |
|
| ProviderID | string |
None. |
|
| AuthrzingProvName | string |
None. |
|
| RefillsRemaining | string |
None. |
|
| Refills | string |
None. |
|
| MedCycle | string |
None. |
|
| FriendlyName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"patID": "sample string 1",
"patMrnID": "sample string 2",
"patEncCsnID": "sample string 3",
"orderMedID": "sample string 4",
"orderingDate": "sample string 5",
"startDate": "sample string 6",
"endDate": "sample string 7",
"medicationID": "sample string 8",
"medicationName": "sample string 9",
"sig": "sample string 10",
"quantity": 11.0,
"discreteDose": "sample string 12",
"doseUnitName": "sample string 13",
"medForm": "sample string 14",
"freqName": "sample string 15",
"medRouteName": "sample string 16",
"providerID": "sample string 17",
"authrzingProvName": "sample string 18",
"refillsRemaining": "sample string 19",
"refills": "sample string 20",
"medCycle": "sample string 21",
"friendlyName": "sample string 22"
}
application/xml, text/xml
Sample:
<AddMedicationFromEMRFormat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models"> <AuthrzingProvName>sample string 18</AuthrzingProvName> <DiscreteDose>sample string 12</DiscreteDose> <DoseUnitName>sample string 13</DoseUnitName> <EndDate>sample string 7</EndDate> <FreqName>sample string 15</FreqName> <FriendlyName>sample string 22</FriendlyName> <MedCycle>sample string 21</MedCycle> <MedForm>sample string 14</MedForm> <MedRouteName>sample string 16</MedRouteName> <MedicationID>sample string 8</MedicationID> <MedicationName>sample string 9</MedicationName> <OrderMedID>sample string 4</OrderMedID> <OrderingDate>sample string 5</OrderingDate> <PatEncCsnID>sample string 3</PatEncCsnID> <PatID>sample string 1</PatID> <PatMrnID>sample string 2</PatMrnID> <ProviderID>sample string 17</ProviderID> <Quantity>11</Quantity> <Refills>sample string 20</Refills> <RefillsRemaining>sample string 19</RefillsRemaining> <Sig>sample string 10</Sig> <StartDate>sample string 6</StartDate> </AddMedicationFromEMRFormat>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfPrescriptionListItem| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | PrescriptionListItem |
None. |
|
| StatusCode |
Gets or sets the status code. |
HttpStatusCode |
None. |
| StatusDescription |
Gets or sets the status description. |
string |
None. |
| Errors | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"prescriptionID": 1,
"subjectID": 2,
"medicationName": "sample string 3",
"amount": "sample string 4",
"effectiveDate": "2025-11-02T10:46:05.5409273-07:00",
"expirationDate": "2025-11-02T10:46:05.5409273-07:00",
"origOrderDtTm": "2025-11-02T10:46:05.5409273-07:00",
"volumeDos": "sample string 8",
"volumeDosUnit": "sample string 9",
"strengthDose": "sample string 10",
"strengthDoseUnit": "sample string 11",
"frequency": "sample string 12",
"route": "sample string 13",
"freetxtdose": "sample string 14",
"drugForm": "sample string 15",
"orderingPhysician": "sample string 16",
"refillsRemaining": "sample string 17",
"totalRefillsPres": "sample string 18",
"medicationNameAndDetails": "sample string 3 (sample string 15, sample string 8 sample string 9,sample string 13, sample string 12)",
"medicationOriginDescription": "sample string 19",
"laboratoryID": 20,
"pictureID": 21,
"pictureURL": "sample string 22",
"medicationStateID": 23,
"laboratoryName": "sample string 24",
"dose": "sample string 10sample string 11, sample string 13, sample string 12",
"strength": "sample string 10sample string 11"
},
"statusCode": 100,
"statusDescription": "sample string 1",
"errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ResponseOfPrescriptionListItemuFpbgzW1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<StatusCode>Continue</StatusCode>
<StatusDescription>sample string 1</StatusDescription>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DomainObjects">
<d2p1:Amount>sample string 4</d2p1:Amount>
<d2p1:DrugForm>sample string 15</d2p1:DrugForm>
<d2p1:EffectiveDate>2025-11-02T10:46:05.5409273-07:00</d2p1:EffectiveDate>
<d2p1:ExpirationDate>2025-11-02T10:46:05.5409273-07:00</d2p1:ExpirationDate>
<d2p1:Freetxtdose>sample string 14</d2p1:Freetxtdose>
<d2p1:Frequency>sample string 12</d2p1:Frequency>
<d2p1:LaboratoryID>20</d2p1:LaboratoryID>
<d2p1:LaboratoryName>sample string 24</d2p1:LaboratoryName>
<d2p1:MedicationName>sample string 3</d2p1:MedicationName>
<d2p1:MedicationOriginDescription>sample string 19</d2p1:MedicationOriginDescription>
<d2p1:MedicationStateID>23</d2p1:MedicationStateID>
<d2p1:OrderingPhysician>sample string 16</d2p1:OrderingPhysician>
<d2p1:OrigOrderDtTm>2025-11-02T10:46:05.5409273-07:00</d2p1:OrigOrderDtTm>
<d2p1:PictureID>21</d2p1:PictureID>
<d2p1:PictureURL>sample string 22</d2p1:PictureURL>
<d2p1:PrescriptionID>1</d2p1:PrescriptionID>
<d2p1:RefillsRemaining>sample string 17</d2p1:RefillsRemaining>
<d2p1:Route>sample string 13</d2p1:Route>
<d2p1:StrengthDose>sample string 10</d2p1:StrengthDose>
<d2p1:StrengthDoseUnit>sample string 11</d2p1:StrengthDoseUnit>
<d2p1:SubjectID>2</d2p1:SubjectID>
<d2p1:TotalRefillsPres>sample string 18</d2p1:TotalRefillsPres>
<d2p1:VolumeDos>sample string 8</d2p1:VolumeDos>
<d2p1:VolumeDosUnit>sample string 9</d2p1:VolumeDosUnit>
</Data>
</ResponseOfPrescriptionListItemuFpbgzW1>