EDI API defines NCPDP Telco resources for all NCPDP messages, batches, and the validation/operation result, that are represented by JSON.

NcpdpTransmission

NcpdpTransmission object represents an NCPDP Telco file. You get an array of NCPDP transmissions as part of the Read operation when translating an NCPDP file to JSON. The Read operation supports NCPDP files that contain multiple transmissions, that's why the response is an array. In most situations, the array will contain only a single item. NcpdpTransmission is intended to cater to both batches of NCPDP messages (that contain transmission header and trailer) and single messages (with or without G1). The TransmissionHeader and TransmissionTrailer segments must be present when used as a batch.

The NcpdpTransmission object can be used with the Write operation, to translate it into a NcpdpTransmission file (batch or single), and with the Validate operation, to validate that the transmission is compliant.

Endpoints

Example

{
    "TransmissionHeader": {
      "TransmissionType_1": "T",
      "SenderId_2": "NNQ02074115 FHCSERVSCORP",
      "BatchNumber_3": "2017086",
      "CreationDate_4": "20170327",
      "CreationTime_5": "1140",
      "FileType_6": "P",
      "Version_7": "12",
      "ReceiverId_8": "EMEDNYBAT               "
    },
    "Transactions": [
      {
        "G1": {
          "TransactionReferenceNumber_1": "0466917401",
          "BINNumber_2": "004740",
          "VersionReleaseNumber_3": "D0",
          "TransactionCode_4": "B1",
          "ProcessorControlNumber_5": "YRG7065NNQ",
          "TransactionCount_6": "1",
          "ServiceProviderIDQualifier_7": "05",
          "ServiceProviderID_8": "02074115       ",
          "DateOfService_9": "20151112",
          "SoftwareVendorCertificationID_10": "          "
        },
        "AM04Loop": {
          "AM04": {
            "CardholderID_C2": "DK86342S",
            "EligibilityClarificationCode_C9": "0",
            "PersonCode_C3": "001"
          },
          "AM01": {
            "DateOfBirth_C4": "19970213",
            "PatientGenderCode_C5": "1",
            "PatientFirstName_CA": "TAHIEM",
            "PatientLastName_CB": "HART"
          }
        },
        "AM07Loop": [
          {
            "AM07": {
              "PrescriptionServiceReferenceNumberQualifier_EM": "1",
              "PrescriptionServiceReferenceNumber_D2": "000005073530",
              "ProductServiceIDQualifier_E1": "03",
              "ProductServiceID_D7": "16729014912",
              "QuantityDispensed_E7": "60000",
              "FillNumber_D3": "00",
              "DaysSupply_D5": "060",
              "CompoundCode_D6": "1",
              "DispenseAsWritten_D8": "0",
              "DatePrescriptionWritten_DE": "20151112",
              "NumberOfRefillsAuthorized_DF": "00",
              "PrescriptionOriginCode_DJ": "1",
              "OtherCoverageCode_C8": "01",
              "ScheduledPrescriptionIDNumber_EK": "06KVYZ11",
              "DelayReasonCode_NV": "03"
            },
            "AM11": {
              "IngredientCostSubmitted_D9": "218G",
              "PatientPaidAmountSubmitted_DX": "0000000{",
              "UsualAndCustomaryCharge_DQ": "253G",
              "GrossAmountDue_DU": "10177E"
            },
            "AM03": {
              "PrescriberIDQualifier_EZ": "01",
              "PrescriberID_DB": "1023043676"
            },
            "AM05": {
              "CoordinationOfBenefitsOtherPaymentsCount_4C": "2",
              "C4C_02": [
                {
                  "OtherPayerCoverageType_5C": "DATA1",
                  "OtherPayerIDQualifier_6C": "DATA2",
                  "OtherPayerAmountPaidCount_HB": "2",
                  "CHB_07": [
                    {
                      "OtherPayerAmountPaidQualifier_HC": "DATA3",
                      "OtherPayerAmountPaid_DV": "DATA4"
                    },
                    {
                      "OtherPayerAmountPaidQualifier_HC": "DATA5",
                      "OtherPayerAmountPaid_DV": "DATA6"
                    }
                  ]
                },
                {
                  "OtherPayerCoverageType_5C": "DATA7",
                  "OtherPayerIDQualifier_6C": "DATA8",
                  "OtherPayerAmountPaidCount_HB": "2",
                  "CHB_07": [
                    {
                      "OtherPayerAmountPaidQualifier_HC": "DATA9",
                      "OtherPayerAmountPaid_DV": "DATA10"
                    },
                    {
                      "OtherPayerAmountPaidQualifier_HC": "DATA11",
                      "OtherPayerAmountPaid_DV": "DATA12"
                    }
                  ]
                }
              ]
            }
          }
        ],
        "Model": "EdiNation.NCPDP.TELCO.D0"
      }
    ],
    "TransmissionTrailer": {
      "BatchNumber_1": "2017086",
      "RecordCount_2": "0000000003",
      "Message_3": "                                   "
    },
    "Result": {
      "LastIndex": 9,
      "Details": [],
      "Status": "success"
    }
  }

Attributes

• TransmissionHeader TransmissionHeader object

  The transmission header. Only used when the NCPDP file is a batch.

• Transactions list of Transaction objects

  The list of transactions. This can be any type that represents a transaction which is also recognized as a model by EdiNation. Each transaction begins with a G1 segment, even if it is not included

  The following transaction models are available as System models:

  • NCPDP Telco Models
• TransmissionTrailer TransmissionTrailer object

  The transmission trailer.  Only used when the NCPDP file is a batch.

• Result OperationResult object

  The operation result.

TransmissionHeader

TransmissionHeader object is only used as part of the NcpdpTransmission object and represents the beginning of a batch. Optional for single messages.

The transmission header is positional (fixed-length), and must be present for batches only.

Example

{
      "TransmissionType_1": "T",
      "SenderId_2": "NNQ02074115 FHCSERVSCORP",
      "BatchNumber_3": "2017086",
      "CreationDate_4": "20170327",
      "CreationTime_5": "1140",
      "FileType_6": "P",
      "Version_7": "12",
      "ReceiverId_8": "EMEDNYBAT               "
}

Attributes

• TransmissionType_01 string

  The transmission type, one of T, R, or E.

• SenderId_02 string

  The agreed ID of the sender.

• BatchNumber_03 string

  Unique identifier of the batch.

• CreationDate_4 string

  The date the batch was created.

• CreationTime_5 string

  The time the batch was created.

• FileType_6 string

  The file type, production, or test.

• Version_7 string

  The version of the batch protocol.

• ReceiverId_8 string

  The agreed ID of the receiver.

TransmissionTrailer

TransmissionTrailer object is only used as part of the NcpdpTransmission object and represents the ending of a batch. Optional for single messages.

The transmission trailer is positional (fixed-length), and must be present for batches only.

Example

{
      "BatchNumber_1": "2017086",
      "RecordCount_2": "0000000003",
      "Message_3": "                                   "
}

Attributes

• BatchNumber_01 string

  Unique identifier of the batch. Must match BatchNumber_03 in the transmission header.

• RecordCount_02 string

  The number of records (transactions) in the batch.

• Message_03 string

  Optional free text.