Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
NcpdpOutboundMessage This table stores the message information for electronic prescriptions sent from Soarian.
Column Name Column Datatype Column Null Option Column Comment
NcpdpOutboundMessageOIDBIGINTNOT NULL Primary key for this table
SoarianOutboundMessageTypeVARCHAR(20)NOT NULL Indicates the type of outbound message(Renew: APPROV, CHANGE, DENIED, DNTFD, DNTFN; Change CHG_APPROV, CHG_CHANGE, CHG_DENY, CHG_DCN_DENY, CHG_DCN_CANRX, CHG_DCN_NEWRX; Cancel: CANRX; Other: NEWRX)
NcpdpMessageVARCHAR(MAX)NOT NULL NCPDP(National Council for Prescription Drug Programs) outbound message
NcpdpMessageTypeVARCHAR(6)NULL NCPDP(National Council for Prescription Drug Programs) outbound type in NCPDP terminology
TransmissionSentDateTimeDATETIMENOT NULL Local time when the message was sent out by Soarian Clinicals
TransmissionSequenceOIDBIGINTNULL Identifies sequences of one or more messages(a single NEWRX has one row with this oid; a DENY-CANCEL-NEW sequence has three)
TransactionDurationMsINTNULL Time(in milliseconds) it takes to send transaction to HDX(Healthcare Data Exchange)
HdxOutboundTransactionIdVARCHAR(20)NULL Transaction id of this transmission via HDX(Healthcare Data Exchange)
TransmissionStatusVARCHAR(7)NOT NULL Transmission status of the outbound message(Sent in transit, Success received by ultimate receiver, Failed)
TransmissionStatusCodeVARCHAR(20)NULL Last Status code from hdx or surescripts(HDX: HXERX000-HXERXnnn; surescripts 000, 010, 6xx, 900 STS status codes )
TransmissionStatusUpdateDateTimeDATETIMENULL Most recent time when system processed a status/error/verify message for this outbound message.
TransmissionFailureInformationVARCHAR(4000)NULL Descriptive errors from transmitting the message
TransmittedDataFormatVARCHAR(3)NULL NCPDP(National Council for Prescription Drug Programs) data format(xml, edi = edifact)
SendingProviderSPIVARCHAR(35)NOT NULL SPI Number(Surescripts Prescriber ID) for sending provider within ncpdp transaction. In proxy case, it will be original request provider spi
StaffOIDINTNOT NULL ObjectId of staff who generated this outbound transaction
StaffNameVARCHAR(187)NOT NULL Name of staff who generated this outbound transaction
UserOIDINTNOT NULL ObjectId of user who generated this outbound transaction
UserNameVARCHAR(12)NOT NULL Username of user who generated this outbound transaction
EntityOIDINTNULL EnitiyOID of the user who produced this outbound transaction
PatientOIDINTNULL Patient object id - identified by looking up the PrescriberOrderNumber to find the patient that is the subject of this message, or by manually identifying the patient. Can be null if patient is unknown.
PatientVisitOIDINTNULL Patient visit object id, References to HPatienvisit table
NcpdpInboundMessageOIDBIGINTNULL Foreign key to InboundNCPDPMessage table
InboundMsgPrescriberStaffOIDINTNULL Prescriber staff oid for related ncpdp inbound message
InboundMsgHdxCorrelationIdVARCHAR(35)NULL CorrelationId in transaction sent to HDX(echo the inbound msg correlation id for response sequences; otherwise leave null)
HdxRelatesToMessageIdVARCHAR(35)NULL The hdxTransactionId of the previous message in a sequence
InboundMsgRxReferenceNumberVARCHAR(35)NULL The prescription number assigned by the pharmacy from UIH-020(EdiFact reference), carried over from ncdp inbound message
PrescriberOrderNumberVARCHAR(35)NULL Prescriber ordering transactions sent to HDX
PrescriberOrderNumberStatusTINYINTNULL Status of prescriber order number(0 inactive, 1 active)
PonDeactivatedDateTimeDATETIMENULL Local time when prescriber order number was deactivated
PonDeactivatedNcpdpOutboundMessageOIDBIGINTNULL Foreign key of the outbound message that deactivated the PON(Prescriber Order Number). Null if the eRx was simply removed with no cancel message.
PonDeactivatedUserOIDINTNULL User OID of user who deactivated the PON(Prescriber Order Number)
SoarianToHDXRequestIdVARCHAR(20)NULL Request id from soarian to hdx, part of web service context, not in ncpdp
SoarianTransientMessageIDVARCHAR(35)NULL Message ID used in ncpdp outbound msg for traceability. Not globally unique, therefore HDX replaces this field with hdxTransactionId in the message to surescripts.
PrescriptionSignatureOIDBIGINTNULL Reference oid for NCPDP response message's signature signed by private key
EPrescriberSAMLSignatureXMLNULL Column holding the digital signature in case this document contains electronically prescribed controlled substances
DenyReasonVARCHAR(70)NULL Reason for Denied or DNTF(Denied New To Follow)
DenyReasonCodeVARCHAR(3)NULL Reason code for Denied or DNTF(Denied New To Follow)( Allowable values: AE,AO,AM,AB,AC,AF,AA,AN,AP)
WorklistDocumentXmlTypeVARCHAR(20)NULL Type of document xml from worklist. Null if not a worklist Rx. Erenew: UsePML, NewMed. TBD for RXCHG: UseReqMedRxC, NewMedRxC
WorklistDocumentXmlXMLNULL Widget xml for ncpdp outbound message created in the Pharmacy worklist
WorklistItemRemovedDateTimeDATETIMENULL Local time the item was removed from the worklist
WorklistItemRemovedUserOidINTNULL User who removed the item from the worklist
WorklistItemRemovedNoteVARCHAR(400)NULL Comments entered by the user when removing the item from the worklist
XmlDocStorageOIDINTNULL Foreign key to the XmlDocStorage med list that was displayed when this message was sent
PharmacyOIDINTNULL Pharmacy table object id
RecipientNcpdpIdInMessageVARCHAR(35)NULL Ncpdp ID of the pharmacy
PharmacyRoleVARCHAR(6)NULL Allowable value: MAIL, RETAIL
QuantityVARCHAR(300)NULL Prescription quantity
RefillsVARCHAR(300)NULL Refills quantity
DispensingUnitFmtCodeVARCHAR(10)NULL National Cancer Institute Thesaurus code(NCIt code; formerly known as Federal Medication Terminologies(FMT) code) for the prescription quantity unit of measure(QUOM)
DispensingUnitFmtDescVARCHAR(50)NULL National Cancer Institute Thesaurus(NCIt) description for the prescription quantity unit of measure(QUOM)
DrugDescriptionVARCHAR(105)NULL Name, strength, and dose form of the prescribed medication
TransmittedViaApiVersionVARCHAR(10)NULL The HDX api that was used to transmit the message( 'MU2' = sendPrescriptionService, sendPrescriptionRenewalResponse; 'MU3' = outboundMessage for edifact e-prescritpions, 'HDX2017' = outboundMessage for xml e-prescriptions)
LastCngDTimeDATETIMENOT NULL Last Updated Date Time EA/DSS(UTC)
LastCngSeqNoINTNOT NULL Last change sequence number, starts at 1; used for optimistic updates
DaysSupplySMALLINTNULL Days Supply for a medication(e.g. '1')
NcpdpMessageVersionVARCHAR(10)NULL Version of eRx being used, 10.6, 2017 071
SentenceIDVARCHAR(25)NULL SentenceID of any new prescription in this message
ResponseTypeProcessingMessagesVARCHAR(4000)NULL Change Response/Refill Response: Human readable Messages that show why the response is an Approve or Approve with Changes
PharmacyNcpdpVersionVARCHAR(10)NULL Ncpdp Version of target Pharmacy at time of message being sent
HdxSynchronousResponseCodeVARCHAR(10)NULL Code indicating the initial synchronous response from HDX(Healthcare Data Exchange)
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