BlankSegmentXML()

Object: EHL7.HL7Vendors

FileName: EHL7.dll

METHOD

Name: BlankSegmentXML()

Parameters:

1) strSegment (String) The name of the HL7 Segment

2) bIncludeGUID (Boolean) default False.  To include the EasyHL7 Internal GUID ID and other properties of the various elements

Returns: XML String

Description: Returns an XML string with information for all of the components of a particular segment.  Called by the EHL7Message object in creation of HL7 Messages. 

Example:

Private Sub VendorTest()

Dim myVendorObj As New EHL7.HL7Vendors

Dim strVendorID As String

Dim strXML As String

Dim domNode As Object

myVendorObj.VendorPath = "C:\EasyHL7"

'Process the XML        

strVendorID = myVendorObj.GetVendorID("Default","2.3")

If strVendorID = "" Then

    MsgBox myVendorObj.LastError

    Set myVendorObj = Nothing

    Exit Sub

End If

If Not MyVendorObj.OpenVendor(strVendorID) Then

    MsgBox myVendorObj.LastError

    Set myVendorObj = Nothing

    Exit Sub

End If

strXML = myVendorObj.BlankSegmentXML("AIP")

End Sub

If bIncludeGUID is passed as each node will also have an 'ITEMGUID' attribute with the internal GUID of the associated element.  The SEGMENT and FIELDxx nodes will also have a 'FLAG' attribute which will be either "0" (not flagged) or "1" (flagged).  The FIELDxx nodes will also have a 'PROPERTIES' attribute containing the extended element properties for that field element.

Example XML String (bIncludeGUID = False):

<SEGMENT NAME="AIP" DESCRIPTION="Appointment information - personnel resource segment" FIELDCOUNT="12">

<FIELD1 DESCRIPTION="Set ID - AIP" DATATYPE="SI" FIELDLEN="4" TABLEID="0" COMPONENTS="1">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Sequence ID" />

</FIELD1>

<FIELD2 DESCRIPTION="Segment Action code" DATATYPE="ID" FIELDLEN="3" TABLEID="206" COMPONENTS="1">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Coded value for HL7 Tables" />

</FIELD2>

<FIELD3 DESCRIPTION="Personnel Resource ID" DATATYPE="XCN" FIELDLEN="80" TABLEID="0" COMPONENTS="7">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="ID Number" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="family name (last name)" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="given name (first name)" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="middle initial or name" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="suffix" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="prefix" />

<COMPONENT7 DATATYPE="ST" DESCRIPTION="degree" />

</FIELD3>

<FIELD4 DESCRIPTION="Resource Role" DATATYPE="CE" FIELDLEN="200" TABLEID="0" COMPONENTS="6">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="identifier" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="text" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="name of coding system" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="alternate identifier" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="alternate text" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="name of alternate coding system" />

</FIELD4>

<FIELD5 DESCRIPTION="Resource Group" DATATYPE="CE" FIELDLEN="200" TABLEID="0" COMPONENTS="6">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="identifier" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="text" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="name of coding system" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="alternate identifier" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="alternate text" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="name of alternate coding system" />

</FIELD5>

<FIELD6 DESCRIPTION="Start Date/Time" DATATYPE="TS" FIELDLEN="26" TABLEID="0" COMPONENTS="2">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Time stamp data" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="degree of precision (optional)" />

</FIELD6>

<FIELD7 DESCRIPTION="Start Date/Time Offset" DATATYPE="NM" FIELDLEN="20" TABLEID="0" COMPONENTS="1">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Numeric data" />

</FIELD7>

<FIELD8 DESCRIPTION="Start Date/Time Offset Units" DATATYPE="CE" FIELDLEN="200" TABLEID="0" COMPONENTS="6">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="identifier" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="text" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="name of coding system" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="alternate identifier" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="alternate text" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="name of alternate coding system" />

</FIELD8>

<FIELD9 DESCRIPTION="Duration" DATATYPE="NM" FIELDLEN="20" TABLEID="0" COMPONENTS="1">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Numeric data" />

</FIELD9>

<FIELD10 DESCRIPTION="Duration Units" DATATYPE="CE" FIELDLEN="200" TABLEID="0" COMPONENTS="6">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="identifier" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="text" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="name of coding system" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="alternate identifier" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="alternate text" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="name of alternate coding system" />

</FIELD10>

<FIELD11 DESCRIPTION="Allow Substitution Code" DATATYPE="IS" FIELDLEN="10" TABLEID="279" COMPONENTS="1">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="Code value for user-defined table" />

</FIELD11>

<FIELD12 DESCRIPTION="Filler Status Code" DATATYPE="CE" FIELDLEN="200" TABLEID="278" COMPONENTS="6">

<COMPONENT1 DATATYPE="ST" DESCRIPTION="identifier" />

<COMPONENT2 DATATYPE="ST" DESCRIPTION="text" />

<COMPONENT3 DATATYPE="ST" DESCRIPTION="name of coding system" />

<COMPONENT4 DATATYPE="ST" DESCRIPTION="alternate identifier" />

<COMPONENT5 DATATYPE="ST" DESCRIPTION="alternate text" />

<COMPONENT6 DATATYPE="ST" DESCRIPTION="name of alternate coding system" />

</FIELD12>

</SEGMENT>