POST api/notifications/refills/{refillId}/replace

Request Information

URI Parameters

NameDescriptionTypeAdditional information
refillId

integer

Required

Body Parameters

ReplaceRenewRequest
NameDescriptionTypeAdditional information
PatientID

integer

None.

Pin

string

None.

Otp

string

None.

NewPrescription

CodedPrescriptionRequest

None.

NewSupplyPrescription

CodedSupplyRequest

None.

NewCompoundPrescription

CodedCompoundRequest

None.

NewFreeTextPrescription

FreeTextPrescriptionRequest

None.

NewCompiledCompoundPrescription

CompoundPrescriptionRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "PatientID": 1,
  "Pin": "sample string 2",
  "Otp": "sample string 3",
  "NewPrescription": {
    "LexiGenProductId": 1,
    "LexiDrugSynId": 1,
    "LexiSynonymTypeId": 1,
    "IsNotIntendedForDetox": true,
    "PatientFormularyId": 1,
    "Refills": 2,
    "DaysSupply": 1,
    "DispenseUnitId": 1,
    "Quantity": 3.0,
    "Directions": "sample string 4",
    "PharmacyId": 1,
    "PharmacyNotes": "sample string 5",
    "NoSubstitutions": true,
    "EffectiveDate": "2024-05-18T20:27:56.9086559+00:00",
    "RxReferenceNumber": "sample string 7",
    "EligibilityId": 8,
    "NonDoseSpotPrescriptionId": "sample string 9",
    "OnBehalfOfUserId": 1,
    "DiagnosisId": 10,
    "FirstPrescriptionDiagnosis": {
      "PrimaryDiagnosisId": 1,
      "SecondaryDiagnosisId": 1
    },
    "SecondPrescriptionDiagnosis": {
      "PrimaryDiagnosisId": 1,
      "SecondaryDiagnosisId": 1
    },
    "IsRefillReplace": true,
    "IsUrgent": true,
    "SupervisorId": 1,
    "RetailPharmacyToMailToPatient": true,
    "Status": 0,
    "InactiveDate": "2024-05-18T20:27:56.9086559+00:00",
    "Comment": "sample string 14",
    "Encounter": "sample string 15"
  },
  "NewSupplyPrescription": {
    "SupplyId": 1,
    "Refills": 3,
    "DaysSupply": 1,
    "DispenseUnitId": 1,
    "Quantity": 4.0,
    "Directions": "sample string 5",
    "PharmacyId": 1,
    "PharmacyNotes": "sample string 6",
    "NoSubstitutions": true,
    "EffectiveDate": "2024-05-18T20:27:56.9086559+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-18T20:27:56.9086559+00:00",
    "Comment": "sample string 15",
    "Encounter": "sample string 16"
  },
  "NewCompoundPrescription": {
    "CompoundId": 1,
    "Refills": 3,
    "DaysSupply": 1,
    "DispenseUnitId": 1,
    "Quantity": 4.0,
    "Directions": "sample string 5",
    "PharmacyId": 1,
    "PharmacyNotes": "sample string 6",
    "NoSubstitutions": true,
    "EffectiveDate": "2024-05-18T20:27:56.9086559+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-18T20:27:56.9086559+00:00",
    "Comment": "sample string 15",
    "Encounter": "sample string 16"
  },
  "NewFreeTextPrescription": {
    "DisplayName": "sample string 1",
    "Type": 1,
    "NotControlled": true,
    "Refills": 4,
    "DaysSupply": 1,
    "DispenseUnitId": 1,
    "Quantity": 5.0,
    "Directions": "sample string 6",
    "PharmacyId": 1,
    "PharmacyNotes": "sample string 7",
    "NoSubstitutions": true,
    "EffectiveDate": "2024-05-18T20:27:56.9086559+00:00",
    "RxReferenceNumber": "sample string 9",
    "EligibilityId": 10,
    "NonDoseSpotPrescriptionId": "sample string 11",
    "OnBehalfOfUserId": 1,
    "DiagnosisId": 12,
    "FirstPrescriptionDiagnosis": {
      "PrimaryDiagnosisId": 1,
      "SecondaryDiagnosisId": 1
    },
    "SecondPrescriptionDiagnosis": {
      "PrimaryDiagnosisId": 1,
      "SecondaryDiagnosisId": 1
    },
    "IsRefillReplace": true,
    "IsUrgent": true,
    "SupervisorId": 1,
    "RetailPharmacyToMailToPatient": true,
    "Status": 0,
    "InactiveDate": "2024-05-18T20:27:56.9086559+00:00",
    "Comment": "sample string 16",
    "Encounter": "sample string 17"
  },
  "NewCompiledCompoundPrescription": {
    "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-18T20:27:56.9086559+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-18T20:27:56.9086559+00:00",
    "Comment": "sample string 15",
    "Encounter": "sample string 16"
  }
}

application/xml, text/xml

Sample:
<ReplaceRenewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <NewCompiledCompoundPrescription>
    <Comment>sample string 15</Comment>
    <Encounter>sample string 16</Encounter>
    <InactiveDate>2024-05-18T20:27:56.9086559+00:00</InactiveDate>
    <Status>Unknown</Status>
    <DaysSupply>1</DaysSupply>
    <DiagnosisId>11</DiagnosisId>
    <Directions>sample string 5</Directions>
    <DispenseUnitId>1</DispenseUnitId>
    <EffectiveDate>2024-05-18T20:27:56.9086559+00:00</EffectiveDate>
    <EligibilityId>9</EligibilityId>
    <FirstPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1: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>
  </NewCompiledCompoundPrescription>
  <NewCompoundPrescription>
    <Comment>sample string 15</Comment>
    <Encounter>sample string 16</Encounter>
    <InactiveDate>2024-05-18T20:27:56.9086559+00:00</InactiveDate>
    <Status>Unknown</Status>
    <DaysSupply>1</DaysSupply>
    <DiagnosisId>11</DiagnosisId>
    <Directions>sample string 5</Directions>
    <DispenseUnitId>1</DispenseUnitId>
    <EffectiveDate>2024-05-18T20:27:56.9086559+00:00</EffectiveDate>
    <EligibilityId>9</EligibilityId>
    <FirstPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </SecondPrescriptionDiagnosis>
    <SupervisorId>1</SupervisorId>
    <CompoundId>1</CompoundId>
  </NewCompoundPrescription>
  <NewFreeTextPrescription>
    <Comment>sample string 16</Comment>
    <Encounter>sample string 17</Encounter>
    <InactiveDate>2024-05-18T20:27:56.9086559+00:00</InactiveDate>
    <Status>Unknown</Status>
    <DaysSupply>1</DaysSupply>
    <DiagnosisId>12</DiagnosisId>
    <Directions>sample string 6</Directions>
    <DispenseUnitId>1</DispenseUnitId>
    <EffectiveDate>2024-05-18T20:27:56.9086559+00:00</EffectiveDate>
    <EligibilityId>10</EligibilityId>
    <FirstPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </FirstPrescriptionDiagnosis>
    <IsRefillReplace>true</IsRefillReplace>
    <IsUrgent>true</IsUrgent>
    <NoSubstitutions>true</NoSubstitutions>
    <NonDoseSpotPrescriptionId>sample string 11</NonDoseSpotPrescriptionId>
    <OnBehalfOfUserId>1</OnBehalfOfUserId>
    <PharmacyId>1</PharmacyId>
    <PharmacyNotes>sample string 7</PharmacyNotes>
    <Quantity>5</Quantity>
    <Refills>4</Refills>
    <RetailPharmacyToMailToPatient>true</RetailPharmacyToMailToPatient>
    <RxReferenceNumber>sample string 9</RxReferenceNumber>
    <SecondPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </SecondPrescriptionDiagnosis>
    <SupervisorId>1</SupervisorId>
    <DisplayName>sample string 1</DisplayName>
    <NotControlled>true</NotControlled>
    <Type>Medication</Type>
  </NewFreeTextPrescription>
  <NewPrescription>
    <Comment>sample string 14</Comment>
    <Encounter>sample string 15</Encounter>
    <InactiveDate>2024-05-18T20:27:56.9086559+00:00</InactiveDate>
    <Status>Unknown</Status>
    <DaysSupply>1</DaysSupply>
    <DiagnosisId>10</DiagnosisId>
    <Directions>sample string 4</Directions>
    <DispenseUnitId>1</DispenseUnitId>
    <EffectiveDate>2024-05-18T20:27:56.9086559+00:00</EffectiveDate>
    <EligibilityId>8</EligibilityId>
    <FirstPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </FirstPrescriptionDiagnosis>
    <IsRefillReplace>true</IsRefillReplace>
    <IsUrgent>true</IsUrgent>
    <NoSubstitutions>true</NoSubstitutions>
    <NonDoseSpotPrescriptionId>sample string 9</NonDoseSpotPrescriptionId>
    <OnBehalfOfUserId>1</OnBehalfOfUserId>
    <PharmacyId>1</PharmacyId>
    <PharmacyNotes>sample string 5</PharmacyNotes>
    <Quantity>3</Quantity>
    <Refills>2</Refills>
    <RetailPharmacyToMailToPatient>true</RetailPharmacyToMailToPatient>
    <RxReferenceNumber>sample string 7</RxReferenceNumber>
    <SecondPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </SecondPrescriptionDiagnosis>
    <SupervisorId>1</SupervisorId>
    <IsNotIntendedForDetox>true</IsNotIntendedForDetox>
    <LexiDrugSynId>1</LexiDrugSynId>
    <LexiGenProductId>1</LexiGenProductId>
    <LexiSynonymTypeId>1</LexiSynonymTypeId>
    <PatientFormularyId>1</PatientFormularyId>
  </NewPrescription>
  <NewSupplyPrescription>
    <Comment>sample string 15</Comment>
    <Encounter>sample string 16</Encounter>
    <InactiveDate>2024-05-18T20:27:56.9086559+00:00</InactiveDate>
    <Status>Unknown</Status>
    <DaysSupply>1</DaysSupply>
    <DiagnosisId>11</DiagnosisId>
    <Directions>sample string 5</Directions>
    <DispenseUnitId>1</DispenseUnitId>
    <EffectiveDate>2024-05-18T20:27:56.9086559+00:00</EffectiveDate>
    <EligibilityId>9</EligibilityId>
    <FirstPrescriptionDiagnosis xmlns:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13.Objects">
      <d3p1:PrimaryDiagnosisId>1</d3p1:PrimaryDiagnosisId>
      <d3p1:SecondaryDiagnosisId>1</d3p1:SecondaryDiagnosisId>
    </SecondPrescriptionDiagnosis>
    <SupervisorId>1</SupervisorId>
    <SupplyId>1</SupplyId>
  </NewSupplyPrescription>
  <Otp>sample string 3</Otp>
  <PatientID>1</PatientID>
  <Pin>sample string 2</Pin>
</ReplaceRenewRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Result

Result

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<Response 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>
</Response>