Net_HL7
[ class tree: Net_HL7 ] [ index: Net_HL7 ] [ all elements ]
Packages:
Net_HL7


Classes:
Net_HL7
   Net_HL7_Messages_ACK
Net_HL7
Net_HL7_Connection
Net_HL7_Message
Net_HL7_Segments_MSH
Files:
ACK.php
Connection.php
HL7.php
Message.php
MSH.php
Segment.php

Class: Net_HL7

Source Location: /Net_HL7-0.1.1/Net/HL7.php

Class Overview




The Net_HL7 class is a factory class for HL7 messages.




Author(s):






        
            

Version:


    
  
  • 0.1.0
    • 









Methods
















Inherited Variables





Inherited Methods














Class Details



[line 37]

The Net_HL7 class is a factory class for HL7 messages.
The factory class provides the convenience of changing several  defaults for HL7 messaging globally, like separators, etc. Note  that some default settings use characters that have special meaning  in PHP, like the HL7 escape character. To be able to set these  values, escape the special characters.









[ Top ]








Method Detail



	
	
Net_HL7 (Constructor)   [line 49]

	

    

    

		Net_HL7 Net_HL7(
)
    

    


	
		Create a new instance of the HL7 factory, and set global  defaults.




        
[ Top ]

  

  
  
	
	
createMessage   [line 70]

	

    

    

		object Net_HL7_Message &createMessage(
[string
$msgStr = ""])
    

    


	
		Create a new Net_HL7_Message, using the global HL7 variables as  defaults.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $msgStr  
        — 
        Text representation of an HL7 message
      

        

    


        
[ Top ]

  

  
  
	
	
createMSH   [line 85]

	

    

    

		object Net_HL7_Segments_MSH &createMSH(
)
    

    


	
		Create a new Net_HL7_Segments_MSH segment, using the global HL7  variables as defaults.


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getNull   [line 221]

	

    

    

		string getNull(
)
    

    


	
		Convenience method for obtaining the special NULL value.


    

  • Return: null value
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setComponentSeparator   [line 101]

	

    

    

		boolean setComponentSeparator(
string
$value)
    

    


	
		Set the component separator to be used by the factory. Should  be a single character. Default ^


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Component separator char.
      

        

    


        
[ Top ]

  

  
  
	
	
setEscapeCharacter   [line 181]

	

    

    

		boolean setEscapeCharacter(
string
$value)
    

    


	
		Set the escape character to be used by the factory. Should  be a single character. Default: \


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Escape character.
      

        

    


        
[ Top ]

  

  
  
	
	
setFieldSeparator   [line 149]

	

    

    

		boolean setFieldSeparator(
string
$value)
    

    


	
		Set the field separator to be used by the factory. Should  be a single character. Default: |


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Field separator char.
      

        

    


        
[ Top ]

  

  
  
	
	
setHL7Version   [line 196]

	

    

    

		boolean setHL7Version(
string
$value)
    

    


	
		Set the HL7 version to be used by the factory.


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        HL7 version character.
      

        

    


        
[ Top ]

  

  
  
	
	
setNull   [line 209]

	

    

    

		boolean setNull(
string
$value)
    

    


	
		Set the NULL string to be used by the factory.


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        NULL string.
      

        

    


        
[ Top ]

  

  
  
	
	
setRepetitionSeparator   [line 133]

	

    

    

		boolean setRepetitionSeparator(
string
$value)
    

    


	
		Set the repetition separator to be used by the factory. Should  be a single character. Default: ~


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Repetition separator char.
      

        

    


        
[ Top ]

  

  
  
	
	
setSegmentSeparator   [line 165]

	

    

    

		boolean setSegmentSeparator(
string
$value)
    

    


	
		Set the segment separator to be used by the factory. Should  be a single character. Default: \015


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Segment separator char.
      

        

    


        
[ Top ]

  

  
  
	
	
setSubcomponentSeparator   [line 117]

	

    

    

		boolean setSubcomponentSeparator(
string
$value)
    

    


	
		Set the subcomponent separator to be used by the factory. Should  be a single character. Default: &


    

  • Return: true if value has been set.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $value  
        — 
        Subcomponent separator char.
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:32:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.