POST api/v2023011/Prescriber/CancelRx

The CancelRx is sent by the prescriber to notify the pharmacy that a previously prescribed prescription should be inactivated, and no additional product should be dispensed.

Request Information

URI Parameters

None.

Body Parameters

ErxMessage

Name	Type	Additional information
FacilityId	string	None.
FacilityAddress	Address	None.
PharmacyId	string	None.
InmateStatus	string	None.
DrugOrder	DrugOrder	None.
PharmacyOrder	PharmacyOrder	None.
Inmate	Inmate	None.
Prescriber	Prescriber	None.
Allergies	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "<FacilityId>k__BackingField": "sample string 1",
  "<FacilityAddress>k__BackingField": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "ZipCode": "sample string 5",
    "StateProvince": "sample string 6",
    "PostalCode": "sample string 7",
    "CountryCode": "sample string 8"
  },
  "<PharmacyId>k__BackingField": "sample string 2",
  "<InmateStatus>k__BackingField": "sample string 3",
  "<DrugOrder>k__BackingField": {
    "<ID>k__BackingField": "sample string 1",
    "<MessageControlID>k__BackingField": "sample string 2",
    "<PlacedBy>k__BackingField": {
      "<FirstName>k__BackingField": "sample string 1",
      "<LastName>k__BackingField": "sample string 2",
      "<MiddleName>k__BackingField": "sample string 3",
      "<SuffixName>k__BackingField": "sample string 4",
      "<PrefixName>k__BackingField": "sample string 5",
      "<Credentials>k__BackingField": "sample string 6"
    },
    "<Drug>k__BackingField": {
      "<Name>k__BackingField": "sample string 1",
      "<Route>k__BackingField": "sample string 2",
      "<RouteAbbrev>k__BackingField": "sample string 3",
      "<Strength>k__BackingField": "sample string 4",
      "<StrengthUnit>k__BackingField": "sample string 5",
      "<DoseForm>k__BackingField": "sample string 6",
      "<DoseCheckUnit>k__BackingField": "sample string 7",
      "<DDID>k__BackingField": "sample string 8",
      "<PNID>k__BackingField": "sample string 9",
      "<RPID>k__BackingField": "sample string 10",
      "<NDC>k__BackingField": "sample string 11"
    },
    "<Quantity>k__BackingField": 3.1,
    "<CompleteSig>k__BackingField": "sample string 4",
    "<SIG>k__BackingField": {
      "<SigAbbreviation>k__BackingField": "sample string 1",
      "<SigVerbose>k__BackingField": "sample string 2",
      "<SigTime1>k__BackingField": "sample string 3",
      "<SigTime2>k__BackingField": "sample string 4",
      "<SigTime3>k__BackingField": "sample string 5",
      "<SigTime4>k__BackingField": "sample string 6",
      "<Criteria>k__BackingField": "sample string 7"
    },
    "<Stamp>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<Start>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<Stop>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<Status>k__BackingField": 8,
    "<Profile>k__BackingField": true,
    "<Reviewed>k__BackingField": true,
    "<ReviewedStamp>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<ReviewedBy>k__BackingField": {
      "<FirstName>k__BackingField": "sample string 1",
      "<LastName>k__BackingField": "sample string 2",
      "<MiddleName>k__BackingField": "sample string 3",
      "<SuffixName>k__BackingField": "sample string 4",
      "<PrefixName>k__BackingField": "sample string 5",
      "<Credentials>k__BackingField": "sample string 6"
    },
    "<DiscontinuedBy>k__BackingField": {
      "<FirstName>k__BackingField": "sample string 1",
      "<LastName>k__BackingField": "sample string 2",
      "<MiddleName>k__BackingField": "sample string 3",
      "<SuffixName>k__BackingField": "sample string 4",
      "<PrefixName>k__BackingField": "sample string 5",
      "<Credentials>k__BackingField": "sample string 6"
    },
    "<DiscontinuedStamp>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<DiscontinuedReason>k__BackingField": "sample string 13",
    "<AllowGeneric>k__BackingField": true,
    "<Refills>k__BackingField": 15,
    "<Dispense>k__BackingField": 16,
    "<AdditionalInformation>k__BackingField": "sample string 17",
    "<Directions>k__BackingField": "sample string 18"
  },
  "<PharmacyOrder>k__BackingField": {
    "<MessageControlID>k__BackingField": "sample string 1",
    "<AcknowledgementCode>k__BackingField": "sample string 2",
    "<StatusMessage>k__BackingField": "sample string 3",
    "<FillerOrderNumber>k__BackingField": "sample string 4",
    "<OrderControl>k__BackingField": "sample string 5"
  },
  "<Inmate>k__BackingField": {
    "<Name>k__BackingField": {
      "<FirstName>k__BackingField": "sample string 1",
      "<LastName>k__BackingField": "sample string 2",
      "<MiddleName>k__BackingField": "sample string 3",
      "<SuffixName>k__BackingField": "sample string 4",
      "<PrefixName>k__BackingField": "sample string 5",
      "<Credentials>k__BackingField": "sample string 6"
    },
    "<BookingNumber>k__BackingField": "sample string 1",
    "<ID>k__BackingField": "sample string 2",
    "<HousingLocation>k__BackingField": {
      "<FacilityUnit>k__BackingField": "sample string 1",
      "<Bed>k__BackingField": "sample string 2",
      "<Room>k__BackingField": "sample string 3"
    },
    "<BookingDate>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<CustodyStatus>k__BackingField": "sample string 4",
    "<DateOfBirth>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<Race>k__BackingField": "sample string 6",
    "<Sex>k__BackingField": "sample string 7",
    "<SSN>k__BackingField": "sample string 8",
    "<ReleaseDate>k__BackingField": "2026-05-19T23:15:35.9744203-05:00",
    "<PreferredLanguage>k__BackingField": "sample string 10",
    "<PreferredCommunication>k__BackingField": "sample string 11",
    "<Ethnicity>k__BackingField": "sample string 12",
    "<MaritalStatus>k__BackingField": "sample string 13"
  },
  "<Prescriber>k__BackingField": {
    "<ID>k__BackingField": "sample string 1",
    "<Name>k__BackingField": {
      "<FirstName>k__BackingField": "sample string 1",
      "<LastName>k__BackingField": "sample string 2",
      "<MiddleName>k__BackingField": "sample string 3",
      "<SuffixName>k__BackingField": "sample string 4",
      "<PrefixName>k__BackingField": "sample string 5",
      "<Credentials>k__BackingField": "sample string 6"
    },
    "<Address>k__BackingField": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "ZipCode": "sample string 5",
      "StateProvince": "sample string 6",
      "PostalCode": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "<Phone1>k__BackingField": {
      "<Extension>k__BackingField": "sample string 1",
      "<Number>k__BackingField": "sample string 2"
    },
    "<Phone2>k__BackingField": {
      "<Extension>k__BackingField": "sample string 1",
      "<Number>k__BackingField": "sample string 2"
    },
    "<Fax>k__BackingField": {
      "<Extension>k__BackingField": "sample string 1",
      "<Number>k__BackingField": "sample string 2"
    },
    "<LicenseNumber>k__BackingField": "sample string 2",
    "<DEANumber>k__BackingField": "sample string 3",
    "<DEANumberSuffix>k__BackingField": "sample string 4",
    "<NPI>k__BackingField": "sample string 5",
    "<SPI>k__BackingField": "sample string 6"
  },
  "<Allergies>k__BackingField": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ErxMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FacilityId>sample string 1</FacilityId>
  <FacilityAddress>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <City>sample string 3</City>
    <State>sample string 4</State>
    <ZipCode>sample string 5</ZipCode>
    <StateProvince>sample string 6</StateProvince>
    <PostalCode>sample string 7</PostalCode>
    <CountryCode>sample string 8</CountryCode>
  </FacilityAddress>
  <PharmacyId>sample string 2</PharmacyId>
  <InmateStatus>sample string 3</InmateStatus>
  <DrugOrder>
    <ID>sample string 1</ID>
    <MessageControlID>sample string 2</MessageControlID>
    <PlacedBy>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <MiddleName>sample string 3</MiddleName>
      <SuffixName>sample string 4</SuffixName>
      <PrefixName>sample string 5</PrefixName>
      <Credentials>sample string 6</Credentials>
    </PlacedBy>
    <Drug>
      <Name>sample string 1</Name>
      <Route>sample string 2</Route>
      <RouteAbbrev>sample string 3</RouteAbbrev>
      <Strength>sample string 4</Strength>
      <StrengthUnit>sample string 5</StrengthUnit>
      <DoseForm>sample string 6</DoseForm>
      <DoseCheckUnit>sample string 7</DoseCheckUnit>
      <DDID>sample string 8</DDID>
      <PNID>sample string 9</PNID>
      <RPID>sample string 10</RPID>
      <NDC>sample string 11</NDC>
    </Drug>
    <Quantity>3.1</Quantity>
    <CompleteSig>sample string 4</CompleteSig>
    <SIG>
      <SigAbbreviation>sample string 1</SigAbbreviation>
      <SigVerbose>sample string 2</SigVerbose>
      <SigTime1>sample string 3</SigTime1>
      <SigTime2>sample string 4</SigTime2>
      <SigTime3>sample string 5</SigTime3>
      <SigTime4>sample string 6</SigTime4>
      <Criteria>sample string 7</Criteria>
    </SIG>
    <Stamp>2026-05-19T23:15:35.9744203-05:00</Stamp>
    <Start>2026-05-19T23:15:35.9744203-05:00</Start>
    <Stop>2026-05-19T23:15:35.9744203-05:00</Stop>
    <Status>8</Status>
    <Profile>true</Profile>
    <Reviewed>true</Reviewed>
    <ReviewedStamp>2026-05-19T23:15:35.9744203-05:00</ReviewedStamp>
    <ReviewedBy>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <MiddleName>sample string 3</MiddleName>
      <SuffixName>sample string 4</SuffixName>
      <PrefixName>sample string 5</PrefixName>
      <Credentials>sample string 6</Credentials>
    </ReviewedBy>
    <DiscontinuedBy>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <MiddleName>sample string 3</MiddleName>
      <SuffixName>sample string 4</SuffixName>
      <PrefixName>sample string 5</PrefixName>
      <Credentials>sample string 6</Credentials>
    </DiscontinuedBy>
    <DiscontinuedStamp>2026-05-19T23:15:35.9744203-05:00</DiscontinuedStamp>
    <DiscontinuedReason>sample string 13</DiscontinuedReason>
    <AllowGeneric>true</AllowGeneric>
    <Refills>15</Refills>
    <Dispense>16</Dispense>
    <AdditionalInformation>sample string 17</AdditionalInformation>
    <Directions>sample string 18</Directions>
  </DrugOrder>
  <PharmacyOrder>
    <MessageControlID>sample string 1</MessageControlID>
    <AcknowledgementCode>sample string 2</AcknowledgementCode>
    <StatusMessage>sample string 3</StatusMessage>
    <FillerOrderNumber>sample string 4</FillerOrderNumber>
    <OrderControl>sample string 5</OrderControl>
  </PharmacyOrder>
  <Inmate>
    <Name>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <MiddleName>sample string 3</MiddleName>
      <SuffixName>sample string 4</SuffixName>
      <PrefixName>sample string 5</PrefixName>
      <Credentials>sample string 6</Credentials>
    </Name>
    <BookingNumber>sample string 1</BookingNumber>
    <ID>sample string 2</ID>
    <HousingLocation>
      <FacilityUnit>sample string 1</FacilityUnit>
      <Bed>sample string 2</Bed>
      <Room>sample string 3</Room>
    </HousingLocation>
    <BookingDate>2026-05-19T23:15:35.9744203-05:00</BookingDate>
    <CustodyStatus>sample string 4</CustodyStatus>
    <DateOfBirth>2026-05-19T23:15:35.9744203-05:00</DateOfBirth>
    <Race>sample string 6</Race>
    <Sex>sample string 7</Sex>
    <SSN>sample string 8</SSN>
    <ReleaseDate>2026-05-19T23:15:35.9744203-05:00</ReleaseDate>
    <PreferredLanguage>sample string 10</PreferredLanguage>
    <PreferredCommunication>sample string 11</PreferredCommunication>
    <Ethnicity>sample string 12</Ethnicity>
    <MaritalStatus>sample string 13</MaritalStatus>
  </Inmate>
  <Prescriber>
    <ID>sample string 1</ID>
    <Name>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <MiddleName>sample string 3</MiddleName>
      <SuffixName>sample string 4</SuffixName>
      <PrefixName>sample string 5</PrefixName>
      <Credentials>sample string 6</Credentials>
    </Name>
    <Address>
      <AddressLine1>sample string 1</AddressLine1>
      <AddressLine2>sample string 2</AddressLine2>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <ZipCode>sample string 5</ZipCode>
      <StateProvince>sample string 6</StateProvince>
      <PostalCode>sample string 7</PostalCode>
      <CountryCode>sample string 8</CountryCode>
    </Address>
    <Phone1>
      <Extension>sample string 1</Extension>
      <Number>sample string 2</Number>
    </Phone1>
    <Phone2>
      <Extension>sample string 1</Extension>
      <Number>sample string 2</Number>
    </Phone2>
    <Fax>
      <Extension>sample string 1</Extension>
      <Number>sample string 2</Number>
    </Fax>
    <LicenseNumber>sample string 2</LicenseNumber>
    <DEANumber>sample string 3</DEANumber>
    <DEANumberSuffix>sample string 4</DEANumberSuffix>
    <NPI>sample string 5</NPI>
    <SPI>sample string 6</SPI>
  </Prescriber>
  <Allergies>
    <Allergy>sample string 1</Allergy>
    <Allergy>sample string 2</Allergy>
  </Allergies>
</ErxMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.