HL7Validator Class

Properties   Methods   Events   Config Settings   Errors  

HL7Validator is a lightweight EDI validation class designed for simple document validation.

Class Name

IPWorksEDITranslator_HL7Validator

Procedural Interface

 ipworkseditranslator_hl7validator_open();
 ipworkseditranslator_hl7validator_close($res);
 ipworkseditranslator_hl7validator_register_callback($res, $id, $function);
 ipworkseditranslator_hl7validator_get_last_error($res);
 ipworkseditranslator_hl7validator_get_last_error_code($res);
 ipworkseditranslator_hl7validator_set($res, $id, $index, $value);
 ipworkseditranslator_hl7validator_get($res, $id, $index);
 ipworkseditranslator_hl7validator_do_compileschema($res, $xsdschema, $binschema);
 ipworkseditranslator_hl7validator_do_config($res, $configurationstring);
 ipworkseditranslator_hl7validator_do_displayschemainfo($res);
 ipworkseditranslator_hl7validator_do_displayxmlinfo($res);
 ipworkseditranslator_hl7validator_do_flush($res);
 ipworkseditranslator_hl7validator_do_loadschema($res, $filename);
 ipworkseditranslator_hl7validator_do_reset($res);
 ipworkseditranslator_hl7validator_do_validate($res);

Remarks

This component provides a simple way to validate an EDI document and obtain details about any validation errors.

EDI Validation

Before calling Validate set SchemaFormat and call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the class depends largely on the schema's definition.

When the Validate method is called the class will attempt to validate the document. If errors are found during validation the ValidationError event will fire with details about each error as it is encountered. After the document has been validated the ValidationErrors property will be populated with details of each error.

Inspect the ValidationErrors property for information on any errors that were encountered.

Validation Example validator.InputFile = "files/EDIDocuments/MyEDIDoc.txt"; validator.LoadSchema("my_schemas/00501/RSSBus_005010X222A1_837.json"); validator.Validate(); foreach (ValidationErrorDetail error in validator.ValidationErrors) { Console.WriteLine(error.ErrorCode + ": " + error.Message); }

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

EDIStandardVersion Property (IPWorksEDITranslator_HL7Validator Class)

The version of the EDI specification.

Object Oriented Interface

public function getEDIStandardVersion();

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 1 );

Default Value

''

Remarks

This property will be populated after parsing begins and the correct version string for is located via the schema, such as 004010 for X12.

This property is read-only and not available at design time.

Data Type

String

InputData Property (IPWorksEDITranslator_HL7Validator Class)

The data to parse.

Object Oriented Interface

public function getInputData();


public function setInputData($value);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 2 );


ipworkseditranslator_hl7validator_set($res, 2, $value );

Default Value

''

Remarks

This property specifies the data to be parsed.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

When a valid source is found the search stops.

Data Type

String

InputFile Property (IPWorksEDITranslator_HL7Validator Class)

The file to parse.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 3 );


ipworkseditranslator_hl7validator_set($res, 3, $value );

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

When a valid source is found the search stops.

This property is not available at design time.

Data Type

String

SchemaFormat Property (IPWorksEDITranslator_HL7Validator Class)

The format of the schema file.

Object Oriented Interface

public function getSchemaFormat();


public function setSchemaFormat($value);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 4 );


ipworkseditranslator_hl7validator_set($res, 4, $value );

Default Value

0

Remarks

Set SchemaFormat before calling the LoadSchema method to specify the loading schema format.

The following schema formats are supported:

Data Type

Integer

ValidationErrorCount Property (IPWorksEDITranslator_HL7Validator Class)

The number of records in the ValidationError arrays.

Object Oriented Interface

public function getValidationErrorCount();

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 5 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ValidationErrorColumn
• ValidationErrorElementErrorCode
• ValidationErrorElementPosition
• ValidationErrorErrorCode
• ValidationErrorLine
• ValidationErrorMessage
• ValidationErrorSegmentErrorCode
• ValidationErrorSegmentNumber
• ValidationErrorSegmentTag
• ValidationErrorTechnicalErrorCode

The array indices start at 0 and end at ValidationErrorCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorColumn Property (IPWorksEDITranslator_HL7Validator Class)

The column number in the EDI document where the error occurred.

Object Oriented Interface

public function getValidationErrorColumn($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 6 , $validationerrorindex);

Default Value

0

Remarks

The column number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorLine property to determine the exact location within the EDI document where the error occurred.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorElementErrorCode Property (IPWorksEDITranslator_HL7Validator Class)

The error code which may be used in the IK403 property of a 999.

Object Oriented Interface

public function getValidationErrorElementErrorCode($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 7 , $validationerrorindex);

Default Value

''

Remarks

The error code which may be used in the IK403 field of a 999.

Note: This property is specific to X12 documents and is not applicable to other document types.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorElementPosition Property (IPWorksEDITranslator_HL7Validator Class)

This property holds the position of the element where the error occurred.

Object Oriented Interface

public function getValidationErrorElementPosition($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 8 , $validationerrorindex);

Default Value

0

Remarks

This property holds the position of the element where the error occurred.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorErrorCode Property (IPWorksEDITranslator_HL7Validator Class)

The ErrorCode property contains the type of error encountered.

Object Oriented Interface

public function getValidationErrorErrorCode($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 9 , $validationerrorindex);

Default Value

0

Remarks

The ValidationErrorErrorCode property contains the type of error encountered. Possible values are:

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorLine Property (IPWorksEDITranslator_HL7Validator Class)

The line number in the EDI document where the error occurred.

Object Oriented Interface

public function getValidationErrorLine($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 10 , $validationerrorindex);

Default Value

0

Remarks

The line number in the EDI document where the error occurred. This value may be used in conjunction with the ValidationErrorColumn property to determine the exact location within the EDI document where the error occurred.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorMessage Property (IPWorksEDITranslator_HL7Validator Class)

Message is a textual description of the error.

Object Oriented Interface

public function getValidationErrorMessage($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 11 , $validationerrorindex);

Default Value

''

Remarks

ValidationErrorMessage is a textual description of the error.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorSegmentErrorCode Property (IPWorksEDITranslator_HL7Validator Class)

The error code which may be used in the IK304 property of a 999.

Object Oriented Interface

public function getValidationErrorSegmentErrorCode($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 12 , $validationerrorindex);

Default Value

''

Remarks

The error code which may be used in the IK304 field of a 999.

Note: This property is specific to X12 documents and is not applicable to other document types.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorSegmentNumber Property (IPWorksEDITranslator_HL7Validator Class)

This property is the index of the segment where the error occurred.

Object Oriented Interface

public function getValidationErrorSegmentNumber($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 13 , $validationerrorindex);

Default Value

0

Remarks

This property is the index of the segment where the error occurred.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorSegmentTag Property (IPWorksEDITranslator_HL7Validator Class)

This property specifies the tag name of the segment where the error occurred.

Object Oriented Interface

public function getValidationErrorSegmentTag($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 14 , $validationerrorindex);

Default Value

''

Remarks

This property specifies the tag name of the segment where the error occurred.

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorTechnicalErrorCode Property (IPWorksEDITranslator_HL7Validator Class)

This property holds a technical error code that helps identify structural issues with the document.

Object Oriented Interface

public function getValidationErrorTechnicalErrorCode($validationerrorindex);

Procedural Interface

ipworkseditranslator_hl7validator_get($res, 15 , $validationerrorindex);

Default Value

''

Remarks

This property holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes.

Note: This property is specific to X12 documents and is not applicable to other document types.

Possible values are:

The $validationerrorindex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

CompileSchema Method (IPWorksEDITranslator_HL7Validator Class)

Compiles an existing XSD schema into an optimized binary representation.

Object Oriented Interface

public function doCompileSchema($xsdschema, $binschema);

Procedural Interface

ipworkseditranslator_hl7validator_do_compileschema($res, $xsdschema, $binschema);

Remarks

This method parses XsdSchema and generates an optimized binary representation that is saved into the path referenced by BinSchema. Binary schemas are smaller and require less resources when loading later using LoadSchema

If the schema file does not exists or cannot be parsed as an EDI schema, the component throws an exception.

Config Method (IPWorksEDITranslator_HL7Validator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkseditranslator_hl7validator_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DisplaySchemaInfo Method (IPWorksEDITranslator_HL7Validator Class)

Returns a string showing the structure of the schema defining the document.

Object Oriented Interface

public function doDisplaySchemaInfo();

Procedural Interface

ipworkseditranslator_hl7validator_do_displayschemainfo($res);

Remarks

After calling LoadSchema this may be called to obtain information about the structure of the schema defining the document. If the desired XPath is not known this helps determine the structure so that the correct XPath can be built.

Note: A valid schema must be loaded via LoadSchema.

For instance: Console.WriteLine(component.DisplaySchemaInfo()); Will output text like:

UNH[0,1]
  BGM[0,1]
  DTM[0,35]
  PAI[0,1]
  ALI[0,5]
  IMD[0,1]
  FTX[0,10]
  LOC[0,10]
  GIS[0,10]
  DGS[0,1]
  RFFLoop1[0,99]
    RFF[0,1]
    DTM_2[0,5]
    GIR[0,5]
    LOC_2[0,2]
    MEA[0,5]
    QTY[0,2]
    FTX_2[0,5]
    MOA[0,2]
  NADLoop1[0,99]
    NAD[0,1]
    LOC_3[0,25]
    FII[0,5]
    RFFLoop2[0,9999]
      RFF_2[0,1]
      DTM_3[0,5]
    DOCLoop1[0,5]
      DOC[0,1]
      DTM_4[0,5]
    CTALoop1[0,5]
      CTA[0,1]
      COM[0,5]
  TAXLoop1[0,5]
    TAX[0,1]
    MOA_2[0,1]
    LOC_4[0,5]
  CUXLoop1[0,5]
    CUX[0,1]
    DTM_5[0,5]
  PATLoop1[0,10]
    PAT[0,1]
    DTM_6[0,5]
    PCD[0,1]
    MOA_3[0,1]
    PAI_2[0,1]
    FII_2[0,1]
  TDTLoop1[0,10]
    TDT[0,1]
    TSR[0,1]
    LOCLoop1[0,10]
      LOC_5[0,1]
      DTM_7[0,5]
    RFFLoop3[0,9999]
      RFF_3[0,1]
      DTM_8[0,5]
  TODLoop1[0,5]
    TOD[0,1]
    LOC_6[0,2]
  PACLoop1[0,1000]
    PAC[0,1]
    MEA_2[0,5]
    EQD[0,1]
    PCILoop1[0,5]
      PCI[0,1]
      RFF_4[0,1]
      DTM_9[0,5]
      GIN[0,5]
  ALCLoop1[0,9999]
    ALC[0,1]
    ALI_2[0,5]
    FTX_3[0,1]
    RFFLoop4[0,5]
      RFF_5[0,1]
      DTM_10[0,5]
    QTYLoop1[0,1]
      QTY_2[0,1]
      RNG[0,1]
    PCDLoop1[0,1]
      PCD_2[0,1]
      RNG_2[0,1]
    MOALoop1[0,2]
      MOA_4[0,1]
      RNG_3[0,1]
      CUX_2[0,1]
      DTM_11[0,1]
    RTELoop1[0,1]
      RTE[0,1]
      RNG_4[0,1]
    TAXLoop2[0,5]
      TAX_2[0,1]
      MOA_5[0,1]
  RCSLoop1[0,100]
    RCS[0,1]
    RFF_6[0,5]
    DTM_12[0,5]
    FTX_4[0,5]
  AJTLoop1[0,1]
    AJT[0,1]
    FTX_5[0,5]
  INPLoop1[0,1]
    INP[0,1]
    FTX_6[0,5]
  LINLoop1[0,9999999]
    LIN[0,1]
    PIA[0,25]
    IMD_2[0,10]
    MEA_3[0,5]
    QTY_3[0,5]
    PCD_3[0,1]
    ALI_3[0,5]
    DTM_13[0,35]
    GIN_2[0,1000]
    GIR_2[0,1000]
    QVR[0,1]
    EQD_2[0,1]
    FTX_7[0,5]
    DGS_2[0,1]
    MOALoop2[0,10]
      MOA_6[0,1]
      CUX_3[0,1]
    PATLoop2[0,10]
      PAT_2[0,1]
      DTM_14[0,5]
      PCD_4[0,1]
      MOA_7[0,1]
    PRILoop1[0,25]
      PRI[0,1]
      CUX_4[0,1]
      APR[0,1]
      RNG_5[0,1]
      DTM_15[0,5]
    RFFLoop5[0,10]
      RFF_7[0,1]
      DTM_16[0,5]
    PACLoop2[0,10]
      PAC_2[0,1]
      MEA_4[0,10]
      EQD_3[0,1]
      PCILoop2[0,10]
        PCI_2[0,1]
        RFF_8[0,1]
        DTM_17[0,5]
        GIN_3[0,10]
    LOCLoop2[0,9999]
      LOC_7[0,1]
      QTY_4[0,100]
      DTM_18[0,5]
    TAXLoop3[0,99]
      TAX_3[0,1]
      MOA_8[0,1]
      LOC_8[0,5]
    NADLoop2[0,99]
      NAD_2[0,1]
      LOC_9[0,5]
      RFFLoop6[0,5]
        RFF_9[0,1]
        DTM_19[0,5]
      DOCLoop2[0,5]
        DOC_2[0,1]
        DTM_20[0,5]
      CTALoop2[0,5]
        CTA_2[0,1]
        COM_2[0,5]
    ALCLoop2[0,30]
      ALC_2[0,1]
      ALI_4[0,5]
      DTM_21[0,5]
      FTX_8[0,1]
      QTYLoop2[0,1]
        QTY_5[0,1]
        RNG_6[0,1]
      PCDLoop2[0,1]
        PCD_5[0,1]
        RNG_7[0,1]
      MOALoop3[0,2]
        MOA_9[0,1]
        RNG_8[0,1]
        CUX_5[0,1]
        DTM_22[0,1]
      RTELoop2[0,1]
        RTE_2[0,1]
        RNG_9[0,1]
      TAXLoop4[0,5]
        TAX_4[0,1]
        MOA_10[0,1]
    TDTLoop2[0,10]
      TDT_2[0,1]
      LOCLoop3[0,10]
        LOC_10[0,1]
        DTM_23[0,5]
    TODLoop2[0,5]
      TOD_2[0,1]
      LOC_11[0,2]
    RCSLoop2[0,100]
      RCS_2[0,1]
      RFF_10[0,5]
      DTM_24[0,5]
      FTX_9[0,5]
    GISLoop1[0,10]
      GIS_2[0,1]
      RFF_11[0,1]
      DTM_25[0,5]
      GIR_3[0,5]
      LOC_12[0,2]
      MEA_5[0,5]
      QTY_6[0,2]
      FTX_10[0,5]
      MOA_11[0,2]
  UNS[0,1]
  CNT[0,10]
  MOALoop4[0,100]
    MOA_12[0,1]
    RFFLoop7[0,1]
      RFF_12[0,1]
      DTM_26[0,5]
  TAXLoop5[0,10]
    TAX_5[0,1]
    MOA_13[0,2]
  ALCLoop3[0,15]
    ALC_3[0,1]
    ALI_5[0,1]
    MOA_14[0,2]
    FTX_11[0,1]
  UNT[0,1]

DisplayXMLInfo Method (IPWorksEDITranslator_HL7Validator Class)

Returns a string showing the structure of the parsed document as XML.

Object Oriented Interface

public function doDisplayXMLInfo();

Procedural Interface

ipworkseditranslator_hl7validator_do_displayxmlinfo($res);

Remarks

After the EDI document has been parsed this method may be called to obtain information about the document structure. The parsed data is represented as XML when queried. This shows all parsed data and may be useful for testing and debugging purposes. For instance: Console.WriteLine(component.DisplayXMLInfo()); Will output text like:

<IX tag="UNB" UNB1="UNOB:1" UNB2="WAYNE_TECH" UNB3="ACME" UNB4="160707:1547" UNB5="000000002" UNB6="" UNB7="1234" UNB8="" UNB9="" UNB10="" UNB11="1">
  <TX tag="UNH" UNH1="509010117" UNH2="INVOIC:D:97A:UN">
    <BGM tag="BGM" BGM01="380:::TAX INVOICE" BGM02="0013550417" BGM03="9"/>
    <DTM tag="DTM" DTM01="3:20070926:102"/>
    <DTM tag="DTM" DTM01="4:20061123:102"/>
    <FTX tag="FTX" FTX01="AAI" FTX02="1"/>
    <TAXLoop1>
      <TAX tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::10072.14" TAX06="S"/>
    </TAXLoop1>
    <CUXLoop1>
      <CUX tag="CUX" CUX01="2:EUR:4" CUX02="" CUX03="0.67529"/>
    </CUXLoop1>
    <PATLoop1>
      <PAT tag="PAT" PAT01="1"/>
      <DTM_6 tag="DTM" DTM01="10:20070926:102"/>
      <PCD tag="PCD" PCD01="2:0:13"/>
    </PATLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000030" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2265S13:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766832002:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:50.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:19150.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:383.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:19150.45"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.45" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.45"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000040" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F22:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254078241:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:20.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:21060.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:1053.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:21060.50"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.50" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.50"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000170" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F10:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254078326:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:10.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:6950.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:695.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:6950.16"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.16" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.16"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000190" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F26:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254051190:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:5.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:2375.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:475.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:2375.06"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.06" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.06"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000200" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2265S24:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766000685:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:957.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:319.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:957.02"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.02" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.02"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000210" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2263T95:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5029766699575:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:2085.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:695.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:2085.05"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.05" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.05"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <LINLoop1>
      <LIN tag="LIN" LIN01="000250" LIN02=""/>
      <PIA tag="PIA" PIA01="1" PIA02="2269F15:BP::92"/>
      <PIA tag="PIA" PIA01="1" PIA02="5051254080091:UP::92"/>
      <IMD_2 tag="IMD" IMD01="F" IMD02=""/>
      <QTY_3 tag="QTY" QTY01="47:3.000:EA"/>
      <DTM_13 tag="DTM" DTM01="11:20070926:102"/>
      <MOALoop2>
        <MOA_6 tag="MOA" MOA01="203:4977.00"/>
      </MOALoop2>
      <PRILoop1>
        <PRI tag="PRI" PRI01="INV:1659.00:TU"/>
      </PRILoop1>
      <TAXLoop3>
        <TAX_3 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
        <MOA_8 tag="MOA" MOA01="125:4977.12"/>
      </TAXLoop3>
      <ALCLoop2>
        <ALC_2 tag="ALC" ALC01="C" ALC02="0.12" ALC03="" ALC04="" ALC05="FC"/>
        <MOALoop3>
          <MOA_9 tag="MOA" MOA01="8:0.12"/>
        </MOALoop3>
      </ALCLoop2>
    </LINLoop1>
    <UNS tag="UNS" UNS01="S"/>
    <CNT tag="CNT" CNT01="4:7"/>
    <MOALoop4>
      <MOA_12 tag="MOA" MOA01="9:67627.50"/>
    </MOALoop4>
    <MOALoop4>
      <MOA_12 tag="MOA" MOA01="79:57554.00"/>
    </MOALoop4>
    <TAXLoop5>
      <TAX_5 tag="TAX" TAX01="7" TAX02="VAT" TAX03="" TAX04="" TAX05=":::17.500" TAX06="S"/>
      <MOA_13 tag="MOA" MOA01="125:57555.36:EUR:3"/>
      <MOA_13 tag="MOA" MOA01="124:10072.14:EUR:3"/>
    </TAXLoop5>
    <ALCLoop3>
      <ALC_3 tag="ALC" ALC01="C" ALC02="1.36" ALC03="" ALC04="" ALC05="FC"/>
      <MOA_14 tag="MOA" MOA01="8:1.36"/>
    </ALCLoop3>
  </TX>
</IX>

Flush Method (IPWorksEDITranslator_HL7Validator Class)

Flushes the parser and checks its end state.

Object Oriented Interface

public function doFlush();

Procedural Interface

ipworkseditranslator_hl7validator_do_flush($res);

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state.

Any extra un-parsed data will be populated in the ExtraData property after this method is called.

LoadSchema Method (IPWorksEDITranslator_HL7Validator Class)

Loads a schema file describing a Transaction Set.

Object Oriented Interface

public function doLoadSchema($filename);

Procedural Interface

ipworkseditranslator_hl7validator_do_loadschema($res, $filename);

Remarks

This method parses the File and loads it into an internal schema list. The class will attempt to automatically detect the SchemaFormat.

If the schema file does not exist or cannot be parsed as an EDI schema, the class fails with an error.

Reset Method (IPWorksEDITranslator_HL7Validator Class)

Resets the parser.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkseditranslator_hl7validator_do_reset($res);

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Validate Method (IPWorksEDITranslator_HL7Validator Class)

Validates the specified EDI document.

Object Oriented Interface

public function doValidate();

Procedural Interface

ipworkseditranslator_hl7validator_do_validate($res);

Remarks

This method validates the EDI document specified by InputFile or InputData.

Before calling Validate set SchemaFormat and call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the class depends largely on the schema's definition.

When the Validate method is called the class will attempt to validate the document. If errors are found during validation the ValidationError event will fire with details about each error as it is encountered. After the document has been validated the ValidationErrors property will be populated with details of each error.

Inspect the ValidationErrors property for information on any errors that were encountered.

Validation Example validator.InputFile = "files/EDIDocuments/MyEDIDoc.txt"; validator.LoadSchema("my_schemas/00501/RSSBus_005010X222A1_837.json"); validator.Validate(); foreach (ValidationErrorDetail error in validator.ValidationErrors) { Console.WriteLine(error.ErrorCode + ": " + error.Message); }

EndFunctionalGroup Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the end of an interchange.

Object Oriented Interface

public function fireEndFunctionalGroup($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 1, array($this, 'fireEndFunctionalGroup'));

Parameter List

 'tag'
 'controlnumber'
 'count'
 'fullsegment'

Remarks

The EndFunctionalGroup event will fire when a control segment marking the end of a functional group is read. The Tag parameter contains the tag of the segment, such as GE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartFunctionalGroup event. Count contains the value of the count element included in the closing segment, which identifies the number of transactions in a functional group.

EndInterchange Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the end of an interchange.

Object Oriented Interface

public function fireEndInterchange($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 2, array($this, 'fireEndInterchange'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

Remarks

The EndInterchange event will fire when a control segment marking the end of an interchange is read. The Tag parameter contains the tag of the segment, such as IEA. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartInterchange event.

EndLoop Event (IPWorksEDITranslator_HL7Validator Class)

Fires when the end of a loop is detected in a transaction set.

Object Oriented Interface

public function fireEndLoop($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 3, array($this, 'fireEndLoop'));

Parameter List

Remarks

The EndLoop event will fire after the last segment in a loop is read. Each EndLoop event is paired with one StartLoop event.

EndTransaction Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the end of a transaction.

Object Oriented Interface

public function fireEndTransaction($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 4, array($this, 'fireEndTransaction'));

Parameter List

 'tag'
 'controlnumber'
 'count'
 'fullsegment'

Remarks

The EndTransaction event will fire when a control segment marking the end of a transaction is read. The Tag parameter contains the tag of the segment, such as SE. ControlNumber contains the control number associated with the segment, and links this event with the corresponding StartTransaction event. Count contains the value of the count element included in the closing segment, which identifies the number of segments in a transaction set.

Error Event (IPWorksEDITranslator_HL7Validator Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ResolveSchema Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a new transaction set is encountered and no schema is found for it.

Object Oriented Interface

public function fireResolveSchema($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 6, array($this, 'fireResolveSchema'));

Parameter List

 'transactioncode'
 'standardversion'

Remarks

The ResolveSchema event will fire when a the class encounters the header segment of a new transaction set, but it finds no schema corresponding to it already loaded.

TransactionCode contains the code of the transaction, such as "810" or "APERAK".

StandardVersion contains the version of the transaction, such as "004010" or "D95A".

When processing this event, the caller can use LoadSchema() to load a new schema into the class that can be used to parse the transaction.

After the event fires, if the class still doesn't have a matching schema, then it will attempt schema-less parsing of the transaction set.

Segment Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a data segment in a transaction set is read.

Object Oriented Interface

public function fireSegment($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 7, array($this, 'fireSegment'));

Parameter List

 'tag'
 'name'
 'loopname'
 'fullsegment'

Remarks

The Segment event will fire when a data segment is read. The Tag parameter contains the tag of the segment. Name contains the name of the segment as defined in the associated transaction set schema. LoopName contains the name of the loop or group this segment is present in (such as N1Loop1).

StartFunctionalGroup Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the start of a functional group.

Object Oriented Interface

public function fireStartFunctionalGroup($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 8, array($this, 'fireStartFunctionalGroup'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

Remarks

The StartFunctionalGroup event will fire when a control segment marking the start of a functional group structure is read. The Tag parameter contains the tag of the segment, such as GS. ControlNumber contains the control number associated with the segment.

StartInterchange Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the start of an interchange.

Object Oriented Interface

public function fireStartInterchange($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 9, array($this, 'fireStartInterchange'));

Parameter List

 'tag'
 'controlnumber'
 'fullsegment'

Remarks

The StartInterchange event will fire when a control segment marking the start of an interchange structure is read. The Tag parameter contains the tag of the segment, such as ISA. ControlNumber contains the control number associated with the segment.

StartLoop Event (IPWorksEDITranslator_HL7Validator Class)

Fires when the starting of a loop is detected in a transaction set.

Object Oriented Interface

public function fireStartLoop($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 10, array($this, 'fireStartLoop'));

Parameter List

 'name'

Remarks

The StartLoop event will fire when the tag of a loop trigger segment is read. The Name parameter contains the schema-provided name of the loop, such as "N1Loop1".

StartTransaction Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a control segment is read that marks the start of a transaction.

Object Oriented Interface

public function fireStartTransaction($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 11, array($this, 'fireStartTransaction'));

Parameter List

 'tag'
 'controlnumber'
 'code'
 'fullsegment'

Remarks

The StartTransaction event will fire when a control segment marking the start of a transaction is read. The Tag parameter contains the tag of the segment, such as ST. ControlNumber contains the control number associated with the segment. Code contains the transaction code (such as 810).

ValidationError Event (IPWorksEDITranslator_HL7Validator Class)

Fires whenever a validation error is encountered.

Object Oriented Interface

public function fireValidationError($param);

Procedural Interface

ipworkseditranslator_hl7validator_register_callback($res, 12, array($this, 'fireValidationError'));

Parameter List

 'errorcode'
 'message'
 'segmentnumber'
 'segmenttag'
 'technicalerrorcode'
 'segmenterrorcode'
 'elementerrorcode'
 'elementposition'
 'line'
 'column'

Remarks

This event will fire with errors as the EDI document is validated. The ErrorCode parameter contains the type of error encountered. Message is a textual description of the problem. SegmentNumber is the index of the segment where the problem was found. SegmentTag holds the tag name of the segment. ElementPosition is the position of the element where the error occurred.

The Line and Column parameters identify the location within the EDI document where the error occurred.

Possible ErrorCode values are:

X12 Specific Parameters

The following parameters are available in all validator classes but are only applicable to X12 document validation at this time.

SegmentErrorCode holds the error code that may be used in the IK304 field of a 999. ElementErrorCode holds the error code that may be used in the IK403 field of a 999.

TechnicalErrorCode holds a technical error code that helps identify structural issues with the document. For instance when parsing an X12 document this will hold values that may be used for TA1 error codes. When parsing X12 documents the following codes are applicable:

Config Settings (HL7Validator Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

HL7Validator Config Settings

Base Config Settings

Trappable Errors (HL7Validator Class)

HL7Validator Errors

	1000   Input/Output error
	1001   No stream or file name were specified for the component
	1002   Unexpected end of file (EOF).
	1003   Segment not found.
	1004   Segment not found in schema.
	1005   Schema not found.
	1010   Invalid Writer state.
	1011   Segment does not have the specified element or component.
	1012   Invalid XPath.
	1013   DOM tree unavailable (set BuildDOM and reparse).
	1014   Document contains incomplete segments.
	1015   Document contains an open EDI structure (interchange, functional group or transaction) with no matching footer segment.
	1044   Error while reading schema file.
	1100   Component is busy.
	1099   Unexpected error.