Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
NcpdpInboundMessage This table stores the electronic prescription (eRx) messages that Soarian has received from pharmacies
Column Name Column Datatype Column Null Option Column Comment
NcpdpInboundMessageOIDBIGINTNOT NULL NCPDP(National Council for Prescription Drug Programs) Inbound Message Id(Primary key)
NcpdpMessageVARCHAR(MAX)NOT NULL NCPDP(National Council for Prescription Drug Programs)message text
NcpdpMessageTypeVARCHAR(10)NULL NCPDP(National Council for Prescription Drug Programs)Type of message(Allowable values: CANRES, RXCHG, RXFILL, REFREQ, STATUS, ERROR, VERIFY)
NcpdpMessageSubTypeVARCHAR(15)NULL NCPDP(National Council for Prescription Drug Programs)Sub-Type of message( Allowable values: Generic, Therapeutic, PriorAuth)
SoarianReceivedDateTimeDATETIMENOT NULL Local time the message was received by Soarian from HDX(Health care date exchange)
ProcessingStatusCHAR(1)NOT NULL Processing status of the inbound message(u-unprocessed, p-processed, f-failure)
HdxCorrelationIdVARCHAR(35)NOT NULL Transaction id for this message in the HDX(Health care date exchange) system
HdxTransactionDateTimeDATETIMENULL Local time the message was received by HDX(Health care date exchange) from Surescripts
ReceivedDataFormatVARCHAR(3)NULL NCPDP data format(Allowable values: xml, edi = edifact)
ProcessingOutcomeCodeVARCHAR(35)NULL Code for describing state of message after inbound processing
WorklistAllOptions: message accepted, user can prescribe or deny
DenyOnlyPonNotFound: message accepted, PON(Prescriber Order Number) not found, user can only deny
DenyOnlyPonDeactivated: message accepted, PON(Prescriber Order Number) no longer active, user can only deny
PtSearchPonNotFound: message accepted, user can deny or search for a patient
RxFailureEventIndicated: a prescription failure event should be raised
RxFailureEventRaised: a prescription failure event was successfully raised
MessageFailed: message failed with NCPDP Status code 6xx
MessageRejected: message rejected with NCPDP Status code 900
ProcessingMessagesVARCHAR(4000)NULL Descriptive errors and warnings from processing the message
PrescriberOrderNumberVARCHAR(35)NULL Prescriber Order number
MessageIDVARCHAR(35)NULL MessageId from Pharmacy
NcpdpOutboundMessageOIDBIGINTNULL Identifier of previous message.(This is the message identifier of the previous message as seen by the receiving pharmacy)
HdxRelatesToMessageIdVARCHAR(35)NULL Identifier of previous message
NotUsed_BatchIdVARCHAR(35)NULL Deprecated column. The BatchId used in pulling eRenews from HDX(Health data Exchange). This is no longer used once the new push model processing is used.
RxReferenceNumberVARCHAR(35)NULL The prescription number assigned by the pharmacy
PrescriberSPIVARCHAR(35)NULL Receiving prescriber's Surescripts Provider Identifier(SPI)
PrescriberStaffOIDINTNULL Prescriber's staff Identification number
ForwardedStaffOIDINTNULL Staff id for forwarded provider used when a Soarian Clinicals user forwards the message to another prescriber
PatientOIDINTNULL Patient identifier determined by Prescriber Order Number lookup to determine the subject of this message, or by manually identifying the patient
PatientOIDResolvingUserOIDINTNULL This is the user who manually resolved patient or confirmed name discrepancy
PatientOIDResolvingUserNameVARCHAR(12)NULL User name of person who manually resolved patient
PatientOIDResolvingDateTimeDATETIMENULL Date time the patient was resolved either by PON(Prescriber Order Number) or manually
PatientFirstNameInMessageVARCHAR(35)NULL First name of patient in incoming NCPDP Message, used in secondary patient verification check
PatientLastNameInMessageVARCHAR(35)NULL Last name of patient in incoming NCPDP Message for secondary check
PatientMiddleNameInMessageVARCHAR(35)NULL Middle name of patient in incoming NCPDP Message for secondary check
PatientDateOfBirthInMessageDATETIMENULL Patient date of birth
PatientGenderInMessageVARCHAR(3)NULL Patient gender in incoming NCPDP Message.(Allowable values M = Male, F = Female, U = Unknown )
PrescriberLastNameInMessageVARCHAR(35)NULL Prescriber's last name
PrescriberFirstNameInMessageVARCHAR(35)NULL Prescriber's first name
PrescriberMiddleNameInMessageVARCHAR(35)NULL Prescriber's middle name
PrescriberNpiInMessageVARCHAR(35)NULL Prescriber's NPI(National Provider Identifier) in message
PrescriberDeaInMessageVARCHAR(35)NULL Prescriber's DEA(Drug Enforcement Administration) in message
PrescribedDrugDescriptionVARCHAR(105)NULL Drug description
PatientNameConfirmationVARCHAR(8)NULL SUCCESS: name mismatch accepted by user in secondary check, RESOLVED: patient oid resolved by user, FAILED: name mismatch rejected by user in secondary check, NULL: name not explicitly confirmed, run secondary checks
SendingPharmacyNcpdpIdVARCHAR(7)NULL Unique identifier of sending United States pharmacy
SendingPharmacyNpiVARCHAR(35)NULL NPI(National Provider Identifier) of sending United State pharmacy
SendingPharmacyTypeVARCHAR(8)NULL Sending pharmacy type: MAIL, RETAIL; NULL is unidentified
SendingPharmacySupportsEpcsSMALLINTNULL Indicates if Pharmacy supports ePrescrption of controlled substance( Allowable values: 1- sending pharmacy supports electronic prescription of controlled substances; 0- does not support; NULL- unknown )
RoutedMedScuiVARCHAR(32)NULL KDI(Knowledge Data Infrastructure) scui(concept unique identifier) for the routed med(part of triplet + brand)
StrengthScuiVARCHAR(32)NULL KDI(Knowledge Data Infrastructure) scui(concept unique identifier) for the med strength(part of triplet + brand)
DoseFormScuiVARCHAR(32)NULL KDI(Knowledge Data Infrastructure) scui(concept unique identifier) for the med dose form(part of triplet + brand)
BrandNameScuiVARCHAR(32)NULL KDI(Knowledge Data Infrastructure) scui(concept unique identifier) for the med brand name(part of triplet + brand). Only present if med in NCPDP message is a branded med.
PatientPrescriptionHistoryOIDINTNULL Foreign key to PatientPrescriptionHistory if Prescriber Order Number lookup succeeds
PrescribedUnitDescriptionVARCHAR(255)NULL Translated FMT(Federal Medication Terminologies) Potency Unit Code
DispensedUnitDescriptionVARCHAR(255)NULL Translated FMT(Federal Medication Terminologies) Potency Unit Code
MrcMedicationOIDBIGINTNULL Foreign key medication identifier of the originally prescribed medication as determined by Prescriber Order Number lookup
PrescriptionVisitOIDINTNULL Foreign key to the visit of the originally prescribed medication as determined by Prescriber Order Number lookup
SentenceIDVARCHAR(25)NULL SentenceID of the originally prescribed medication as determined by Prescriber Order Number lookup
ResponseStatusVARCHAR(3)NULL Indicated whether the pharmacy accepted or rejected the request(A: approved, D: denied; null: unknown)
ResponseReasonCodeVARCHAR(3)NULL Coded reason given by the pharmacy for the response
ResponseNoteVARCHAR(70)NULL Free text response note from the pharmacy
XmlDocStorageOIDINTNULL The originating XmlDocStorage med list as determined by PrescriberOrderNumber lookup
LastCngDTimeDATETIMENOT NULL Last Updated Date Time( EA/DSS(UTC) - Current Universal Time Coordinate or Greenwich Mean Time)
LastCngSeqNoINTNOT NULL Last change sequence number
RecievedDataNcpdpVersionVARCHAR(10)NULL NCPDP(National Council for Prescription Drug Programs) Version of Message received
SoarianSynchronousResponseCodeVARCHAR(10)NULL Code indicating initial synchronous response to HDX(Health Data Exchange)
FollowUpRequestCountSMALLINTNULL Follow Up Request Count indicating that this message is a follow-up to a previously received message
PrescriberAuthorizationCodesVARCHAR(32)NULL Used in Prescription Change Request transactions. Contains comma delimited list of up to 10 digit codes
RealWorldTestingTransactionStatusVARCHAR(10)NULL Allowable values Success, Failure, Unknown.
RealWorldTestingTransactionInformationVARCHAR(max)NULL Transaction, exception, and processing information from HDX and Surescripts related to the success or failure of a transaction.
VisitTypeCodeVARCHAR(30)NULL Internal code of the visit type. Allowable values IP(Inpatient), OP(Outpatient), EOP(Emergency Outpatient).

Return to Table-Index

  Soarian Clinicals Schema Documentation  
Copyright © 2023, Oracle and/or its affiliates