POST api/patients/{patientId}/prescriptions/ndc
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
Body Parameters
NDCPrescriptionRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DisplayName | string |
Required |
|
| NDC | string |
Required |
|
| DrugDBCode | string |
String length: inclusive between 0 and 35 |
|
| DrugDBCodeQualifier | string |
String length: inclusive between 0 and 3 |
|
| 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:
{
"DisplayName": "sample string 1",
"NDC": "sample string 2",
"DrugDBCode": "sample string 3",
"DrugDBCodeQualifier": "sample string 4",
"Refills": 6,
"DaysSupply": 1,
"DispenseUnitId": 1,
"Quantity": 7.0,
"Directions": "sample string 8",
"PharmacyId": 1,
"PharmacyNotes": "sample string 9",
"NoSubstitutions": true,
"EffectiveDate": "2025-12-15T18:01:06.422173+00:00",
"RxReferenceNumber": "sample string 11",
"EligibilityId": 12,
"NonDoseSpotPrescriptionId": "sample string 13",
"OnBehalfOfUserId": 1,
"DiagnosisId": 14,
"FirstPrescriptionDiagnosis": {
"PrimaryDiagnosisId": 1,
"SecondaryDiagnosisId": 1
},
"SecondPrescriptionDiagnosis": {
"PrimaryDiagnosisId": 1,
"SecondaryDiagnosisId": 1
},
"IsRefillReplace": true,
"IsUrgent": true,
"SupervisorId": 1,
"RetailPharmacyToMailToPatient": true,
"Status": 0,
"InactiveDate": "2025-12-15T18:01:06.422173+00:00",
"Comment": "sample string 18",
"Encounter": "sample string 19"
}
application/xml, text/xml
Sample:
<NDCPrescriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Comment>sample string 18</Comment>
<Encounter>sample string 19</Encounter>
<InactiveDate>2025-12-15T18:01:06.422173+00:00</InactiveDate>
<Status>Unknown</Status>
<DaysSupply>1</DaysSupply>
<DiagnosisId>14</DiagnosisId>
<Directions>sample string 8</Directions>
<DispenseUnitId>1</DispenseUnitId>
<EffectiveDate>2025-12-15T18:01:06.422173+00:00</EffectiveDate>
<EligibilityId>12</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 13</NonDoseSpotPrescriptionId>
<OnBehalfOfUserId>1</OnBehalfOfUserId>
<PharmacyId>1</PharmacyId>
<PharmacyNotes>sample string 9</PharmacyNotes>
<Quantity>7</Quantity>
<Refills>6</Refills>
<RetailPharmacyToMailToPatient>true</RetailPharmacyToMailToPatient>
<RxReferenceNumber>sample string 11</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>
<DisplayName>sample string 1</DisplayName>
<DrugDBCode>sample string 3</DrugDBCode>
<DrugDBCodeQualifier>sample string 4</DrugDBCodeQualifier>
<NDC>sample string 2</NDC>
</NDCPrescriptionRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IdentifierResponse| Name | Description | Type | Additional 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>