NewCrop LLC V7 Update1 Services Demo

Click here for Update1 WSDL

Note: For web methods that return XML, NewCrop reserves the right to add additional elements at the end of the current list - make sure you consider this during coding. Also, you can request a schema in the web service results so you can always have the latest schema.
Quick start steps:
  1. Review the Update1 Services link below
  2. Enter your PartnerName, Name, and Password and press Save Credentials
    (demo can be used as PartnerName, Name, and Password for testing)
  3. Enter your AccountID, SiteID, and PatientID (if required)
    (demo can be used for AccountID and SiteID for testing)
  4. Press Submit at the desired web method
Featured GetPatientFullMedicationHistory6 GetAccountStatusV2 GetPatientAllergyHistoryV4
Patient GetPatientFullMedicationHistory4 (old) GetPatientFullMedicationHistory5 (old) GetPatientFullMedicationHistory6 (XML)
GetCompleteMedicationHistory GetPBMDrugHistoryV2 GetPatientAllergyHistory2
GetPatientFreeFormAllergyHistory GetPBMEligibilityV2 V3 (5010) GetPatientAllergyHistoryV3
GetPatientAllergyHistoryV4 GetPBMDrugHistoryV3 GetPatientAllergyLog
GetSessionPatients GetPatientsByTimeRange
Renewals GetRenewalResponseStatus GenerateTestRenewalRequest GetAllRenewalRequestsDetailV4
GetAllRenewalRequestsV2 GetRenewalRequestDetail ProcessRenewalRequest
GetAllRenewalRequestsV3 GetRenewalRequestDetailV5 GetRenewalBatchStatusV2
CreateRenewalBatch CompleteRenewalBatch V2 GetRenewalBatchStatus
Clinical FormularyAlternativesWithDrugInfo2 DrugDiseaseInteraction FormularyCoverageV3
GetCounselingMessages GetSideEffects DrugSearchWithFormularyWithFavoritesV2
DrugSearchWithFormularyWithFavoritesV3 GetMeaningfulUsePatientEncounterInfo SendClinicalMessage
CreateRxBatch CompleteRxBatch  V2 GetRxBatchStatus
CreateDigitalSigningBatch CompleteDigitalSigningBatch V2 GetDigitalSigningBatchStatus
GetDigitallySignedMessage
Reports GetDailyScriptReport (old) GetDailyScriptReportV2 (old) GetDailyScriptReportV3
GenerateMeaningfulUseUtilizationReport GetMeaningfulUseUtilizationReport GetDailyMeaningfulUseReport
Transactions GetPrescriptionTransmissionStatusByPatient GetPrescriptionTransmissionStatus GetPrescriptionTransmissionStatusV2
GetSubmittedMessageTransactionStatus ResolveFailedPrescriptionTransmission
Misc SendMissingHealthplanInformation GetMostRecentDownloadUrl HealthplanSearchV2
GetAccountStatusDetail GetAccountStatusV2 RegisterLicensedPrescriberV2
LicensedPrescriberStatusV2 GetPrescriberFavorites SetDrugDatabaseType
MU 2015 SendCancelRx CheckCancelRxStatus ConfirmCancelRx
GetAllRxFillsSummary GetRxFillDetail ConfirmRxFillReceipt
GetAllRxChangesSummary / V2 GetRxChangeDetail ConfirmRxChangeReceipt
SendRxChangeDenyResponse CreateRxChangeApprovalResponse CompleteRxChangeApproval V2
CheckRxChangeDeliveryStatus
Destination URL: https://preproduction.newcropaccounts.com/v7/webservices/update1.asmx
PartnerName: Name: Password:
Results: (displayed after you press the Submit button)


The following fields are used for the following web methods:
AccountID:
SiteID:
PatientID:
ProviderID / ProviderType /
A combination of the following are used for the next four methods
StartDate:
EndDate:
PrescriptionStatus:   C = Completed Prescription, P = Pending Medication (% = Both Complete and Pending can be used for GetPatientFullMedicationHistory6)
PrescriptionSubStatus:
% = All meds (Returns all meds regardless of the sub status)
A = NS (Returns only meds that have a 'NS' - Needs staff sub status)
U = DR (Returns only meds that have a 'DR' - Needs doctor review sub status)
P = Renewal Request that has been selected for processing on the NewCrop screens - it has not yet been denied, denied and re-written or accepted
S = Standard Rx (Returns only meds that have an 'InProc' - InProcess sub status)
D = DrugSet source - indicates the prescription was created by selecting the medication from the DrugSet selection box on the ComposeRx page
O = Outside Prescription - indicates the prescription was created on the MedEntry page
PrescriptionArchive:

 N = Not archived (i.e. Current Medication) Y = Archived (i.e. Previous Mediation), % = Both Not Archived and Archived
Note: This field will contain values other than Y,N in future releases.

The following field may be used with any web method below that returns XML:
Include Schema?:  Allowed values: Y, or N
Superseded: GetPatientFullMedicationHistory4
Retrieves a given set of patient prescriptions based on the given search criteria. When used to retrieve current medications, the startDate argument specified above is ignored. For patient safety reasons, all current medications should always be returned.
Top
Superseded: GetPatientFullMedicationHistory5
Retrieves a given set of patient prescriptions based on the given search criteria. When used to retrieve current medications, the startDate argument specified above is ignored. For patient safety reasons, all current medications should always be returned.
Top
GetPatientFullMedicationHistory6
Retrieves a given set of patient prescriptions based on the given search criteria. When used to retrieve current medications, the startDate argument specified above is ignored. For patient safety reasons, all current medications should always be returned.
Meaningful Use Return Fields Descriptions:
PrintLeaflet: Indicates whether or not a patient leaflet was printed.
T=True, F=False
DeaClassCode: Indicates the DEA drug schedule.
0 = No DEA Class Code Assigned
2 = Class 2 Scheduled Drug
3 = Class 3 Scheduled Drug
4 = Class 4 Scheduled Drug
5 = Class 5 Scheduled Drug
9 = No Value
PharmacyType: Indicates if the receiving pharmacy is electronic, fax, or not selected.
1 = Electronic
2 = Fax
0 = No Pharmacy Selected
PharmacyDetailType: Indicates the network to which the receiving pharmacy belongs
1 = Surescripts
2 = RxHub (Merged with Surescripts)
3 = NewCrop (i.e. Direct Fax or Printed)
FinalDestinationType: Indicates the transmission method from NewCrop to the receiving entity
0 = Not Transmitted
1 = Print
2 = Fax
3 = Electronic/Surescripts Retail
4 = Electronic/Surescripts Mail Order
5 = Test
FinalStatusType: Indicates the prescription status
1 = Success
2 = Error
3 = Queued
4 = Unknown
5 = Verified
Other Return Field Descriptions:
DeaGenericNamedCode: Indicates if the drug is Brand or Generic.
0 = Non-drug item, such as medical supplies and bulk chemicals
1 = Generic
2 = Brand
3 = Alternative
4 = Related products span multiple Generic Drug Name Codes
9 = No Value
1 AccountGuid uniqueidentifier NOT NULL
2 AccountName nvarchar(100) NOT NULL
3 ExternalAccountID varchar(50) NULL
4 SiteID varchar(50) NULL
5 PatientGUID uniqueidentifier NOT NULL
6 FullName nvarchar(144) NULL
7 ExternalPatientID nvarchar(50) NULL
8 PrescriptionDate datetime NOT NULL
9 DrugID varchar(20) NOT NULL
10 DrugTypeID char NOT NULL
11 DrugName varchar(30) NOT NULL
12 DrugInfo varchar(200) NULL
13 Strength varchar(15) NULL
14 StrengthUOM varchar(15) NULL
15 DosageNumberDescription nvarchar(50) NULL
16 DosageForm nvarchar(50) NULL
17 Route nvarchar(50) NULL
18 DosageFrequencyDescription nvarchar(50) NULL
19 Dispense nvarchar(100) NULL
20 TakeAsNeeded char NOT NULL
21 DispenseAsWritten char NOT NULL
22 Refills tinyint NOT NULL
23 Status char NOT NULL
24 SubStatus char NOT NULL
25 Archive char NOT NULL
26 PrescriptionGuid uniqueidentifier NOT NULL
27 OrderGUID uniqueidentifier NULL
28 PrescriptionNotes nvarchar(255) NULL
29 PharmacistNotes nvarchar(255) NULL
30 ExternalPhysicianID nvarchar(50) NULL
31 PhysicianName nvarchar(176) NULL
32 DateMovedToPreviousMedications varchar(1) NOT NULL
33 FormularyType varchar(20) NULL
34 FormularyTypeID varchar(1) NOT NULL
35 FormularyMember varchar(50) NULL
36 FormularyId varchar(50) NULL
37 FormularyStatus varchar(2) NULL
38 ModifiedSig bit NULL
39 ModifiedSigStatus varchar(1) NULL
40 ExternalPrescriptionID varchar(50) NOT NULL
41 EpisodeIdentifier varchar(40) NOT NULL
42 EncounterIdentifier varchar(40) NOT NULL
43 ExternalSource varchar(1) NULL
44 ExternalDrugConcept varchar(105) NULL
45 ExternalDrugName varchar(35) NULL
46 ExternalDrugStrength varchar(35) NULL
47 ExternalDrugStrengthUOM varchar(35) NULL
48 ExternalDrugStrengthWithUOM varchar(35) NULL
49 ExternalDrugDosageForm varchar(35) NULL
50 ExternalDrugRoute varchar(35) NULL
51 ExternalDrugIdentifier varchar(35) NULL
52 ExternalDrugIdentifierType varchar(35) NULL
53 ExternalDrugSchedule varchar(1) NULL
54 ExternalDrugOTC varchar(1) NULL
55 DosageNumberTypeID smallint NOT NULL
56 DosageFormTypeId tinyint NOT NULL
57 DosageRouteTypeId tinyint NOT NULL
58 DosageFrequencyTypeID smallint NOT NULL
59 DaysSupply int NOT NULL
60 PrescriptionTimestamp datetime NOT NULL
61 OriginalPrescriptionGuid uniqueidentifier NOT NULL
62 ExternalUserID nvarchar(50) NOT NULL
63 ExternalUserType varchar(1) NOT NULL
64 DeaGenericNamedCode varchar(1) NOT NULL
65 Diagnosis varchar(20) NOT NULL
66 DiagnosisSource varchar(6) NOT NULL
67 DiagnosisName nvarchar(200) NOT NULL
68 DispenseNumberQualifier varchar(50) NOT NULL
69 DispenseNumberQualifierDescription varchar(50) NOT NULL
70 LocationName nvarchar(100) NOT NULL
71 GenericName varchar(30) NOT NULL
72 PatientFriendlySIG varchar(140) NOT NULL
73 PrintLeaflet varchar(1) NOT NULL
74 DeaClassCode varchar(1) NOT NULL
75 PharmacyType int NOT NULL
76 PharmacyDetailType tinyint NOT NULL
77 FinalDestinationType tinyint NOT NULL
78 FinalStatusType tinyint NOT NULL
79 PatientID nvarchar(50) NULL
80 PatientIDType varchar(1) NOT NULL
81 rxcui numeric(11, 0) NULL
GetPrescriptionTransmissionStatusByPatient
Retrieves prescription transmission status information based on patient and prescription status info.
Enter the query mode:  Query modes allowed: standard, or 1
Return values coming soon!
GetCompleteMedicationHistory
Description coming soon!
Return values coming soon!
GetDailyScriptReport
SUPERSEDED by a newer version below.
Report Date (CCYYMMDD):
Return values coming soon!
GetDailyScriptReportV2
Retrieves a list of all prescriptions with a given status for a specific day, hour range, accountID, and siteID. Prescriptions in the report are based on the latest transactional status item.
For example, suppose only one prescription was sent on the requested report date and that it had the following transactional status entries:
  1 - Queued - 12:00 PM
   2 - Failed - 12:03 PM
    3 - Queued - 12:13 PM (This Queued status is generated when the Rx is retransmitted after the failure)
     4 - Success - 12:15 PM (Successful retransmission)
The timestamp is the time that the transactional status item was created. Calling this web method with Status=Queued at 12:03 PM would yield no return, but calling the web method with Status=Failed would return the prescription in the report results. Similarly, calling the web method with Status=Success at 12:15 or later would result in the prescription being returned in the report.
Report Start Date (CCYYMMDD):
Start Hour: 0 based hour.  0 = Midnight
End Hour: 0 based hour.  24 = End of the report start date.
Status: Allowed Values:  All, Failed, Success, Queued
Transmission Type: Allowed Values:  All, Fax, Electronic
Return values coming soon!
GetDailyScriptReportV3
Retrieves a list of all prescriptions, including accepted and denied renewal requests, with a given status for a specific day, hour range, accountID, and siteID. Prescriptions in the report are based on the latest transactional status item.
For example, suppose only one prescription was sent on the requested report date and that it had the following transactional status entries:
  1 - Queued - 12:00 PM
   2 - Failed - 12:03 PM
    3 - Queued - 12:13 PM (This Queued status is generated when the Rx is retransmitted after the failure)
     4 - Success - 12:15 PM (Successful retransmission)
The timestamp is the time that the transactional status item was created. Calling this web method with Status=Queued at 12:03 PM would yield no return, but calling the web method with Status=Failed would return the prescription in the report results. Similarly, calling the web method with Status=Success at 12:15 or later would result in the prescription being returned in the report
Report Start Date (CCYYMMDD):
Start Hour: 0 based hour.  0 = Midnight
End Hour: 0 based hour.  24 = End of the report start date.
Status: Allowed Values:  All, Failed, Success, Queued
Transmission Type: Allowed Values:  All, Fax, Electronic
Prescription Type: Allowed Values:  All, New, Renewal
Prescription Sub Type: Allowed Values:  All, Approved, Denied
Return values coming soon!
GenerateMeaningfulUseUtilizationReport
Top
Enter your unique licensed prescriber ID:
Report Start Date (CCYYMMDD):
Report End Date (CCYYMMDD):
Quarter Number: 1 = First, 2 = Second, 3 = Third, 4 = Fourth
Quarter Year (CCYY):
Time Period Query Type:
GetMeaningfulUseUtilizationReport
Top
Report Transaction ID: (i.e. 7B16F3CC-6FB9-48A1-B10F-46F2026E3CF7)
GetDailyMeaningfulUseReport
Retrieves the data necessary to meet the automated numerator calculation (g1 and g2) of Meaningful Use attestable events View, Download, Transmit, and Med Reconciliation.
Meaningful Use Return Fields Descriptions:
SourceTypeID: Indicates where the given action was performed.
  0=Unknown
  1=Web Application
  2=Patient Portal
  3=Web Services
ActionTypeID: Indicates what action occurred
  0=Unknown
  1=View
  2=Download
  3=Transmit
PerformerUserTypeID: Indicates who performed the action
  0=Unknown
  1=Agent
  2=Doctor
  3=MidLevel
  4=Patient
  5=Staff
DestinationTypeID: Indicates the destination for a transmission action
  0=Unknown
  1=Patient Portal
  2=Doctor
DocumentMimeType: Indicates the type of MIME document on which the action was performed
DocumentClassificationType: Indicates the classification of the document (e.g. CCDA)
DocumentClassificationSubType: Indicates the sub-classification of the document (e.g. Summary of Care, Transition of Care, etc.)
Top
Enter your unique location ID: (Optional)
Enter your unique licensed prescriber ID: (Optional)
Report Date (CCYYMMDD): (Required)
GetPBMDrugHistoryV2 / V3 Requests Pharmacy Benefit Management drug history for a given patient.
EligibilityTransactionID: (i.e. 7B16F3CC-6FB9-48A1-B10F-46F2026E3CF7)
Months Prior:  The number of months back from today's date to retrieve the Rx history. (i.e. 6 = 6 months)
DrugHistoryTransactionGuid uniqueidentifier NOT NULL
DrugInfo varchar(110) NULL
NDC varchar(20) NULL
DoctorLastName varchar(100) NULL
DoctorFirstName varchar(100) NULL
DoctorContactNumber varchar(100) NULL
PharmacyName varchar(100) NULL
PharmacyContactNumber varchar(100) NULL
ScriptDate varchar(100) NULL
Source varchar(100) NULL
HealthplanName varchar(100) NULL
DrugID varchar(11) NULL
DrugQuantity varchar(35) NULL
Sig varchar(140) NULL
GetRenewalResponseStatus Retrieves renewal response status information based on a renewal request identifier.
Enter the renewal request identifier:
Return values coming soon!
GetPatientAllergyHistory2 Retrieves a list of patient allergies.
1 Name nvarchar(50) NULL
2 CompositeID int NULL
3 ConceptID int NULL
4 Source varchar(1) NULL
5 ConceptTypeID int NULL
6 Status varchar(1) NULL
7 SeverityTypeID int NULL
8 SeverityName nvarchar(50) NULL
9 Notes varchar(200) NULL
GetPatientAllergyHistoryV3 Retrieves a list of patient allergies in XML format.
Top
GetPatientAllergyHistoryV4 Retrieves a list of patient allergies with additional data for MU support.
Top
GetPatientFreeFormAllergyHistory Retrieves a list of patient free form (unencoded) allergies.
1 ExternalId varchar(50) NULL
2 Name varchar(80) NULL
3 SeverityTypeID int NULL
4 SeverityName varchar(50) NULL
5 Notes varchar(200) NULL
GetPatientAllergyLog Retrieves the allergy log details for a patient.
Top
GetSessionPatients Return a list of Patient IDs touched during a given session.
Top
GetPatientsByTimeRange Return a list of Patient IDs touched during a given time range.
Top
Start Date: Example:  2023-05-15T09:10:30.0000000Z
End Hour: Example:  2023-05-15T19:19:30.0000000Z
GetPrescriptionTransmissionStatus Retrieves prescription transmission status information based on a list of your prescription Ids.
Enter a comma separated list of unique keys from your database for the prescription(s):
Return values coming soon!
GenerateTestRenewalRequest (Obsolete) Generates a test renewal request message based on supplied prescription information.
Generate Test Renewal (Mapped Drug)
Generate Test Renewal (Unmapped Drug - With NDC)
Generate Test Renewal (Unmapped Drug - Without NDC)
If using the unmapped drug XML example, you must supply a value for the externalId element. This should be a unique prescription id from your database.
Top
Original prescription fill date (CCYYMMDD):   Optional
XML Input:
GetAllRenewalRequestsRetrieves all pending renewal requests for an account.
Top
Enter your unique location ID:
 Optional
Enter your unique licensed prescriber ID:
 Optional
GetAllRenewalRequestsV2
Retrieves all pending renewal requests for an account.

Note: Spare elements in the results convey additional information specified as follows:

Spare1 - The Pharmacist Message from the original new prescription
Spare2 - The Dispense Number Qualifier:R or PRN: Refill Count. Values are separated by ":" for parsing purposes

  For example, U2:R:2 translates to U2=Tablet, R=Number of Refills, 2=Quantity for the number of refills
  BO:PRN: translates to BO=Bottle, PRN=Take as Needed, No value or 0 will be used when PRN is specified

Spare3 - The NDC for the requested drug (if provided by the pharmacy software system)
Spare4 - :Message Reference Number:R:LeftForExternalDoctorID:LeftByExternalStaffID: The first character is used for parsing purposes

  For example, :PH456:DRID123:STID123: translates to PH456=Message Reference Number, which is the prescription number   assigned by the pharmacy software system. It's used to identify the refill response, or the follow up new prescription message sent after the   renewal request is "Denied - NewRx to follow". DRID123=The EMR's unique identifier for the doctor the renewal request was left for review   STID123=The EMR's unique identifier for the staff who left the renewal request for doctor review.

Spare5 - Not yet used
Enter your unique location ID:
 Optional
Enter your unique licensed prescriber ID:
 Optional
1 AccountName nvarchar(100) NULL
2 LocationName nvarchar(100) NULL
3 DoctorFullName nvarchar(176) NULL
4 PharmacyStoreName varchar(50) NULL
5 PharmacyStore varchar(20) NULL
6 Response nvarchar(255) NULL
7 ResponseDetail nvarchar(255) NULL
8 ResponsePersonName varchar(200) NULL
9 NDCHealthRefreqTID uniqueidentifier NOT NULL
10 TransactionID varchar(50) NULL
11 AccountGuid uniqueidentifier NULL
12 LocationGuid uniqueidentifier NULL
13 DoctorGuid uniqueidentifier NULL
14 PharmacyGuid uniqueidentifier NULL
15 Message varchar(5000) NULL
16 ReceivedTimestamp datetime NULL
17 Valid tinyint NULL
18 ResponseCode varchar(10) NULL
19 ResponseCodeDetail varchar(10) NULL
20 ResponseFreeText varchar(70) NULL
21 ResponseTimestamp datetime NULL
22 ResponseUserGuid uniqueidentifier NULL
23 ResponseUserType char NULL
24 PatientGuid uniqueidentifier NULL
25 PatientFirstName varchar(35) NULL
26 PatientMiddleName varchar(35) NULL
27 PatientLastName varchar(35) NULL
28 PatientDOB varchar(8) NULL
29 PatientGender varchar(1) NULL
30 DrugInfo varchar(105) NULL
31 SentTimestamp datetime NULL
32 SentStatus varchar(10) NULL
33 SentStatusMessage varchar(300) NULL
34 NumberOfRefills varchar(10) NULL
35 CompositeTransaction varchar(30) NULL
36 ReviewUserGuid uniqueidentifier NULL
37 ReviewUserType char NULL
38 ReviewTimestamp datetime NULL
39 Pon varchar(50) NULL
40 Sig varchar(140) NULL
41 Quantity varchar(15) NULL
42 QuantityType varchar(2) NULL
43 PharmacyInfo varchar(334) NULL
44 PharmacyFullInfo varchar(301) NULL
45 LocationExternalId varchar(50) NULL
46 DoctorExternalId nvarchar(50) NULL
47 Pharmacy_NCPDP varchar(10) NULL
48 Spare1 varchar(210) NULL
49 Spare2 varchar(20) NULL
50 Spare3 varchar(11) NULL
51 Spare4 varchar(512) NULL
52 Spare5 varchar(?) NULL
GetAllRenewalRequestsV3
Retrieves all pending renewal requests for an account, allowing retrieval by a specific renewal date
Note: Spare elements in the results convey additional information specified as follows:

Spare1 - The Pharmacist Message from the original new prescription
Spare2 - The Dispense Number Qualifier:R or PRN: Refill Count. Values are separated by ":" for parsing purposes

  For example, U2:R:2 translates to U2=Tablet, R=Number of Refills, 2=Quantity for the number of refills
  BO:PRN: translates to BO=Bottle, PRN=Take as Needed, No value or 0 will be used when PRN is specified

Spare3 - The NDC for the requested drug (if provided by the pharmacy software system)
Spare4 - :Message Reference Number:R:LeftForExternalDoctorID:LeftByExternalStaffID: The first character is used for parsing purposes

  For example, :PH456:DRID123:STID123: translates to PH456=Message Reference Number, which is the prescription number   assigned by the pharmacy software system. It's used to identify the refill response, or the follow up new prescription message sent after the   renewal request is "Denied - NewRx to follow". DRID123=The EMR's unique identifier for the doctor the renewal request was left for review   STID123=The EMR's unique identifier for the staff who left the renewal request for doctor review.

Spare5 - Not yet used
Enter your unique location ID:
 Optional
Enter your unique licensed prescriber ID:
 Optional
Enter the renewal request date (CCYYMMDD format - Defines the date renewal request was received from the pharmacy):
 Optional
1 AccountName nvarchar(100) NULL
2 LocationName nvarchar(100) NULL
3 DoctorFullName nvarchar(176) NULL
4 PharmacyStoreName varchar(50) NULL
5 PharmacyStore varchar(20) NULL
6 Response nvarchar(255) NULL
7 ResponseDetail nvarchar(255) NULL
8 ResponsePersonName varchar(200) NULL
9 NDCHealthRefreqTID uniqueidentifier NOT NULL
10 TransactionID varchar(50) NULL
11 AccountGuid uniqueidentifier NULL
12 LocationGuid uniqueidentifier NULL
13 DoctorGuid uniqueidentifier NULL
14 PharmacyGuid uniqueidentifier NULL
15 Message varchar(5000) NULL
16 ReceivedTimestamp datetime NULL
17 Valid tinyint NULL
18 ResponseCode varchar(10) NULL
19 ResponseCodeDetail varchar(10) NULL
20 ResponseFreeText varchar(70) NULL
21 ResponseTimestamp datetime NULL
22 ResponseUserGuid uniqueidentifier NULL
23 ResponseUserType char NULL
24 PatientGuid uniqueidentifier NULL
25 PatientFirstName varchar(35) NULL
26 PatientMiddleName varchar(35) NULL
27 PatientLastName varchar(35) NULL
28 PatientDOB varchar(8) NULL
29 PatientGender varchar(1) NULL
30 DrugInfo varchar(105) NULL
31 SentTimestamp datetime NULL
32 SentStatus varchar(10) NULL
33 SentStatusMessage varchar(300) NULL
34 NumberOfRefills varchar(10) NULL
35 CompositeTransaction varchar(30) NULL
36 ReviewUserGuid uniqueidentifier NULL
37 ReviewUserType char NULL
38 ReviewTimestamp datetime NULL
39 Pon varchar(50) NULL
40 Sig varchar(140) NULL
41 Quantity varchar(15) NULL
42 QuantityType varchar(2) NULL
43 PharmacyInfo varchar(334) NULL
44 PharmacyFullInfo varchar(301) NULL
45 LocationExternalId varchar(50) NULL
46 DoctorExternalId nvarchar(50) NULL
47 Pharmacy_NCPDP varchar(10) NULL
48 Spare1 varchar(210) NULL
49 Spare2 varchar(20) NULL
50 Spare3 varchar(11) NULL
51 Spare4 varchar(512) NULL
52 Spare5 varchar(?) NULL
GetRenewalRequestDetailRetrieves a specific renewal request message for processing based on NewCrop's unique renewal request ID
Top
Enter the unique renewal request ID:
GetRenewalRequestDetailV4Retrieves a specific renewal request message for processing based on NewCrop's unique renewal request ID
Top
Enter the unique renewal request ID:
GetRenewalRequestDetailV5Retrieves a specific renewal request message for processing based on NewCrop's unique renewal request ID
Top
Enter the unique renewal request ID:
GetAllRenewalRequestsDetailV4 Retrieves all renewal request messages for processing
Top
GetAllRenewalRequestsSummaryV4 Retrieves all renewal request messages for processing
Top
ProcessRenewalRequest Processes a renewal request from an electronically connected pharmacy by accepting the renewal request, denying the renewal request, or indicating that the renewal request cannot be processed due to an error.
Top
XML Input:
GetRenewalResponseTransmissionStatus Retrieves renewal response transmission status information based on a renewal request identifier.
Top
Enter the renewal request identifier:


CreateRenewalBatch Digitally signs and routes renewals to the specified pharmacy.

Note: you must Base64 encode the entire 'NCScript' message before including it in the <xmlIn> element in the web service call.  The soap message should look similar to the following:
...</accountRequest> <xmlIn>base64 encoded message</xmlIn> </CreateRenewalBatch>...

Top
XML Input:


CompleteRenewalBatch, CompleteRenewalBatchV2 Marks a renewal batch as complete and allows transmission to occur.

Top
RenewalBatchTransactionGuid
CompletionStatus
AuthenticationType
Passcode
GetRenewalBatchStatus Gets the latest digital signing status information for each item in the batch.
Top
RxBatchTransactionGuid
GetRenewalBatchStatusV2 Gets the latest digital signing and transmission status information for each item in the batch.
Top
RxBatchTransactionGuid
FormularyAlternativesWithDrugInfo2 Provides a list of alternatives for a given drug concept sorted by preference. Note that either the summary or detail formulary list can be used.
Top
Healthplan ID:
Healthplan Type ID:
Eligibility Index:
Drug Concept:

Drug Concept Type:
SendMissingHealthplanInformation Reports a missing healthplan to NewCrop.
Top
Healthplan Name:
Healthplan ID:
Address1:
Address2:
City:
State Code:
Zip:
Zip4:
Phone Number:
GetMostRecentDownloadUrl
Retrieves a URL to where the latest NewCrop supplied data or documentation can be downloaded.
NOTE!!! Drug Database Download URLs are from PRODUCTION .  Some of the DrugIDs used with some Preproduction web services may not exist/be found because we DO NOT update the FDB Drug Database on the Preproduction Server due to certification requirements and formulary testing. If you receive a <Status> of FAIL, with a <Message> containing "Unknown drug: 583676", then this is why. Please use a different DrugID. You can always check the status of the drug via the "Drug DB Lookup" feature in the Preproduction Customer Maintenance Portal.
Top
Desired Download:  (See table below for allowed values)
Allowed Values:
Download File Name Download Description
1 NCFull-CCYYMM.zip Contains several tables including FirstDataBank drug index, healthplan index, allergy index, and pharmacy index
2 NCNDC-CCYYMM.zip Provides the ability to obtain a FirstDataBank drug id from a validated representative NDC
3 - Obsolete NCRxNorm-CCYYMM.zip Contains the RxNorm drug and allergy indexes - Obsolete
4 RxCUI2MEDID.zip Provides the ability to obtain a FirstDataBank drug id from an RxNorm drug id - Obsolete
5 NCPharms-CCYYMMDD.zip Contains the latest pharmacy index, which is updated nightly
6 CodifiedSig.zip Contains tables that allows partner systems to display the exact same SIG options as NewCrop. The SIG selection options include dosage number, form, route, frequency, and action. For example: Take 1 tablet(s) by mouth BID
7 NCOffline-CCYYMM.zip Contains tables that allows drug-drug interactions to be performed locally in a disconnected state
8 NCOfflineAllergy-CCYYMM.zip Contains tables that allows drug-allergy interactions to be performed locally in a disconnected state
9 NCFull-Multum-CCYYMM.zip Contains several tables including Multum drug index, allergy index, and NDC mapping
10 NCAgePrecautions-CCYYMM.zip Contains tables that allows drug-pediatric and drug-geriatric interactions to be performed locally in a disconnected state
11 NCDrugDisease-CCYYMM.zip Contains tables that allows drug-disease to be performed locally in a disconnected state
12 NCPharms2-CCYYMM.zip Contains the pharmacy extended table which is updated nightly
13 NCFDB-RxNorm-XXXX.zip Contains the FDB-RxNorm crosswalk mapping tables for allergies and medications.
DrugDiseaseInteraction returns a list of interactions between current diagnosises (ICD9 codes) and proposed medications.
Top
Use a comma separated list of ICD9 codes and drug ids when passing more than one.
Current Diagnosis(s):      V22 (Normal Pregnancy)
Diagnosis Code Type:    Allowed values: ICD9, ICD10, SNOMED
Proposed DrugID(s):       150546 (Tetracycline 500 mg Cap)
Drug Standard Type:       FDB = First Data Bank; RXNORM = RxNorm
HealthplanSearchV2 returns a list of active healthplans based on plan name and state.
Top
Healthplan Name:    
Healthplan State:     
FormularyCoverageV3 Checks a list of Drug Concepts against a given formulary.  Note that either the summary, detail or eligibility formulary list can be used.
Top
Healthplan ID:
Healthplan Type ID: MediaMedia
Eligibility Index: Not Used
Drug Concept List:

Crestor

Drug Concept Type:

Multum

GetCounselingMessages Retrieves professional/patient counseling messages for a given drug concept
Top
DrugConcept:
DrugStandardType: FirstData Bank
GetSideEffects Retrieves a list of side effects for a given drug concept.
Top
DrugConcept:
DrugStandardType: FirstData Bank
Disease Description Type: 1=Professional Synonym, 2=Primary Layman Name, 3=Layman Synonym
GetAccountStatusDetail Retrieves a section from the NewCrop Status page
Top
Enter your unique location ID:
Enter your unique licensed prescriber ID:
Status Section Type: Options: DrReview, FailedElectronicRx, FailedFax, StaffProcessing, AllDoctorReview
GetAccountStatusV2 Retrieves the current status of the account.
Top
(PatientID is not required)
UserID:
UserTypeID:
GetPBMEligibilityV2
requests Pharmacy Benefit Management eligibility for a given patient.
NOTE: The newcropdemo account sends to RxHub. Use patient Bruce Paltrow as provided in the following XML:
Paltrow.xml
XML Input:
1 Source VARCHAR(10)
2 PBM VARCHAR(100)
3 PBMId VARCHAR(100)
4 PlanName VARCHAR(100)
5 PlanId VARCHAR(100)
6 CoverageListId VARCHAR(100)
7 CardholderName VARCHAR(100)
8 CardholderId VARCHAR(100)
9 SSN VARCHAR(100)
10 SSNName VARCHAR(100)
11 PersonCode VARCHAR(10)
12 GroupNumber VARCHAR(100)
13 GroupNumberId VARCHAR(100)
14 formularyId VARCHAR(100)
15 formularyTypeId VARCHAR(1)
16 AlternateFormularyId VARCHAR(100)
17 BIN VARCHAR(100)
18 BINInfo VARCHAR(100)
19 CopayId VARCHAR(80)
20 PharmacyBenefit VARCHAR(10)
21 MailOrderBenefit VARCHAR(10)
22 PBMPatientId VARCHAR(100)
23 PersonType VARCHAR(1)
24 NameLast VARCHAR(35)
25 NameFirst VARCHAR(25)
26 NameMiddle VARCHAR(25)
27 NameSuffix VARCHAR(10)
28 Address1 VARCHAR(55)
29 Address2 VARCHAR(55)
30 CityName VARCHAR(30)
31 StateCode VARCHAR(2)
32 PostalCode VARCHAR(15)
33 DOB VARCHAR(35)
34 Gender VARCHAR(1)
35 AAAResult VARCHAR(80)
36 SubscriberDate VARCHAR(80)
37 BenefitSummary VARCHAR(160)
38 PharmacyBenefitDescription VARCHAR(80)
39 MailOrderBenefitDescription VARCHAR(80)
40 BenefitLoop INT

GetPBMEligibilityV3 requests Pharmacy Benefit Management eligibility for a given patient.

NOTE: The newcropdemo account sends to RxHub. Use patient Bruce Paltrow as provided in the following XML:
  Paltrow.xml
Top
XML Input:
GetPrescriptionTransmissionStatusV2 Retrieves prescription transmission status information based on one of the following: prescription Ids, prescription guid, transaction guid, transaction detail guid
Top
Enter a comma separated list of prescription ids, OR enter a single prescription guid, transaction guid, or transaction detail guid:
GetSubmittedMessageTransactionStatus (Obsolete) Retrieves a submitted transaction status based on a unique message transaction Id and message transaction source. After each message transaction (click through or web service call involving NewCrop XML), the partner applicaiton should use this web method to determine whether or not the message transactoin is still pending or completed. If the message transaction state is "PENDING", then no additional message transactions should occur until a message transaction state of "COMPLETE" is received. In addition, no calls to any NewCrop web methods that retrieve information for a given patient, such as medications and allergies, should be conducted until a message transaction state of "COMPLETE" is received. If a message transaction state of "COMPLETE" is not received withing 30 seconds, then the message transaction should be considered a failure and redone with a new unique message transaction Id.
Top
Message Transaction ID:
Message transaction Id must be a unique value for each click through, or for each call to one of our web services involving XML.
Message Transaction Source: C=Click through to RxEntry transaction; W=Web service transaction
ResolveFailedPrescriptionTransmission Marks a failed new or renewal transaction as resolved.
Top
patientInformationRequester - UserType D for doctor, M for midlevel, S for staff
patientInformationRequester - UserId ID (primary key from your database) for the user that is marking the transaction as complete
Prescription Type: New, Renewal
Transaction ID:
DrugSearchWithFormularyWithFavoritesV2
SUPERSEDED by a newer version below. Returns a list of drugs matching the required name. Also returns formulary coverage information and provider drug list status.
Top
drugName:  At least first 3 letters: acc (for accupril)
drugStandardType:  F = First Data Bank, R = RxNorm
includeObsolete:   'Y' to include obsolete drugs, 'N' otherwise
searchBrandGeneric   'A' for all, 'B' for Brand, 'G' for generic
searchRxOTC    'A' for all, 'R' for Rx (legend drugs), 'O' for Over The Counter drugs
searchDrugSupply    'A' for all, 'D' for Drugs, 'S' for Supplies
healthplanID:           133 - Aetna Alaska PPO
healthplanTypeID:  S for Summary, D for Detail, R for RxHub, N for no health plan
eligibilityIndex:  Eligibility Index for RxHub
locationID:               Internal Location ID for this provider
providerID:              Internal ID for this provider
DrugSearchWithFormularyWithFavoritesV3
Returns a list of drugs matching the required name. Also returns formulary coverage information and provider drug list status.
Top

drugName:  At least first 3 letters: acc (for accupril)
drugStandardType:  F = First Data Bank, R = RxNorm
includeObsolete:   'Y' to include obsolete drugs, 'N' otherwise
searchBrandGeneric   'A' for all, 'B' for Brand, 'G' for generic
searchRxOTC    'A' for all, 'R' for Rx (legend drugs), 'O' for Over The Counter drugs
searchDrugSupply    'A' for all, 'D' for Drugs, 'S' for Supplies
healthplanID:           133 - Aetna Alaska PPO
healthplanTypeID:  S for Summary, D for Detail, R for RxHub, N for no health plan
eligibilityIndex:  Eligibility Index for RxHub
locationID:               Internal Location ID for this provider
providerID:              Internal ID for this provider
GetMeaningfulUsePatientEncounterInfo Retrieves information related to a specific patient encounter for Meaningful Use reporting requirements.
Top
Enter your unique encounter ID:
Your unique patient ID is required! Plesae supply a value in the PatientID textbox near the top of the page
SendClinicalMessage Sends a clinical message to a specified Direct address
Top
To Direct Address:
From Direct Address:
Subject:
DoseCheck Provides details on a proposed patient dose. Accounts for age, weight, condition and dose type.
Top
Drug Concept:

Drug Concept Type:

BirthdateCCYYMMDD:
Gender:
Diagnosis:
Dose type:
Dose:
Dose Unit of Measure:
Weight in Kg:

SendToRegistry Sends a base 64 encoded message to a given registry (immunization)

NOTE: Use the following XML to get started:
  SendToRegistry.xml
Top
Raw registry message (HL7):
Top
Base 64 encoded version of raw registry message:
Raw message size:
XML Input:
RegisterLicensedPrescriberV2 requires complete location and prescriber information for registration as a valid prescriber.  This method must be used before a doctor can participate in the electronic pharmacy network.  If a doctor will be sending prescriptions from more than one location, the doctor must be registered at each location.
Top
XML Input:    

LicensedPrescriberStatusV2
Returns the registration status of a Licensed Prescriber.
<spare1> will contain the prescriber's IDP Status and EPCS Status separated by a separator character (:). The separator character will be in the first character position e.g. <spare1>:2:5</spare1>

IDP Status Values:
NoIDP = 0
IDPQueued = 1
IDPSuccess = 2
IDPFailed = 3

EPCS Status Values:
Undefined = 0 (Default value on Insert)
GrantEPCSAccess = 1 (User shows in grant access control)
GrantedEPCSAccess = 4 (User shows in grant finalizer control)
GrantedEPCSAccessAndTFA = 5 (User shows in revoke access control)
RevokedEPCSAccess = 6 (User shows in revoke finalizer control)
RevokedEPCSAccessAndTFA = 7 (User shows in regrant access control)
RegrantEPCSAccess = 8 (User shows in grant finalizer control (note RegrantEPCSAccess acts the same as GrantedEPCSAccess))

NOTE:  If a prescriber is only registered with NewCrop, or registered but inactive with SureScripts, then all scripts are transmitted via fax if the account has faxing enabled.  If a prescriber is registered and active with SureScripts, they can transmit scripts electronically to electronically enabled pharmacies.  Faxing is used as a backup mechanism to electronically enabled pharmacies and is the primary transmission method for non electronic pharmacies when the account has faxing enabled.

Please be sure that your users understand why their scripts may be transmitted via fax due to their registration status.
Top
    
licensedPrescriberID:    
locationID:    

GetPrescriberFavorites  Returns all current favorites by prescriber. Prescriber is an optional element.
Top
Enter your unique licensed prescriber ID: (Optional)
CreateRxBatch Digitally signs and routes controlled substance prescription(s) to the specified pharmacy.

Note: you must Base64 encode the entire 'NCScript' message before including it in the <xmlIn> element in the web service call.  The soap message should look similar to the following:
...</accountRequest> <xmlIn>base64 encoded message</xmlIn> </CreateRxBatch>...

Note: This web service should only be used to transmit prescriptions for drugs that have a Status code of "A" or "P". If your drug content is provided by NewCrop, then the drug's Status code is obtained either from a monthly updated drug database from NewCrop (that may be downloaded via a web service), or returned in the <Status> result field of the drug search web service implemented by your software (e.g DrugSearch, DrugSearchWithFormularyWithFavoritesV3, etc.). While it is clinically useful for your software to display current or past prescriptions for inactive, replaced, or retired (obsolete) drug concepts (e.g. Vioxx 25 mg oral tablet), they should not be transmitted to a pharmacy.
Top
XML Input:
CompleteRxBatch, CompleteRxBatchV2 Marks a batch as complete and allows transmission to occur.
Top
RxBatchTransactionGuid
CompletionStatus
AuthenticationType
Passcode
GetRxBatchStatus Gets the latest digital signing and transmission status information for each item in the batch.
Top
RxBatchTransactionGuid
CreateDigitalSigningBatch Digitally signs and routes controlled substance prescription(s) to the specified pharmacy.

Note: you must Base64 encode the entire 'NCScript' message before including it in the <xmlIn> element in the web service call.  The soap message should look similar to the following:
...</accountRequest> <xmlIn>base64 encoded message</xmlIn> </CreateDigitalSigningBatch>...

Note: This web service should only be used to transmit prescriptions for drugs that have a Status code of "A" or "P". If your drug content is provided by NewCrop, then the drug's Status code is obtained either from a monthly updated drug database from NewCrop (that may be downloaded via a web service), or returned in the <Status> result field of the drug search web service implemented by your software (e.g DrugSearch, DrugSearchWithFormularyWithFavoritesV3, etc.). While it is clinically useful for your software to display current or past prescriptions for inactive, replaced, or retired (obsolete) drug concepts (e.g. Vioxx 25 mg oral tablet), they should not be transmitted to a pharmacy.

Top
XML Input:
CompleteDigitalSigningBatch, CompleteDigitalSigningBatchV2 Notifies NewCrop to Continue or Cancel the batch based on user input from the digital signing toolkit.
Top
RxBatchTransactionGuid
Digital Signing Format:
AuthenticationType:
Passcode
GetDigitalSigningBatchStatus Gets the latest digital signing status information for each item in the batch.
Top
RxBatchTransactionGuid
GetDigitallySignedMessage Gets the latest digital signing status information for each item in the batch.
Top
External Digital Signing Message ID:
Digital Signing Format:
DrugAllergyInteractionV2 returns a list of interactions between the current allergies and proposed medications.
Top

Use a comma separated list of CompositeAllergyIDs and Proposed DrugIDs when passing more than one.
CompositeAllergyIDs:  245  (Penicillin Group  (ConceptType = 1 = Allergen Group))
Proposed DrugIDs:       171050,196275  (Amoxicillin 125 mg Oral Chew, Penicillin V Potassium 500 mg Oral Tab)
SendCancelRxForNewRx / SendCancelRxForRenewalResponse Sends a CancelRx message to the pharmacy based on a previous NewRx / Renewal Response message.
Top
XML Input:
CheckCancelRxStatus Checks the status of a previously sent CancelRx message to the pharmacy.
Top
Integer transactionId from SendCancelRx:
ConfirmCancelRx Confirms the CancelRx response is stored in the database. Sends a Verify message to the pharmacy.
Top
Integer transactionId from SendCancelRx:
GetAllRxFillsSummary Returns any outstanding pharmacy RxFill requests with summary only.
Top
GetRxFillDetail Retrieves a specific RxFill message for processing based on a unique RxFill ID.
Top
Guid transactionId from GetAllRxFillsSummary:
ConfirmRxFillReceipt Confirms the status of the Rx Fill response stored in the database. Sends an Error or Verify message to the pharmacy.
Top
Guid transactionId from GetAllRxFillsSummary:
NCPDP Status (Verify or Error):
Note:
GetAllRxChangesSummary / GetAllRxChangesSummaryV2 Returns any outstanding pharmacy Rx Change requests with summary information only.
Top
GetRxChangeDetail Retrieves a specific RxChange message for processing based on a unique RxChange ID.
Top
Guid transactionId from GetAllRxChangesSummary:
CheckRxChangeDeliveryStatus Retrieves a status of an RxChange response message based on a unique RxChange ID.
Top
Guid transactionId from GetAllRxChangesSummary:
GetRxChangeStatus Retrieves the status of an RxChange response message based on a unique RxChange ID.
Top
Guid transactionId from GetAllRxChangesSummary:
ConfirmRxChangeReceipt Confirms the status of the Rx Change response stored in the database. Sends an Error or Verify message to the pharmacy.
Top
Guid transactionId from GetAllRxChangesSummary:
NCPDP Status (Verify or Error):
Note:
SendRxChangeDenyResponse Sends the RxChange deny response to the pharmacy.

CreateRxChangeResponseApproval Determines if RxChange approve response requires Two Factor Authentication - does not send to pharmacy.

CompleteRxChangeApproval, CompleteRxChangeApprovalV2 Sends the RxChange approve response to the pharmacy.
Top
RxBatchTransactionGuid
AuthenticationType:
Passcode
GetLastPDMPReviewDateByPatient Retrieves PDMP review status for given patient and doctor.
Top
SetDrugDatabaseType
Set Drug database type F = FirstDataBank (M = Multum Deprecated)
Top
Drug database type: