Uploaded From CV. Swandhana Server

This commit is contained in:
Duidev Software House
2025-01-27 08:16:55 +07:00
commit 6b3be42361
15186 changed files with 2328862 additions and 0 deletions

118
vendor/aranyasen/hl7/docs/Connection.md vendored Normal file
View File

@@ -0,0 +1,118 @@
# Aranyasen\HL7\Connection
Usage:
```php
$connection = new Connection('127.0.0.1', 5002);
$req = new Message();
// .
.. set some request attributes
$response = $connection->send($req);
$response->toString(); // Read ACK message from remote
```
The Connection object represents the tcp connection to the HL7 message broker. The Connection has only one public
method (apart from the constructor), send(). The 'send' method takes a Message object as argument, and also
returns a Message object. The send method can be used more than once, before the connection is closed.
Connection is closed automatically when the connection object is destroyed.
The Connection object holds the following fields:
MESSAGE_PREFIX
The prefix to be sent to the HL7 server to initiate the
message. Defaults to \013.
MESSAGE_SUFFIX
End of message signal for HL7 server. Defaults to \034\015.
## Methods
| Name | Description |
|------|-------------|
|[__construct](#connection__construct)|Creates a connection to a HL7 server, or throws exception when a connection could not be established.|
|[__destruct](#connection__destruct)||
|[send](#connectionsend)|Sends a Message object over this connection.|
### Connection::__construct
**Description**
```php
public __construct (string $host, string $port)
```
Creates a connection to a HL7 server, or throws exception when a connection could not be established.
**Parameters**
* `(string) $host`
: Host to connect to
* `(string) $port`
: Port to connect to
**Return Values**
`void`
<hr />
### Connection::__destruct
**Description**
```php
public __destruct (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### Connection::send
**Description**
```php
public send (\Message $req, string $responseCharEncoding)
```
Sends a Message object over this connection.
**Parameters**
* `(\Message) $req`
* `(string) $responseCharEncoding`
: The expected character encoding of the response.
**Return Values**
`\Message`
<hr />

355
vendor/aranyasen/hl7/docs/Message.md vendored Normal file
View File

@@ -0,0 +1,355 @@
# Aranyasen\HL7\Message
Class specifying the HL7 message, both request and response.
In general one needn't create an instance of the Message class directly, but use the HL7 factory class to create one.
When adding segments, note that the segment index starts at 0, so to get the first segment, do
```php $msg->getSegmentByIndex(0) ```
The segment separator defaults to \015. To change this, set the global variable $SEGMENT_SEPARATOR.
## Methods
| Name | Description |
|------|-------------|
|[__construct](#message__construct)|Constructor for Message. Consider using the HL7 factory to obtain a message instead.|
|[addSegment](#messageaddsegment)|Append a segment to the end of the message|
|[getSegmentAsString](#messagegetsegmentasstring)|Get the segment identified by index as string, using the messages separators.|
|[getSegmentByIndex](#messagegetsegmentbyindex)|Return the segment specified by $index.|
|[getSegmentFieldAsString](#messagegetsegmentfieldasstring)|Get the field identified by $fieldIndex from segment $segmentIndex.|
|[getSegments](#messagegetsegments)|Return an array containing all segments in the right order.|
|[getSegmentsByName](#messagegetsegmentsbyname)|Return an array of all segments with the given name|
|[insertSegment](#messageinsertsegment)|Insert a segment.|
|[removeSegmentByIndex](#messageremovesegmentbyindex)|Remove the segment indexed by $index.|
|[segmentToString](#messagesegmenttostring)|Convert Segment object to string|
|[setSegment](#messagesetsegment)|Set the segment on index.|
|[toString](#messagetostring)|Return a string representation of this message.|
### Message::__construct
**Description**
```php
public __construct (string $msgStr, array $hl7Globals)
```
Constructor for Message. Consider using the HL7 factory to obtain a message instead.
The constructor takes an optional string argument that is a string representation of a HL7 message. If the
string representation is not a valid HL7 message. according to the specifications, undef is returned instead of
a new instance. This means that segments should be separated within the message with the segment separator
(defaults to \015) or a newline, and segments should be syntactically correct. When using the string argument
constructor, make sure that you have escaped any characters that would have special meaning in PHP.
The control characters and field separator will take the values from the MSH segment, if set. Otherwise defaults
will be used. Changing the MSH fields specifying the field separator and control characters after the MSH has
been added to the message will result in setting these values for the message.
If the message couldn't be created, for example due to a erroneous HL7 message string, an error is raised.
**Parameters**
* `(string) $msgStr`
* `(array) $hl7Globals`
**Return Values**
`void`
<hr />
### Message::addSegment
**Description**
```php
public addSegment (\Segment $segment)
```
Append a segment to the end of the message
**Parameters**
* `(\Segment) $segment`
**Return Values**
`bool`
<hr />
### Message::getSegmentAsString
**Description**
```php
public getSegmentAsString (int $index)
```
Get the segment identified by index as string, using the messages separators.
**Parameters**
* `(int) $index`
: Index for segment to get
**Return Values**
`string|null`
> String representation of segment
<hr />
### Message::getSegmentByIndex
**Description**
```php
public getSegmentByIndex (int $index)
```
Return the segment specified by $index.
Note: Segment count within the message starts at 0.
**Parameters**
* `(int) $index`
: Index where segment is inserted
**Return Values**
`\Segment`
<hr />
### Message::getSegmentFieldAsString
**Description**
```php
public getSegmentFieldAsString (int $segmentIndex, int $fieldIndex)
```
Get the field identified by $fieldIndex from segment $segmentIndex.
Returns empty string if field is not set.
**Parameters**
* `(int) $segmentIndex`
: Index for segment to get
* `(int) $fieldIndex`
: Index for field to get
**Return Values**
`mixed`
> String representation of field
<hr />
### Message::getSegments
**Description**
```php
public getSegments (void)
```
Return an array containing all segments in the right order.
**Parameters**
`This function has no parameters.`
**Return Values**
`array`
> List of all segments
<hr />
### Message::getSegmentsByName
**Description**
```php
public getSegmentsByName (string $name)
```
Return an array of all segments with the given name
**Parameters**
* `(string) $name`
: Segment name
**Return Values**
`array`
> List of segments identified by name
<hr />
### Message::insertSegment
**Description**
```php
public insertSegment (\Segment $segment, null|int $index)
```
Insert a segment.
**Parameters**
* `(\Segment) $segment`
* `(null|int) $index`
: Index where segment is inserted
**Return Values**
`void`
<hr />
### Message::removeSegmentByIndex
**Description**
```php
public removeSegmentByIndex (int $index)
```
Remove the segment indexed by $index.
If it doesn't exist, nothing happens, if it does, all segments
after this one will be moved one index up.
**Parameters**
* `(int) $index`
: Index where segment is removed
**Return Values**
`boolean`
<hr />
### Message::segmentToString
**Description**
```php
public segmentToString ( $seg)
```
Convert Segment object to string
**Parameters**
* `() $seg`
**Return Values**
`string`
<hr />
### Message::setSegment
**Description**
```php
public setSegment (\Segment $segment, int $index)
```
Set the segment on index.
If index is out of range, or not provided, do nothing. Setting MSH on index 0 will re-validate field separator,
control characters and hl7 version, based on MSH(1), MSH(2) and MSH(12).
**Parameters**
* `(\Segment) $segment`
* `(int) $index`
: Index where segment is set
**Return Values**
`boolean`
<hr />
### Message::toString
**Description**
```php
public toString (boolean $pretty)
```
Return a string representation of this message.
This can be used to send the message over a socket to an HL7 server. To print to other output, use the $pretty
argument as some true value. This will not use the default segment separator, but '\n' instead.
**Parameters**
* `(boolean) $pretty`
: Whether to use \n as separator or default (\r).
**Return Values**
`mixed`
> String representation of HL7 message
<hr />

View File

@@ -0,0 +1,89 @@
# Aranyasen\HL7\Messages\ACK
## Extend:
Aranyasen\HL7\Message
## Methods
| Name | Description |
|------|-------------|
|[setAckCode](#acksetackcode)|Set the acknowledgement code for the acknowledgement.|
|[setErrorMessage](#ackseterrormessage)|Set the error message for the acknowledgement.|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Constructor for Message. Consider using the HL7 factory to obtain a message instead.|
|addSegment|Append a segment to the end of the message|
|getSegmentAsString|Get the segment identified by index as string, using the messages separators.|
|getSegmentByIndex|Return the segment specified by $index.|
|getSegmentFieldAsString|Get the field identified by $fieldIndex from segment $segmentIndex.|
|getSegments|Return an array containing all segments in the right order.|
|getSegmentsByName|Return an array of all segments with the given name|
|insertSegment|Insert a segment.|
|removeSegmentByIndex|Remove the segment indexed by $index.|
|segmentToString|Convert Segment object to string|
|setSegment|Set the segment on index.|
|toString|Return a string representation of this message.|
### ACK::setAckCode
**Description**
```php
public setAckCode (string $code, string $msg)
```
Set the acknowledgement code for the acknowledgement.
Code should be one of: A, E, R. Codes can be prepended with C or A, denoting enhanced or normal acknowledge mode.
This denotes: accept, general error and reject respectively. The ACK module will determine the right answer mode
(normal or enhanced) based upon the request, if not provided. The message provided in $msg will be set in MSA 3.
**Parameters**
* `(string) $code`
: Code to use in acknowledgement
* `(string) $msg`
: Acknowledgement message
**Return Values**
`boolean`
<hr />
### ACK::setErrorMessage
**Description**
```php
public setErrorMessage (string $msg)
```
Set the error message for the acknowledgement.
This will also set the error code to either AE or CE, depending on the mode of the incoming message.
**Parameters**
* `(string) $msg`
: Error message
**Return Values**
`void`
<hr />

16
vendor/aranyasen/hl7/docs/README.md vendored Normal file
View File

@@ -0,0 +1,16 @@
# Aranyasen\HL7
* [Connection](Connection.md)
* [Message](Message.md)
* [Messages\ACK](Messages/ACK.md)
* [Segment](Segment.md)
* [Segments\MSH](Segments/MSH.md)
* [Segments\PID](Segments/PID.md)
* [Segments\IN1](Segments/IN1.md)
* [Segments\IN3](Segments/IN3.md)
* [Segments\NTE](Segments/NTE.md)
* [Segments\DG1](Segments/DG1.md)
* [Segments\OBR](Segments/OBR.md)
* [Segments\OBX](Segments/OBX.md)
* [Segments\ORC](Segments/ORC.md)
* [Segments\PV1](Segments/PV1.md)

208
vendor/aranyasen/hl7/docs/Segment.md vendored Normal file
View File

@@ -0,0 +1,208 @@
# Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[__construct](#segment__construct)|Create a segment.|
|[getField](#segmentgetfield)|Get the field at index.|
|[getFields](#segmentgetfields)|Get fields from a segment|
|[getName](#segmentgetname)|Get the name of the segment. This is basically the value at index 0|
|[setField](#segmentsetfield)|Set the field specified by index to value.|
|[size](#segmentsize)|Get the number of fields for this segment, not including the name|
### Segment::__construct
**Description**
```php
public __construct (string $name, array|null $fields)
```
Create a segment.
A segment may be created with just a name or a name and an array of field
values. The segment name should be a standard HL7 segment (e.g. MSH / PID etc.) that is three characters long, and
upper case. If an array is given, all fields will be filled from that array. Note that for composed fields and
sub-components, the array may hold sub-arrays and sub-sub-arrays. Repeated fields can not be supported the same
way, since we can't distinguish between composed fields and repeated fields.
Example:
```php
$seg = new Segment("PID");
$seg->setField(3, "12345678");
echo $seg->getField(1);
```
**Parameters**
* `(string) $name`
: Name of the segment
* `(array|null) $fields`
: Fields for segment
**Return Values**
`void`
<hr />
### Segment::getField
**Description**
```php
public getField (int $index)
```
Get the field at index.
If the field is a composite field, it returns an array
Example:
```php
$field = $seg->getField(9); // Returns a string/null/array depending on what the 9th field is.
```
**Parameters**
* `(int) $index`
: Index of field
**Return Values**
`null|string|array`
> The value of the field
<hr />
### Segment::getFields
**Description**
```php
public getFields (int $from, int|null $to)
```
Get fields from a segment
Get the fields in the specified range, or all if nothing specified. If only the 'from' value is provided, all
fields from this index till the end of the segment will be returned.
**Parameters**
* `(int) $from`
: Start range at this index
* `(int|null) $to`
: Stop range at this index
**Return Values**
`array`
> List of fields
<hr />
### Segment::getName
**Description**
```php
public getName (void)
```
Get the name of the segment. This is basically the value at index 0
**Parameters**
`This function has no parameters.`
**Return Values**
`mixed`
> Name of segment
<hr />
### Segment::setField
**Description**
```php
public setField (int $index, string|array $value)
```
Set the field specified by index to value.
Indices start at 1, to stay with the HL7 standard. Trying to set the
value at index 0 has no effect. The value may also be a reference to an array (that may itself contain arrays)
to support composite fields (and sub-components).
Examples:
```php
$segment->setField(18, 'abcd'); // Sets 18th field to abcd
$segment->setField(8, 'ab^cd'); // Sets 8th field to ab^cd
$segment->setField(10, ['John', 'Doe']); // Sets 10th field to John^Doe
$segment->setField(12, ['']); // Sets 12th field to ''
```
If values are not provided at all, the method will just return.
**Parameters**
* `(int) $index`
: Index to set
* `(string|array) $value`
: Value for field
**Return Values**
`boolean`
<hr />
### Segment::size
**Description**
```php
public size (void)
```
Get the number of fields for this segment, not including the name
**Parameters**
`This function has no parameters.`
**Return Values**
`int`
> number of fields
<hr />

View File

@@ -0,0 +1,940 @@
# Aranyasen\HL7\Segments\DG1
DG1 segment class
Ref: http://hl7-definition.caristix.com:9010/HL7%20v2.3.1/segment/DG1
## Extend:
Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[getAttestationDateTime](#dg1getattestationdatetime)||
|[getConfidentialIndicator](#dg1getconfidentialindicator)||
|[getDRGApprovalIndicator](#dg1getdrgapprovalindicator)||
|[getDRGGrouperReviewCode](#dg1getdrggrouperreviewcode)||
|[getDiagnosingClinician](#dg1getdiagnosingclinician)||
|[getDiagnosisClassification](#dg1getdiagnosisclassification)||
|[getDiagnosisCodeDG1](#dg1getdiagnosiscodedg1)||
|[getDiagnosisCodingMethod](#dg1getdiagnosiscodingmethod)||
|[getDiagnosisDateTime](#dg1getdiagnosisdatetime)||
|[getDiagnosisDescription](#dg1getdiagnosisdescription)||
|[getDiagnosisPriority](#dg1getdiagnosispriority)||
|[getDiagnosisType](#dg1getdiagnosistype)||
|[getDiagnosticRelatedGroup](#dg1getdiagnosticrelatedgroup)||
|[getGrouperVersionAndType](#dg1getgrouperversionandtype)||
|[getID](#dg1getid)||
|[getMajorDiagnosticCategory](#dg1getmajordiagnosticcategory)||
|[getOutlierCost](#dg1getoutliercost)||
|[getOutlierDays](#dg1getoutlierdays)||
|[getOutlierType](#dg1getoutliertype)||
|[setAttestationDateTime](#dg1setattestationdatetime)||
|[setConfidentialIndicator](#dg1setconfidentialindicator)||
|[setDRGApprovalIndicator](#dg1setdrgapprovalindicator)||
|[setDRGGrouperReviewCode](#dg1setdrggrouperreviewcode)||
|[setDiagnosingClinician](#dg1setdiagnosingclinician)||
|[setDiagnosisClassification](#dg1setdiagnosisclassification)||
|[setDiagnosisCodeDG1](#dg1setdiagnosiscodedg1)||
|[setDiagnosisCodingMethod](#dg1setdiagnosiscodingmethod)||
|[setDiagnosisDateTime](#dg1setdiagnosisdatetime)||
|[setDiagnosisDescription](#dg1setdiagnosisdescription)||
|[setDiagnosisPriority](#dg1setdiagnosispriority)||
|[setDiagnosisType](#dg1setdiagnosistype)||
|[setDiagnosticRelatedGroup](#dg1setdiagnosticrelatedgroup)||
|[setGrouperVersionAndType](#dg1setgrouperversionandtype)||
|[setID](#dg1setid)||
|[setMajorDiagnosticCategory](#dg1setmajordiagnosticcategory)||
|[setOutlierCost](#dg1setoutliercost)||
|[setOutlierDays](#dg1setoutlierdays)||
|[setOutlierType](#dg1setoutliertype)||
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
|getField|Get the field at index.|
|getFields|Get fields from a segment|
|getName|Get the name of the segment. This is basically the value at index 0|
|setField|Set the field specified by index to value.|
|size|Get the number of fields for this segment, not including the name|
### DG1::getAttestationDateTime
**Description**
```php
public getAttestationDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getConfidentialIndicator
**Description**
```php
public getConfidentialIndicator (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDRGApprovalIndicator
**Description**
```php
public getDRGApprovalIndicator (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDRGGrouperReviewCode
**Description**
```php
public getDRGGrouperReviewCode (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosingClinician
**Description**
```php
public getDiagnosingClinician (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisClassification
**Description**
```php
public getDiagnosisClassification (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisCodeDG1
**Description**
```php
public getDiagnosisCodeDG1 (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisCodingMethod
**Description**
```php
public getDiagnosisCodingMethod (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisDateTime
**Description**
```php
public getDiagnosisDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisDescription
**Description**
```php
public getDiagnosisDescription (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisPriority
**Description**
```php
public getDiagnosisPriority (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosisType
**Description**
```php
public getDiagnosisType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getDiagnosticRelatedGroup
**Description**
```php
public getDiagnosticRelatedGroup (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getGrouperVersionAndType
**Description**
```php
public getGrouperVersionAndType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getID
**Description**
```php
public getID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getMajorDiagnosticCategory
**Description**
```php
public getMajorDiagnosticCategory (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getOutlierCost
**Description**
```php
public getOutlierCost (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getOutlierDays
**Description**
```php
public getOutlierDays (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::getOutlierType
**Description**
```php
public getOutlierType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setAttestationDateTime
**Description**
```php
public setAttestationDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setConfidentialIndicator
**Description**
```php
public setConfidentialIndicator (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDRGApprovalIndicator
**Description**
```php
public setDRGApprovalIndicator (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDRGGrouperReviewCode
**Description**
```php
public setDRGGrouperReviewCode (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosingClinician
**Description**
```php
public setDiagnosingClinician (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisClassification
**Description**
```php
public setDiagnosisClassification (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisCodeDG1
**Description**
```php
public setDiagnosisCodeDG1 (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisCodingMethod
**Description**
```php
public setDiagnosisCodingMethod (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisDateTime
**Description**
```php
public setDiagnosisDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisDescription
**Description**
```php
public setDiagnosisDescription (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisPriority
**Description**
```php
public setDiagnosisPriority (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosisType
**Description**
```php
public setDiagnosisType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setDiagnosticRelatedGroup
**Description**
```php
public setDiagnosticRelatedGroup (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setGrouperVersionAndType
**Description**
```php
public setGrouperVersionAndType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setID
**Description**
```php
public setID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setMajorDiagnosticCategory
**Description**
```php
public setMajorDiagnosticCategory (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setOutlierCost
**Description**
```php
public setOutlierCost (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setOutlierDays
**Description**
```php
public setOutlierDays (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### DG1::setOutlierType
**Description**
```php
public setOutlierType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />

View File

@@ -0,0 +1,303 @@
# Aranyasen\HL7\Segments\EQU
EQU segment class
Ref: https://www.interfaceware.com/hl7-standard/hl7-segment-EQU.html
## Extend:
Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[getAlertLevel](#equgetalertlevel)||
|[getEquipmentInstanceIdentifier](#equgetequipmentinstanceidentifier)||
|[getEquipmentState](#equgetequipmentstate)||
|[getEventDateTime](#equgeteventdatetime)||
|[getLocalRemoteControlState](#equgetlocalremotecontrolstate)||
|[resetIndex](#equresetindex)|Reset index of this segment|
|[setAlertLevel](#equsetalertlevel)||
|[setEquipmentInstanceIdentifier](#equsetequipmentinstanceidentifier)||
|[setEquipmentState](#equsetequipmentstate)||
|[setEventDateTime](#equseteventdatetime)||
|[setLocalRemoteControlState](#equsetlocalremotecontrolstate)||
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
|getField|Get the field at index.|
|getFields|Get fields from a segment|
|getName|Get the name of the segment. This is basically the value at index 0|
|setField|Set the field specified by index to value.|
|size|Get the number of fields for this segment, not including the name|
### EQU::getAlertLevel
**Description**
```php
getAlertLevel (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::getEquipmentInstanceIdentifier
**Description**
```php
getEquipmentInstanceIdentifier (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::getEquipmentState
**Description**
```php
getEquipmentState (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::getEventDateTime
**Description**
```php
getEventDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::getLocalRemoteControlState
**Description**
```php
getLocalRemoteControlState (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::resetIndex
**Description**
```php
public static resetIndex (int $index)
```
Reset index of this segment
**Parameters**
* `(int) $index`
**Return Values**
`void`
<hr />
### EQU::setAlertLevel
**Description**
```php
setAlertLevel (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::setEquipmentInstanceIdentifier
**Description**
```php
setEquipmentInstanceIdentifier (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::setEquipmentState
**Description**
```php
setEquipmentState (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::setEventDateTime
**Description**
```php
setEventDateTime (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### EQU::setLocalRemoteControlState
**Description**
```php
setLocalRemoteControlState (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />

2380
vendor/aranyasen/hl7/docs/Segments/IN1.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1228
vendor/aranyasen/hl7/docs/Segments/IN3.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,747 @@
# Aranyasen\HL7\Segments\MSH
MSH (message header) segment class
Usage:
```php
$seg = new MSH();
$seg->setField(9, "ADT^A24");
echo $seg->getField(1);
```
The MSH is an implementation of the Segment class. The MSH segment is a bit different from other segments, in that
the first field is the field separator after the segment name. Other fields thus start counting from 2! The setting
for the field separator for a whole message can be changed by the setField method on index 1 of the MSH for that
message. The MSH segment also contains the default settings for field 2, COMPONENT_SEPARATOR, REPETITION_SEPARATOR,
ESCAPE_CHARACTER and SUBCOMPONENT_SEPARATOR. These fields default to ^, ~, \ and & respectively.
Reference: https://corepointhealth.com/resource-center/hl7-resources/hl7-msh-message-header
## Extend:
Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[getDateTimeOfMessage](#mshgetdatetimeofmessage)||
|[getMessageControlId](#mshgetmessagecontrolid)||
|[getMessageType](#mshgetmessagetype)|ORM / ORU etc.|
|[getProcessingId](#mshgetprocessingid)||
|[getReceivingApplication](#mshgetreceivingapplication)||
|[getReceivingFacility](#mshgetreceivingfacility)||
|[getSendingApplication](#mshgetsendingapplication)||
|[getSendingFacility](#mshgetsendingfacility)||
|[getTriggerEvent](#mshgettriggerevent)||
|[getVersionId](#mshgetversionid)|Get HL7 version, e.g. 2.1, 2.3, 3.0 etc.|
|[setAcceptAcknowledgementType](#mshsetacceptacknowledgementtype)||
|[setApplicationAcknowledgementType](#mshsetapplicationacknowledgementtype)||
|[setCharacterSet](#mshsetcharacterset)||
|[setContinuationPointer](#mshsetcontinuationpointer)||
|[setCountryCode](#mshsetcountrycode)||
|[setDateTimeOfMessage](#mshsetdatetimeofmessage)||
|[setMessageControlId](#mshsetmessagecontrolid)||
|[setMessageType](#mshsetmessagetype)|Sets message type to MSH segment.|
|[setPrincipalLanguage](#mshsetprincipallanguage)||
|[setProcessingId](#mshsetprocessingid)||
|[setReceivingApplication](#mshsetreceivingapplication)||
|[setReceivingFacility](#mshsetreceivingfacility)||
|[setSecurity](#mshsetsecurity)||
|[setSendingApplication](#mshsetsendingapplication)||
|[setSendingFacility](#mshsetsendingfacility)||
|[setSequenceNumber](#mshsetsequencenumber)||
|[setTriggerEvent](#mshsettriggerevent)|Sets trigger event to MSH segment.|
|[setVersionId](#mshsetversionid)||
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
|getField|Get the field at index.|
|getFields|Get fields from a segment|
|getName|Get the name of the segment. This is basically the value at index 0|
|setField|Set the field specified by index to value.|
|size|Get the number of fields for this segment, not including the name|
### MSH::getDateTimeOfMessage
**Description**
```php
public getDateTimeOfMessage (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getMessageControlId
**Description**
```php
public getMessageControlId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getMessageType
**Description**
```php
public getMessageType (int $position)
```
ORM / ORU etc.
**Parameters**
* `(int) $position`
**Return Values**
`string`
<hr />
### MSH::getProcessingId
**Description**
```php
public getProcessingId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getReceivingApplication
**Description**
```php
public getReceivingApplication (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getReceivingFacility
**Description**
```php
public getReceivingFacility (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getSendingApplication
**Description**
```php
public getSendingApplication (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getSendingFacility
**Description**
```php
public getSendingFacility (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getTriggerEvent
**Description**
```php
public getTriggerEvent (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::getVersionId
**Description**
```php
public getVersionId (int $position)
```
Get HL7 version, e.g. 2.1, 2.3, 3.0 etc.
**Parameters**
* `(int) $position`
**Return Values**
`array|null|string`
<hr />
### MSH::setAcceptAcknowledgementType
**Description**
```php
public setAcceptAcknowledgementType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setApplicationAcknowledgementType
**Description**
```php
public setApplicationAcknowledgementType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setCharacterSet
**Description**
```php
public setCharacterSet (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setContinuationPointer
**Description**
```php
public setContinuationPointer (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setCountryCode
**Description**
```php
public setCountryCode (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setDateTimeOfMessage
**Description**
```php
public setDateTimeOfMessage (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setMessageControlId
**Description**
```php
public setMessageControlId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setMessageType
**Description**
```php
public setMessageType (string $value, int $position)
```
Sets message type to MSH segment.
If trigger event is already set, then it is preserved
Example:
If field value is ORU^R01 and you call
```
$msh->setMessageType('ORM');
```
Then the new field value will be ORM^R01.
If it was empty then the new value will be just ORM.
**Parameters**
* `(string) $value`
* `(int) $position`
**Return Values**
`bool`
<hr />
### MSH::setPrincipalLanguage
**Description**
```php
public setPrincipalLanguage (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setProcessingId
**Description**
```php
public setProcessingId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setReceivingApplication
**Description**
```php
public setReceivingApplication (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setReceivingFacility
**Description**
```php
public setReceivingFacility (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setSecurity
**Description**
```php
public setSecurity (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setSendingApplication
**Description**
```php
public setSendingApplication (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setSendingFacility
**Description**
```php
public setSendingFacility (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setSequenceNumber
**Description**
```php
public setSequenceNumber (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### MSH::setTriggerEvent
**Description**
```php
public setTriggerEvent (string $value, int $position)
```
Sets trigger event to MSH segment.
If meessage type is already set, then it is preserved
Example:
If field value is ORU^R01 and you call
```
$msh->setTriggerEvent('R30');
```
Then the new field value will be ORU^R30.
If trigger event was not set then it will set the new value.
**Parameters**
* `(string) $value`
* `(int) $position`
**Return Values**
`bool`
<hr />
### MSH::setVersionId
**Description**
```php
public setVersionId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />

View File

@@ -0,0 +1,220 @@
# Aranyasen\HL7\Segments\NTE
NTE segment class
Ref: https://corepointhealth.com/resource-center/hl7-resources/hl7-nte-notes-comments
## Extend:
Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[getComment](#ntegetcomment)||
|[getCommentType](#ntegetcommenttype)||
|[getID](#ntegetid)||
|[getSourceOfComment](#ntegetsourceofcomment)||
|[setComment](#ntesetcomment)||
|[setCommentType](#ntesetcommenttype)||
|[setID](#ntesetid)||
|[setSourceOfComment](#ntesetsourceofcomment)||
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
|getField|Get the field at index.|
|getFields|Get fields from a segment|
|getName|Get the name of the segment. This is basically the value at index 0|
|setField|Set the field specified by index to value.|
|size|Get the number of fields for this segment, not including the name|
### NTE::getComment
**Description**
```php
public getComment (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::getCommentType
**Description**
```php
public getCommentType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::getID
**Description**
```php
public getID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::getSourceOfComment
**Description**
```php
public getSourceOfComment (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::setComment
**Description**
```php
public setComment (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::setCommentType
**Description**
```php
public setCommentType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::setID
**Description**
```php
public setID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### NTE::setSourceOfComment
**Description**
```php
public setSourceOfComment (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />

2092
vendor/aranyasen/hl7/docs/Segments/OBR.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,844 @@
# Aranyasen\HL7\Segments\OBX
OBX segment class
Ref: https://corepointhealth.com/resource-center/hl7-resources/hl7-obx-segment
## Extend:
Aranyasen\HL7\Segment
## Methods
| Name | Description |
|------|-------------|
|[getAbnormalFlags](#obxgetabnormalflags)||
|[getDataLastObsNormalValues](#obxgetdatalastobsnormalvalues)||
|[getDateTimeOfTheObservation](#obxgetdatetimeoftheobservation)||
|[getID](#obxgetid)||
|[getNatureOfAbnormalTest](#obxgetnatureofabnormaltest)||
|[getObservationIdentifier](#obxgetobservationidentifier)||
|[getObservationMethod](#obxgetobservationmethod)||
|[getObservationSubId](#obxgetobservationsubid)||
|[getObservationValue](#obxgetobservationvalue)||
|[getObserveResultStatus](#obxgetobserveresultstatus)||
|[getProbability](#obxgetprobability)||
|[getProducersId](#obxgetproducersid)||
|[getReferenceRange](#obxgetreferencerange)||
|[getResponsibleObserver](#obxgetresponsibleobserver)||
|[getUnits](#obxgetunits)||
|[getUserDefinedAccessChecks](#obxgetuserdefinedaccesschecks)||
|[getValueType](#obxgetvaluetype)||
|[setAbnormalFlags](#obxsetabnormalflags)||
|[setDataLastObsNormalValues](#obxsetdatalastobsnormalvalues)||
|[setDateTimeOfTheObservation](#obxsetdatetimeoftheobservation)||
|[setID](#obxsetid)||
|[setNatureOfAbnormalTest](#obxsetnatureofabnormaltest)||
|[setObservationIdentifier](#obxsetobservationidentifier)||
|[setObservationMethod](#obxsetobservationmethod)||
|[setObservationSubId](#obxsetobservationsubid)||
|[setObservationValue](#obxsetobservationvalue)||
|[setObserveResultStatus](#obxsetobserveresultstatus)||
|[setProbability](#obxsetprobability)||
|[setProducersId](#obxsetproducersid)||
|[setReferenceRange](#obxsetreferencerange)||
|[setResponsibleObserver](#obxsetresponsibleobserver)||
|[setUnits](#obxsetunits)||
|[setUserDefinedAccessChecks](#obxsetuserdefinedaccesschecks)||
|[setValueType](#obxsetvaluetype)||
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
|getField|Get the field at index.|
|getFields|Get fields from a segment|
|getName|Get the name of the segment. This is basically the value at index 0|
|setField|Set the field specified by index to value.|
|size|Get the number of fields for this segment, not including the name|
### OBX::getAbnormalFlags
**Description**
```php
public getAbnormalFlags (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getDataLastObsNormalValues
**Description**
```php
public getDataLastObsNormalValues (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getDateTimeOfTheObservation
**Description**
```php
public getDateTimeOfTheObservation (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getID
**Description**
```php
public getID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getNatureOfAbnormalTest
**Description**
```php
public getNatureOfAbnormalTest (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getObservationIdentifier
**Description**
```php
public getObservationIdentifier (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getObservationMethod
**Description**
```php
public getObservationMethod (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getObservationSubId
**Description**
```php
public getObservationSubId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getObservationValue
**Description**
```php
public getObservationValue (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getObserveResultStatus
**Description**
```php
public getObserveResultStatus (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getProbability
**Description**
```php
public getProbability (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getProducersId
**Description**
```php
public getProducersId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getReferenceRange
**Description**
```php
public getReferenceRange (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getResponsibleObserver
**Description**
```php
public getResponsibleObserver (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getUnits
**Description**
```php
public getUnits (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getUserDefinedAccessChecks
**Description**
```php
public getUserDefinedAccessChecks (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::getValueType
**Description**
```php
public getValueType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setAbnormalFlags
**Description**
```php
public setAbnormalFlags (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setDataLastObsNormalValues
**Description**
```php
public setDataLastObsNormalValues (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setDateTimeOfTheObservation
**Description**
```php
public setDateTimeOfTheObservation (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setID
**Description**
```php
public setID (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setNatureOfAbnormalTest
**Description**
```php
public setNatureOfAbnormalTest (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setObservationIdentifier
**Description**
```php
public setObservationIdentifier (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setObservationMethod
**Description**
```php
public setObservationMethod (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setObservationSubId
**Description**
```php
public setObservationSubId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setObservationValue
**Description**
```php
public setObservationValue (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setObserveResultStatus
**Description**
```php
public setObserveResultStatus (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setProbability
**Description**
```php
public setProbability (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setProducersId
**Description**
```php
public setProducersId (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setReferenceRange
**Description**
```php
public setReferenceRange (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setResponsibleObserver
**Description**
```php
public setResponsibleObserver (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setUnits
**Description**
```php
public setUnits (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setUserDefinedAccessChecks
**Description**
```php
public setUserDefinedAccessChecks (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />
### OBX::setValueType
**Description**
```php
public setValueType (void)
```
**Parameters**
`This function has no parameters.`
**Return Values**
`void`
<hr />

1516
vendor/aranyasen/hl7/docs/Segments/ORC.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1472
vendor/aranyasen/hl7/docs/Segments/PID.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2671
vendor/aranyasen/hl7/docs/Segments/PV1.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2253
vendor/aranyasen/hl7/docs/Segments/SAC.md vendored Normal file
View File

File diff suppressed because it is too large Load Diff