POST api/patients/{patientId}/prescriptions/compiledcompound/{prescriptionId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

integer

Required

prescriptionId

integer

Required

Body Parameters

CompoundPrescriptionRequest
NameDescriptionTypeAdditional information
CompoundDescription

string

Required

CompoundIngredients

Collection of CompoundIngredient

Required

IsNotIntendedForDetox

boolean

None.

Refills

integer

Required

Range: inclusive between 0 and 99

DaysSupply

integer

Range: inclusive between 0 and 365

DispenseUnitId

integer

Required

Quantity

decimal number

Required

Directions

string

Required

String length: inclusive between 0 and 1000

PharmacyId

integer

None.

PharmacyNotes

string

String length: inclusive between 0 and 210

NoSubstitutions

boolean

None.

EffectiveDate

date

None.

RxReferenceNumber

string

String length: inclusive between 0 and 35

EligibilityId

integer

None.

NonDoseSpotPrescriptionId

string

String length: inclusive between 0 and 35

OnBehalfOfUserId

integer

None.

DiagnosisId

integer

None.

FirstPrescriptionDiagnosis

PrescriptionDiagnosisIdentifiers

None.

SecondPrescriptionDiagnosis

PrescriptionDiagnosisIdentifiers

None.

IsRefillReplace

boolean

None.

IsUrgent

boolean

None.

SupervisorId

integer

None.

RetailPharmacyToMailToPatient

boolean

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:
{
  "CompoundDescription": "sample string 1",
  "CompoundIngredients": [
    {
      "LexiGenProductId": 1,
      "LexiDrugSynId": 1,
      "LexiSynonymTypeId": 1,
      "FreeText": "sample string 1",
      "DispenseUnitId": 2,
      "Quantity": "sample string 3",
      "IsFreeTextEPCS": true
    },
    {
      "LexiGenProductId": 1,
      "LexiDrugSynId": 1,
      "LexiSynonymTypeId": 1,
      "FreeText": "sample string 1",
      "DispenseUnitId": 2,
      "Quantity": "sample string 3",
      "IsFreeTextEPCS": true
    }
  ],
  "IsNotIntendedForDetox": true,
  "Refills": 3,
  "DaysSupply": 1,
  "DispenseUnitId": 1,
  "Quantity": 4.0,
  "Directions": "sample string 5",
  "PharmacyId": 1,
  "PharmacyNotes": "sample string 6",
  "NoSubstitutions": true,
  "EffectiveDate": "2024-05-18T22:56:59.5160194+00:00",
  "RxReferenceNumber": "sample string 8",
  "EligibilityId": 9,
  "NonDoseSpotPrescriptionId": "sample string 10",
  "OnBehalfOfUserId": 1,
  "DiagnosisId": 11,
  "FirstPrescriptionDiagnosis": {
    "PrimaryDiagnosisId": 1,
    "SecondaryDiagnosisId": 1
  },
  "SecondPrescriptionDiagnosis": {
    "PrimaryDiagnosisId": 1,
    "SecondaryDiagnosisId": 1
  },
  "IsRefillReplace": true,
  "IsUrgent": true,
  "SupervisorId": 1,
  "RetailPharmacyToMailToPatient": true,
  "Status": 0,
  "InactiveDate": "2024-05-18T22:56:59.5160194+00:00",
  "Comment": "sample string 15",
  "Encounter": "sample string 16"
}

application/xml, text/xml

Sample:
<CompoundPrescriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Comment>sample string 15</Comment>
  <Encounter>sample string 16</Encounter>
  <InactiveDate>2024-05-18T22:56:59.5160194+00:00</InactiveDate>
  <Status>Unknown</Status>
  <DaysSupply>1</DaysSupply>
  <DiagnosisId>11</DiagnosisId>
  <Directions>sample string 5</Directions>
  <DispenseUnitId>1</DispenseUnitId>
  <EffectiveDate>2024-05-18T22:56:59.5160194+00:00</EffectiveDate>
  <EligibilityId>9</EligibilityId>
  <FirstPrescriptionDiagnosis xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
    <d2p1:PrimaryDiagnosisId>1</d2p1:PrimaryDiagnosisId>
    <d2p1:SecondaryDiagnosisId>1</d2p1:SecondaryDiagnosisId>
  </FirstPrescriptionDiagnosis>
  <IsRefillReplace>true</IsRefillReplace>
  <IsUrgent>true</IsUrgent>
  <NoSubstitutions>true</NoSubstitutions>
  <NonDoseSpotPrescriptionId>sample string 10</NonDoseSpotPrescriptionId>
  <OnBehalfOfUserId>1</OnBehalfOfUserId>
  <PharmacyId>1</PharmacyId>
  <PharmacyNotes>sample string 6</PharmacyNotes>
  <Quantity>4</Quantity>
  <Refills>3</Refills>
  <RetailPharmacyToMailToPatient>true</RetailPharmacyToMailToPatient>
  <RxReferenceNumber>sample string 8</RxReferenceNumber>
  <SecondPrescriptionDiagnosis xmlns:d2p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
    <d2p1:PrimaryDiagnosisId>1</d2p1:PrimaryDiagnosisId>
    <d2p1:SecondaryDiagnosisId>1</d2p1:SecondaryDiagnosisId>
  </SecondPrescriptionDiagnosis>
  <SupervisorId>1</SupervisorId>
  <CompoundDescription>sample string 1</CompoundDescription>
  <CompoundIngredients>
    <CompoundIngredient>
      <DispenseUnitId>2</DispenseUnitId>
      <FreeText>sample string 1</FreeText>
      <IsFreeTextEPCS>true</IsFreeTextEPCS>
      <LexiDrugSynId>1</LexiDrugSynId>
      <LexiGenProductId>1</LexiGenProductId>
      <LexiSynonymTypeId>1</LexiSynonymTypeId>
      <Quantity>sample string 3</Quantity>
    </CompoundIngredient>
    <CompoundIngredient>
      <DispenseUnitId>2</DispenseUnitId>
      <FreeText>sample string 1</FreeText>
      <IsFreeTextEPCS>true</IsFreeTextEPCS>
      <LexiDrugSynId>1</LexiDrugSynId>
      <LexiGenProductId>1</LexiGenProductId>
      <LexiSynonymTypeId>1</LexiSynonymTypeId>
      <Quantity>sample string 3</Quantity>
    </CompoundIngredient>
  </CompoundIngredients>
  <IsNotIntendedForDetox>true</IsNotIntendedForDetox>
</CompoundPrescriptionRequest>

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>