POST api/patients/{patientId}/selfReportedMedications/simple

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

integer

Required

Body Parameters

SimpleSelfReportedMedicationRequest
NameDescriptionTypeAdditional information
LexiGenDrugId

string

Required

LexiDrugSynId

integer

Required

Refills

integer

None.

DaysSupply

integer

None.

DispenseUnitId

integer

None.

Quantity

string

String length: inclusive between 0 and 11

Directions

string

String length: inclusive between 0 and 1000

WrittenDate

date

None.

Status

PatientMedicationStatusType

Required

Range: inclusive between 1 and 5

InactiveDate

date

None.

Comment

string

String length: inclusive between 0 and 500

Encounter

string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:
{
  "LexiGenDrugId": "sample string 1",
  "LexiDrugSynId": 1,
  "Refills": 1,
  "DaysSupply": 1,
  "DispenseUnitId": 1,
  "Quantity": "sample string 3",
  "Directions": "sample string 4",
  "WrittenDate": "2024-05-18T22:56:58.3519415+00:00",
  "Status": 0,
  "InactiveDate": "2024-05-18T22:56:58.3519415+00:00",
  "Comment": "sample string 5",
  "Encounter": "sample string 6"
}

application/xml, text/xml

Sample:
<SimpleSelfReportedMedicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Comment>sample string 5</Comment>
  <Encounter>sample string 6</Encounter>
  <InactiveDate>2024-05-18T22:56:58.3519415+00:00</InactiveDate>
  <Status>Unknown</Status>
  <DaysSupply>1</DaysSupply>
  <Directions>sample string 4</Directions>
  <DispenseUnitId>1</DispenseUnitId>
  <Quantity>sample string 3</Quantity>
  <Refills>1</Refills>
  <WrittenDate>2024-05-18T22:56:58.3519415+00:00</WrittenDate>
  <LexiDrugSynId>1</LexiDrugSynId>
  <LexiGenDrugId>sample string 1</LexiGenDrugId>
</SimpleSelfReportedMedicationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IdentifierResponse
NameDescriptionTypeAdditional information
Id

integer

None.

Result

Result

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<IdentifierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
  <Id>1</Id>
</IdentifierResponse>