Skip to content

Commit

Permalink
Updates to CmdLet usage
Browse files Browse the repository at this point in the history
Added -Encoding parameter help for send-hl7message and receive-hl7message
  • Loading branch information
RobHolme authored Jun 21, 2020
1 parent 972cb39 commit ab58156
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,16 @@ Filter Examples:
Send a HL7 v2.x message from a file (or list of files) via TCP to a remote endpoint. Messages are framed using MLLP (Minimal Lower Layer Protocol).

```
Send-HL7Message [-HostName] <string> [-Port] <int> [-LiteralPath] <string[]> [-NoACK] [-Delay] <int> [<CommonParameters>]
Send-HL7Message [-HostName] <string> [-Port] <int> [-LiteralPath] <string[]> [-NoACK] [-Delay] <int> [[-Encoding] <String>] [<CommonParameters>]
Send-HL7Message [-HostName] <string> [-Port] <int> [-Path] <string[]> [-NoACK] [-Delay] <int> [<CommonParameters>]
Send-HL7Message [-HostName] <string> [-Port] <int> [-Path] <string[]> [-NoACK] [-Delay] <int> [[-Encoding] <String>] [<CommonParameters>]
```
example:

`Send-Hl7Message -Hostname 192.168.0.10 -Port 1234 -Path c:\HL7Files\message1.hl7`

`Send-Hl7Message -Hostname 192.168.0.10 -Port 1234 -Path c:\HL7Files\*.hl7 -Encoding ISO-8859-1`

### Parameters
__-Hostname \<string\>__: The IP Address or host name of the remote host to send the HL7 message to

Expand All @@ -111,6 +113,8 @@ __-NoACK__: This switch instructs the CmdLet not to wait for an ACK response fro

__-Delay \<int\>__: The delay (in seconds) between sending each message.

__-Encoding \<string\>__: The text encoding to use when sending the message. Supports "UTF-8" or "ISO-8859-1" (Western European). Defaults to "UTF-8" if parameter not supplied.


## Remove-HL7Identifiers
Removes names, addresses and other personally identifiable details from a HL7 v2.x Message.
Expand Down Expand Up @@ -247,7 +251,7 @@ __-OverwriteFile__: Don't warn when overwriting existing files
Receives a HL7 v2.x message via a TCP connection (MLLP framing).

```
Receive-HL7Message -Path <string> -Port <int> [-Timeout] <int> [<CommonParameters>]
Receive-HL7Message [-Path] <String> [-Port] <Int32> [[-Timeout] <Int32>] [[-Encoding] <String>] [-NoACK <SwitchParameter>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
```

### Parameters
Expand All @@ -257,6 +261,10 @@ __-Port \<int\>__: The the TCP port to listen for messages on.

__-Timeout \<int\>__: The timeout in seconds before idle connections are dropped (defaults to 60 seconds if not specified).

__-Encoding \<string\>__: The text encoding to use when receiving the message. Supports "UTF-8" or "ISO-8859-1" (Western European). Defaults to "UTF-8" if parameter not supplied.

__-NoACK \<SwitchParameter\>__: Set this switch parameter to suppress acknowledgment (ACK) messages from being sent in reposne to messages received.


## Show-HL7MessageTimeline
Lists messages chronologically based on the message header receive date/time field (MSH-7)
Expand Down

0 comments on commit ab58156

Please sign in to comment.