diff --git a/.phpdoc-md b/.phpdoc-md
index ac88ada..ed39f4c 100644
--- a/.phpdoc-md
+++ b/.phpdoc-md
@@ -1,23 +1,36 @@
HL7::class,
@@ -28,18 +41,31 @@ return (object)[
Message::class,
ACK::class,
Segment::class,
- MSH::class,
- PID::class,
+ AIG::class,
+ AIL::class,
+ AIP::class,
+ DG1::class,
+ EQU::class,
+ EVN::class,
+ FHS::class,
+ FTS::class,
+ GT1::class,
IN1::class,
IN3::class,
+ MRG::class,
+ MSA::class,
+ MSH::class,
+ NK1::class,
NTE::class,
- DG1::class,
OBR::class,
OBX::class,
ORC::class,
+ PID::class,
PV1::class,
- EVN::class,
- EQU::class,
+ PV2::class,
+ RGS::class,
SAC::class,
+ SCH::class,
+ TQ1::class,
],
];
diff --git a/docs/Connection.md b/docs/Connection.md
index ba174f8..0741d8c 100644
--- a/docs/Connection.md
+++ b/docs/Connection.md
@@ -4,9 +4,7 @@ Usage:
```php
$connection = new Connection('127.0.0.1', 5002);
$req = new Message();
-// .
-
-.. set some request attributes
+// ... set some request attributes
$response = $connection->send($req);
$response->toString(); // Read ACK message from remote
```
@@ -36,6 +34,7 @@ End of message signal for HL7 server. Defaults to \034\015.
|------|-------------|
|[__construct](#connection__construct)|Creates a connection to a HL7 server, or throws exception when a connection could not be established.|
|[__destruct](#connection__destruct)||
+|[getSocket](#connectiongetsocket)||
|[send](#connectionsend)|Sends a Message object over this connection.|
@@ -46,7 +45,7 @@ End of message signal for HL7 server. Defaults to \034\015.
**Description**
```php
-public __construct (string $host, string $port)
+public __construct (string $host, int $port, int $timeout)
```
Creates a connection to a HL7 server, or throws exception when a connection could not be established.
@@ -57,13 +56,22 @@ Creates a connection to a HL7 server, or throws exception when a connection coul
* `(string) $host`
: Host to connect to
-* `(string) $port`
+* `(int) $port`
: Port to connect to
+* `(int) $timeout`
+: Connection timeout
**Return Values**
`void`
+
+**Throws Exceptions**
+
+
+`\HL7ConnectionException`
+
+
@@ -72,7 +80,7 @@ Creates a connection to a HL7 server, or throws exception when a connection coul
**Description**
```php
-public __destruct (void)
+ __destruct (void)
```
@@ -87,6 +95,31 @@ public __destruct (void)
`void`
+
+
+
+
+### Connection::getSocket
+
+**Description**
+
+```php
+ getSocket (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
@@ -95,7 +128,7 @@ public __destruct (void)
**Description**
```php
-public send (\Message $req, string $responseCharEncoding)
+public send (string $responseCharEncoding, bool $noWait)
```
Sends a Message object over this connection.
@@ -104,14 +137,23 @@ Sends a Message object over this connection.
**Parameters**
-* `(\Message) $req`
* `(string) $responseCharEncoding`
: The expected character encoding of the response.
+* `(bool) $noWait`
+: Do no wait for ACK. Helpful for building load testing tools...
**Return Values**
-`\Message`
+`void`
+
+
+**Throws Exceptions**
+
+
+`\HL7ConnectionException`
+
+`\HL7Exception`
diff --git a/docs/Message.md b/docs/Message.md
index 5ad91c0..063a8b8 100644
--- a/docs/Message.md
+++ b/docs/Message.md
@@ -18,15 +18,27 @@ The segment separator defaults to \015. To change this, set the global variable
|------|-------------|
|[__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|
+|[getFirstSegmentInstance](#messagegetfirstsegmentinstance)|Return the first segment with given name in 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.|
+|[getSegmentIndex](#messagegetsegmentindex)||
|[getSegments](#messagegetsegments)|Return an array containing all segments in the right order.|
|[getSegmentsByName](#messagegetsegmentsbyname)|Return an array of all segments with the given name|
+|[hasSegment](#messagehassegment)|Check if given segment is present in the message object|
|[insertSegment](#messageinsertsegment)|Insert a segment.|
+|[isAdt](#messageisadt)||
+|[isEmpty](#messageisempty)||
+|[isOrm](#messageisorm)||
+|[isOru](#messageisoru)||
+|[isSiu](#messageissiu)||
+|[removeSegment](#messageremovesegment)||
|[removeSegmentByIndex](#messageremovesegmentbyindex)|Remove the segment indexed by $index.|
+|[removeSegmentsByName](#messageremovesegmentsbyname)|Remove given segment|
+|[resetSegmentIndices](#messageresetsegmentindices)|Reset index attribute of each given segment, so when those are added the indices start from 1|
|[segmentToString](#messagesegmenttostring)|Convert Segment object to string|
|[setSegment](#messagesetsegment)|Set the segment on index.|
+|[toFile](#messagetofile)|Write HL7 to a file|
|[toString](#messagetostring)|Return a string representation of this message.|
@@ -37,7 +49,7 @@ The segment separator defaults to \015. To change this, set the global variable
**Description**
```php
-public __construct (string $msgStr, array $hl7Globals)
+public __construct (string|null $msgStr, array|null $hl7Globals, bool $keepEmptySubFields, bool $resetIndices, bool $autoIncrementIndices, bool|null $doNotSplitRepetition)
```
Constructor for Message. Consider using the HL7 factory to obtain a message instead.
@@ -56,13 +68,30 @@ If the message couldn't be created, for example due to a erroneous HL7 message s
**Parameters**
-* `(string) $msgStr`
-* `(array) $hl7Globals`
+* `(string|null) $msgStr`
+* `(array|null) $hl7Globals`
+: Set control characters or HL7 properties. e.g., ['HL7_VERSION' => '2.5']
+* `(bool) $keepEmptySubFields`
+: Set this to true to retain empty sub-fields
+* `(bool) $resetIndices`
+: Reset Indices of each segment to 1.
+* `(bool) $autoIncrementIndices`
+: True: auto-increment for each instance of same segment.
+* `(bool|null) $doNotSplitRepetition`
+: If true, repeated segments will be in single array instead of sub-arrays.
+Note: Since this is non-standard, it may be removed in future!
**Return Values**
`void`
+
+**Throws Exceptions**
+
+
+`\HL7Exception`
+
+
@@ -71,7 +100,7 @@ If the message couldn't be created, for example due to a erroneous HL7 message s
**Description**
```php
-public addSegment (\Segment $segment)
+public addSegment (void)
```
Append a segment to the end of the message
@@ -80,11 +109,36 @@ Append a segment to the end of the message
**Parameters**
-* `(\Segment) $segment`
+`This function has no parameters.`
**Return Values**
-`bool`
+`void`
+
+
+
+
+
+### Message::getFirstSegmentInstance
+
+**Description**
+
+```php
+public getFirstSegmentInstance (void)
+```
+
+Return the first segment with given name in the message
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`mixed|null`
+
@@ -114,6 +168,7 @@ Get the segment identified by index as string, using the messages separators.
> String representation of segment
+
@@ -136,8 +191,7 @@ Note: Segment count within the message starts at 0.
**Return Values**
-`\Segment`
-
+`void`
@@ -164,10 +218,35 @@ Returns empty string if field is not set.
**Return Values**
-`mixed`
+`null|string`
> String representation of field
+
+
+
+
+### Message::getSegmentIndex
+
+**Description**
+
+```php
+ getSegmentIndex (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
@@ -193,6 +272,7 @@ Return an array containing all segments in the right order.
> List of all segments
+
@@ -219,6 +299,31 @@ Return an array of all segments with the given name
> List of segments identified by name
+
+
+
+
+### Message::hasSegment
+
+**Description**
+
+```php
+public hasSegment (void)
+```
+
+Check if given segment is present in the message object
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
@@ -227,7 +332,7 @@ Return an array of all segments with the given name
**Description**
```php
-public insertSegment (\Segment $segment, null|int $index)
+public insertSegment (null|int $index)
```
Insert a segment.
@@ -236,7 +341,6 @@ Insert a segment.
**Parameters**
-* `(\Segment) $segment`
* `(null|int) $index`
: Index where segment is inserted
@@ -244,6 +348,157 @@ Insert a segment.
`void`
+
+**Throws Exceptions**
+
+
+`\InvalidArgumentException`
+
+
+
+
+
+### Message::isAdt
+
+**Description**
+
+```php
+ isAdt (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### Message::isEmpty
+
+**Description**
+
+```php
+ isEmpty (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### Message::isOrm
+
+**Description**
+
+```php
+ isOrm (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### Message::isOru
+
+**Description**
+
+```php
+ isOru (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### Message::isSiu
+
+**Description**
+
+```php
+ isSiu (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### Message::removeSegment
+
+**Description**
+
+```php
+ removeSegment (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
@@ -267,9 +522,58 @@ after this one will be moved one index up.
**Return Values**
-`boolean`
+`void`
+
+
+
+### Message::removeSegmentsByName
+
+**Description**
+
+```php
+public removeSegmentsByName (void)
+```
+
+Remove given segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`int`
+
+> Count of segments removed
+
+
+
+
+
+### Message::resetSegmentIndices
+
+**Description**
+
+```php
+public resetSegmentIndices (void)
+```
+
+Reset index attribute of each given segment, so when those are added the indices start from 1
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
@@ -279,7 +583,7 @@ after this one will be moved one index up.
**Description**
```php
-public segmentToString ( $seg)
+public segmentToString (void)
```
Convert Segment object to string
@@ -288,12 +592,11 @@ Convert Segment object to string
**Parameters**
-* `() $seg`
+`This function has no parameters.`
**Return Values**
-`string`
-
+`void`
@@ -304,7 +607,7 @@ Convert Segment object to string
**Description**
```php
-public setSegment (\Segment $segment, int $index)
+public setSegment (int $index)
```
Set the segment on index.
@@ -314,15 +617,49 @@ 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`
+`void`
+
+
+**Throws Exceptions**
+
+
+`\InvalidArgumentException`
+
+
+
+
+
+### Message::toFile
+
+**Description**
+
+```php
+public toFile (void)
+```
+
+Write HL7 to a file
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+**Throws Exceptions**
+`\HL7Exception`
+
@@ -332,7 +669,7 @@ control characters and hl7 version, based on MSH(1), MSH(2) and MSH(12).
**Description**
```php
-public toString (boolean $pretty)
+public toString (bool $pretty)
```
Return a string representation of this message.
@@ -342,7 +679,7 @@ argument as some true value. This will not use the default segment separator, bu
**Parameters**
-* `(boolean) $pretty`
+* `(bool) $pretty`
: Whether to use \n as separator or default (\r).
**Return Values**
@@ -351,5 +688,12 @@ argument as some true value. This will not use the default segment separator, bu
> String representation of HL7 message
+
+**Throws Exceptions**
+
+
+`\HL7Exception`
+
+
diff --git a/docs/Messages/ACK.md b/docs/Messages/ACK.md
index fcfcd95..4031586 100644
--- a/docs/Messages/ACK.md
+++ b/docs/Messages/ACK.md
@@ -13,7 +13,7 @@ Aranyasen\HL7\Message
| Name | Description |
|------|-------------|
|[setAckCode](#acksetackcode)|Set the acknowledgement code for the acknowledgement.|
-|[setErrorMessage](#ackseterrormessage)|Set the error message for the acknowledgement.|
+|[setErrorMessage](#ackseterrormessage)|Set the error message for acknowledgement.|
## Inherited methods
@@ -21,15 +21,27 @@ Aranyasen\HL7\Message
|------|-------------|
|__construct|Constructor for Message. Consider using the HL7 factory to obtain a message instead.|
|addSegment|Append a segment to the end of the message|
+|getFirstSegmentInstance|Return the first segment with given name in 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.|
+| [getSegmentIndex](https://secure.php.net/manual/en/aranyasen\hl7\message.getsegmentindex.php) | - |
|getSegments|Return an array containing all segments in the right order.|
|getSegmentsByName|Return an array of all segments with the given name|
+|hasSegment|Check if given segment is present in the message object|
|insertSegment|Insert a segment.|
+| [isAdt](https://secure.php.net/manual/en/aranyasen\hl7\message.isadt.php) | - |
+| [isEmpty](https://secure.php.net/manual/en/aranyasen\hl7\message.isempty.php) | - |
+| [isOrm](https://secure.php.net/manual/en/aranyasen\hl7\message.isorm.php) | - |
+| [isOru](https://secure.php.net/manual/en/aranyasen\hl7\message.isoru.php) | - |
+| [isSiu](https://secure.php.net/manual/en/aranyasen\hl7\message.issiu.php) | - |
+| [removeSegment](https://secure.php.net/manual/en/aranyasen\hl7\message.removesegment.php) | - |
|removeSegmentByIndex|Remove the segment indexed by $index.|
+|removeSegmentsByName|Remove given segment|
+|resetSegmentIndices|Reset index attribute of each given segment, so when those are added the indices start from 1|
|segmentToString|Convert Segment object to string|
|setSegment|Set the segment on index.|
+|toFile|Write HL7 to a file|
|toString|Return a string representation of this message.|
@@ -39,7 +51,7 @@ Aranyasen\HL7\Message
**Description**
```php
-public setAckCode (string $code, string $msg)
+public setAckCode (string $code, string|null $msg)
```
Set the acknowledgement code for the acknowledgement.
@@ -52,13 +64,12 @@ This denotes: accept, general error and reject respectively. The ACK module will
* `(string) $code`
: Code to use in acknowledgement
-* `(string) $msg`
+* `(string|null) $msg`
: Acknowledgement message
**Return Values**
-`boolean`
-
+`void`
@@ -72,7 +83,7 @@ This denotes: accept, general error and reject respectively. The ACK module will
public setErrorMessage (string $msg)
```
-Set the error message for the acknowledgement.
+Set the error message for acknowledgement.
This will also set the error code to either AE or CE, depending on the mode of the incoming message.
@@ -85,5 +96,6 @@ This will also set the error code to either AE or CE, depending on the mode of t
`void`
+
diff --git a/docs/README.md b/docs/README.md
index 03d49cf..98e4d38 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,13 +4,29 @@
* [Message](Message.md)
* [Messages\ACK](Messages/ACK.md)
* [Segment](Segment.md)
-* [Segments\MSH](Segments/MSH.md)
-* [Segments\PID](Segments/PID.md)
+* [Segments\AIG](Segments/AIG.md)
+* [Segments\AIL](Segments/AIL.md)
+* [Segments\AIP](Segments/AIP.md)
+* [Segments\DG1](Segments/DG1.md)
+* [Segments\EQU](Segments/EQU.md)
+* [Segments\EVN](Segments/EVN.md)
+* [Segments\FHS](Segments/FHS.md)
+* [Segments\FTS](Segments/FTS.md)
+* [Segments\GT1](Segments/GT1.md)
* [Segments\IN1](Segments/IN1.md)
* [Segments\IN3](Segments/IN3.md)
+* [Segments\MRG](Segments/MRG.md)
+* [Segments\MSA](Segments/MSA.md)
+* [Segments\MSH](Segments/MSH.md)
+* [Segments\NK1](Segments/NK1.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\PID](Segments/PID.md)
* [Segments\PV1](Segments/PV1.md)
+* [Segments\PV2](Segments/PV2.md)
+* [Segments\RGS](Segments/RGS.md)
+* [Segments\SAC](Segments/SAC.md)
+* [Segments\SCH](Segments/SCH.md)
+* [Segments\TQ1](Segments/TQ1.md)
diff --git a/docs/Segment.md b/docs/Segment.md
index d834428..5b1aa00 100644
--- a/docs/Segment.md
+++ b/docs/Segment.md
@@ -11,6 +11,7 @@
| Name | Description |
|------|-------------|
|[__construct](#segment__construct)|Create a segment.|
+|[clearField](#segmentclearfield)|Remove any existing value from the field|
|[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|
@@ -30,11 +31,11 @@ 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.
+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
@@ -55,6 +56,38 @@ echo $seg->getField(1);
`void`
+
+**Throws Exceptions**
+
+
+`\InvalidArgumentException`
+
+
+
+
+
+### Segment::clearField
+
+**Description**
+
+```php
+public clearField (int $index)
+```
+
+Remove any existing value from the field
+
+
+
+**Parameters**
+
+* `(int) $index`
+: Field index
+
+**Return Values**
+
+`void`
+
+
@@ -63,7 +96,7 @@ echo $seg->getField(1);
**Description**
```php
-public getField (int $index)
+public getField (void)
```
Get the field at index.
@@ -76,14 +109,12 @@ $field = $seg->getField(9); // Returns a string/null/array depending on what the
**Parameters**
-* `(int) $index`
-: Index of field
+`This function has no parameters.`
**Return Values**
-`null|string|array`
+`void`
-> The value of the field
@@ -114,6 +145,7 @@ fields from this index till the end of the segment will be returned.
> List of fields
+
@@ -135,10 +167,11 @@ Get the name of the segment. This is basically the value at index 0
**Return Values**
-`mixed`
+`string`
> Name of segment
+
@@ -147,7 +180,7 @@ Get the name of the segment. This is basically the value at index 0
**Description**
```php
-public setField (int $index, string|array $value)
+public setField (int $index)
```
Set the field specified by index to value.
@@ -170,13 +203,10 @@ If values are not provided at all, the method will just return.
* `(int) $index`
: Index to set
-* `(string|array) $value`
-: Value for field
**Return Values**
-`boolean`
-
+`void`
@@ -204,5 +234,6 @@ Get the number of fields for this segment, not including the name
> number of fields
+
diff --git a/docs/Segments/AIG.md b/docs/Segments/AIG.md
new file mode 100644
index 0000000..7b17264
--- /dev/null
+++ b/docs/Segments/AIG.md
@@ -0,0 +1,885 @@
+# Aranyasen\HL7\Segments\AIG
+
+AIG segment class
+
+AIG: Appointment information - general resource segment
+The AIG segment contains information about various kinds of resources (other than those with specifically defined
+segments in this chapter) that can be scheduled. Resources included in a transaction using this segment are assumed
+to be controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not
+identified on a schedule request using this segment. Resources described by this segment are general kinds of
+resources, such as equipment, that are identified with a simple identification code.
+
+Ref: http://hl7-definition.caristix.com:9010/Default.aspx?version=HL7+v2.3.1&segment=AIG
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#aig__destruct)||
+|[getAllowSubstitutionCode](#aiggetallowsubstitutioncode)|Get Allow Substitution Code (AIG.13)|
+|[getDuration](#aiggetduration)|Get Duration (AIG.11)|
+|[getDurationUnits](#aiggetdurationunits)|Get Duration Units (AIG.12)|
+|[getFillerStatusCode](#aiggetfillerstatuscode)|Get Filler Status Code (AIG.14)|
+|[getID](#aiggetid)|Get ID (AIG.1)|
+|[getResourceGroup](#aiggetresourcegroup)|Get Resource Group (AIG.5)|
+|[getResourceID](#aiggetresourceid)|Get Resource ID (AIG.3)|
+|[getResourceQuantity](#aiggetresourcequantity)|Get Resource Quantity (AIG.6)|
+|[getResourceQuantityUnits](#aiggetresourcequantityunits)|Get Resource Quantity Units (AIG.7)|
+|[getResourceType](#aiggetresourcetype)|Get Resource Type (AIG.4)|
+|[getSegmentActionCode](#aiggetsegmentactioncode)|Get Segment Action Code (AIG.2)|
+|[getStartDateTime](#aiggetstartdatetime)|Get Start Date Time (AIG.8)|
+|[getStartDateTimeOffset](#aiggetstartdatetimeoffset)|Get Start Date Time Offset (AIG.9)|
+|[getStartDateTimeOffsetUnits](#aiggetstartdatetimeoffsetunits)|Get Start Date Time Offset Units (AIG.10)|
+|[resetIndex](#aigresetindex)|Reset index of this segment|
+|[setAllowSubstitutionCode](#aigsetallowsubstitutioncode)|Set Allow Substitution Code (AIG.13)|
+|[setDuration](#aigsetduration)|Set Duration (AIG.11)|
+|[setDurationUnits](#aigsetdurationunits)|Set Duration Units (AIG.12)|
+|[setFillerStatusCode](#aigsetfillerstatuscode)|Set Filler Status Code (AIG.14)|
+|[setID](#aigsetid)|Set ID (AIG.1)|
+|[setResourceGroup](#aigsetresourcegroup)|Set Resource Group (AIG.5)|
+|[setResourceID](#aigsetresourceid)|Set Resource ID (AIG.3)|
+|[setResourceQuantity](#aigsetresourcequantity)|Set Resource Quantity (AIG.6)|
+|[setResourceQuantityUnits](#aigsetresourcequantityunits)|Set Resource Quantity Units (AIG.7)|
+|[setResourceType](#aigsetresourcetype)|Set Resource Type (AIG.4)|
+|[setSegmentActionCode](#aigsetsegmentactioncode)|Set Segment Action Code (AIG.2)|
+|[setStartDateTime](#aigsetstartdatetime)|Set Start Date Time (AIG.8)|
+|[setStartDateTimeOffset](#aigsetstartdatetimeoffset)|Set Start Date Time Offset (AIG.9)|
+|[setStartDateTimeOffsetUnits](#aigsetstartdatetimeoffsetunits)|Set Start Date Time Offset Units (AIG.10)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### AIG::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIG::getAllowSubstitutionCode
+
+**Description**
+
+```php
+public getAllowSubstitutionCode (int $position)
+```
+
+Get Allow Substitution Code (AIG.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getDuration
+
+**Description**
+
+```php
+public getDuration (int $position)
+```
+
+Get Duration (AIG.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getDurationUnits
+
+**Description**
+
+```php
+public getDurationUnits (int $position)
+```
+
+Get Duration Units (AIG.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getFillerStatusCode
+
+**Description**
+
+```php
+public getFillerStatusCode (int $position)
+```
+
+Get Filler Status Code (AIG.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (AIG.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getResourceGroup
+
+**Description**
+
+```php
+public getResourceGroup (int $position)
+```
+
+Get Resource Group (AIG.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getResourceID
+
+**Description**
+
+```php
+public getResourceID (int $position)
+```
+
+Get Resource ID (AIG.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getResourceQuantity
+
+**Description**
+
+```php
+public getResourceQuantity (int $position)
+```
+
+Get Resource Quantity (AIG.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getResourceQuantityUnits
+
+**Description**
+
+```php
+public getResourceQuantityUnits (int $position)
+```
+
+Get Resource Quantity Units (AIG.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getResourceType
+
+**Description**
+
+```php
+public getResourceType (int $position)
+```
+
+Get Resource Type (AIG.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getSegmentActionCode
+
+**Description**
+
+```php
+public getSegmentActionCode (int $position)
+```
+
+Get Segment Action Code (AIG.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getStartDateTime
+
+**Description**
+
+```php
+public getStartDateTime (int $position)
+```
+
+Get Start Date Time (AIG.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getStartDateTimeOffset
+
+**Description**
+
+```php
+public getStartDateTimeOffset (int $position)
+```
+
+Get Start Date Time Offset (AIG.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::getStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public getStartDateTimeOffsetUnits (int $position)
+```
+
+Get Start Date Time Offset Units (AIG.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIG::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIG::setAllowSubstitutionCode
+
+**Description**
+
+```php
+public setAllowSubstitutionCode (string|int|array|null $value, int $position)
+```
+
+Set Allow Substitution Code (AIG.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setDuration
+
+**Description**
+
+```php
+public setDuration (string|int|array|null $value, int $position)
+```
+
+Set Duration (AIG.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setDurationUnits
+
+**Description**
+
+```php
+public setDurationUnits (string|int|array|null $value, int $position)
+```
+
+Set Duration Units (AIG.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setFillerStatusCode
+
+**Description**
+
+```php
+public setFillerStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Filler Status Code (AIG.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (AIG.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setResourceGroup
+
+**Description**
+
+```php
+public setResourceGroup (string|int|array|null $value, int $position)
+```
+
+Set Resource Group (AIG.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setResourceID
+
+**Description**
+
+```php
+public setResourceID (string|int|array|null $value, int $position)
+```
+
+Set Resource ID (AIG.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setResourceQuantity
+
+**Description**
+
+```php
+public setResourceQuantity (string|int|array|null $value, int $position)
+```
+
+Set Resource Quantity (AIG.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setResourceQuantityUnits
+
+**Description**
+
+```php
+public setResourceQuantityUnits (string|int|array|null $value, int $position)
+```
+
+Set Resource Quantity Units (AIG.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setResourceType
+
+**Description**
+
+```php
+public setResourceType (string|int|array|null $value, int $position)
+```
+
+Set Resource Type (AIG.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setSegmentActionCode
+
+**Description**
+
+```php
+public setSegmentActionCode (string|int|array|null $value, int $position)
+```
+
+Set Segment Action Code (AIG.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setStartDateTime
+
+**Description**
+
+```php
+public setStartDateTime (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time (AIG.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setStartDateTimeOffset
+
+**Description**
+
+```php
+public setStartDateTimeOffset (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset (AIG.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIG::setStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public setStartDateTimeOffsetUnits (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset Units (AIG.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/AIL.md b/docs/Segments/AIL.md
new file mode 100644
index 0000000..4992348
--- /dev/null
+++ b/docs/Segments/AIL.md
@@ -0,0 +1,772 @@
+# Aranyasen\HL7\Segments\AIL
+
+AIL segment class
+
+AIL: Appointment Information - Location Resource
+
+The AIL segment contains information about location resources (meeting rooms, operating rooms, examination rooms, or
+other locations) that can be scheduled. Resources included in a transaction using this segment are assumed to be
+controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not identified
+on a schedule request using this segment. Location resources are identified with this specific segment because of the
+specific encoding of locations used by the HL7 specification.
+
+Ref: http://hl7-definition.caristix.com:9010/Default.aspx?version=HL7+v2.5.1&segment=AIL
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#ail__destruct)||
+|[getAllowSubstitutionCode](#ailgetallowsubstitutioncode)|Get Allow Substitution Code (AIL.11)|
+|[getDuration](#ailgetduration)|Get Duration (AIL.9)|
+|[getDurationUnits](#ailgetdurationunits)|Get Duration Units (AIL.10)|
+|[getFillerStatusCode](#ailgetfillerstatuscode)|Get Filler Status Code (AIL.12)|
+|[getID](#ailgetid)|Get ID (AIL.1)|
+|[getLocationGroup](#ailgetlocationgroup)|Get Location Group (AIL.5)|
+|[getLocationResourceID](#ailgetlocationresourceid)|Get Location Resource ID (AIL.3)|
+|[getLocationTypeAIL](#ailgetlocationtypeail)|Get Location Type AIL (AIL.4)|
+|[getSegmentActionCode](#ailgetsegmentactioncode)|Get Segment Action Code (AIL.2)|
+|[getStartDateTime](#ailgetstartdatetime)|Get Start Date Time (AIL.6)|
+|[getStartDateTimeOffset](#ailgetstartdatetimeoffset)|Get Start Date Time Offset (AIL.7)|
+|[getStartDateTimeOffsetUnits](#ailgetstartdatetimeoffsetunits)|Get Start Date Time Offset Units (AIL.8)|
+|[resetIndex](#ailresetindex)|Reset index of this segment|
+|[setAllowSubstitutionCode](#ailsetallowsubstitutioncode)|Set Allow Substitution Code (AIL.11)|
+|[setDuration](#ailsetduration)|Set Duration (AIL.9)|
+|[setDurationUnits](#ailsetdurationunits)|Set Duration Units (AIL.10)|
+|[setFillerStatusCode](#ailsetfillerstatuscode)|Set Filler Status Code (AIL.12)|
+|[setID](#ailsetid)|Set ID (AIL.1)|
+|[setLocationGroup](#ailsetlocationgroup)|Set Location Group (AIL.5)|
+|[setLocationResourceID](#ailsetlocationresourceid)|Set Location Resource ID (AIL.3)|
+|[setLocationTypeAIL](#ailsetlocationtypeail)|Set Location Type AIL (AIL.4)|
+|[setSegmentActionCode](#ailsetsegmentactioncode)|Set Segment Action Code (AIL.2)|
+|[setStartDateTime](#ailsetstartdatetime)|Set Start Date Time (AIL.6)|
+|[setStartDateTimeOffset](#ailsetstartdatetimeoffset)|Set Start Date Time Offset (AIL.7)|
+|[setStartDateTimeOffsetUnits](#ailsetstartdatetimeoffsetunits)|Set Start Date Time Offset Units (AIL.8)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### AIL::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIL::getAllowSubstitutionCode
+
+**Description**
+
+```php
+public getAllowSubstitutionCode (int $position)
+```
+
+Get Allow Substitution Code (AIL.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getDuration
+
+**Description**
+
+```php
+public getDuration (int $position)
+```
+
+Get Duration (AIL.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getDurationUnits
+
+**Description**
+
+```php
+public getDurationUnits (int $position)
+```
+
+Get Duration Units (AIL.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getFillerStatusCode
+
+**Description**
+
+```php
+public getFillerStatusCode (int $position)
+```
+
+Get Filler Status Code (AIL.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (AIL.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getLocationGroup
+
+**Description**
+
+```php
+public getLocationGroup (int $position)
+```
+
+Get Location Group (AIL.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getLocationResourceID
+
+**Description**
+
+```php
+public getLocationResourceID (int $position)
+```
+
+Get Location Resource ID (AIL.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getLocationTypeAIL
+
+**Description**
+
+```php
+public getLocationTypeAIL (int $position)
+```
+
+Get Location Type AIL (AIL.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getSegmentActionCode
+
+**Description**
+
+```php
+public getSegmentActionCode (int $position)
+```
+
+Get Segment Action Code (AIL.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getStartDateTime
+
+**Description**
+
+```php
+public getStartDateTime (int $position)
+```
+
+Get Start Date Time (AIL.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getStartDateTimeOffset
+
+**Description**
+
+```php
+public getStartDateTimeOffset (int $position)
+```
+
+Get Start Date Time Offset (AIL.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::getStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public getStartDateTimeOffsetUnits (int $position)
+```
+
+Get Start Date Time Offset Units (AIL.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIL::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIL::setAllowSubstitutionCode
+
+**Description**
+
+```php
+public setAllowSubstitutionCode (string|int|array|null $value, int $position)
+```
+
+Set Allow Substitution Code (AIL.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setDuration
+
+**Description**
+
+```php
+public setDuration (string|int|array|null $value, int $position)
+```
+
+Set Duration (AIL.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setDurationUnits
+
+**Description**
+
+```php
+public setDurationUnits (string|int|array|null $value, int $position)
+```
+
+Set Duration Units (AIL.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setFillerStatusCode
+
+**Description**
+
+```php
+public setFillerStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Filler Status Code (AIL.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (AIL.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setLocationGroup
+
+**Description**
+
+```php
+public setLocationGroup (string|int|array|null $value, int $position)
+```
+
+Set Location Group (AIL.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setLocationResourceID
+
+**Description**
+
+```php
+public setLocationResourceID (string|int|array|null $value, int $position)
+```
+
+Set Location Resource ID (AIL.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setLocationTypeAIL
+
+**Description**
+
+```php
+public setLocationTypeAIL (string|int|array|null $value, int $position)
+```
+
+Set Location Type AIL (AIL.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setSegmentActionCode
+
+**Description**
+
+```php
+public setSegmentActionCode (string|int|array|null $value, int $position)
+```
+
+Set Segment Action Code (AIL.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setStartDateTime
+
+**Description**
+
+```php
+public setStartDateTime (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time (AIL.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setStartDateTimeOffset
+
+**Description**
+
+```php
+public setStartDateTimeOffset (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset (AIL.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIL::setStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public setStartDateTimeOffsetUnits (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset Units (AIL.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/AIP.md b/docs/Segments/AIP.md
new file mode 100644
index 0000000..386c8ae
--- /dev/null
+++ b/docs/Segments/AIP.md
@@ -0,0 +1,772 @@
+# Aranyasen\HL7\Segments\AIP
+
+AIP segment class
+
+AIP: Appointment Information - Personnel Resource
+The AIP segment contains information about the personnel types that can be scheduled. Personnel included in a
+transaction using this segment are assumed to be controlled by a schedule on a schedule filler application.
+Personnel not controlled by a schedule are not identified on a schedule request using this segment. The kinds of
+personnel described on this segment include any healthcare provider in the institution controlled by a schedule (for
+example: technicians, physicians, nurses, surgeons, anesthesiologists, or CRNAs).
+
+
+Ref: http://hl7-definition.caristix.com:9010/Default.aspx?version=HL7+v2.5.1&segment=AIP
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#aip__destruct)||
+|[getAllowSubstitutionCode](#aipgetallowsubstitutioncode)|Get Allow Substitution Code (AIP.11)|
+|[getDuration](#aipgetduration)|Get Duration (AIP.9)|
+|[getDurationUnits](#aipgetdurationunits)|Get Duration Units (AIP.10)|
+|[getFillerStatusCode](#aipgetfillerstatuscode)|Get Filler Status Code (AIP.12)|
+|[getID](#aipgetid)|Get ID (AIP.1)|
+|[getPersonnelResourceID](#aipgetpersonnelresourceid)|Get Personnel Resource ID (AIP.3)|
+|[getResourceGroup](#aipgetresourcegroup)|Get Resource Group (AIP.5)|
+|[getResourceType](#aipgetresourcetype)|Get Resource Type (AIP.4)|
+|[getSegmentActionCode](#aipgetsegmentactioncode)|Get Segment Action Code (AIP.2)|
+|[getStartDateTime](#aipgetstartdatetime)|Get Start Date Time (AIP.6)|
+|[getStartDateTimeOffset](#aipgetstartdatetimeoffset)|Get Start Date Time Offset (AIP.7)|
+|[getStartDateTimeOffsetUnits](#aipgetstartdatetimeoffsetunits)|Get Start Date Time Offset Units (AIP.8)|
+|[resetIndex](#aipresetindex)|Reset index of this segment|
+|[setAllowSubstitutionCode](#aipsetallowsubstitutioncode)|Set Allow Substitution Code (AIP.11)|
+|[setDuration](#aipsetduration)|Set Duration (AIP.9)|
+|[setDurationUnits](#aipsetdurationunits)|Set Duration Units (AIP.10)|
+|[setFillerStatusCode](#aipsetfillerstatuscode)|Set Filler Status Code (AIP.12)|
+|[setID](#aipsetid)|Set ID (AIP.1)|
+|[setPersonnelResourceID](#aipsetpersonnelresourceid)|Set Personnel Resource ID (AIP.3)|
+|[setResourceGroup](#aipsetresourcegroup)|Set Resource Group (AIP.5)|
+|[setResourceType](#aipsetresourcetype)|Set Resource Type (AIP.4)|
+|[setSegmentActionCode](#aipsetsegmentactioncode)|Set Segment Action Code (AIP.2)|
+|[setStartDateTime](#aipsetstartdatetime)|Set Start Date Time (AIP.6)|
+|[setStartDateTimeOffset](#aipsetstartdatetimeoffset)|Set Start Date Time Offset (AIP.7)|
+|[setStartDateTimeOffsetUnits](#aipsetstartdatetimeoffsetunits)|Set Start Date Time Offset Units (AIP.8)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### AIP::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIP::getAllowSubstitutionCode
+
+**Description**
+
+```php
+public getAllowSubstitutionCode (int $position)
+```
+
+Get Allow Substitution Code (AIP.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getDuration
+
+**Description**
+
+```php
+public getDuration (int $position)
+```
+
+Get Duration (AIP.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getDurationUnits
+
+**Description**
+
+```php
+public getDurationUnits (int $position)
+```
+
+Get Duration Units (AIP.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getFillerStatusCode
+
+**Description**
+
+```php
+public getFillerStatusCode (int $position)
+```
+
+Get Filler Status Code (AIP.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (AIP.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getPersonnelResourceID
+
+**Description**
+
+```php
+public getPersonnelResourceID (int $position)
+```
+
+Get Personnel Resource ID (AIP.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getResourceGroup
+
+**Description**
+
+```php
+public getResourceGroup (int $position)
+```
+
+Get Resource Group (AIP.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getResourceType
+
+**Description**
+
+```php
+public getResourceType (int $position)
+```
+
+Get Resource Type (AIP.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getSegmentActionCode
+
+**Description**
+
+```php
+public getSegmentActionCode (int $position)
+```
+
+Get Segment Action Code (AIP.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getStartDateTime
+
+**Description**
+
+```php
+public getStartDateTime (int $position)
+```
+
+Get Start Date Time (AIP.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getStartDateTimeOffset
+
+**Description**
+
+```php
+public getStartDateTimeOffset (int $position)
+```
+
+Get Start Date Time Offset (AIP.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::getStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public getStartDateTimeOffsetUnits (int $position)
+```
+
+Get Start Date Time Offset Units (AIP.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### AIP::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### AIP::setAllowSubstitutionCode
+
+**Description**
+
+```php
+public setAllowSubstitutionCode (string|int|array|null $value, int $position)
+```
+
+Set Allow Substitution Code (AIP.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setDuration
+
+**Description**
+
+```php
+public setDuration (string|int|array|null $value, int $position)
+```
+
+Set Duration (AIP.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setDurationUnits
+
+**Description**
+
+```php
+public setDurationUnits (string|int|array|null $value, int $position)
+```
+
+Set Duration Units (AIP.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setFillerStatusCode
+
+**Description**
+
+```php
+public setFillerStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Filler Status Code (AIP.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (AIP.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setPersonnelResourceID
+
+**Description**
+
+```php
+public setPersonnelResourceID (string|int|array|null $value, int $position)
+```
+
+Set Personnel Resource ID (AIP.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setResourceGroup
+
+**Description**
+
+```php
+public setResourceGroup (string|int|array|null $value, int $position)
+```
+
+Set Resource Group (AIP.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setResourceType
+
+**Description**
+
+```php
+public setResourceType (string|int|array|null $value, int $position)
+```
+
+Set Resource Type (AIP.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setSegmentActionCode
+
+**Description**
+
+```php
+public setSegmentActionCode (string|int|array|null $value, int $position)
+```
+
+Set Segment Action Code (AIP.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setStartDateTime
+
+**Description**
+
+```php
+public setStartDateTime (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time (AIP.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setStartDateTimeOffset
+
+**Description**
+
+```php
+public setStartDateTimeOffset (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset (AIP.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### AIP::setStartDateTimeOffsetUnits
+
+**Description**
+
+```php
+public setStartDateTimeOffsetUnits (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time Offset Units (AIP.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/DG1.md b/docs/Segments/DG1.md
index 854230c..d96983b 100644
--- a/docs/Segments/DG1.md
+++ b/docs/Segments/DG1.md
@@ -13,50 +13,53 @@ Aranyasen\HL7\Segment
| 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)||
+|[__destruct](#dg1__destruct)||
+|[getAttestationDateTime](#dg1getattestationdatetime)|Get Attestation Date Time (DG1.19)|
+|[getConfidentialIndicator](#dg1getconfidentialindicator)|Get Confidential Indicator (DG1.18)|
+|[getDRGApprovalIndicator](#dg1getdrgapprovalindicator)|Get DRGApproval Indicator (DG1.9)|
+|[getDRGGrouperReviewCode](#dg1getdrggrouperreviewcode)|Get DRGGrouper Review Code (DG1.10)|
+|[getDiagnosingClinician](#dg1getdiagnosingclinician)|Get Diagnosing Clinician (DG1.16)|
+|[getDiagnosisClassification](#dg1getdiagnosisclassification)|Get Diagnosis Classification (DG1.17)|
+|[getDiagnosisCodeDG1](#dg1getdiagnosiscodedg1)|Get Diagnosis Code DG1 (DG1.3)|
+|[getDiagnosisCodingMethod](#dg1getdiagnosiscodingmethod)|Get Diagnosis Coding Method (DG1.2)|
+|[getDiagnosisDateTime](#dg1getdiagnosisdatetime)|Get Diagnosis Date Time (DG1.5)|
+|[getDiagnosisDescription](#dg1getdiagnosisdescription)|Get Diagnosis Description (DG1.4)|
+|[getDiagnosisPriority](#dg1getdiagnosispriority)|Get Diagnosis Priority (DG1.15)|
+|[getDiagnosisType](#dg1getdiagnosistype)|Get Diagnosis Type (DG1.6)|
+|[getDiagnosticRelatedGroup](#dg1getdiagnosticrelatedgroup)|Get Diagnostic Related Group (DG1.8)|
+|[getGrouperVersionAndType](#dg1getgrouperversionandtype)|Get Grouper Version And Type (DG1.14)|
+|[getID](#dg1getid)|Get ID (DG1.1)|
+|[getMajorDiagnosticCategory](#dg1getmajordiagnosticcategory)|Get Major Diagnostic Category (DG1.7)|
+|[getOutlierCost](#dg1getoutliercost)|Get Outlier Cost (DG1.13)|
+|[getOutlierDays](#dg1getoutlierdays)|Get Outlier Days (DG1.12)|
+|[getOutlierType](#dg1getoutliertype)|Get Outlier Type (DG1.11)|
+|[resetIndex](#dg1resetindex)|Reset index of this segment|
+|[setAttestationDateTime](#dg1setattestationdatetime)|Set Attestation Date Time (DG1.19)|
+|[setConfidentialIndicator](#dg1setconfidentialindicator)|Set Confidential Indicator (DG1.18)|
+|[setDRGApprovalIndicator](#dg1setdrgapprovalindicator)|Set DRGApproval Indicator (DG1.9)|
+|[setDRGGrouperReviewCode](#dg1setdrggrouperreviewcode)|Set DRGGrouper Review Code (DG1.10)|
+|[setDiagnosingClinician](#dg1setdiagnosingclinician)|Set Diagnosing Clinician (DG1.16)|
+|[setDiagnosisClassification](#dg1setdiagnosisclassification)|Set Diagnosis Classification (DG1.17)|
|[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)||
+|[setDiagnosisCodingMethod](#dg1setdiagnosiscodingmethod)|Set Diagnosis Coding Method (DG1.2)|
+|[setDiagnosisDateTime](#dg1setdiagnosisdatetime)|Set Diagnosis Date Time (DG1.5)|
+|[setDiagnosisDescription](#dg1setdiagnosisdescription)|Set Diagnosis Description (DG1.4)|
+|[setDiagnosisPriority](#dg1setdiagnosispriority)|Set Diagnosis Priority (DG1.15)|
+|[setDiagnosisType](#dg1setdiagnosistype)|Set Diagnosis Type (DG1.6)|
+|[setDiagnosticRelatedGroup](#dg1setdiagnosticrelatedgroup)|Set Diagnostic Related Group (DG1.8)|
+|[setGrouperVersionAndType](#dg1setgrouperversionandtype)|Set Grouper Version And Type (DG1.14)|
+|[setID](#dg1setid)|Set ID (DG1.1)|
+|[setMajorDiagnosticCategory](#dg1setmajordiagnosticcategory)|Set Major Diagnostic Category (DG1.7)|
+|[setOutlierCost](#dg1setoutliercost)|Set Outlier Cost (DG1.13)|
+|[setOutlierDays](#dg1setoutlierdays)|Set Outlier Days (DG1.12)|
+|[setOutlierType](#dg1setoutliertype)|Set Outlier Type (DG1.11)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -65,12 +68,12 @@ Aranyasen\HL7\Segment
-### DG1::getAttestationDateTime
+### DG1::__destruct
**Description**
```php
-public getAttestationDateTime (void)
+ __destruct (void)
```
@@ -85,28 +88,60 @@ public getAttestationDateTime (void)
`void`
+
-### DG1::getConfidentialIndicator
+### DG1::getAttestationDateTime
**Description**
```php
-public getConfidentialIndicator (void)
+public getAttestationDateTime (int $position)
```
+Get Attestation Date Time (DG1.19)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### DG1::getConfidentialIndicator
+
+**Description**
+
+```php
+public getConfidentialIndicator (int $position)
+```
+
+Get Confidential Indicator (DG1.18)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -116,20 +151,24 @@ public getConfidentialIndicator (void)
**Description**
```php
-public getDRGApprovalIndicator (void)
+public getDRGApprovalIndicator (int $position)
```
-
+Get DRGApproval Indicator (DG1.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -139,20 +178,24 @@ public getDRGApprovalIndicator (void)
**Description**
```php
-public getDRGGrouperReviewCode (void)
+public getDRGGrouperReviewCode (int $position)
```
-
+Get DRGGrouper Review Code (DG1.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -162,20 +205,24 @@ public getDRGGrouperReviewCode (void)
**Description**
```php
-public getDiagnosingClinician (void)
+public getDiagnosingClinician (int $position)
```
-
+Get Diagnosing Clinician (DG1.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -185,20 +232,24 @@ public getDiagnosingClinician (void)
**Description**
```php
-public getDiagnosisClassification (void)
+public getDiagnosisClassification (int $position)
```
-
+Get Diagnosis Classification (DG1.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -208,20 +259,24 @@ public getDiagnosisClassification (void)
**Description**
```php
-public getDiagnosisCodeDG1 (void)
+public getDiagnosisCodeDG1 (int $position)
```
-
+Get Diagnosis Code DG1 (DG1.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -231,20 +286,24 @@ public getDiagnosisCodeDG1 (void)
**Description**
```php
-public getDiagnosisCodingMethod (void)
+public getDiagnosisCodingMethod (int $position)
```
-
+Get Diagnosis Coding Method (DG1.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -254,20 +313,24 @@ public getDiagnosisCodingMethod (void)
**Description**
```php
-public getDiagnosisDateTime (void)
+public getDiagnosisDateTime (int $position)
```
-
+Get Diagnosis Date Time (DG1.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -277,20 +340,24 @@ public getDiagnosisDateTime (void)
**Description**
```php
-public getDiagnosisDescription (void)
+public getDiagnosisDescription (int $position)
```
-
+Get Diagnosis Description (DG1.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -300,20 +367,24 @@ public getDiagnosisDescription (void)
**Description**
```php
-public getDiagnosisPriority (void)
+public getDiagnosisPriority (int $position)
```
-
+Get Diagnosis Priority (DG1.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -323,20 +394,24 @@ public getDiagnosisPriority (void)
**Description**
```php
-public getDiagnosisType (void)
+public getDiagnosisType (int $position)
```
-
+Get Diagnosis Type (DG1.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -346,20 +421,24 @@ public getDiagnosisType (void)
**Description**
```php
-public getDiagnosticRelatedGroup (void)
+public getDiagnosticRelatedGroup (int $position)
```
-
+Get Diagnostic Related Group (DG1.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -369,20 +448,24 @@ public getDiagnosticRelatedGroup (void)
**Description**
```php
-public getGrouperVersionAndType (void)
+public getGrouperVersionAndType (int $position)
```
-
+Get Grouper Version And Type (DG1.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -392,20 +475,24 @@ public getGrouperVersionAndType (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (DG1.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -415,20 +502,24 @@ public getID (void)
**Description**
```php
-public getMajorDiagnosticCategory (void)
+public getMajorDiagnosticCategory (int $position)
```
-
+Get Major Diagnostic Category (DG1.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -438,20 +529,24 @@ public getMajorDiagnosticCategory (void)
**Description**
```php
-public getOutlierCost (void)
+public getOutlierCost (int $position)
```
-
+Get Outlier Cost (DG1.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -461,20 +556,24 @@ public getOutlierCost (void)
**Description**
```php
-public getOutlierDays (void)
+public getOutlierDays (int $position)
```
-
+Get Outlier Days (DG1.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -484,11 +583,38 @@ public getOutlierDays (void)
**Description**
```php
-public getOutlierType (void)
+public getOutlierType (int $position)
```
+Get Outlier Type (DG1.11)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### DG1::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -499,6 +625,7 @@ public getOutlierType (void)
`void`
+
@@ -507,20 +634,25 @@ public getOutlierType (void)
**Description**
```php
-public setAttestationDateTime (void)
+public setAttestationDateTime (string|int|array|null $value, int $position)
```
-
+Set Attestation Date Time (DG1.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -530,20 +662,25 @@ public setAttestationDateTime (void)
**Description**
```php
-public setConfidentialIndicator (void)
+public setConfidentialIndicator (string|int|array|null $value, int $position)
```
-
+Set Confidential Indicator (DG1.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -553,20 +690,25 @@ public setConfidentialIndicator (void)
**Description**
```php
-public setDRGApprovalIndicator (void)
+public setDRGApprovalIndicator (string|int|array|null $value, int $position)
```
-
+Set DRGApproval Indicator (DG1.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -576,20 +718,25 @@ public setDRGApprovalIndicator (void)
**Description**
```php
-public setDRGGrouperReviewCode (void)
+public setDRGGrouperReviewCode (string|int|array|null $value, int $position)
```
-
+Set DRGGrouper Review Code (DG1.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -599,20 +746,25 @@ public setDRGGrouperReviewCode (void)
**Description**
```php
-public setDiagnosingClinician (void)
+public setDiagnosingClinician (string|int|array|null $value, int $position)
```
-
+Set Diagnosing Clinician (DG1.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -622,20 +774,25 @@ public setDiagnosingClinician (void)
**Description**
```php
-public setDiagnosisClassification (void)
+public setDiagnosisClassification (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Classification (DG1.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -645,7 +802,7 @@ public setDiagnosisClassification (void)
**Description**
```php
-public setDiagnosisCodeDG1 (void)
+ setDiagnosisCodeDG1 (void)
```
@@ -660,6 +817,7 @@ public setDiagnosisCodeDG1 (void)
`void`
+
@@ -668,20 +826,25 @@ public setDiagnosisCodeDG1 (void)
**Description**
```php
-public setDiagnosisCodingMethod (void)
+public setDiagnosisCodingMethod (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Coding Method (DG1.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -691,20 +854,25 @@ public setDiagnosisCodingMethod (void)
**Description**
```php
-public setDiagnosisDateTime (void)
+public setDiagnosisDateTime (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Date Time (DG1.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -714,20 +882,25 @@ public setDiagnosisDateTime (void)
**Description**
```php
-public setDiagnosisDescription (void)
+public setDiagnosisDescription (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Description (DG1.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -737,20 +910,25 @@ public setDiagnosisDescription (void)
**Description**
```php
-public setDiagnosisPriority (void)
+public setDiagnosisPriority (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Priority (DG1.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -760,20 +938,25 @@ public setDiagnosisPriority (void)
**Description**
```php
-public setDiagnosisType (void)
+public setDiagnosisType (string|int|array|null $value, int $position)
```
-
+Set Diagnosis Type (DG1.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -783,20 +966,25 @@ public setDiagnosisType (void)
**Description**
```php
-public setDiagnosticRelatedGroup (void)
+public setDiagnosticRelatedGroup (string|int|array|null $value, int $position)
```
-
+Set Diagnostic Related Group (DG1.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -806,20 +994,25 @@ public setDiagnosticRelatedGroup (void)
**Description**
```php
-public setGrouperVersionAndType (void)
+public setGrouperVersionAndType (string|int|array|null $value, int $position)
```
-
+Set Grouper Version And Type (DG1.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -829,20 +1022,25 @@ public setGrouperVersionAndType (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (DG1.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -852,20 +1050,25 @@ public setID (void)
**Description**
```php
-public setMajorDiagnosticCategory (void)
+public setMajorDiagnosticCategory (string|int|array|null $value, int $position)
```
-
+Set Major Diagnostic Category (DG1.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -875,20 +1078,25 @@ public setMajorDiagnosticCategory (void)
**Description**
```php
-public setOutlierCost (void)
+public setOutlierCost (string|int|array|null $value, int $position)
```
-
+Set Outlier Cost (DG1.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -898,20 +1106,25 @@ public setOutlierCost (void)
**Description**
```php
-public setOutlierDays (void)
+public setOutlierDays (string|int|array|null $value, int $position)
```
-
+Set Outlier Days (DG1.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -921,20 +1134,25 @@ public setOutlierDays (void)
**Description**
```php
-public setOutlierType (void)
+public setOutlierType (string|int|array|null $value, int $position)
```
-
+Set Outlier Type (DG1.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/EQU.md b/docs/Segments/EQU.md
index ddf49b7..9edfecf 100644
--- a/docs/Segments/EQU.md
+++ b/docs/Segments/EQU.md
@@ -13,23 +13,24 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAlertLevel](#equgetalertlevel)||
-|[getEquipmentInstanceIdentifier](#equgetequipmentinstanceidentifier)||
-|[getEquipmentState](#equgetequipmentstate)||
-|[getEventDateTime](#equgeteventdatetime)||
-|[getLocalRemoteControlState](#equgetlocalremotecontrolstate)||
+|[getAlertLevel](#equgetalertlevel)|Get Alert Level (EQU.4)|
+|[getEquipmentInstanceIdentifier](#equgetequipmentinstanceidentifier)|Get Equipment Instance Identifier (EQU.1)|
+|[getEquipmentState](#equgetequipmentstate)|Get Equipment State (EQU.3)|
+|[getEventDateTime](#equgeteventdatetime)|Get Event Date Time (EQU.2)|
+|[getLocalRemoteControlState](#equgetlocalremotecontrolstate)|Get Local Remote Control State (EQU.4)|
|[resetIndex](#equresetindex)|Reset index of this segment|
-|[setAlertLevel](#equsetalertlevel)||
+|[setAlertLevel](#equsetalertlevel)|Set Alert Level (EQU.5)|
|[setEquipmentInstanceIdentifier](#equsetequipmentinstanceidentifier)||
-|[setEquipmentState](#equsetequipmentstate)||
-|[setEventDateTime](#equseteventdatetime)||
-|[setLocalRemoteControlState](#equsetlocalremotecontrolstate)||
+|[setEquipmentState](#equsetequipmentstate)|Set Equipment State (EQU.3)|
+|[setEventDateTime](#equseteventdatetime)|Set Event Date Time (EQU.2)|
+|[setLocalRemoteControlState](#equsetlocalremotecontrolstate)|Set Local Remote Control State (EQU.4)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -43,20 +44,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getAlertLevel (void)
+public getAlertLevel (int $position)
```
-
+Get Alert Level (EQU.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -67,20 +71,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getEquipmentInstanceIdentifier (void)
+public getEquipmentInstanceIdentifier (int $position)
```
-
+Get Equipment Instance Identifier (EQU.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -91,20 +98,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getEquipmentState (void)
+public getEquipmentState (int $position)
```
-
+Get Equipment State (EQU.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -115,20 +125,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getEventDateTime (void)
+public getEventDateTime (int $position)
```
-
+Get Event Date Time (EQU.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -139,20 +152,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getLocalRemoteControlState (void)
+public getLocalRemoteControlState (int $position)
```
-
+Get Local Remote Control State (EQU.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -163,7 +179,7 @@ Aranyasen\HL7\Segment
**Description**
```php
-public static resetIndex (int $index)
+public static resetIndex (void)
```
Reset index of this segment
@@ -172,7 +188,7 @@ Reset index of this segment
**Parameters**
-* `(int) $index`
+`This function has no parameters.`
**Return Values**
@@ -187,20 +203,24 @@ Reset index of this segment
**Description**
```php
- setAlertLevel (void)
+public setAlertLevel (string|int|array|null $value, int $position)
```
-
+Set Alert Level (EQU.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
@@ -235,20 +255,24 @@ Reset index of this segment
**Description**
```php
- setEquipmentState (void)
+public setEquipmentState (string|int|array|null $value, int $position)
```
-
+Set Equipment State (EQU.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
@@ -259,20 +283,24 @@ Reset index of this segment
**Description**
```php
- setEventDateTime (void)
+public setEventDateTime (string|int|array|null $value, int $position)
```
-
+Set Event Date Time (EQU.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
@@ -283,20 +311,24 @@ Reset index of this segment
**Description**
```php
- setLocalRemoteControlState (void)
+public setLocalRemoteControlState (string|int|array|null $value, int $position)
```
-
+Set Local Remote Control State (EQU.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
diff --git a/docs/Segments/EVN.md b/docs/Segments/EVN.md
new file mode 100644
index 0000000..a666bd4
--- /dev/null
+++ b/docs/Segments/EVN.md
@@ -0,0 +1,372 @@
+# Aranyasen\HL7\Segments\EVN
+
+EVN segment class
+Ref: http://hl7-definition.caristix.com:9010/HL7%20v2.3.1/segment/EVN
+ https://corepointhealth.com/resource-center/hl7-resources/hl7-evn-event-type-segment
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getDateTimePlannedEvent](#evngetdatetimeplannedevent)|Get Date Time Planned Event (EVN.3)|
+|[getEventOccurred](#evngeteventoccurred)|Get Event Occurred (EVN.6)|
+|[getEventReasonCode](#evngeteventreasoncode)|Get Event Reason Code (EVN.4)|
+|[getEventTypeCode](#evngeteventtypecode)|Get Event Type Code (EVN.1)|
+|[getOperatorID](#evngetoperatorid)|Get Operator ID (EVN.5)|
+|[getRecordedDateTime](#evngetrecordeddatetime)|Get Recorded Date Time (EVN.2)|
+|[setDateTimePlannedEvent](#evnsetdatetimeplannedevent)|Set Date Time Planned Event (EVN.3)|
+|[setEventOccurred](#evnseteventoccurred)|Set Event Occurred (EVN.6)|
+|[setEventReasonCode](#evnseteventreasoncode)|Set Event Reason Code (EVN.4)|
+|[setEventTypeCode](#evnseteventtypecode)|Set Event Type Code (EVN.1)|
+|[setOperatorID](#evnsetoperatorid)|Set Operator ID (EVN.5)|
+|[setRecordedDateTime](#evnsetrecordeddatetime)|Set Recorded Date Time (EVN.2)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### EVN::getDateTimePlannedEvent
+
+**Description**
+
+```php
+public getDateTimePlannedEvent (int $position)
+```
+
+Get Date Time Planned Event (EVN.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::getEventOccurred
+
+**Description**
+
+```php
+public getEventOccurred (int $position)
+```
+
+Get Event Occurred (EVN.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::getEventReasonCode
+
+**Description**
+
+```php
+public getEventReasonCode (int $position)
+```
+
+Get Event Reason Code (EVN.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::getEventTypeCode
+
+**Description**
+
+```php
+public getEventTypeCode (int $position)
+```
+
+Get Event Type Code (EVN.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::getOperatorID
+
+**Description**
+
+```php
+public getOperatorID (int $position)
+```
+
+Get Operator ID (EVN.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::getRecordedDateTime
+
+**Description**
+
+```php
+public getRecordedDateTime (int $position)
+```
+
+Get Recorded Date Time (EVN.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### EVN::setDateTimePlannedEvent
+
+**Description**
+
+```php
+public setDateTimePlannedEvent (string|int|array|null $value, int $position)
+```
+
+Set Date Time Planned Event (EVN.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### EVN::setEventOccurred
+
+**Description**
+
+```php
+public setEventOccurred (string|int|array|null $value, int $position)
+```
+
+Set Event Occurred (EVN.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### EVN::setEventReasonCode
+
+**Description**
+
+```php
+public setEventReasonCode (string|int|array|null $value, int $position)
+```
+
+Set Event Reason Code (EVN.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### EVN::setEventTypeCode
+
+**Description**
+
+```php
+public setEventTypeCode (string|int|array|null $value, int $position)
+```
+
+Set Event Type Code (EVN.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### EVN::setOperatorID
+
+**Description**
+
+```php
+public setOperatorID (string|int|array|null $value, int $position)
+```
+
+Set Operator ID (EVN.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### EVN::setRecordedDateTime
+
+**Description**
+
+```php
+public setRecordedDateTime (string|int|array|null $value, int $position)
+```
+
+Set Recorded Date Time (EVN.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/FHS.md b/docs/Segments/FHS.md
new file mode 100644
index 0000000..e097675
--- /dev/null
+++ b/docs/Segments/FHS.md
@@ -0,0 +1,713 @@
+# Aranyasen\HL7\Segments\FHS
+
+FHS: File Header Segment
+Ref: https://hl7-definition.caristix.com/v2/HL7v2.3/Segments/FHS
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getFileControlId](#fhsgetfilecontrolid)|Get File Control Id (FHS.11)|
+|[getFileCreationDateTime](#fhsgetfilecreationdatetime)|Get File Creation Date Time (FHS.7)|
+|[getFileEncodingCharacters](#fhsgetfileencodingcharacters)|Get File Encoding Characters (FHS.2)|
+|[getFileFieldSeparator](#fhsgetfilefieldseparator)|Get File Field Separator (FHS.1)|
+|[getFileHeaderComment](#fhsgetfileheadercomment)|Get File Header Comment (FHS.10)|
+|[getFileNameId](#fhsgetfilenameid)|Get File Name Id (FHS.9)|
+|[getFileRecievingApplication](#fhsgetfilerecievingapplication)|Get File Recieving Application (FHS.5)|
+|[getFileRecievingFacility](#fhsgetfilerecievingfacility)|Get File Recieving Facility (FHS.6)|
+|[getFileSecurity](#fhsgetfilesecurity)|Get File Security (FHS.8)|
+|[getFileSendingApplication](#fhsgetfilesendingapplication)|Get File Sending Application (FHS.3)|
+|[getFileSendingFacility](#fhsgetfilesendingfacility)|Get File Sending Facility (FHS.4)|
+|[getReferenceFileControlId](#fhsgetreferencefilecontrolid)|Get Reference File Control Id (FHS.12)|
+|[setFileControlId](#fhssetfilecontrolid)|Set File Control Id (FHS.11)|
+|[setFileCreationDateTime](#fhssetfilecreationdatetime)|Set File Creation Date Time (FHS.7)|
+|[setFileEncodingCharacters](#fhssetfileencodingcharacters)|Set File Encoding Characters (FHS.2)|
+|[setFileFieldSeparator](#fhssetfilefieldseparator)|Set File Field Separator (FHS.1)|
+|[setFileHeaderComment](#fhssetfileheadercomment)|Set File Header Comment (FHS.10)|
+|[setFileNameId](#fhssetfilenameid)|Set File Name Id (FHS.9)|
+|[setFileRecievingApplication](#fhssetfilerecievingapplication)|Set File Recieving Application (FHS.5)|
+|[setFileRecievingFacility](#fhssetfilerecievingfacility)|Set File Recieving Facility (FHS.6)|
+|[setFileSecurity](#fhssetfilesecurity)|Set File Security (FHS.8)|
+|[setFileSendingApplication](#fhssetfilesendingapplication)|Set File Sending Application (FHS.3)|
+|[setFileSendingFacility](#fhssetfilesendingfacility)|Set File Sending Facility (FHS.4)|
+|[setReferenceFileControlId](#fhssetreferencefilecontrolid)|Set Reference File Control Id (FHS.12)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### FHS::getFileControlId
+
+**Description**
+
+```php
+public getFileControlId (int $position)
+```
+
+Get File Control Id (FHS.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileCreationDateTime
+
+**Description**
+
+```php
+public getFileCreationDateTime (int $position)
+```
+
+Get File Creation Date Time (FHS.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileEncodingCharacters
+
+**Description**
+
+```php
+public getFileEncodingCharacters (int $position)
+```
+
+Get File Encoding Characters (FHS.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileFieldSeparator
+
+**Description**
+
+```php
+public getFileFieldSeparator (int $position)
+```
+
+Get File Field Separator (FHS.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileHeaderComment
+
+**Description**
+
+```php
+public getFileHeaderComment (int $position)
+```
+
+Get File Header Comment (FHS.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileNameId
+
+**Description**
+
+```php
+public getFileNameId (int $position)
+```
+
+Get File Name Id (FHS.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileRecievingApplication
+
+**Description**
+
+```php
+public getFileRecievingApplication (int $position)
+```
+
+Get File Recieving Application (FHS.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileRecievingFacility
+
+**Description**
+
+```php
+public getFileRecievingFacility (int $position)
+```
+
+Get File Recieving Facility (FHS.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileSecurity
+
+**Description**
+
+```php
+public getFileSecurity (int $position)
+```
+
+Get File Security (FHS.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileSendingApplication
+
+**Description**
+
+```php
+public getFileSendingApplication (int $position)
+```
+
+Get File Sending Application (FHS.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getFileSendingFacility
+
+**Description**
+
+```php
+public getFileSendingFacility (int $position)
+```
+
+Get File Sending Facility (FHS.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::getReferenceFileControlId
+
+**Description**
+
+```php
+public getReferenceFileControlId (int $position)
+```
+
+Get Reference File Control Id (FHS.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FHS::setFileControlId
+
+**Description**
+
+```php
+public setFileControlId (string|int|array|null $value, int $position)
+```
+
+Set File Control Id (FHS.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileCreationDateTime
+
+**Description**
+
+```php
+public setFileCreationDateTime (string|int|array|null $value, int $position)
+```
+
+Set File Creation Date Time (FHS.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileEncodingCharacters
+
+**Description**
+
+```php
+public setFileEncodingCharacters (string|int|array|null $value, int $position)
+```
+
+Set File Encoding Characters (FHS.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileFieldSeparator
+
+**Description**
+
+```php
+public setFileFieldSeparator (string|int|array|null $value, int $position)
+```
+
+Set File Field Separator (FHS.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileHeaderComment
+
+**Description**
+
+```php
+public setFileHeaderComment (string|int|array|null $value, int $position)
+```
+
+Set File Header Comment (FHS.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileNameId
+
+**Description**
+
+```php
+public setFileNameId (string|int|array|null $value, int $position)
+```
+
+Set File Name Id (FHS.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileRecievingApplication
+
+**Description**
+
+```php
+public setFileRecievingApplication (string|int|array|null $value, int $position)
+```
+
+Set File Recieving Application (FHS.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileRecievingFacility
+
+**Description**
+
+```php
+public setFileRecievingFacility (string|int|array|null $value, int $position)
+```
+
+Set File Recieving Facility (FHS.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileSecurity
+
+**Description**
+
+```php
+public setFileSecurity (string|int|array|null $value, int $position)
+```
+
+Set File Security (FHS.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileSendingApplication
+
+**Description**
+
+```php
+public setFileSendingApplication (string|int|array|null $value, int $position)
+```
+
+Set File Sending Application (FHS.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setFileSendingFacility
+
+**Description**
+
+```php
+public setFileSendingFacility (string|int|array|null $value, int $position)
+```
+
+Set File Sending Facility (FHS.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FHS::setReferenceFileControlId
+
+**Description**
+
+```php
+public setReferenceFileControlId (string|int|array|null $value, int $position)
+```
+
+Set Reference File Control Id (FHS.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/FTS.md b/docs/Segments/FTS.md
new file mode 100644
index 0000000..35f5ff0
--- /dev/null
+++ b/docs/Segments/FTS.md
@@ -0,0 +1,143 @@
+# Aranyasen\HL7\Segments\FTS
+
+FTS: File Trailer Segment
+Ref: https://hl7-definition.caristix.com/v2/HL7v2.3/Segments/FTS
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getFileBatchCount](#ftsgetfilebatchcount)|Get File Batch Count (FTS.1)|
+|[getFileTrailerComment](#ftsgetfiletrailercomment)|Get File Trailer Comment (FTS.2)|
+|[setFileBatchCount](#ftssetfilebatchcount)|Set File Batch Count (FTS.1)|
+|[setFileTrailerComment](#ftssetfiletrailercomment)|Set File Trailer Comment (FTS.2)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### FTS::getFileBatchCount
+
+**Description**
+
+```php
+public getFileBatchCount (int $position)
+```
+
+Get File Batch Count (FTS.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FTS::getFileTrailerComment
+
+**Description**
+
+```php
+public getFileTrailerComment (int $position)
+```
+
+Get File Trailer Comment (FTS.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### FTS::setFileBatchCount
+
+**Description**
+
+```php
+public setFileBatchCount (string|int|array|null $value, int $position)
+```
+
+Set File Batch Count (FTS.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### FTS::setFileTrailerComment
+
+**Description**
+
+```php
+public setFileTrailerComment (string|int|array|null $value, int $position)
+```
+
+Set File Trailer Comment (FTS.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/GT1.md b/docs/Segments/GT1.md
new file mode 100644
index 0000000..ee21478
--- /dev/null
+++ b/docs/Segments/GT1.md
@@ -0,0 +1,3324 @@
+# Aranyasen\HL7\Segments\GT1
+
+GT1 segment class
+Reference: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/GT1
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#gt1__destruct)||
+|[getAmbulatoryStatus](#gt1getambulatorystatus)|Get Ambulatory Status (GT1.34)|
+|[getCitizenship](#gt1getcitizenship)|Get Citizenship (GT1.35)|
+|[getContactPersonsName](#gt1getcontactpersonsname)|Get Contact Persons Name (GT1.45)|
+|[getContactPersonsPhone](#gt1getcontactpersonsphone)|Get Contact Persons Phone (GT1.46)|
+|[getContactReason](#gt1getcontactreason)|Get Contact Reason (GT1.47)|
+|[getContactRelationship](#gt1getcontactrelationship)|Get Contact Relationship (GT1.48)|
+|[getEmploymentStopDate](#gt1getemploymentstopdate)|Get Employment Stop Date (GT1.32)|
+|[getEthnicGroup](#gt1getethnicgroup)|Get Ethnic Group (GT1.44)|
+|[getGuarantorAddress](#gt1getguarantoraddress)|Get Guarantor Address (GT1.5)|
+|[getGuarantorAnnualIncome](#gt1getguarantorannualincome)|Get Guarantor Annual Income (GT1.27)|
+|[getGuarantorBeginDate](#gt1getguarantorbegindate)|Get Guarantor Begin Date (GT1.13)|
+|[getGuarantorBillingHoldFlag](#gt1getguarantorbillingholdflag)|Get Guarantor Billing Hold Flag (GT1.22)|
+|[getGuarantorBirthPlace](#gt1getguarantorbirthplace)|Get Guarantor Birth Place (GT1.56)|
+|[getGuarantorBusinessPhone](#gt1getguarantorbusinessphone)|Get Guarantor Business Phone (GT1.7)|
+|[getGuarantorChargeAdjustmentCode](#gt1getguarantorchargeadjustmentcode)|Get Guarantor Charge Adjustment Code (GT1.26)|
+|[getGuarantorCreditRatingCode](#gt1getguarantorcreditratingcode)|Get Guarantor Credit Rating Code (GT1.23)|
+|[getGuarantorDateOfBirth](#gt1getguarantordateofbirth)|Get Guarantor Date Of Birth (GT1.8)|
+|[getGuarantorDeathDateAndTime](#gt1getguarantordeathdateandtime)|Get Guarantor Death Date And Time (GT1.24)|
+|[getGuarantorDeathFlag](#gt1getguarantordeathflag)|Get Guarantor Death Flag (GT1.25)|
+|[getGuarantorEmployeeID](#gt1getguarantoremployeeid)|Get Guarantor Employee ID (GT1.19)|
+|[getGuarantorEmployerAddress](#gt1getguarantoremployeraddress)|Get Guarantor Employer Address (GT1.17)|
+|[getGuarantorEmployerID](#gt1getguarantoremployerid)|Get Guarantor Employer ID (GT1.29)|
+|[getGuarantorEmployerName](#gt1getguarantoremployername)|Get Guarantor Employer Name (GT1.16)|
+|[getGuarantorEmployerPhone](#gt1getguarantoremployerphone)|Get Guarantor Employer Phone (GT1.18)|
+|[getGuarantorEmployersOrganizationName](#gt1getguarantoremployersorganizationname)|Get Guarantor Employers Organization Name (GT1.51)|
+|[getGuarantorEmploymentStatus](#gt1getguarantoremploymentstatus)|Get Guarantor Employment Status (GT1.20)|
+|[getGuarantorEndDate](#gt1getguarantorenddate)|Get Guarantor End Date (GT1.14)|
+|[getGuarantorFinancialClass](#gt1getguarantorfinancialclass)|Get Guarantor Financial Class (GT1.54)|
+|[getGuarantorHireEffectiveDate](#gt1getguarantorhireeffectivedate)|Get Guarantor Hire Effective Date (GT1.31)|
+|[getGuarantorHomePhone](#gt1getguarantorhomephone)|Get Guarantor Home Phone (GT1.6)|
+|[getGuarantorHouseholdSize](#gt1getguarantorhouseholdsize)|Get Guarantor Household Size (GT1.28)|
+|[getGuarantorMaritalStatusCode](#gt1getguarantormaritalstatuscode)|Get Guarantor Marital Status Code (GT1.30)|
+|[getGuarantorName](#gt1getguarantorname)|Get Guarantor Name (GT1.3)|
+|[getGuarantorNumber](#gt1getguarantornumber)|Get Guarantor Number (GT1.2)|
+|[getGuarantorOrganizationName](#gt1getguarantororganizationname)|Get Guarantor Organization Name (GT1.21)|
+|[getGuarantorPriority](#gt1getguarantorpriority)|Get Guarantor Priority (GT1.15)|
+|[getGuarantorRace](#gt1getguarantorrace)|Get Guarantor Race (GT1.55)|
+|[getGuarantorRelationship](#gt1getguarantorrelationship)|Get Guarantor Relationship (GT1.11)|
+|[getGuarantorSSN](#gt1getguarantorssn)|Get Guarantor SSN (GT1.12)|
+|[getGuarantorSex](#gt1getguarantorsex)|Get Guarantor Sex (GT1.9)|
+|[getGuarantorSpouseName](#gt1getguarantorspousename)|Get Guarantor Spouse Name (GT1.4)|
+|[getGuarantorType](#gt1getguarantortype)|Get Guarantor Type (GT1.10)|
+|[getHandicap](#gt1gethandicap)|Get Handicap (GT1.52)|
+|[getID](#gt1getid)|Get ID (GT1.1)|
+|[getJobClass](#gt1getjobclass)|Get Job Class (GT1.50)|
+|[getJobStatus](#gt1getjobstatus)|Get Job Status (GT1.53)|
+|[getJobTitle](#gt1getjobtitle)|Get Job Title (GT1.49)|
+|[getLivingArrangement](#gt1getlivingarrangement)|Get Living Arrangement (GT1.37)|
+|[getLivingDependency](#gt1getlivingdependency)|Get Living Dependency (GT1.33)|
+|[getMotherMaidenName](#gt1getmothermaidenname)|Get Mother Maiden Name (GT1.42)|
+|[getNationality](#gt1getnationality)|Get Nationality (GT1.43)|
+|[getPrimaryLanguage](#gt1getprimarylanguage)|Get Primary Language (GT1.36)|
+|[getProtectionIndicator](#gt1getprotectionindicator)|Get Protection Indicator (GT1.39)|
+|[getPublicityCode](#gt1getpublicitycode)|Get Publicity Code (GT1.38)|
+|[getReligion](#gt1getreligion)|Get Religion (GT1.41)|
+|[getStudentIndicator](#gt1getstudentindicator)|Get Student Indicator (GT1.40)|
+|[getVipIndicator](#gt1getvipindicator)|Get Vip Indicator (GT1.57)|
+|[resetIndex](#gt1resetindex)|Reset index of this segment|
+|[setAmbulatoryStatus](#gt1setambulatorystatus)|Set Ambulatory Status (GT1.34)|
+|[setCitizenship](#gt1setcitizenship)|Set Citizenship (GT1.35)|
+|[setContactPersonsName](#gt1setcontactpersonsname)|Set Contact Persons Name (GT1.45)|
+|[setContactPersonsPhone](#gt1setcontactpersonsphone)|Set Contact Persons Phone (GT1.46)|
+|[setContactReason](#gt1setcontactreason)|Set Contact Reason (GT1.47)|
+|[setContactRelationship](#gt1setcontactrelationship)|Set Contact Relationship (GT1.48)|
+|[setEmploymentStopDate](#gt1setemploymentstopdate)|Set Employment Stop Date (GT1.32)|
+|[setEthnicGroup](#gt1setethnicgroup)|Set Ethnic Group (GT1.44)|
+|[setGuarantorAddress](#gt1setguarantoraddress)|Set Guarantor Address (GT1.5)|
+|[setGuarantorAnnualIncome](#gt1setguarantorannualincome)|Set Guarantor Annual Income (GT1.27)|
+|[setGuarantorBeginDate](#gt1setguarantorbegindate)|Set Guarantor Begin Date (GT1.13)|
+|[setGuarantorBillingHoldFlag](#gt1setguarantorbillingholdflag)|Set Guarantor Billing Hold Flag (GT1.22)|
+|[setGuarantorBirthPlace](#gt1setguarantorbirthplace)|Set Guarantor Birth Place (GT1.56)|
+|[setGuarantorBusinessPhone](#gt1setguarantorbusinessphone)|Set Guarantor Business Phone (GT1.7)|
+|[setGuarantorChargeAdjustmentCode](#gt1setguarantorchargeadjustmentcode)|Set Guarantor Charge Adjustment Code (GT1.26)|
+|[setGuarantorCreditRatingCode](#gt1setguarantorcreditratingcode)|Set Guarantor Credit Rating Code (GT1.23)|
+|[setGuarantorDateOfBirth](#gt1setguarantordateofbirth)|Set Guarantor Date Of Birth (GT1.8)|
+|[setGuarantorDeathDateAndTime](#gt1setguarantordeathdateandtime)|Set Guarantor Death Date And Time (GT1.24)|
+|[setGuarantorDeathFlag](#gt1setguarantordeathflag)|Set Guarantor Death Flag (GT1.25)|
+|[setGuarantorEmployeeID](#gt1setguarantoremployeeid)|Set Guarantor Employee ID (GT1.19)|
+|[setGuarantorEmployerAddress](#gt1setguarantoremployeraddress)|Set Guarantor Employer Address (GT1.17)|
+|[setGuarantorEmployerID](#gt1setguarantoremployerid)|Set Guarantor Employer ID (GT1.29)|
+|[setGuarantorEmployerName](#gt1setguarantoremployername)|Set Guarantor Employer Name (GT1.16)|
+|[setGuarantorEmployerPhone](#gt1setguarantoremployerphone)|Set Guarantor Employer Phone (GT1.18)|
+|[setGuarantorEmployersOrganizationName](#gt1setguarantoremployersorganizationname)|Set Guarantor Employers Organization Name (GT1.51)|
+|[setGuarantorEmploymentStatus](#gt1setguarantoremploymentstatus)|Set Guarantor Employment Status (GT1.20)|
+|[setGuarantorEndDate](#gt1setguarantorenddate)|Set Guarantor End Date (GT1.14)|
+|[setGuarantorFinancialClass](#gt1setguarantorfinancialclass)|Set Guarantor Financial Class (GT1.54)|
+|[setGuarantorHireEffectiveDate](#gt1setguarantorhireeffectivedate)|Set Guarantor Hire Effective Date (GT1.31)|
+|[setGuarantorHomePhone](#gt1setguarantorhomephone)|Set Guarantor Home Phone (GT1.6)|
+|[setGuarantorHouseholdSize](#gt1setguarantorhouseholdsize)|Set Guarantor Household Size (GT1.28)|
+|[setGuarantorMaritalStatusCode](#gt1setguarantormaritalstatuscode)|Set Guarantor Marital Status Code (GT1.30)|
+|[setGuarantorName](#gt1setguarantorname)|Set Guarantor Name (GT1.3)|
+|[setGuarantorNumber](#gt1setguarantornumber)|Set Guarantor Number (GT1.2)|
+|[setGuarantorOrganizationName](#gt1setguarantororganizationname)|Set Guarantor Organization Name (GT1.21)|
+|[setGuarantorPriority](#gt1setguarantorpriority)|Set Guarantor Priority (GT1.15)|
+|[setGuarantorRace](#gt1setguarantorrace)|Set Guarantor Race (GT1.55)|
+|[setGuarantorRelationship](#gt1setguarantorrelationship)|Set Guarantor Relationship (GT1.11)|
+|[setGuarantorSSN](#gt1setguarantorssn)|Set Guarantor SSN (GT1.12)|
+|[setGuarantorSex](#gt1setguarantorsex)||
+|[setGuarantorSpouseName](#gt1setguarantorspousename)|Set Guarantor Spouse Name (GT1.4)|
+|[setGuarantorType](#gt1setguarantortype)|Set Guarantor Type (GT1.10)|
+|[setHandicap](#gt1sethandicap)|Set Handicap (GT1.52)|
+|[setID](#gt1setid)|Set ID (GT1.1)|
+|[setJobClass](#gt1setjobclass)|Set Job Class (GT1.50)|
+|[setJobStatus](#gt1setjobstatus)|Set Job Status (GT1.53)|
+|[setJobTitle](#gt1setjobtitle)|Set Job Title (GT1.49)|
+|[setLivingArrangement](#gt1setlivingarrangement)|Set Living Arrangement (GT1.37)|
+|[setLivingDependency](#gt1setlivingdependency)|Set Living Dependency (GT1.33)|
+|[setMotherMaidenName](#gt1setmothermaidenname)|Set Mother Maiden Name (GT1.42)|
+|[setNationality](#gt1setnationality)|Set Nationality (GT1.43)|
+|[setPrimaryLanguage](#gt1setprimarylanguage)|Set Primary Language (GT1.36)|
+|[setProtectionIndicator](#gt1setprotectionindicator)|Set Protection Indicator (GT1.39)|
+|[setPublicityCode](#gt1setpublicitycode)|Set Publicity Code (GT1.38)|
+|[setReligion](#gt1setreligion)|Set Religion (GT1.41)|
+|[setStudentIndicator](#gt1setstudentindicator)|Set Student Indicator (GT1.40)|
+|[setVipIndicator](#gt1setvipindicator)|Set Vip Indicator (GT1.57)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### GT1::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### GT1::getAmbulatoryStatus
+
+**Description**
+
+```php
+public getAmbulatoryStatus (int $position)
+```
+
+Get Ambulatory Status (GT1.34)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getCitizenship
+
+**Description**
+
+```php
+public getCitizenship (int $position)
+```
+
+Get Citizenship (GT1.35)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getContactPersonsName
+
+**Description**
+
+```php
+public getContactPersonsName (int $position)
+```
+
+Get Contact Persons Name (GT1.45)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 45
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getContactPersonsPhone
+
+**Description**
+
+```php
+public getContactPersonsPhone (int $position)
+```
+
+Get Contact Persons Phone (GT1.46)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 46
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getContactReason
+
+**Description**
+
+```php
+public getContactReason (int $position)
+```
+
+Get Contact Reason (GT1.47)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 47
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getContactRelationship
+
+**Description**
+
+```php
+public getContactRelationship (int $position)
+```
+
+Get Contact Relationship (GT1.48)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 48
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getEmploymentStopDate
+
+**Description**
+
+```php
+public getEmploymentStopDate (int $position)
+```
+
+Get Employment Stop Date (GT1.32)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getEthnicGroup
+
+**Description**
+
+```php
+public getEthnicGroup (int $position)
+```
+
+Get Ethnic Group (GT1.44)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 44
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorAddress
+
+**Description**
+
+```php
+public getGuarantorAddress (int $position)
+```
+
+Get Guarantor Address (GT1.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorAnnualIncome
+
+**Description**
+
+```php
+public getGuarantorAnnualIncome (int $position)
+```
+
+Get Guarantor Annual Income (GT1.27)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorBeginDate
+
+**Description**
+
+```php
+public getGuarantorBeginDate (int $position)
+```
+
+Get Guarantor Begin Date (GT1.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorBillingHoldFlag
+
+**Description**
+
+```php
+public getGuarantorBillingHoldFlag (int $position)
+```
+
+Get Guarantor Billing Hold Flag (GT1.22)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorBirthPlace
+
+**Description**
+
+```php
+public getGuarantorBirthPlace (int $position)
+```
+
+Get Guarantor Birth Place (GT1.56)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 56
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorBusinessPhone
+
+**Description**
+
+```php
+public getGuarantorBusinessPhone (int $position)
+```
+
+Get Guarantor Business Phone (GT1.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorChargeAdjustmentCode
+
+**Description**
+
+```php
+public getGuarantorChargeAdjustmentCode (int $position)
+```
+
+Get Guarantor Charge Adjustment Code (GT1.26)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorCreditRatingCode
+
+**Description**
+
+```php
+public getGuarantorCreditRatingCode (int $position)
+```
+
+Get Guarantor Credit Rating Code (GT1.23)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorDateOfBirth
+
+**Description**
+
+```php
+public getGuarantorDateOfBirth (int $position)
+```
+
+Get Guarantor Date Of Birth (GT1.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorDeathDateAndTime
+
+**Description**
+
+```php
+public getGuarantorDeathDateAndTime (int $position)
+```
+
+Get Guarantor Death Date And Time (GT1.24)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorDeathFlag
+
+**Description**
+
+```php
+public getGuarantorDeathFlag (int $position)
+```
+
+Get Guarantor Death Flag (GT1.25)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployeeID
+
+**Description**
+
+```php
+public getGuarantorEmployeeID (int $position)
+```
+
+Get Guarantor Employee ID (GT1.19)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployerAddress
+
+**Description**
+
+```php
+public getGuarantorEmployerAddress (int $position)
+```
+
+Get Guarantor Employer Address (GT1.17)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployerID
+
+**Description**
+
+```php
+public getGuarantorEmployerID (int $position)
+```
+
+Get Guarantor Employer ID (GT1.29)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployerName
+
+**Description**
+
+```php
+public getGuarantorEmployerName (int $position)
+```
+
+Get Guarantor Employer Name (GT1.16)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployerPhone
+
+**Description**
+
+```php
+public getGuarantorEmployerPhone (int $position)
+```
+
+Get Guarantor Employer Phone (GT1.18)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmployersOrganizationName
+
+**Description**
+
+```php
+public getGuarantorEmployersOrganizationName (int $position)
+```
+
+Get Guarantor Employers Organization Name (GT1.51)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 51
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEmploymentStatus
+
+**Description**
+
+```php
+public getGuarantorEmploymentStatus (int $position)
+```
+
+Get Guarantor Employment Status (GT1.20)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorEndDate
+
+**Description**
+
+```php
+public getGuarantorEndDate (int $position)
+```
+
+Get Guarantor End Date (GT1.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorFinancialClass
+
+**Description**
+
+```php
+public getGuarantorFinancialClass (int $position)
+```
+
+Get Guarantor Financial Class (GT1.54)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 54
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorHireEffectiveDate
+
+**Description**
+
+```php
+public getGuarantorHireEffectiveDate (int $position)
+```
+
+Get Guarantor Hire Effective Date (GT1.31)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorHomePhone
+
+**Description**
+
+```php
+public getGuarantorHomePhone (int $position)
+```
+
+Get Guarantor Home Phone (GT1.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorHouseholdSize
+
+**Description**
+
+```php
+public getGuarantorHouseholdSize (int $position)
+```
+
+Get Guarantor Household Size (GT1.28)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorMaritalStatusCode
+
+**Description**
+
+```php
+public getGuarantorMaritalStatusCode (int $position)
+```
+
+Get Guarantor Marital Status Code (GT1.30)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorName
+
+**Description**
+
+```php
+public getGuarantorName (int $position)
+```
+
+Get Guarantor Name (GT1.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorNumber
+
+**Description**
+
+```php
+public getGuarantorNumber (int $position)
+```
+
+Get Guarantor Number (GT1.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorOrganizationName
+
+**Description**
+
+```php
+public getGuarantorOrganizationName (int $position)
+```
+
+Get Guarantor Organization Name (GT1.21)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorPriority
+
+**Description**
+
+```php
+public getGuarantorPriority (int $position)
+```
+
+Get Guarantor Priority (GT1.15)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorRace
+
+**Description**
+
+```php
+public getGuarantorRace (int $position)
+```
+
+Get Guarantor Race (GT1.55)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 55
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorRelationship
+
+**Description**
+
+```php
+public getGuarantorRelationship (int $position)
+```
+
+Get Guarantor Relationship (GT1.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorSSN
+
+**Description**
+
+```php
+public getGuarantorSSN (int $position)
+```
+
+Get Guarantor SSN (GT1.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorSex
+
+**Description**
+
+```php
+public getGuarantorSex (int $position)
+```
+
+Get Guarantor Sex (GT1.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorSpouseName
+
+**Description**
+
+```php
+public getGuarantorSpouseName (int $position)
+```
+
+Get Guarantor Spouse Name (GT1.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getGuarantorType
+
+**Description**
+
+```php
+public getGuarantorType (int $position)
+```
+
+Get Guarantor Type (GT1.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getHandicap
+
+**Description**
+
+```php
+public getHandicap (int $position)
+```
+
+Get Handicap (GT1.52)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 52
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (GT1.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getJobClass
+
+**Description**
+
+```php
+public getJobClass (int $position)
+```
+
+Get Job Class (GT1.50)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 50
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getJobStatus
+
+**Description**
+
+```php
+public getJobStatus (int $position)
+```
+
+Get Job Status (GT1.53)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 53
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getJobTitle
+
+**Description**
+
+```php
+public getJobTitle (int $position)
+```
+
+Get Job Title (GT1.49)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 49
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getLivingArrangement
+
+**Description**
+
+```php
+public getLivingArrangement (int $position)
+```
+
+Get Living Arrangement (GT1.37)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getLivingDependency
+
+**Description**
+
+```php
+public getLivingDependency (int $position)
+```
+
+Get Living Dependency (GT1.33)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getMotherMaidenName
+
+**Description**
+
+```php
+public getMotherMaidenName (int $position)
+```
+
+Get Mother Maiden Name (GT1.42)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 42
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getNationality
+
+**Description**
+
+```php
+public getNationality (int $position)
+```
+
+Get Nationality (GT1.43)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 43
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getPrimaryLanguage
+
+**Description**
+
+```php
+public getPrimaryLanguage (int $position)
+```
+
+Get Primary Language (GT1.36)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getProtectionIndicator
+
+**Description**
+
+```php
+public getProtectionIndicator (int $position)
+```
+
+Get Protection Indicator (GT1.39)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getPublicityCode
+
+**Description**
+
+```php
+public getPublicityCode (int $position)
+```
+
+Get Publicity Code (GT1.38)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getReligion
+
+**Description**
+
+```php
+public getReligion (int $position)
+```
+
+Get Religion (GT1.41)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 41
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getStudentIndicator
+
+**Description**
+
+```php
+public getStudentIndicator (int $position)
+```
+
+Get Student Indicator (GT1.40)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 40
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::getVipIndicator
+
+**Description**
+
+```php
+public getVipIndicator (int $position)
+```
+
+Get Vip Indicator (GT1.57)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 57
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### GT1::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### GT1::setAmbulatoryStatus
+
+**Description**
+
+```php
+public setAmbulatoryStatus (string|int|array|null $value, int $position)
+```
+
+Set Ambulatory Status (GT1.34)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setCitizenship
+
+**Description**
+
+```php
+public setCitizenship (string|int|array|null $value, int $position)
+```
+
+Set Citizenship (GT1.35)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setContactPersonsName
+
+**Description**
+
+```php
+public setContactPersonsName (string|int|array|null $value, int $position)
+```
+
+Set Contact Persons Name (GT1.45)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 45
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setContactPersonsPhone
+
+**Description**
+
+```php
+public setContactPersonsPhone (string|int|array|null $value, int $position)
+```
+
+Set Contact Persons Phone (GT1.46)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 46
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setContactReason
+
+**Description**
+
+```php
+public setContactReason (string|int|array|null $value, int $position)
+```
+
+Set Contact Reason (GT1.47)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 47
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setContactRelationship
+
+**Description**
+
+```php
+public setContactRelationship (string|int|array|null $value, int $position)
+```
+
+Set Contact Relationship (GT1.48)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 48
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setEmploymentStopDate
+
+**Description**
+
+```php
+public setEmploymentStopDate (string|int|array|null $value, int $position)
+```
+
+Set Employment Stop Date (GT1.32)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setEthnicGroup
+
+**Description**
+
+```php
+public setEthnicGroup (string|int|array|null $value, int $position)
+```
+
+Set Ethnic Group (GT1.44)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 44
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorAddress
+
+**Description**
+
+```php
+public setGuarantorAddress (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Address (GT1.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorAnnualIncome
+
+**Description**
+
+```php
+public setGuarantorAnnualIncome (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Annual Income (GT1.27)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorBeginDate
+
+**Description**
+
+```php
+public setGuarantorBeginDate (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Begin Date (GT1.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorBillingHoldFlag
+
+**Description**
+
+```php
+public setGuarantorBillingHoldFlag (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Billing Hold Flag (GT1.22)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorBirthPlace
+
+**Description**
+
+```php
+public setGuarantorBirthPlace (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Birth Place (GT1.56)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 56
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorBusinessPhone
+
+**Description**
+
+```php
+public setGuarantorBusinessPhone (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Business Phone (GT1.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorChargeAdjustmentCode
+
+**Description**
+
+```php
+public setGuarantorChargeAdjustmentCode (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Charge Adjustment Code (GT1.26)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorCreditRatingCode
+
+**Description**
+
+```php
+public setGuarantorCreditRatingCode (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Credit Rating Code (GT1.23)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorDateOfBirth
+
+**Description**
+
+```php
+public setGuarantorDateOfBirth (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Date Of Birth (GT1.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorDeathDateAndTime
+
+**Description**
+
+```php
+public setGuarantorDeathDateAndTime (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Death Date And Time (GT1.24)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorDeathFlag
+
+**Description**
+
+```php
+public setGuarantorDeathFlag (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Death Flag (GT1.25)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployeeID
+
+**Description**
+
+```php
+public setGuarantorEmployeeID (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employee ID (GT1.19)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployerAddress
+
+**Description**
+
+```php
+public setGuarantorEmployerAddress (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employer Address (GT1.17)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployerID
+
+**Description**
+
+```php
+public setGuarantorEmployerID (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employer ID (GT1.29)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployerName
+
+**Description**
+
+```php
+public setGuarantorEmployerName (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employer Name (GT1.16)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployerPhone
+
+**Description**
+
+```php
+public setGuarantorEmployerPhone (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employer Phone (GT1.18)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmployersOrganizationName
+
+**Description**
+
+```php
+public setGuarantorEmployersOrganizationName (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employers Organization Name (GT1.51)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 51
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEmploymentStatus
+
+**Description**
+
+```php
+public setGuarantorEmploymentStatus (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Employment Status (GT1.20)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorEndDate
+
+**Description**
+
+```php
+public setGuarantorEndDate (string|int|array|null $value, int $position)
+```
+
+Set Guarantor End Date (GT1.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorFinancialClass
+
+**Description**
+
+```php
+public setGuarantorFinancialClass (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Financial Class (GT1.54)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 54
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorHireEffectiveDate
+
+**Description**
+
+```php
+public setGuarantorHireEffectiveDate (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Hire Effective Date (GT1.31)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorHomePhone
+
+**Description**
+
+```php
+public setGuarantorHomePhone (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Home Phone (GT1.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorHouseholdSize
+
+**Description**
+
+```php
+public setGuarantorHouseholdSize (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Household Size (GT1.28)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorMaritalStatusCode
+
+**Description**
+
+```php
+public setGuarantorMaritalStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Marital Status Code (GT1.30)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorName
+
+**Description**
+
+```php
+public setGuarantorName (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Name (GT1.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorNumber
+
+**Description**
+
+```php
+public setGuarantorNumber (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Number (GT1.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorOrganizationName
+
+**Description**
+
+```php
+public setGuarantorOrganizationName (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Organization Name (GT1.21)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorPriority
+
+**Description**
+
+```php
+public setGuarantorPriority (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Priority (GT1.15)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorRace
+
+**Description**
+
+```php
+public setGuarantorRace (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Race (GT1.55)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 55
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorRelationship
+
+**Description**
+
+```php
+public setGuarantorRelationship (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Relationship (GT1.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorSSN
+
+**Description**
+
+```php
+public setGuarantorSSN (string|int|array|null $value, int $position)
+```
+
+Set Guarantor SSN (GT1.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorSex
+
+**Description**
+
+```php
+ setGuarantorSex (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### GT1::setGuarantorSpouseName
+
+**Description**
+
+```php
+public setGuarantorSpouseName (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Spouse Name (GT1.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setGuarantorType
+
+**Description**
+
+```php
+public setGuarantorType (string|int|array|null $value, int $position)
+```
+
+Set Guarantor Type (GT1.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setHandicap
+
+**Description**
+
+```php
+public setHandicap (string|int|array|null $value, int $position)
+```
+
+Set Handicap (GT1.52)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 52
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (GT1.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setJobClass
+
+**Description**
+
+```php
+public setJobClass (string|int|array|null $value, int $position)
+```
+
+Set Job Class (GT1.50)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 50
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setJobStatus
+
+**Description**
+
+```php
+public setJobStatus (string|int|array|null $value, int $position)
+```
+
+Set Job Status (GT1.53)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 53
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setJobTitle
+
+**Description**
+
+```php
+public setJobTitle (string|int|array|null $value, int $position)
+```
+
+Set Job Title (GT1.49)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 49
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setLivingArrangement
+
+**Description**
+
+```php
+public setLivingArrangement (string|int|array|null $value, int $position)
+```
+
+Set Living Arrangement (GT1.37)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setLivingDependency
+
+**Description**
+
+```php
+public setLivingDependency (string|int|array|null $value, int $position)
+```
+
+Set Living Dependency (GT1.33)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setMotherMaidenName
+
+**Description**
+
+```php
+public setMotherMaidenName (string|int|array|null $value, int $position)
+```
+
+Set Mother Maiden Name (GT1.42)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 42
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setNationality
+
+**Description**
+
+```php
+public setNationality (string|int|array|null $value, int $position)
+```
+
+Set Nationality (GT1.43)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 43
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setPrimaryLanguage
+
+**Description**
+
+```php
+public setPrimaryLanguage (string|int|array|null $value, int $position)
+```
+
+Set Primary Language (GT1.36)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setProtectionIndicator
+
+**Description**
+
+```php
+public setProtectionIndicator (string|int|array|null $value, int $position)
+```
+
+Set Protection Indicator (GT1.39)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setPublicityCode
+
+**Description**
+
+```php
+public setPublicityCode (string|int|array|null $value, int $position)
+```
+
+Set Publicity Code (GT1.38)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setReligion
+
+**Description**
+
+```php
+public setReligion (string|int|array|null $value, int $position)
+```
+
+Set Religion (GT1.41)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 41
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setStudentIndicator
+
+**Description**
+
+```php
+public setStudentIndicator (string|int|array|null $value, int $position)
+```
+
+Set Student Indicator (GT1.40)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 40
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### GT1::setVipIndicator
+
+**Description**
+
+```php
+public setVipIndicator (string|int|array|null $value, int $position)
+```
+
+Set Vip Indicator (GT1.57)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 57
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/IN1.md b/docs/Segments/IN1.md
index b0f7e7d..1e62f36 100644
--- a/docs/Segments/IN1.md
+++ b/docs/Segments/IN1.md
@@ -13,110 +13,113 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAssignmentOfBenefits](#in1getassignmentofbenefits)||
-|[getAuthorizationInformation](#in1getauthorizationinformation)||
-|[getBillingStatus](#in1getbillingstatus)||
-|[getCompanyPlanCode](#in1getcompanyplancode)||
-|[getCoordOfBenPriority](#in1getcoordofbenpriority)||
-|[getCoordinationOfBenefits](#in1getcoordinationofbenefits)||
-|[getCoverageType](#in1getcoveragetype)||
-|[getDelayBeforeLRDay](#in1getdelaybeforelrday)||
-|[getGroupName](#in1getgroupname)||
-|[getGroupNumber](#in1getgroupnumber)||
-|[getHandicap](#in1gethandicap)||
-|[getID](#in1getid)||
-|[getInsuranceCoContactPerson](#in1getinsurancecocontactperson)||
-|[getInsuranceCoPhoneNumber](#in1getinsurancecophonenumber)||
-|[getInsuranceCompanyAddress](#in1getinsurancecompanyaddress)||
-|[getInsuranceCompanyID](#in1getinsurancecompanyid)||
-|[getInsuranceCompanyName](#in1getinsurancecompanyname)||
-|[getInsurancePlanID](#in1getinsuranceplanid)||
-|[getInsuredsAddress](#in1getinsuredsaddress)||
-|[getInsuredsDateOfBirth](#in1getinsuredsdateofbirth)||
-|[getInsuredsEmployersAddress](#in1getinsuredsemployersaddress)||
-|[getInsuredsEmploymentStatus](#in1getinsuredsemploymentstatus)||
-|[getInsuredsGroupEmpID](#in1getinsuredsgroupempid)||
-|[getInsuredsGroupEmpName](#in1getinsuredsgroupempname)||
-|[getInsuredsIDNumber](#in1getinsuredsidnumber)||
-|[getInsuredsRelationshipToPatient](#in1getinsuredsrelationshiptopatient)||
-|[getInsuredsSex](#in1getinsuredssex)||
-|[getLifetimeReserveDays](#in1getlifetimereservedays)||
-|[getNameOfInsured](#in1getnameofinsured)||
-|[getNoticeOfAdmissionDate](#in1getnoticeofadmissiondate)||
-|[getNoticeOfAdmissionFlag](#in1getnoticeofadmissionflag)||
-|[getPlanEffectiveDate](#in1getplaneffectivedate)||
-|[getPlanExpirationDate](#in1getplanexpirationdate)||
-|[getPlanType](#in1getplantype)||
-|[getPolicyDeductible](#in1getpolicydeductible)||
-|[getPolicyLimitAmount](#in1getpolicylimitamount)||
-|[getPolicyLimitDays](#in1getpolicylimitdays)||
-|[getPolicyNumber](#in1getpolicynumber)||
-|[getPreAdmitCertPAC](#in1getpreadmitcertpac)||
-|[getPriorInsurancePlanID](#in1getpriorinsuranceplanid)||
-|[getReleaseInformationCode](#in1getreleaseinformationcode)||
-|[getReportOfEligibilityDate](#in1getreportofeligibilitydate)||
-|[getReportOfEligibilityFlag](#in1getreportofeligibilityflag)||
-|[getRoomRatePrivate](#in1getroomrateprivate)||
-|[getRoomRateSemiPrivate](#in1getroomratesemiprivate)||
-|[getTypeOfAgreementCode](#in1gettypeofagreementcode)||
-|[getVerificationBy](#in1getverificationby)||
-|[getVerificationDateTime](#in1getverificationdatetime)||
-|[getVerificationStatus](#in1getverificationstatus)||
-|[setAssignmentOfBenefits](#in1setassignmentofbenefits)||
-|[setAuthorizationInformation](#in1setauthorizationinformation)||
-|[setBillingStatus](#in1setbillingstatus)||
-|[setCompanyPlanCode](#in1setcompanyplancode)||
-|[setCoordOfBenPriority](#in1setcoordofbenpriority)||
-|[setCoordinationOfBenefits](#in1setcoordinationofbenefits)||
-|[setCoverageType](#in1setcoveragetype)||
-|[setDelayBeforeLRDay](#in1setdelaybeforelrday)||
-|[setGroupName](#in1setgroupname)||
-|[setGroupNumber](#in1setgroupnumber)||
-|[setHandicap](#in1sethandicap)||
+|[__destruct](#in1__destruct)||
+|[getAssignmentOfBenefits](#in1getassignmentofbenefits)|Get Assignment Of Benefits (IN1.20)|
+|[getAuthorizationInformation](#in1getauthorizationinformation)|Get Authorization Information (IN1.14)|
+|[getBillingStatus](#in1getbillingstatus)|Get Billing Status (IN1.32)|
+|[getCompanyPlanCode](#in1getcompanyplancode)|Get Company Plan Code (IN1.35)|
+|[getCoordOfBenPriority](#in1getcoordofbenpriority)|Get Coord Of Ben Priority (IN1.22)|
+|[getCoordinationOfBenefits](#in1getcoordinationofbenefits)|Get Coordination Of Benefits (IN1.21)|
+|[getCoverageType](#in1getcoveragetype)|Get Coverage Type (IN1.47)|
+|[getDelayBeforeLRDay](#in1getdelaybeforelrday)|Get Delay Before LRDay (IN1.34)|
+|[getGroupName](#in1getgroupname)|Get Group Name (IN1.9)|
+|[getGroupNumber](#in1getgroupnumber)|Get Group Number (IN1.8)|
+|[getHandicap](#in1gethandicap)|Get Handicap (IN1.48)|
+|[getID](#in1getid)|Get ID (IN1.1)|
+|[getInsuranceCoContactPerson](#in1getinsurancecocontactperson)|Get Insurance Co Contact Person (IN1.6)|
+|[getInsuranceCoPhoneNumber](#in1getinsurancecophonenumber)|Get Insurance Co Phone Number (IN1.7)|
+|[getInsuranceCompanyAddress](#in1getinsurancecompanyaddress)|Get Insurance Company Address (IN1.5)|
+|[getInsuranceCompanyID](#in1getinsurancecompanyid)|Get Insurance Company ID (IN1.3)|
+|[getInsuranceCompanyName](#in1getinsurancecompanyname)|Get Insurance Company Name (IN1.4)|
+|[getInsurancePlanID](#in1getinsuranceplanid)|Get Insurance Plan ID (IN1.2)|
+|[getInsuredsAddress](#in1getinsuredsaddress)|Get Insureds Address (IN1.19)|
+|[getInsuredsDateOfBirth](#in1getinsuredsdateofbirth)|Get Insureds Date Of Birth (IN1.18)|
+|[getInsuredsEmployersAddress](#in1getinsuredsemployersaddress)|Get Insureds Employers Address (IN1.44)|
+|[getInsuredsEmploymentStatus](#in1getinsuredsemploymentstatus)|Get Insureds Employment Status (IN1.42)|
+|[getInsuredsGroupEmpID](#in1getinsuredsgroupempid)|Get Insureds Group Emp ID (IN1.10)|
+|[getInsuredsGroupEmpName](#in1getinsuredsgroupempname)|Get Insureds Group Emp Name (IN1.11)|
+|[getInsuredsIDNumber](#in1getinsuredsidnumber)|Get Insureds IDNumber (IN1.49)|
+|[getInsuredsRelationshipToPatient](#in1getinsuredsrelationshiptopatient)|Get Insureds Relationship To Patient (IN1.17)|
+|[getInsuredsSex](#in1getinsuredssex)|Get Insureds Sex (IN1.43)|
+|[getLifetimeReserveDays](#in1getlifetimereservedays)|Get Lifetime Reserve Days (IN1.33)|
+|[getNameOfInsured](#in1getnameofinsured)|Get Name Of Insured (IN1.16)|
+|[getNoticeOfAdmissionDate](#in1getnoticeofadmissiondate)|Get Notice Of Admission Date (IN1.24)|
+|[getNoticeOfAdmissionFlag](#in1getnoticeofadmissionflag)|Get Notice Of Admission Flag (IN1.23)|
+|[getPlanEffectiveDate](#in1getplaneffectivedate)|Get Plan Effective Date (IN1.12)|
+|[getPlanExpirationDate](#in1getplanexpirationdate)|Get Plan Expiration Date (IN1.13)|
+|[getPlanType](#in1getplantype)|Get Plan Type (IN1.15)|
+|[getPolicyDeductible](#in1getpolicydeductible)|Get Policy Deductible (IN1.37)|
+|[getPolicyLimitAmount](#in1getpolicylimitamount)|Get Policy Limit Amount (IN1.38)|
+|[getPolicyLimitDays](#in1getpolicylimitdays)|Get Policy Limit Days (IN1.39)|
+|[getPolicyNumber](#in1getpolicynumber)|Get Policy Number (IN1.36)|
+|[getPreAdmitCertPAC](#in1getpreadmitcertpac)|Get Pre Admit Cert PAC (IN1.28)|
+|[getPriorInsurancePlanID](#in1getpriorinsuranceplanid)|Get Prior Insurance Plan ID (IN1.46)|
+|[getReleaseInformationCode](#in1getreleaseinformationcode)|Get Release Information Code (IN1.27)|
+|[getReportOfEligibilityDate](#in1getreportofeligibilitydate)|Get Report Of Eligibility Date (IN1.26)|
+|[getReportOfEligibilityFlag](#in1getreportofeligibilityflag)|Get Report Of Eligibility Flag (IN1.25)|
+|[getRoomRatePrivate](#in1getroomrateprivate)|Get Room Rate Private (IN1.41)|
+|[getRoomRateSemiPrivate](#in1getroomratesemiprivate)|Get Room Rate Semi Private (IN1.40)|
+|[getTypeOfAgreementCode](#in1gettypeofagreementcode)|Get Type Of Agreement Code (IN1.31)|
+|[getVerificationBy](#in1getverificationby)|Get Verification By (IN1.30)|
+|[getVerificationDateTime](#in1getverificationdatetime)|Get Verification Date Time (IN1.29)|
+|[getVerificationStatus](#in1getverificationstatus)|Get Verification Status (IN1.45)|
+|[resetIndex](#in1resetindex)|Reset index of this segment|
+|[setAssignmentOfBenefits](#in1setassignmentofbenefits)|Set Assignment Of Benefits (IN1.20)|
+|[setAuthorizationInformation](#in1setauthorizationinformation)|Set Authorization Information (IN1.14)|
+|[setBillingStatus](#in1setbillingstatus)|Set Billing Status (IN1.32)|
+|[setCompanyPlanCode](#in1setcompanyplancode)|Set Company Plan Code (IN1.35)|
+|[setCoordOfBenPriority](#in1setcoordofbenpriority)|Set Coord Of Ben Priority (IN1.22)|
+|[setCoordinationOfBenefits](#in1setcoordinationofbenefits)|Set Coordination Of Benefits (IN1.21)|
+|[setCoverageType](#in1setcoveragetype)|Set Coverage Type (IN1.47)|
+|[setDelayBeforeLRDay](#in1setdelaybeforelrday)|Set Delay Before LRDay (IN1.34)|
+|[setGroupName](#in1setgroupname)|Set Group Name (IN1.9)|
+|[setGroupNumber](#in1setgroupnumber)|Set Group Number (IN1.8)|
+|[setHandicap](#in1sethandicap)|Set Handicap (IN1.48)|
|[setID](#in1setid)||
-|[setInsuranceCoContactPerson](#in1setinsurancecocontactperson)||
-|[setInsuranceCoPhoneNumber](#in1setinsurancecophonenumber)||
-|[setInsuranceCompanyAddress](#in1setinsurancecompanyaddress)||
-|[setInsuranceCompanyID](#in1setinsurancecompanyid)||
-|[setInsuranceCompanyName](#in1setinsurancecompanyname)||
-|[setInsurancePlanID](#in1setinsuranceplanid)||
-|[setInsuredsAddress](#in1setinsuredsaddress)||
-|[setInsuredsDateOfBirth](#in1setinsuredsdateofbirth)||
-|[setInsuredsEmployersAddress](#in1setinsuredsemployersaddress)||
-|[setInsuredsEmploymentStatus](#in1setinsuredsemploymentstatus)||
-|[setInsuredsGroupEmpID](#in1setinsuredsgroupempid)||
-|[setInsuredsGroupEmpName](#in1setinsuredsgroupempname)||
-|[setInsuredsIDNumber](#in1setinsuredsidnumber)||
-|[setInsuredsRelationshipToPatient](#in1setinsuredsrelationshiptopatient)||
-|[setInsuredsSex](#in1setinsuredssex)||
-|[setLifetimeReserveDays](#in1setlifetimereservedays)||
-|[setNameOfInsured](#in1setnameofinsured)||
-|[setNoticeOfAdmissionDate](#in1setnoticeofadmissiondate)||
-|[setNoticeOfAdmissionFlag](#in1setnoticeofadmissionflag)||
-|[setPlanEffectiveDate](#in1setplaneffectivedate)||
-|[setPlanExpirationDate](#in1setplanexpirationdate)||
-|[setPlanType](#in1setplantype)||
-|[setPolicyDeductible](#in1setpolicydeductible)||
-|[setPolicyLimitAmount](#in1setpolicylimitamount)||
-|[setPolicyLimitDays](#in1setpolicylimitdays)||
-|[setPolicyNumber](#in1setpolicynumber)||
-|[setPreAdmitCertPAC](#in1setpreadmitcertpac)||
-|[setPriorInsurancePlanID](#in1setpriorinsuranceplanid)||
-|[setReleaseInformationCode](#in1setreleaseinformationcode)||
-|[setReportOfEligibilityDate](#in1setreportofeligibilitydate)||
-|[setReportOfEligibilityFlag](#in1setreportofeligibilityflag)||
-|[setRoomRatePrivate](#in1setroomrateprivate)||
-|[setRoomRateSemiPrivate](#in1setroomratesemiprivate)||
-|[setTypeOfAgreementCode](#in1settypeofagreementcode)||
-|[setVerificationBy](#in1setverificationby)||
-|[setVerificationDateTime](#in1setverificationdatetime)||
-|[setVerificationStatus](#in1setverificationstatus)||
+|[setInsuranceCoContactPerson](#in1setinsurancecocontactperson)|Set Insurance Co Contact Person (IN1.6)|
+|[setInsuranceCoPhoneNumber](#in1setinsurancecophonenumber)|Set Insurance Co Phone Number (IN1.7)|
+|[setInsuranceCompanyAddress](#in1setinsurancecompanyaddress)|Set Insurance Company Address (IN1.5)|
+|[setInsuranceCompanyID](#in1setinsurancecompanyid)|Set Insurance Company ID (IN1.3)|
+|[setInsuranceCompanyName](#in1setinsurancecompanyname)|Set Insurance Company Name (IN1.4)|
+|[setInsurancePlanID](#in1setinsuranceplanid)|Set Insurance Plan ID (IN1.2)|
+|[setInsuredsAddress](#in1setinsuredsaddress)|Set Insureds Address (IN1.19)|
+|[setInsuredsDateOfBirth](#in1setinsuredsdateofbirth)|Set Insureds Date Of Birth (IN1.18)|
+|[setInsuredsEmployersAddress](#in1setinsuredsemployersaddress)|Set Insureds Employers Address (IN1.44)|
+|[setInsuredsEmploymentStatus](#in1setinsuredsemploymentstatus)|Set Insureds Employment Status (IN1.42)|
+|[setInsuredsGroupEmpID](#in1setinsuredsgroupempid)|Set Insureds Group Emp ID (IN1.10)|
+|[setInsuredsGroupEmpName](#in1setinsuredsgroupempname)|Set Insureds Group Emp Name (IN1.11)|
+|[setInsuredsIDNumber](#in1setinsuredsidnumber)|Set Insureds IDNumber (IN1.49)|
+|[setInsuredsRelationshipToPatient](#in1setinsuredsrelationshiptopatient)|Set Insureds Relationship To Patient (IN1.17)|
+|[setInsuredsSex](#in1setinsuredssex)|Set Insureds Sex (IN1.43)|
+|[setLifetimeReserveDays](#in1setlifetimereservedays)|Set Lifetime Reserve Days (IN1.33)|
+|[setNameOfInsured](#in1setnameofinsured)|Set Name Of Insured (IN1.16)|
+|[setNoticeOfAdmissionDate](#in1setnoticeofadmissiondate)|Set Notice Of Admission Date (IN1.24)|
+|[setNoticeOfAdmissionFlag](#in1setnoticeofadmissionflag)|Set Notice Of Admission Flag (IN1.23)|
+|[setPlanEffectiveDate](#in1setplaneffectivedate)|Set Plan Effective Date (IN1.12)|
+|[setPlanExpirationDate](#in1setplanexpirationdate)|Set Plan Expiration Date (IN1.13)|
+|[setPlanType](#in1setplantype)|Set Plan Type (IN1.15)|
+|[setPolicyDeductible](#in1setpolicydeductible)|Set Policy Deductible (IN1.37)|
+|[setPolicyLimitAmount](#in1setpolicylimitamount)|Set Policy Limit Amount (IN1.38)|
+|[setPolicyLimitDays](#in1setpolicylimitdays)|Set Policy Limit Days (IN1.39)|
+|[setPolicyNumber](#in1setpolicynumber)|Set Policy Number (IN1.36)|
+|[setPreAdmitCertPAC](#in1setpreadmitcertpac)|Set Pre Admit Cert PAC (IN1.28)|
+|[setPriorInsurancePlanID](#in1setpriorinsuranceplanid)|Set Prior Insurance Plan ID (IN1.46)|
+|[setReleaseInformationCode](#in1setreleaseinformationcode)|Set Release Information Code (IN1.27)|
+|[setReportOfEligibilityDate](#in1setreportofeligibilitydate)|Set Report Of Eligibility Date (IN1.26)|
+|[setReportOfEligibilityFlag](#in1setreportofeligibilityflag)|Set Report Of Eligibility Flag (IN1.25)|
+|[setRoomRatePrivate](#in1setroomrateprivate)|Set Room Rate Private (IN1.41)|
+|[setRoomRateSemiPrivate](#in1setroomratesemiprivate)|Set Room Rate Semi Private (IN1.40)|
+|[setTypeOfAgreementCode](#in1settypeofagreementcode)|Set Type Of Agreement Code (IN1.31)|
+|[setVerificationBy](#in1setverificationby)|Set Verification By (IN1.30)|
+|[setVerificationDateTime](#in1setverificationdatetime)|Set Verification Date Time (IN1.29)|
+|[setVerificationStatus](#in1setverificationstatus)|Set Verification Status (IN1.45)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -125,12 +128,12 @@ Aranyasen\HL7\Segment
-### IN1::getAssignmentOfBenefits
+### IN1::__destruct
**Description**
```php
-public getAssignmentOfBenefits (void)
+ __destruct (void)
```
@@ -145,28 +148,60 @@ public getAssignmentOfBenefits (void)
`void`
+
-### IN1::getAuthorizationInformation
+### IN1::getAssignmentOfBenefits
**Description**
```php
-public getAuthorizationInformation (void)
+public getAssignmentOfBenefits (int $position)
```
+Get Assignment Of Benefits (IN1.20)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### IN1::getAuthorizationInformation
+
+**Description**
+
+```php
+public getAuthorizationInformation (int $position)
+```
+
+Get Authorization Information (IN1.14)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -176,20 +211,24 @@ public getAuthorizationInformation (void)
**Description**
```php
-public getBillingStatus (void)
+public getBillingStatus (int $position)
```
-
+Get Billing Status (IN1.32)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -199,20 +238,24 @@ public getBillingStatus (void)
**Description**
```php
-public getCompanyPlanCode (void)
+public getCompanyPlanCode (int $position)
```
-
+Get Company Plan Code (IN1.35)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -222,20 +265,24 @@ public getCompanyPlanCode (void)
**Description**
```php
-public getCoordOfBenPriority (void)
+public getCoordOfBenPriority (int $position)
```
-
+Get Coord Of Ben Priority (IN1.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -245,20 +292,24 @@ public getCoordOfBenPriority (void)
**Description**
```php
-public getCoordinationOfBenefits (void)
+public getCoordinationOfBenefits (int $position)
```
-
+Get Coordination Of Benefits (IN1.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -268,20 +319,24 @@ public getCoordinationOfBenefits (void)
**Description**
```php
-public getCoverageType (void)
+public getCoverageType (int $position)
```
-
+Get Coverage Type (IN1.47)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 47
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -291,20 +346,24 @@ public getCoverageType (void)
**Description**
```php
-public getDelayBeforeLRDay (void)
+public getDelayBeforeLRDay (int $position)
```
-
+Get Delay Before LRDay (IN1.34)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -314,20 +373,24 @@ public getDelayBeforeLRDay (void)
**Description**
```php
-public getGroupName (void)
+public getGroupName (int $position)
```
-
+Get Group Name (IN1.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -337,20 +400,24 @@ public getGroupName (void)
**Description**
```php
-public getGroupNumber (void)
+public getGroupNumber (int $position)
```
-
+Get Group Number (IN1.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -360,20 +427,24 @@ public getGroupNumber (void)
**Description**
```php
-public getHandicap (void)
+public getHandicap (int $position)
```
-
+Get Handicap (IN1.48)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 48
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -383,20 +454,24 @@ public getHandicap (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (IN1.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -406,20 +481,24 @@ public getID (void)
**Description**
```php
-public getInsuranceCoContactPerson (void)
+public getInsuranceCoContactPerson (int $position)
```
-
+Get Insurance Co Contact Person (IN1.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -429,20 +508,24 @@ public getInsuranceCoContactPerson (void)
**Description**
```php
-public getInsuranceCoPhoneNumber (void)
+public getInsuranceCoPhoneNumber (int $position)
```
-
+Get Insurance Co Phone Number (IN1.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -452,20 +535,24 @@ public getInsuranceCoPhoneNumber (void)
**Description**
```php
-public getInsuranceCompanyAddress (void)
+public getInsuranceCompanyAddress (int $position)
```
-
+Get Insurance Company Address (IN1.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -475,20 +562,24 @@ public getInsuranceCompanyAddress (void)
**Description**
```php
-public getInsuranceCompanyID (void)
+public getInsuranceCompanyID (int $position)
```
-
+Get Insurance Company ID (IN1.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -498,20 +589,24 @@ public getInsuranceCompanyID (void)
**Description**
```php
-public getInsuranceCompanyName (void)
+public getInsuranceCompanyName (int $position)
```
-
+Get Insurance Company Name (IN1.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -521,20 +616,24 @@ public getInsuranceCompanyName (void)
**Description**
```php
-public getInsurancePlanID (void)
+public getInsurancePlanID (int $position)
```
-
+Get Insurance Plan ID (IN1.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -544,20 +643,24 @@ public getInsurancePlanID (void)
**Description**
```php
-public getInsuredsAddress (void)
+public getInsuredsAddress (int $position)
```
-
+Get Insureds Address (IN1.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -567,20 +670,24 @@ public getInsuredsAddress (void)
**Description**
```php
-public getInsuredsDateOfBirth (void)
+public getInsuredsDateOfBirth (int $position)
```
-
+Get Insureds Date Of Birth (IN1.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -590,20 +697,24 @@ public getInsuredsDateOfBirth (void)
**Description**
```php
-public getInsuredsEmployersAddress (void)
+public getInsuredsEmployersAddress (int $position)
```
-
+Get Insureds Employers Address (IN1.44)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 44
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -613,20 +724,24 @@ public getInsuredsEmployersAddress (void)
**Description**
```php
-public getInsuredsEmploymentStatus (void)
+public getInsuredsEmploymentStatus (int $position)
```
-
+Get Insureds Employment Status (IN1.42)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -636,20 +751,24 @@ public getInsuredsEmploymentStatus (void)
**Description**
```php
-public getInsuredsGroupEmpID (void)
+public getInsuredsGroupEmpID (int $position)
```
-
+Get Insureds Group Emp ID (IN1.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -659,20 +778,24 @@ public getInsuredsGroupEmpID (void)
**Description**
```php
-public getInsuredsGroupEmpName (void)
+public getInsuredsGroupEmpName (int $position)
```
-
+Get Insureds Group Emp Name (IN1.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -682,20 +805,24 @@ public getInsuredsGroupEmpName (void)
**Description**
```php
-public getInsuredsIDNumber (void)
+public getInsuredsIDNumber (int $position)
```
-
+Get Insureds IDNumber (IN1.49)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 49
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -705,20 +832,24 @@ public getInsuredsIDNumber (void)
**Description**
```php
-public getInsuredsRelationshipToPatient (void)
+public getInsuredsRelationshipToPatient (int $position)
```
-
+Get Insureds Relationship To Patient (IN1.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -728,20 +859,24 @@ public getInsuredsRelationshipToPatient (void)
**Description**
```php
-public getInsuredsSex (void)
+public getInsuredsSex (int $position)
```
-
+Get Insureds Sex (IN1.43)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -751,20 +886,24 @@ public getInsuredsSex (void)
**Description**
```php
-public getLifetimeReserveDays (void)
+public getLifetimeReserveDays (int $position)
```
-
+Get Lifetime Reserve Days (IN1.33)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 33
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -774,20 +913,24 @@ public getLifetimeReserveDays (void)
**Description**
```php
-public getNameOfInsured (void)
+public getNameOfInsured (int $position)
```
-
+Get Name Of Insured (IN1.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -797,20 +940,24 @@ public getNameOfInsured (void)
**Description**
```php
-public getNoticeOfAdmissionDate (void)
+public getNoticeOfAdmissionDate (int $position)
```
-
+Get Notice Of Admission Date (IN1.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -820,20 +967,24 @@ public getNoticeOfAdmissionDate (void)
**Description**
```php
-public getNoticeOfAdmissionFlag (void)
+public getNoticeOfAdmissionFlag (int $position)
```
-
+Get Notice Of Admission Flag (IN1.23)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -843,20 +994,24 @@ public getNoticeOfAdmissionFlag (void)
**Description**
```php
-public getPlanEffectiveDate (void)
+public getPlanEffectiveDate (int $position)
```
-
+Get Plan Effective Date (IN1.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -866,20 +1021,24 @@ public getPlanEffectiveDate (void)
**Description**
```php
-public getPlanExpirationDate (void)
+public getPlanExpirationDate (int $position)
```
-
+Get Plan Expiration Date (IN1.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -889,20 +1048,24 @@ public getPlanExpirationDate (void)
**Description**
```php
-public getPlanType (void)
+public getPlanType (int $position)
```
-
+Get Plan Type (IN1.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -912,20 +1075,24 @@ public getPlanType (void)
**Description**
```php
-public getPolicyDeductible (void)
+public getPolicyDeductible (int $position)
```
-
+Get Policy Deductible (IN1.37)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -935,20 +1102,24 @@ public getPolicyDeductible (void)
**Description**
```php
-public getPolicyLimitAmount (void)
+public getPolicyLimitAmount (int $position)
```
-
+Get Policy Limit Amount (IN1.38)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -958,20 +1129,24 @@ public getPolicyLimitAmount (void)
**Description**
```php
-public getPolicyLimitDays (void)
+public getPolicyLimitDays (int $position)
```
-
+Get Policy Limit Days (IN1.39)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -981,20 +1156,24 @@ public getPolicyLimitDays (void)
**Description**
```php
-public getPolicyNumber (void)
+public getPolicyNumber (int $position)
```
-
+Get Policy Number (IN1.36)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1004,20 +1183,24 @@ public getPolicyNumber (void)
**Description**
```php
-public getPreAdmitCertPAC (void)
+public getPreAdmitCertPAC (int $position)
```
-
+Get Pre Admit Cert PAC (IN1.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1027,20 +1210,24 @@ public getPreAdmitCertPAC (void)
**Description**
```php
-public getPriorInsurancePlanID (void)
+public getPriorInsurancePlanID (int $position)
```
-
+Get Prior Insurance Plan ID (IN1.46)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 46
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1050,20 +1237,24 @@ public getPriorInsurancePlanID (void)
**Description**
```php
-public getReleaseInformationCode (void)
+public getReleaseInformationCode (int $position)
```
-
+Get Release Information Code (IN1.27)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1073,20 +1264,24 @@ public getReleaseInformationCode (void)
**Description**
```php
-public getReportOfEligibilityDate (void)
+public getReportOfEligibilityDate (int $position)
```
-
+Get Report Of Eligibility Date (IN1.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1096,20 +1291,24 @@ public getReportOfEligibilityDate (void)
**Description**
```php
-public getReportOfEligibilityFlag (void)
+public getReportOfEligibilityFlag (int $position)
```
-
+Get Report Of Eligibility Flag (IN1.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1119,20 +1318,24 @@ public getReportOfEligibilityFlag (void)
**Description**
```php
-public getRoomRatePrivate (void)
+public getRoomRatePrivate (int $position)
```
-
+Get Room Rate Private (IN1.41)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1142,20 +1345,24 @@ public getRoomRatePrivate (void)
**Description**
```php
-public getRoomRateSemiPrivate (void)
+public getRoomRateSemiPrivate (int $position)
```
-
+Get Room Rate Semi Private (IN1.40)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1165,20 +1372,24 @@ public getRoomRateSemiPrivate (void)
**Description**
```php
-public getTypeOfAgreementCode (void)
+public getTypeOfAgreementCode (int $position)
```
-
+Get Type Of Agreement Code (IN1.31)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1188,20 +1399,24 @@ public getTypeOfAgreementCode (void)
**Description**
```php
-public getVerificationBy (void)
+public getVerificationBy (int $position)
```
-
+Get Verification By (IN1.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1211,20 +1426,24 @@ public getVerificationBy (void)
**Description**
```php
-public getVerificationDateTime (void)
+public getVerificationDateTime (int $position)
```
-
+Get Verification Date Time (IN1.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1234,11 +1453,38 @@ public getVerificationDateTime (void)
**Description**
```php
-public getVerificationStatus (void)
+public getVerificationStatus (int $position)
```
+Get Verification Status (IN1.45)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 45
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### IN1::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -1249,6 +1495,7 @@ public getVerificationStatus (void)
`void`
+
@@ -1257,20 +1504,25 @@ public getVerificationStatus (void)
**Description**
```php
-public setAssignmentOfBenefits (void)
+public setAssignmentOfBenefits (string|int|array|null $value, int $position)
```
-
+Set Assignment Of Benefits (IN1.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1280,20 +1532,25 @@ public setAssignmentOfBenefits (void)
**Description**
```php
-public setAuthorizationInformation (void)
+public setAuthorizationInformation (string|int|array|null $value, int $position)
```
-
+Set Authorization Information (IN1.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1303,20 +1560,25 @@ public setAuthorizationInformation (void)
**Description**
```php
-public setBillingStatus (void)
+public setBillingStatus (string|int|array|null $value, int $position)
```
-
+Set Billing Status (IN1.32)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1326,20 +1588,25 @@ public setBillingStatus (void)
**Description**
```php
-public setCompanyPlanCode (void)
+public setCompanyPlanCode (string|int|array|null $value, int $position)
```
-
+Set Company Plan Code (IN1.35)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1349,20 +1616,25 @@ public setCompanyPlanCode (void)
**Description**
```php
-public setCoordOfBenPriority (void)
+public setCoordOfBenPriority (string|int|array|null $value, int $position)
```
-
+Set Coord Of Ben Priority (IN1.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1372,20 +1644,25 @@ public setCoordOfBenPriority (void)
**Description**
```php
-public setCoordinationOfBenefits (void)
+public setCoordinationOfBenefits (string|int|array|null $value, int $position)
```
-
+Set Coordination Of Benefits (IN1.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`bool`
+
-**Return Values**
-`void`
@@ -1395,20 +1672,25 @@ public setCoordinationOfBenefits (void)
**Description**
```php
-public setCoverageType (void)
+public setCoverageType (string|int|array|null $value, int $position)
```
-
+Set Coverage Type (IN1.47)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 47
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1418,20 +1700,25 @@ public setCoverageType (void)
**Description**
```php
-public setDelayBeforeLRDay (void)
+public setDelayBeforeLRDay (string|int|array|null $value, int $position)
```
-
+Set Delay Before LRDay (IN1.34)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1441,20 +1728,25 @@ public setDelayBeforeLRDay (void)
**Description**
```php
-public setGroupName (void)
+public setGroupName (string|int|array|null $value, int $position)
```
-
+Set Group Name (IN1.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1464,20 +1756,25 @@ public setGroupName (void)
**Description**
```php
-public setGroupNumber (void)
+public setGroupNumber (string|int|array|null $value, int $position)
```
-
+Set Group Number (IN1.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1487,20 +1784,25 @@ public setGroupNumber (void)
**Description**
```php
-public setHandicap (void)
+public setHandicap (string|int|array|null $value, int $position)
```
-
+Set Handicap (IN1.48)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 48
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1510,7 +1812,7 @@ public setHandicap (void)
**Description**
```php
-public setID (void)
+ setID (void)
```
@@ -1525,6 +1827,7 @@ public setID (void)
`void`
+
@@ -1533,20 +1836,25 @@ public setID (void)
**Description**
```php
-public setInsuranceCoContactPerson (void)
+public setInsuranceCoContactPerson (string|int|array|null $value, int $position)
```
-
+Set Insurance Co Contact Person (IN1.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1556,20 +1864,25 @@ public setInsuranceCoContactPerson (void)
**Description**
```php
-public setInsuranceCoPhoneNumber (void)
+public setInsuranceCoPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Insurance Co Phone Number (IN1.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1579,20 +1892,25 @@ public setInsuranceCoPhoneNumber (void)
**Description**
```php
-public setInsuranceCompanyAddress (void)
+public setInsuranceCompanyAddress (string|int|array|null $value, int $position)
```
-
+Set Insurance Company Address (IN1.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1602,20 +1920,25 @@ public setInsuranceCompanyAddress (void)
**Description**
```php
-public setInsuranceCompanyID (void)
+public setInsuranceCompanyID (string|int|array|null $value, int $position)
```
-
+Set Insurance Company ID (IN1.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1625,20 +1948,25 @@ public setInsuranceCompanyID (void)
**Description**
```php
-public setInsuranceCompanyName (void)
+public setInsuranceCompanyName (string|int|array|null $value, int $position)
```
-
+Set Insurance Company Name (IN1.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1648,20 +1976,25 @@ public setInsuranceCompanyName (void)
**Description**
```php
-public setInsurancePlanID (void)
+public setInsurancePlanID (string|int|array|null $value, int $position)
```
-
+Set Insurance Plan ID (IN1.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1671,20 +2004,25 @@ public setInsurancePlanID (void)
**Description**
```php
-public setInsuredsAddress (void)
+public setInsuredsAddress (string|int|array|null $value, int $position)
```
-
+Set Insureds Address (IN1.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1694,20 +2032,25 @@ public setInsuredsAddress (void)
**Description**
```php
-public setInsuredsDateOfBirth (void)
+public setInsuredsDateOfBirth (string|int|array|null $value, int $position)
```
-
+Set Insureds Date Of Birth (IN1.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1717,20 +2060,25 @@ public setInsuredsDateOfBirth (void)
**Description**
```php
-public setInsuredsEmployersAddress (void)
+public setInsuredsEmployersAddress (string|int|array|null $value, int $position)
```
-
+Set Insureds Employers Address (IN1.44)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 44
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1740,20 +2088,25 @@ public setInsuredsEmployersAddress (void)
**Description**
```php
-public setInsuredsEmploymentStatus (void)
+public setInsuredsEmploymentStatus (string|int|array|null $value, int $position)
```
-
+Set Insureds Employment Status (IN1.42)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1763,20 +2116,25 @@ public setInsuredsEmploymentStatus (void)
**Description**
```php
-public setInsuredsGroupEmpID (void)
+public setInsuredsGroupEmpID (string|int|array|null $value, int $position)
```
-
+Set Insureds Group Emp ID (IN1.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1786,20 +2144,25 @@ public setInsuredsGroupEmpID (void)
**Description**
```php
-public setInsuredsGroupEmpName (void)
+public setInsuredsGroupEmpName (string|int|array|null $value, int $position)
```
-
+Set Insureds Group Emp Name (IN1.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1809,20 +2172,25 @@ public setInsuredsGroupEmpName (void)
**Description**
```php
-public setInsuredsIDNumber (void)
+public setInsuredsIDNumber (string|int|array|null $value, int $position)
```
-
+Set Insureds IDNumber (IN1.49)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 49
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1832,20 +2200,25 @@ public setInsuredsIDNumber (void)
**Description**
```php
-public setInsuredsRelationshipToPatient (void)
+public setInsuredsRelationshipToPatient (string|int|array|null $value, int $position)
```
-
+Set Insureds Relationship To Patient (IN1.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1855,20 +2228,25 @@ public setInsuredsRelationshipToPatient (void)
**Description**
```php
-public setInsuredsSex (void)
+public setInsuredsSex (string|int|array|null $value, int $position)
```
-
+Set Insureds Sex (IN1.43)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1878,20 +2256,25 @@ public setInsuredsSex (void)
**Description**
```php
-public setLifetimeReserveDays (void)
+public setLifetimeReserveDays (string|int|array|null $value, int $position)
```
-
+Set Lifetime Reserve Days (IN1.33)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1901,20 +2284,25 @@ public setLifetimeReserveDays (void)
**Description**
```php
-public setNameOfInsured (void)
+public setNameOfInsured (string|int|array|null $value, int $position)
```
-
+Set Name Of Insured (IN1.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1924,20 +2312,25 @@ public setNameOfInsured (void)
**Description**
```php
-public setNoticeOfAdmissionDate (void)
+public setNoticeOfAdmissionDate (string|int|array|null $value, int $position)
```
-
+Set Notice Of Admission Date (IN1.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1947,20 +2340,25 @@ public setNoticeOfAdmissionDate (void)
**Description**
```php
-public setNoticeOfAdmissionFlag (void)
+public setNoticeOfAdmissionFlag (string|int|array|null $value, int $position)
```
-
+Set Notice Of Admission Flag (IN1.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1970,20 +2368,25 @@ public setNoticeOfAdmissionFlag (void)
**Description**
```php
-public setPlanEffectiveDate (void)
+public setPlanEffectiveDate (string|int|array|null $value, int $position)
```
-
+Set Plan Effective Date (IN1.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1993,20 +2396,25 @@ public setPlanEffectiveDate (void)
**Description**
```php
-public setPlanExpirationDate (void)
+public setPlanExpirationDate (string|int|array|null $value, int $position)
```
-
+Set Plan Expiration Date (IN1.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2016,20 +2424,25 @@ public setPlanExpirationDate (void)
**Description**
```php
-public setPlanType (void)
+public setPlanType (string|int|array|null $value, int $position)
```
-
+Set Plan Type (IN1.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2039,20 +2452,25 @@ public setPlanType (void)
**Description**
```php
-public setPolicyDeductible (void)
+public setPolicyDeductible (string|int|array|null $value, int $position)
```
-
+Set Policy Deductible (IN1.37)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2062,20 +2480,25 @@ public setPolicyDeductible (void)
**Description**
```php
-public setPolicyLimitAmount (void)
+public setPolicyLimitAmount (string|int|array|null $value, int $position)
```
-
+Set Policy Limit Amount (IN1.38)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2085,20 +2508,25 @@ public setPolicyLimitAmount (void)
**Description**
```php
-public setPolicyLimitDays (void)
+public setPolicyLimitDays (string|int|array|null $value, int $position)
```
-
+Set Policy Limit Days (IN1.39)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2108,20 +2536,25 @@ public setPolicyLimitDays (void)
**Description**
```php
-public setPolicyNumber (void)
+public setPolicyNumber (string|int|array|null $value, int $position)
```
-
+Set Policy Number (IN1.36)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2131,20 +2564,25 @@ public setPolicyNumber (void)
**Description**
```php
-public setPreAdmitCertPAC (void)
+public setPreAdmitCertPAC (string|int|array|null $value, int $position)
```
-
+Set Pre Admit Cert PAC (IN1.28)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2154,20 +2592,25 @@ public setPreAdmitCertPAC (void)
**Description**
```php
-public setPriorInsurancePlanID (void)
+public setPriorInsurancePlanID (string|int|array|null $value, int $position)
```
-
+Set Prior Insurance Plan ID (IN1.46)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 46
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2177,20 +2620,25 @@ public setPriorInsurancePlanID (void)
**Description**
```php
-public setReleaseInformationCode (void)
+public setReleaseInformationCode (string|int|array|null $value, int $position)
```
-
+Set Release Information Code (IN1.27)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2200,20 +2648,25 @@ public setReleaseInformationCode (void)
**Description**
```php
-public setReportOfEligibilityDate (void)
+public setReportOfEligibilityDate (string|int|array|null $value, int $position)
```
-
+Set Report Of Eligibility Date (IN1.26)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2223,20 +2676,25 @@ public setReportOfEligibilityDate (void)
**Description**
```php
-public setReportOfEligibilityFlag (void)
+public setReportOfEligibilityFlag (string|int|array|null $value, int $position)
```
-
+Set Report Of Eligibility Flag (IN1.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2246,20 +2704,25 @@ public setReportOfEligibilityFlag (void)
**Description**
```php
-public setRoomRatePrivate (void)
+public setRoomRatePrivate (string|int|array|null $value, int $position)
```
-
+Set Room Rate Private (IN1.41)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2269,20 +2732,25 @@ public setRoomRatePrivate (void)
**Description**
```php
-public setRoomRateSemiPrivate (void)
+public setRoomRateSemiPrivate (string|int|array|null $value, int $position)
```
-
+Set Room Rate Semi Private (IN1.40)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2292,20 +2760,25 @@ public setRoomRateSemiPrivate (void)
**Description**
```php
-public setTypeOfAgreementCode (void)
+public setTypeOfAgreementCode (string|int|array|null $value, int $position)
```
-
+Set Type Of Agreement Code (IN1.31)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2315,20 +2788,25 @@ public setTypeOfAgreementCode (void)
**Description**
```php
-public setVerificationBy (void)
+public setVerificationBy (string|int|array|null $value, int $position)
```
-
+Set Verification By (IN1.30)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2338,20 +2816,25 @@ public setVerificationBy (void)
**Description**
```php
-public setVerificationDateTime (void)
+public setVerificationDateTime (string|int|array|null $value, int $position)
```
-
+Set Verification Date Time (IN1.29)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2361,20 +2844,25 @@ public setVerificationDateTime (void)
**Description**
```php
-public setVerificationStatus (void)
+public setVerificationStatus (string|int|array|null $value, int $position)
```
-
+Set Verification Status (IN1.45)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 45
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/IN3.md b/docs/Segments/IN3.md
index a323bda..fc0bea3 100644
--- a/docs/Segments/IN3.md
+++ b/docs/Segments/IN3.md
@@ -13,62 +13,65 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAppealReason](#in3getappealreason)||
-|[getCaseManager](#in3getcasemanager)||
-|[getCertificationAgency](#in3getcertificationagency)||
-|[getCertificationAgencyPhoneNumber](#in3getcertificationagencyphonenumber)||
-|[getCertificationBeginDate](#in3getcertificationbegindate)||
-|[getCertificationContact](#in3getcertificationcontact)||
-|[getCertificationContactPhoneNumber](#in3getcertificationcontactphonenumber)||
-|[getCertificationDateTime](#in3getcertificationdatetime)||
-|[getCertificationEndDate](#in3getcertificationenddate)||
-|[getCertificationModifyDateTime](#in3getcertificationmodifydatetime)||
-|[getCertificationNumber](#in3getcertificationnumber)||
-|[getCertificationRequired](#in3getcertificationrequired)||
-|[getCertifiedBy](#in3getcertifiedby)||
-|[getDays](#in3getdays)||
-|[getID](#in3getid)||
-|[getNonConcurCodeDescription](#in3getnonconcurcodedescription)||
-|[getNonConcurEffectiveDateTime](#in3getnonconcureffectivedatetime)||
-|[getOperator](#in3getoperator)||
-|[getPenalty](#in3getpenalty)||
-|[getPhysicianReviewer](#in3getphysicianreviewer)||
-|[getPreCertificationRequirement](#in3getprecertificationrequirement)||
-|[getSecondOpinionDate](#in3getsecondopiniondate)||
-|[getSecondOpinionDocumentationReceived](#in3getsecondopiniondocumentationreceived)||
-|[getSecondOpinionPhysician](#in3getsecondopinionphysician)||
-|[getSecondOpinionStatus](#in3getsecondopinionstatus)||
-|[setAppealReason](#in3setappealreason)||
-|[setCaseManager](#in3setcasemanager)||
-|[setCertificationAgency](#in3setcertificationagency)||
-|[setCertificationAgencyPhoneNumber](#in3setcertificationagencyphonenumber)||
-|[setCertificationBeginDate](#in3setcertificationbegindate)||
-|[setCertificationContact](#in3setcertificationcontact)||
-|[setCertificationContactPhoneNumber](#in3setcertificationcontactphonenumber)||
-|[setCertificationDateTime](#in3setcertificationdatetime)||
-|[setCertificationEndDate](#in3setcertificationenddate)||
-|[setCertificationModifyDateTime](#in3setcertificationmodifydatetime)||
-|[setCertificationNumber](#in3setcertificationnumber)||
-|[setCertificationRequired](#in3setcertificationrequired)||
-|[setCertifiedBy](#in3setcertifiedby)||
-|[setDays](#in3setdays)||
-|[setID](#in3setid)||
-|[setNonConcurCodeDescription](#in3setnonconcurcodedescription)||
-|[setNonConcurEffectiveDateTime](#in3setnonconcureffectivedatetime)||
-|[setOperator](#in3setoperator)||
-|[setPenalty](#in3setpenalty)||
-|[setPhysicianReviewer](#in3setphysicianreviewer)||
-|[setPreCertificationRequirement](#in3setprecertificationrequirement)||
-|[setSecondOpinionDate](#in3setsecondopiniondate)||
-|[setSecondOpinionDocumentationReceived](#in3setsecondopiniondocumentationreceived)||
-|[setSecondOpinionPhysician](#in3setsecondopinionphysician)||
-|[setSecondOpinionStatus](#in3setsecondopinionstatus)||
+|[__destruct](#in3__destruct)||
+|[getAppealReason](#in3getappealreason)|Get Appeal Reason (IN3.17)|
+|[getCaseManager](#in3getcasemanager)|Get Case Manager (IN3.21)|
+|[getCertificationAgency](#in3getcertificationagency)|Get Certification Agency (IN3.18)|
+|[getCertificationAgencyPhoneNumber](#in3getcertificationagencyphonenumber)|Get Certification Agency Phone Number (IN3.19)|
+|[getCertificationBeginDate](#in3getcertificationbegindate)|Get Certification Begin Date (IN3.9)|
+|[getCertificationContact](#in3getcertificationcontact)|Get Certification Contact (IN3.15)|
+|[getCertificationContactPhoneNumber](#in3getcertificationcontactphonenumber)|Get Certification Contact Phone Number (IN3.16)|
+|[getCertificationDateTime](#in3getcertificationdatetime)|Get Certification Date Time (IN3.6)|
+|[getCertificationEndDate](#in3getcertificationenddate)|Get Certification End Date (IN3.10)|
+|[getCertificationModifyDateTime](#in3getcertificationmodifydatetime)|Get Certification Modify Date Time (IN3.7)|
+|[getCertificationNumber](#in3getcertificationnumber)|Get Certification Number (IN3.2)|
+|[getCertificationRequired](#in3getcertificationrequired)|Get Certification Required (IN3.4)|
+|[getCertifiedBy](#in3getcertifiedby)|Get Certified By (IN3.3)|
+|[getDays](#in3getdays)|Get Days (IN3.11)|
+|[getID](#in3getid)|Get ID (IN3.1)|
+|[getNonConcurCodeDescription](#in3getnonconcurcodedescription)|Get Non Concur Code Description (IN3.12)|
+|[getNonConcurEffectiveDateTime](#in3getnonconcureffectivedatetime)|Get Non Concur Effective Date Time (IN3.13)|
+|[getOperator](#in3getoperator)|Get Operator (IN3.8)|
+|[getPenalty](#in3getpenalty)|Get Penalty (IN3.5)|
+|[getPhysicianReviewer](#in3getphysicianreviewer)|Get Physician Reviewer (IN3.14)|
+|[getPreCertificationRequirement](#in3getprecertificationrequirement)|Get Pre Certification Requirement (IN3.20)|
+|[getSecondOpinionDate](#in3getsecondopiniondate)|Get Second Opinion Date (IN3.22)|
+|[getSecondOpinionDocumentationReceived](#in3getsecondopiniondocumentationreceived)|Get Second Opinion Documentation Received (IN3.24)|
+|[getSecondOpinionPhysician](#in3getsecondopinionphysician)|Get Second Opinion Physician (IN3.25)|
+|[getSecondOpinionStatus](#in3getsecondopinionstatus)|Get Second Opinion Status (IN3.23)|
+|[resetIndex](#in3resetindex)|Reset index of this segment|
+|[setAppealReason](#in3setappealreason)|Set Appeal Reason (IN3.17)|
+|[setCaseManager](#in3setcasemanager)|Set Case Manager (IN3.21)|
+|[setCertificationAgency](#in3setcertificationagency)|Set Certification Agency (IN3.18)|
+|[setCertificationAgencyPhoneNumber](#in3setcertificationagencyphonenumber)|Set Certification Agency Phone Number (IN3.19)|
+|[setCertificationBeginDate](#in3setcertificationbegindate)|Set Certification Begin Date (IN3.9)|
+|[setCertificationContact](#in3setcertificationcontact)|Set Certification Contact (IN3.15)|
+|[setCertificationContactPhoneNumber](#in3setcertificationcontactphonenumber)|Set Certification Contact Phone Number (IN3.16)|
+|[setCertificationDateTime](#in3setcertificationdatetime)|Set Certification Date Time (IN3.6)|
+|[setCertificationEndDate](#in3setcertificationenddate)|Set Certification End Date (IN3.10)|
+|[setCertificationModifyDateTime](#in3setcertificationmodifydatetime)|Set Certification Modify Date Time (IN3.7)|
+|[setCertificationNumber](#in3setcertificationnumber)|Set Certification Number (IN3.2)|
+|[setCertificationRequired](#in3setcertificationrequired)|Set Certification Required (IN3.4)|
+|[setCertifiedBy](#in3setcertifiedby)|Set Certified By (IN3.3)|
+|[setDays](#in3setdays)|Set Days (IN3.11)|
+|[setID](#in3setid)|Set ID (IN3.1)|
+|[setNonConcurCodeDescription](#in3setnonconcurcodedescription)|Set Non Concur Code Description (IN3.12)|
+|[setNonConcurEffectiveDateTime](#in3setnonconcureffectivedatetime)|Set Non Concur Effective Date Time (IN3.13)|
+|[setOperator](#in3setoperator)|Set Operator (IN3.8)|
+|[setPenalty](#in3setpenalty)|Set Penalty (IN3.5)|
+|[setPhysicianReviewer](#in3setphysicianreviewer)|Set Physician Reviewer (IN3.14)|
+|[setPreCertificationRequirement](#in3setprecertificationrequirement)|Set Pre Certification Requirement (IN3.20)|
+|[setSecondOpinionDate](#in3setsecondopiniondate)|Set Second Opinion Date (IN3.22)|
+|[setSecondOpinionDocumentationReceived](#in3setsecondopiniondocumentationreceived)|Set Second Opinion Documentation Received (IN3.24)|
+|[setSecondOpinionPhysician](#in3setsecondopinionphysician)|Set Second Opinion Physician (IN3.25)|
+|[setSecondOpinionStatus](#in3setsecondopinionstatus)|Set Second Opinion Status (IN3.23)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -77,12 +80,12 @@ Aranyasen\HL7\Segment
-### IN3::getAppealReason
+### IN3::__destruct
**Description**
```php
-public getAppealReason (void)
+ __destruct (void)
```
@@ -97,28 +100,60 @@ public getAppealReason (void)
`void`
+
-### IN3::getCaseManager
+### IN3::getAppealReason
**Description**
```php
-public getCaseManager (void)
+public getAppealReason (int $position)
```
+Get Appeal Reason (IN3.17)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### IN3::getCaseManager
+
+**Description**
+
+```php
+public getCaseManager (int $position)
+```
+
+Get Case Manager (IN3.21)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -128,20 +163,24 @@ public getCaseManager (void)
**Description**
```php
-public getCertificationAgency (void)
+public getCertificationAgency (int $position)
```
-
+Get Certification Agency (IN3.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -151,20 +190,24 @@ public getCertificationAgency (void)
**Description**
```php
-public getCertificationAgencyPhoneNumber (void)
+public getCertificationAgencyPhoneNumber (int $position)
```
-
+Get Certification Agency Phone Number (IN3.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -174,20 +217,24 @@ public getCertificationAgencyPhoneNumber (void)
**Description**
```php
-public getCertificationBeginDate (void)
+public getCertificationBeginDate (int $position)
```
-
+Get Certification Begin Date (IN3.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -197,20 +244,24 @@ public getCertificationBeginDate (void)
**Description**
```php
-public getCertificationContact (void)
+public getCertificationContact (int $position)
```
-
+Get Certification Contact (IN3.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -220,20 +271,24 @@ public getCertificationContact (void)
**Description**
```php
-public getCertificationContactPhoneNumber (void)
+public getCertificationContactPhoneNumber (int $position)
```
-
+Get Certification Contact Phone Number (IN3.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -243,20 +298,24 @@ public getCertificationContactPhoneNumber (void)
**Description**
```php
-public getCertificationDateTime (void)
+public getCertificationDateTime (int $position)
```
-
+Get Certification Date Time (IN3.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -266,20 +325,24 @@ public getCertificationDateTime (void)
**Description**
```php
-public getCertificationEndDate (void)
+public getCertificationEndDate (int $position)
```
-
+Get Certification End Date (IN3.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -289,20 +352,24 @@ public getCertificationEndDate (void)
**Description**
```php
-public getCertificationModifyDateTime (void)
+public getCertificationModifyDateTime (int $position)
```
-
+Get Certification Modify Date Time (IN3.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -312,20 +379,24 @@ public getCertificationModifyDateTime (void)
**Description**
```php
-public getCertificationNumber (void)
+public getCertificationNumber (int $position)
```
-
+Get Certification Number (IN3.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -335,20 +406,24 @@ public getCertificationNumber (void)
**Description**
```php
-public getCertificationRequired (void)
+public getCertificationRequired (int $position)
```
-
+Get Certification Required (IN3.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -358,20 +433,24 @@ public getCertificationRequired (void)
**Description**
```php
-public getCertifiedBy (void)
+public getCertifiedBy (int $position)
```
-
+Get Certified By (IN3.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -381,20 +460,24 @@ public getCertifiedBy (void)
**Description**
```php
-public getDays (void)
+public getDays (int $position)
```
-
+Get Days (IN3.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -404,20 +487,24 @@ public getDays (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (IN3.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -427,20 +514,24 @@ public getID (void)
**Description**
```php
-public getNonConcurCodeDescription (void)
+public getNonConcurCodeDescription (int $position)
```
-
+Get Non Concur Code Description (IN3.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -450,20 +541,24 @@ public getNonConcurCodeDescription (void)
**Description**
```php
-public getNonConcurEffectiveDateTime (void)
+public getNonConcurEffectiveDateTime (int $position)
```
-
+Get Non Concur Effective Date Time (IN3.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -473,20 +568,24 @@ public getNonConcurEffectiveDateTime (void)
**Description**
```php
-public getOperator (void)
+public getOperator (int $position)
```
-
+Get Operator (IN3.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -496,20 +595,24 @@ public getOperator (void)
**Description**
```php
-public getPenalty (void)
+public getPenalty (int $position)
```
-
+Get Penalty (IN3.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -519,20 +622,24 @@ public getPenalty (void)
**Description**
```php
-public getPhysicianReviewer (void)
+public getPhysicianReviewer (int $position)
```
-
+Get Physician Reviewer (IN3.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -542,20 +649,24 @@ public getPhysicianReviewer (void)
**Description**
```php
-public getPreCertificationRequirement (void)
+public getPreCertificationRequirement (int $position)
```
-
+Get Pre Certification Requirement (IN3.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -565,20 +676,24 @@ public getPreCertificationRequirement (void)
**Description**
```php
-public getSecondOpinionDate (void)
+public getSecondOpinionDate (int $position)
```
-
+Get Second Opinion Date (IN3.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -588,20 +703,24 @@ public getSecondOpinionDate (void)
**Description**
```php
-public getSecondOpinionDocumentationReceived (void)
+public getSecondOpinionDocumentationReceived (int $position)
```
-
+Get Second Opinion Documentation Received (IN3.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -611,20 +730,24 @@ public getSecondOpinionDocumentationReceived (void)
**Description**
```php
-public getSecondOpinionPhysician (void)
+public getSecondOpinionPhysician (int $position)
```
-
+Get Second Opinion Physician (IN3.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -634,11 +757,38 @@ public getSecondOpinionPhysician (void)
**Description**
```php
-public getSecondOpinionStatus (void)
+public getSecondOpinionStatus (int $position)
```
+Get Second Opinion Status (IN3.23)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### IN3::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -649,6 +799,7 @@ public getSecondOpinionStatus (void)
`void`
+
@@ -657,20 +808,25 @@ public getSecondOpinionStatus (void)
**Description**
```php
-public setAppealReason (void)
+public setAppealReason (string|int|array|null $value, int $position)
```
-
+Set Appeal Reason (IN3.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -680,20 +836,25 @@ public setAppealReason (void)
**Description**
```php
-public setCaseManager (void)
+public setCaseManager (string|int|array|null $value, int $position)
```
-
+Set Case Manager (IN3.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`bool`
+
+
+
@@ -703,20 +864,25 @@ public setCaseManager (void)
**Description**
```php
-public setCertificationAgency (void)
+public setCertificationAgency (string|int|array|null $value, int $position)
```
-
+Set Certification Agency (IN3.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -726,20 +892,25 @@ public setCertificationAgency (void)
**Description**
```php
-public setCertificationAgencyPhoneNumber (void)
+public setCertificationAgencyPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Certification Agency Phone Number (IN3.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -749,20 +920,25 @@ public setCertificationAgencyPhoneNumber (void)
**Description**
```php
-public setCertificationBeginDate (void)
+public setCertificationBeginDate (string|int|array|null $value, int $position)
```
-
+Set Certification Begin Date (IN3.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -772,20 +948,25 @@ public setCertificationBeginDate (void)
**Description**
```php
-public setCertificationContact (void)
+public setCertificationContact (string|int|array|null $value, int $position)
```
-
+Set Certification Contact (IN3.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -795,20 +976,25 @@ public setCertificationContact (void)
**Description**
```php
-public setCertificationContactPhoneNumber (void)
+public setCertificationContactPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Certification Contact Phone Number (IN3.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -818,20 +1004,25 @@ public setCertificationContactPhoneNumber (void)
**Description**
```php
-public setCertificationDateTime (void)
+public setCertificationDateTime (string|int|array|null $value, int $position)
```
-
+Set Certification Date Time (IN3.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -841,20 +1032,25 @@ public setCertificationDateTime (void)
**Description**
```php
-public setCertificationEndDate (void)
+public setCertificationEndDate (string|int|array|null $value, int $position)
```
-
+Set Certification End Date (IN3.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -864,20 +1060,25 @@ public setCertificationEndDate (void)
**Description**
```php
-public setCertificationModifyDateTime (void)
+public setCertificationModifyDateTime (string|int|array|null $value, int $position)
```
-
+Set Certification Modify Date Time (IN3.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -887,20 +1088,25 @@ public setCertificationModifyDateTime (void)
**Description**
```php
-public setCertificationNumber (void)
+public setCertificationNumber (string|int|array|null $value, int $position)
```
-
+Set Certification Number (IN3.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -910,20 +1116,25 @@ public setCertificationNumber (void)
**Description**
```php
-public setCertificationRequired (void)
+public setCertificationRequired (string|int|array|null $value, int $position)
```
-
+Set Certification Required (IN3.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -933,20 +1144,25 @@ public setCertificationRequired (void)
**Description**
```php
-public setCertifiedBy (void)
+public setCertifiedBy (string|int|array|null $value, int $position)
```
-
+Set Certified By (IN3.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -956,20 +1172,25 @@ public setCertifiedBy (void)
**Description**
```php
-public setDays (void)
+public setDays (string|int|array|null $value, int $position)
```
-
+Set Days (IN3.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -979,20 +1200,25 @@ public setDays (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (IN3.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1002,20 +1228,25 @@ public setID (void)
**Description**
```php
-public setNonConcurCodeDescription (void)
+public setNonConcurCodeDescription (string|int|array|null $value, int $position)
```
-
+Set Non Concur Code Description (IN3.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1025,20 +1256,25 @@ public setNonConcurCodeDescription (void)
**Description**
```php
-public setNonConcurEffectiveDateTime (void)
+public setNonConcurEffectiveDateTime (string|int|array|null $value, int $position)
```
-
+Set Non Concur Effective Date Time (IN3.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1048,20 +1284,25 @@ public setNonConcurEffectiveDateTime (void)
**Description**
```php
-public setOperator (void)
+public setOperator (string|int|array|null $value, int $position)
```
-
+Set Operator (IN3.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1071,20 +1312,25 @@ public setOperator (void)
**Description**
```php
-public setPenalty (void)
+public setPenalty (string|int|array|null $value, int $position)
```
-
+Set Penalty (IN3.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1094,20 +1340,25 @@ public setPenalty (void)
**Description**
```php
-public setPhysicianReviewer (void)
+public setPhysicianReviewer (string|int|array|null $value, int $position)
```
-
+Set Physician Reviewer (IN3.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1117,20 +1368,25 @@ public setPhysicianReviewer (void)
**Description**
```php
-public setPreCertificationRequirement (void)
+public setPreCertificationRequirement (string|int|array|null $value, int $position)
```
-
+Set Pre Certification Requirement (IN3.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1140,20 +1396,25 @@ public setPreCertificationRequirement (void)
**Description**
```php
-public setSecondOpinionDate (void)
+public setSecondOpinionDate (string|int|array|null $value, int $position)
```
-
+Set Second Opinion Date (IN3.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1163,20 +1424,25 @@ public setSecondOpinionDate (void)
**Description**
```php
-public setSecondOpinionDocumentationReceived (void)
+public setSecondOpinionDocumentationReceived (string|int|array|null $value, int $position)
```
-
+Set Second Opinion Documentation Received (IN3.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1186,20 +1452,25 @@ public setSecondOpinionDocumentationReceived (void)
**Description**
```php
-public setSecondOpinionPhysician (void)
+public setSecondOpinionPhysician (string|int|array|null $value, int $position)
```
-
+Set Second Opinion Physician (IN3.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1209,20 +1480,25 @@ public setSecondOpinionPhysician (void)
**Description**
```php
-public setSecondOpinionStatus (void)
+public setSecondOpinionStatus (string|int|array|null $value, int $position)
```
-
+Set Second Opinion Status (IN3.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/MRG.md b/docs/Segments/MRG.md
new file mode 100644
index 0000000..994af64
--- /dev/null
+++ b/docs/Segments/MRG.md
@@ -0,0 +1,428 @@
+# Aranyasen\HL7\Segments\MRG
+
+MRG segment class
+Ref: http://hl7-definition.caristix.com:9010/HL7%20v2.3.1/segment/MRG
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getPriorAlternatePatientID](#mrggetprioralternatepatientid)|Get Prior Alternate Patient ID (MRG.2)|
+|[getPriorAlternateVisitID](#mrggetprioralternatevisitid)|Get Prior Alternate Visit ID (MRG.6)|
+|[getPriorPatientAccountNumber](#mrggetpriorpatientaccountnumber)|Get Prior Patient Account Number (MRG.3)|
+|[getPriorPatientID](#mrggetpriorpatientid)|Get Prior Patient ID (MRG.4)|
+|[getPriorPatientIdentifierList](#mrggetpriorpatientidentifierlist)|Get Prior Patient Identifier List (MRG.1)|
+|[getPriorPatientName](#mrggetpriorpatientname)|Get Prior Patient Name (MRG.7)|
+|[getPriorVisitNumber](#mrggetpriorvisitnumber)|Get Prior Visit Number (MRG.5)|
+|[setPriorAlternatePatientID](#mrgsetprioralternatepatientid)|Set Prior Alternate Patient ID (MRG.2)|
+|[setPriorAlternateVisitID](#mrgsetprioralternatevisitid)|Set Prior Alternate Visit ID (MRG.6)|
+|[setPriorPatientAccountNumber](#mrgsetpriorpatientaccountnumber)|Set Prior Patient Account Number (MRG.3)|
+|[setPriorPatientID](#mrgsetpriorpatientid)|Set Prior Patient ID (MRG.4)|
+|[setPriorPatientIdentifierList](#mrgsetpriorpatientidentifierlist)|Set Prior Patient Identifier List (MRG.1)|
+|[setPriorPatientName](#mrgsetpriorpatientname)|Set Prior Patient Name (MRG.7)|
+|[setPriorVisitNumber](#mrgsetpriorvisitnumber)|Set Prior Visit Number (MRG.5)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### MRG::getPriorAlternatePatientID
+
+**Description**
+
+```php
+public getPriorAlternatePatientID (int $position)
+```
+
+Get Prior Alternate Patient ID (MRG.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorAlternateVisitID
+
+**Description**
+
+```php
+public getPriorAlternateVisitID (int $position)
+```
+
+Get Prior Alternate Visit ID (MRG.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorPatientAccountNumber
+
+**Description**
+
+```php
+public getPriorPatientAccountNumber (int $position)
+```
+
+Get Prior Patient Account Number (MRG.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorPatientID
+
+**Description**
+
+```php
+public getPriorPatientID (int $position)
+```
+
+Get Prior Patient ID (MRG.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorPatientIdentifierList
+
+**Description**
+
+```php
+public getPriorPatientIdentifierList (int $position)
+```
+
+Get Prior Patient Identifier List (MRG.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorPatientName
+
+**Description**
+
+```php
+public getPriorPatientName (int $position)
+```
+
+Get Prior Patient Name (MRG.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::getPriorVisitNumber
+
+**Description**
+
+```php
+public getPriorVisitNumber (int $position)
+```
+
+Get Prior Visit Number (MRG.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MRG::setPriorAlternatePatientID
+
+**Description**
+
+```php
+public setPriorAlternatePatientID (string|int|array|null $value, int $position)
+```
+
+Set Prior Alternate Patient ID (MRG.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorAlternateVisitID
+
+**Description**
+
+```php
+public setPriorAlternateVisitID (string|int|array|null $value, int $position)
+```
+
+Set Prior Alternate Visit ID (MRG.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorPatientAccountNumber
+
+**Description**
+
+```php
+public setPriorPatientAccountNumber (string|int|array|null $value, int $position)
+```
+
+Set Prior Patient Account Number (MRG.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorPatientID
+
+**Description**
+
+```php
+public setPriorPatientID (string|int|array|null $value, int $position)
+```
+
+Set Prior Patient ID (MRG.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorPatientIdentifierList
+
+**Description**
+
+```php
+public setPriorPatientIdentifierList (string|int|array|null $value, int $position)
+```
+
+Set Prior Patient Identifier List (MRG.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorPatientName
+
+**Description**
+
+```php
+public setPriorPatientName (string|int|array|null $value, int $position)
+```
+
+Set Prior Patient Name (MRG.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MRG::setPriorVisitNumber
+
+**Description**
+
+```php
+public setPriorVisitNumber (string|int|array|null $value, int $position)
+```
+
+Set Prior Visit Number (MRG.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/MSA.md b/docs/Segments/MSA.md
new file mode 100644
index 0000000..330bf6c
--- /dev/null
+++ b/docs/Segments/MSA.md
@@ -0,0 +1,371 @@
+# Aranyasen\HL7\Segments\MSA
+
+MSA: Message acknowledgement segment
+Ref: http://hl7-definition.caristix.com:9010/HL7%20v2.3/segment/MSA
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getAcknowledgementCode](#msagetacknowledgementcode)|Get Acknowledgement Code (MSA.1)|
+|[getDelayedAcknowledgementType](#msagetdelayedacknowledgementtype)|Get Delayed Acknowledgement Type (MSA.5)|
+|[getErrorCondition](#msageterrorcondition)|Get Error Condition (MSA.6)|
+|[getExpectedSequenceNumber](#msagetexpectedsequencenumber)|Get Expected Sequence Number (MSA.4)|
+|[getMessageControlID](#msagetmessagecontrolid)|Get Message Control ID (MSA.2)|
+|[getTextMessage](#msagettextmessage)|Get Text Message (MSA.3)|
+|[setAcknowledgementCode](#msasetacknowledgementcode)|Set Acknowledgement Code (MSA.1)|
+|[setDelayedAcknowledgementType](#msasetdelayedacknowledgementtype)|Set Delayed Acknowledgement Type (MSA.5)|
+|[setErrorCondition](#msaseterrorcondition)|Set Error Condition (MSA.6)|
+|[setExpectedSequenceNumber](#msasetexpectedsequencenumber)|Set Expected Sequence Number (MSA.4)|
+|[setMessageControlID](#msasetmessagecontrolid)|Set Message Control ID (MSA.2)|
+|[setTextMessage](#msasettextmessage)|Set Text Message (MSA.3)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### MSA::getAcknowledgementCode
+
+**Description**
+
+```php
+public getAcknowledgementCode (int $position)
+```
+
+Get Acknowledgement Code (MSA.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::getDelayedAcknowledgementType
+
+**Description**
+
+```php
+public getDelayedAcknowledgementType (int $position)
+```
+
+Get Delayed Acknowledgement Type (MSA.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::getErrorCondition
+
+**Description**
+
+```php
+public getErrorCondition (int $position)
+```
+
+Get Error Condition (MSA.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::getExpectedSequenceNumber
+
+**Description**
+
+```php
+public getExpectedSequenceNumber (int $position)
+```
+
+Get Expected Sequence Number (MSA.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::getMessageControlID
+
+**Description**
+
+```php
+public getMessageControlID (int $position)
+```
+
+Get Message Control ID (MSA.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::getTextMessage
+
+**Description**
+
+```php
+public getTextMessage (int $position)
+```
+
+Get Text Message (MSA.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### MSA::setAcknowledgementCode
+
+**Description**
+
+```php
+public setAcknowledgementCode (string|int|array|null $value, int $position)
+```
+
+Set Acknowledgement Code (MSA.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MSA::setDelayedAcknowledgementType
+
+**Description**
+
+```php
+public setDelayedAcknowledgementType (string|int|array|null $value, int $position)
+```
+
+Set Delayed Acknowledgement Type (MSA.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MSA::setErrorCondition
+
+**Description**
+
+```php
+public setErrorCondition (string|int|array|null $value, int $position)
+```
+
+Set Error Condition (MSA.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MSA::setExpectedSequenceNumber
+
+**Description**
+
+```php
+public setExpectedSequenceNumber (string|int|array|null $value, int $position)
+```
+
+Set Expected Sequence Number (MSA.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MSA::setMessageControlID
+
+**Description**
+
+```php
+public setMessageControlID (string|int|array|null $value, int $position)
+```
+
+Set Message Control ID (MSA.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### MSA::setTextMessage
+
+**Description**
+
+```php
+public setTextMessage (string|int|array|null $value, int $position)
+```
+
+Set Text Message (MSA.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/MSH.md b/docs/Segments/MSH.md
index 51928ba..39decf0 100644
--- a/docs/Segments/MSH.md
+++ b/docs/Segments/MSH.md
@@ -28,40 +28,41 @@ Aranyasen\HL7\Segment
| 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)||
+|[getDateTimeOfMessage](#mshgetdatetimeofmessage)|Get Date Time Of Message (MSH.7)|
+|[getMessageControlId](#mshgetmessagecontrolid)|Get Message Control Id (MSH.10)|
+|[getMessageType](#mshgetmessagetype)|Get Message Type (MSH.9)|
+|[getProcessingId](#mshgetprocessingid)|Get Processing Id (MSH.11)|
+|[getReceivingApplication](#mshgetreceivingapplication)|Get Receiving Application (MSH.5)|
+|[getReceivingFacility](#mshgetreceivingfacility)|Get Receiving Facility (MSH.6)|
+|[getSendingApplication](#mshgetsendingapplication)|Get Sending Application (MSH.3)|
+|[getSendingFacility](#mshgetsendingfacility)|Get Sending Facility (MSH.4)|
+|[getTriggerEvent](#mshgettriggerevent)|Get Trigger Event (MSH.9)|
+|[getVersionId](#mshgetversionid)|Get Version Id (MSH.12)|
+|[setAcceptAcknowledgementType](#mshsetacceptacknowledgementtype)|Set Accept Acknowledgement Type (MSH.15)|
+|[setApplicationAcknowledgementType](#mshsetapplicationacknowledgementtype)|Set Application Acknowledgement Type (MSH.16)|
+|[setCharacterSet](#mshsetcharacterset)|Set Character Set (MSH.18)|
+|[setContinuationPointer](#mshsetcontinuationpointer)|Set Continuation Pointer (MSH.14)|
+|[setCountryCode](#mshsetcountrycode)|Set Country Code (MSH.17)|
+|[setDateTimeOfMessage](#mshsetdatetimeofmessage)|Set Date Time Of Message (MSH.7)|
+|[setMessageControlId](#mshsetmessagecontrolid)|Set Message Control Id (MSH.10)|
+|[setMessageType](#mshsetmessagetype)|Sets message type to MSH segment. (MSH.9)|
+|[setPrincipalLanguage](#mshsetprincipallanguage)|Set Principal Language (MSH.19)|
+|[setProcessingId](#mshsetprocessingid)|Set Processing Id (MSH.11)|
+|[setReceivingApplication](#mshsetreceivingapplication)|Set Receiving Application (MSH.5)|
+|[setReceivingFacility](#mshsetreceivingfacility)|Set Receiving Facility (MSH.6)|
+|[setSecurity](#mshsetsecurity)|Set Security (MSH.8)|
+|[setSendingApplication](#mshsetsendingapplication)|Set Sending Application (MSH.3)|
+|[setSendingFacility](#mshsetsendingfacility)|Set Sending Facility (MSH.4)|
+|[setSequenceNumber](#mshsetsequencenumber)|Set Sequence Number (MSH.13)|
+|[setTriggerEvent](#mshsettriggerevent)|Sets trigger event to MSH segment. (MSH.9)|
+|[setVersionId](#mshsetversionid)|Set Version Id (MSH.12)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -75,20 +76,24 @@ Aranyasen\HL7\Segment
**Description**
```php
-public getDateTimeOfMessage (void)
+public getDateTimeOfMessage (int $position)
```
-
+Get Date Time Of Message (MSH.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -98,20 +103,24 @@ public getDateTimeOfMessage (void)
**Description**
```php
-public getMessageControlId (void)
+public getMessageControlId (int $position)
```
-
+Get Message Control Id (MSH.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -124,17 +133,19 @@ public getMessageControlId (void)
public getMessageType (int $position)
```
-ORM / ORU etc.
+Get Message Type (MSH.9)
**Parameters**
* `(int) $position`
+: Defaults to 9
**Return Values**
-`string`
+`array|string|int|null`
+
@@ -146,20 +157,24 @@ ORM / ORU etc.
**Description**
```php
-public getProcessingId (void)
+public getProcessingId (int $position)
```
-
+Get Processing Id (MSH.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -169,20 +184,24 @@ public getProcessingId (void)
**Description**
```php
-public getReceivingApplication (void)
+public getReceivingApplication (int $position)
```
-
+Get Receiving Application (MSH.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -192,20 +211,24 @@ public getReceivingApplication (void)
**Description**
```php
-public getReceivingFacility (void)
+public getReceivingFacility (int $position)
```
-
+Get Receiving Facility (MSH.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -215,20 +238,24 @@ public getReceivingFacility (void)
**Description**
```php
-public getSendingApplication (void)
+public getSendingApplication (int $position)
```
-
+Get Sending Application (MSH.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -238,20 +265,24 @@ public getSendingApplication (void)
**Description**
```php
-public getSendingFacility (void)
+public getSendingFacility (int $position)
```
-
+Get Sending Facility (MSH.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -261,20 +292,24 @@ public getSendingFacility (void)
**Description**
```php
-public getTriggerEvent (void)
+public getTriggerEvent (int $position)
```
-
+Get Trigger Event (MSH.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -287,17 +322,19 @@ public getTriggerEvent (void)
public getVersionId (int $position)
```
-Get HL7 version, e.g. 2.1, 2.3, 3.0 etc.
+Get Version Id (MSH.12)
**Parameters**
* `(int) $position`
+: Defaults to 12
**Return Values**
-`array|null|string`
+`array|string|int|null`
+
@@ -309,20 +346,25 @@ Get HL7 version, e.g. 2.1, 2.3, 3.0 etc.
**Description**
```php
-public setAcceptAcknowledgementType (void)
+public setAcceptAcknowledgementType (string|int|array|null $value, int $position)
```
-
+Set Accept Acknowledgement Type (MSH.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -332,20 +374,25 @@ public setAcceptAcknowledgementType (void)
**Description**
```php
-public setApplicationAcknowledgementType (void)
+public setApplicationAcknowledgementType (string|int|array|null $value, int $position)
```
-
+Set Application Acknowledgement Type (MSH.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -355,20 +402,25 @@ public setApplicationAcknowledgementType (void)
**Description**
```php
-public setCharacterSet (void)
+public setCharacterSet (string|int|array|null $value, int $position)
```
-
+Set Character Set (MSH.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -378,20 +430,25 @@ public setCharacterSet (void)
**Description**
```php
-public setContinuationPointer (void)
+public setContinuationPointer (string|int|array|null $value, int $position)
```
-
+Set Continuation Pointer (MSH.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -401,20 +458,25 @@ public setContinuationPointer (void)
**Description**
```php
-public setCountryCode (void)
+public setCountryCode (string|int|array|null $value, int $position)
```
-
+Set Country Code (MSH.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -424,20 +486,25 @@ public setCountryCode (void)
**Description**
```php
-public setDateTimeOfMessage (void)
+public setDateTimeOfMessage (string|int|array|null $value, int $position)
```
-
+Set Date Time Of Message (MSH.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -447,20 +514,25 @@ public setDateTimeOfMessage (void)
**Description**
```php
-public setMessageControlId (void)
+public setMessageControlId (string|int|array|null $value, int $position)
```
-
+Set Message Control Id (MSH.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -470,10 +542,10 @@ public setMessageControlId (void)
**Description**
```php
-public setMessageType (string $value, int $position)
+public setMessageType (string|int|array|null $value, int $position)
```
-Sets message type to MSH segment.
+Sets message type to MSH segment. (MSH.9)
If trigger event is already set, then it is preserved
@@ -490,8 +562,9 @@ If it was empty then the new value will be just ORM.
**Parameters**
-* `(string) $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 9
**Return Values**
@@ -499,6 +572,7 @@ If it was empty then the new value will be just ORM.
+
@@ -507,20 +581,25 @@ If it was empty then the new value will be just ORM.
**Description**
```php
-public setPrincipalLanguage (void)
+public setPrincipalLanguage (string|int|array|null $value, int $position)
```
-
+Set Principal Language (MSH.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -530,20 +609,25 @@ public setPrincipalLanguage (void)
**Description**
```php
-public setProcessingId (void)
+public setProcessingId (string|int|array|null $value, int $position)
```
-
+Set Processing Id (MSH.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -553,20 +637,25 @@ public setProcessingId (void)
**Description**
```php
-public setReceivingApplication (void)
+public setReceivingApplication (string|int|array|null $value, int $position)
```
-
+Set Receiving Application (MSH.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -576,20 +665,25 @@ public setReceivingApplication (void)
**Description**
```php
-public setReceivingFacility (void)
+public setReceivingFacility (string|int|array|null $value, int $position)
```
-
+Set Receiving Facility (MSH.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -599,20 +693,25 @@ public setReceivingFacility (void)
**Description**
```php
-public setSecurity (void)
+public setSecurity (string|int|array|null $value, int $position)
```
-
+Set Security (MSH.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -622,20 +721,25 @@ public setSecurity (void)
**Description**
```php
-public setSendingApplication (void)
+public setSendingApplication (string|int|array|null $value, int $position)
```
-
+Set Sending Application (MSH.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -645,20 +749,25 @@ public setSendingApplication (void)
**Description**
```php
-public setSendingFacility (void)
+public setSendingFacility (string|int|array|null $value, int $position)
```
-
+Set Sending Facility (MSH.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -668,20 +777,25 @@ public setSendingFacility (void)
**Description**
```php
-public setSequenceNumber (void)
+public setSequenceNumber (string|int|array|null $value, int $position)
```
-
+Set Sequence Number (MSH.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -691,10 +805,10 @@ public setSequenceNumber (void)
**Description**
```php
-public setTriggerEvent (string $value, int $position)
+public setTriggerEvent (string|int|array|null $value, int $position)
```
-Sets trigger event to MSH segment.
+Sets trigger event to MSH segment. (MSH.9)
If meessage type is already set, then it is preserved
@@ -711,8 +825,9 @@ If trigger event was not set then it will set the new value.
**Parameters**
-* `(string) $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 9
**Return Values**
@@ -720,6 +835,7 @@ If trigger event was not set then it will set the new value.
+
@@ -728,20 +844,25 @@ If trigger event was not set then it will set the new value.
**Description**
```php
-public setVersionId (void)
+public setVersionId (string|int|array|null $value, int $position)
```
-
+Set Version Id (MSH.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/NK1.md b/docs/Segments/NK1.md
new file mode 100644
index 0000000..37a13dc
--- /dev/null
+++ b/docs/Segments/NK1.md
@@ -0,0 +1,2305 @@
+# Aranyasen\HL7\Segments\NK1
+
+NK1 segment class: Next of Kin / Associated Parties
+The NK1 segment contains information about the patients other related parties. Any associated parties may be
+identified. Utilizing NK1-1 - set ID, multiple NK1 segments can be sent to patient accounts.
+
+Ref: https://hl7-definition.caristix.com/v2/HL7v2.5/Segments/NK1
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#nk1__destruct)||
+|[getAddress](#nk1getaddress)|Get Address (NK1.4)|
+|[getAdministrativeSex](#nk1getadministrativesex)|Get Administrative Sex (NK1.15)|
+|[getAmbulatoryStatus](#nk1getambulatorystatus)|Get Ambulatory Status (NK1.18)|
+|[getBusinessPhoneNumber](#nk1getbusinessphonenumber)|Get Business Phone Number (NK1.6)|
+|[getCitizenship](#nk1getcitizenship)|Get Citizenship (NK1.19)|
+|[getContactPersonSocialSecurityNumber](#nk1getcontactpersonsocialsecuritynumber)|Get Contact Person Social Security Number (NK1.37)|
+|[getContactPersonsAddress](#nk1getcontactpersonsaddress)|Get Contact Persons Address (NK1.32)|
+|[getContactPersonsName](#nk1getcontactpersonsname)|Get Contact Persons Name (NK1.30)|
+|[getContactPersonsTelephoneNumber](#nk1getcontactpersonstelephonenumber)|Get Contact Persons Telephone Number (NK1.31)|
+|[getContactReason](#nk1getcontactreason)|Get Contact Reason (NK1.29)|
+|[getContactRole](#nk1getcontactrole)|Get Contact Role (NK1.7)|
+|[getDateTimeOfBirth](#nk1getdatetimeofbirth)|Get Date Time Of Birth (NK1.16)|
+|[getEndDate](#nk1getenddate)|Get End Date (NK1.9)|
+|[getEthnicGroup](#nk1getethnicgroup)|Get Ethnic Group (NK1.28)|
+|[getHandicap](#nk1gethandicap)|Get Handicap (NK1.36)|
+|[getID](#nk1getid)|Get ID (NK1.1)|
+|[getJobStatus](#nk1getjobstatus)|Get Job Status (NK1.34)|
+|[getLivingArrangement](#nk1getlivingarrangement)|Get Living Arrangement (NK1.21)|
+|[getLivingDependency](#nk1getlivingdependency)|Get Living Dependency (NK1.17)|
+|[getMaritalStatus](#nk1getmaritalstatus)|Get Marital Status (NK1.14)|
+|[getMothersMaidenName](#nk1getmothersmaidenname)|Get Mothers Maiden Name (NK1.26)|
+|[getNKName](#nk1getnkname)|Get NKName (NK1.2)|
+|[getNationality](#nk1getnationality)|Get Nationality (NK1.27)|
+|[getNextOfKinBirthPlace](#nk1getnextofkinbirthplace)|Get Next Of Kin Birth Place (NK1.38)|
+|[getNextOfKinOrAssociatedPartiesEmployeeNumber](#nk1getnextofkinorassociatedpartiesemployeenumber)|Get Next Of Kin Or Associated Parties Employee Number (NK1.12)|
+|[getNextOfKinOrAssociatedPartiesJobCodeOrClass](#nk1getnextofkinorassociatedpartiesjobcodeorclass)|Get Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)|
+|[getNextOfKinOrAssociatedPartiesJobTitle](#nk1getnextofkinorassociatedpartiesjobtitle)|Get Next Of Kin Or Associated Parties Job Title (NK1.10)|
+|[getNextOfKinOrAssociatedPartysIdentifiers](#nk1getnextofkinorassociatedpartysidentifiers)|Get Next Of Kin Or Associated Partys Identifiers (NK1.33)|
+|[getOrganizationName](#nk1getorganizationname)|Get Organization Name (NK1.13)|
+|[getPhoneNumber](#nk1getphonenumber)|Get Phone Number (NK1.5)|
+|[getPrimaryLanguage](#nk1getprimarylanguage)|Get Primary Language (NK1.20)|
+|[getProtectionIndicator](#nk1getprotectionindicator)|Get Protection Indicator (NK1.23)|
+|[getPublicityCode](#nk1getpublicitycode)|Get Publicity Code (NK1.22)|
+|[getRace](#nk1getrace)|Get Race (NK1.35)|
+|[getRelationship](#nk1getrelationship)|Get Relationship (NK1.3)|
+|[getReligion](#nk1getreligion)|Get Religion (NK1.25)|
+|[getStartDate](#nk1getstartdate)|Get Start Date (NK1.8)|
+|[getStudentIndicator](#nk1getstudentindicator)|Get Student Indicator (NK1.24)|
+|[getVipIndicator](#nk1getvipindicator)|Get Vip Indicator (NK1.39)|
+|[resetIndex](#nk1resetindex)|Reset index of this segment|
+|[setAddress](#nk1setaddress)|Set Address (NK1.4)|
+|[setAdministrativeSex](#nk1setadministrativesex)|Set Administrative Sex (NK1.15)|
+|[setAmbulatoryStatus](#nk1setambulatorystatus)|Set Ambulatory Status (NK1.18)|
+|[setBusinessPhoneNumber](#nk1setbusinessphonenumber)|Set Business Phone Number (NK1.6)|
+|[setCitizenship](#nk1setcitizenship)|Set Citizenship (NK1.19)|
+|[setContactPersonSocialSecurityNumber](#nk1setcontactpersonsocialsecuritynumber)|Set Contact Person Social Security Number (NK1.37)|
+|[setContactPersonsAddress](#nk1setcontactpersonsaddress)|Set Contact Persons Address (NK1.32)|
+|[setContactPersonsName](#nk1setcontactpersonsname)|Set Contact Persons Name (NK1.30)|
+|[setContactPersonsTelephoneNumber](#nk1setcontactpersonstelephonenumber)|Set Contact Persons Telephone Number (NK1.31)|
+|[setContactReason](#nk1setcontactreason)|Set Contact Reason (NK1.29)|
+|[setContactRole](#nk1setcontactrole)|Set Contact Role (NK1.7)|
+|[setDateTimeOfBirth](#nk1setdatetimeofbirth)|Set Date Time Of Birth (NK1.16)|
+|[setEndDate](#nk1setenddate)|Set End Date (NK1.9)|
+|[setEthnicGroup](#nk1setethnicgroup)|Set Ethnic Group (NK1.28)|
+|[setHandicap](#nk1sethandicap)|Set Handicap (NK1.36)|
+|[setID](#nk1setid)|Set ID (NK1.1)|
+|[setJobStatus](#nk1setjobstatus)|Set Job Status (NK1.34)|
+|[setLivingArrangement](#nk1setlivingarrangement)|Set Living Arrangement (NK1.21)|
+|[setLivingDependency](#nk1setlivingdependency)|Set Living Dependency (NK1.17)|
+|[setMaritalStatus](#nk1setmaritalstatus)|Set Marital Status (NK1.14)|
+|[setMothersMaidenName](#nk1setmothersmaidenname)|Set Mothers Maiden Name (NK1.26)|
+|[setNKName](#nk1setnkname)|Set NKName (NK1.2)|
+|[setNationality](#nk1setnationality)|Set Nationality (NK1.27)|
+|[setNextOfKinBirthPlace](#nk1setnextofkinbirthplace)|Set Next Of Kin Birth Place (NK1.38)|
+|[setNextOfKinOrAssociatedPartiesEmployeeNumber](#nk1setnextofkinorassociatedpartiesemployeenumber)|Set Next Of Kin Or Associated Parties Employee Number (NK1.12)|
+|[setNextOfKinOrAssociatedPartiesJobCodeOrClass](#nk1setnextofkinorassociatedpartiesjobcodeorclass)|Set Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)|
+|[setNextOfKinOrAssociatedPartiesJobTitle](#nk1setnextofkinorassociatedpartiesjobtitle)|Set Next Of Kin Or Associated Parties Job Title (NK1.10)|
+|[setNextOfKinOrAssociatedPartysIdentifiers](#nk1setnextofkinorassociatedpartysidentifiers)|Set Next Of Kin Or Associated Partys Identifiers (NK1.33)|
+|[setOrganizationName](#nk1setorganizationname)|Set Organization Name (NK1.13)|
+|[setPhoneNumber](#nk1setphonenumber)|Set Phone Number (NK1.5)|
+|[setPrimaryLanguage](#nk1setprimarylanguage)|Set Primary Language (NK1.20)|
+|[setProtectionIndicator](#nk1setprotectionindicator)|Set Protection Indicator (NK1.23)|
+|[setPublicityCode](#nk1setpublicitycode)|Set Publicity Code (NK1.22)|
+|[setRace](#nk1setrace)|Set Race (NK1.35)|
+|[setRelationship](#nk1setrelationship)|Set Relationship (NK1.3)|
+|[setReligion](#nk1setreligion)|Set Religion (NK1.25)|
+|[setStartDate](#nk1setstartdate)|Set Start Date (NK1.8)|
+|[setStudentIndicator](#nk1setstudentindicator)|Set Student Indicator (NK1.24)|
+|[setVipIndicator](#nk1setvipindicator)|Set Vip Indicator (NK1.39)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### NK1::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### NK1::getAddress
+
+**Description**
+
+```php
+public getAddress (int $position)
+```
+
+Get Address (NK1.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getAdministrativeSex
+
+**Description**
+
+```php
+public getAdministrativeSex (int $position)
+```
+
+Get Administrative Sex (NK1.15)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getAmbulatoryStatus
+
+**Description**
+
+```php
+public getAmbulatoryStatus (int $position)
+```
+
+Get Ambulatory Status (NK1.18)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getBusinessPhoneNumber
+
+**Description**
+
+```php
+public getBusinessPhoneNumber (int $position)
+```
+
+Get Business Phone Number (NK1.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getCitizenship
+
+**Description**
+
+```php
+public getCitizenship (int $position)
+```
+
+Get Citizenship (NK1.19)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactPersonSocialSecurityNumber
+
+**Description**
+
+```php
+public getContactPersonSocialSecurityNumber (int $position)
+```
+
+Get Contact Person Social Security Number (NK1.37)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactPersonsAddress
+
+**Description**
+
+```php
+public getContactPersonsAddress (int $position)
+```
+
+Get Contact Persons Address (NK1.32)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactPersonsName
+
+**Description**
+
+```php
+public getContactPersonsName (int $position)
+```
+
+Get Contact Persons Name (NK1.30)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactPersonsTelephoneNumber
+
+**Description**
+
+```php
+public getContactPersonsTelephoneNumber (int $position)
+```
+
+Get Contact Persons Telephone Number (NK1.31)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactReason
+
+**Description**
+
+```php
+public getContactReason (int $position)
+```
+
+Get Contact Reason (NK1.29)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getContactRole
+
+**Description**
+
+```php
+public getContactRole (int $position)
+```
+
+Get Contact Role (NK1.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getDateTimeOfBirth
+
+**Description**
+
+```php
+public getDateTimeOfBirth (int $position)
+```
+
+Get Date Time Of Birth (NK1.16)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getEndDate
+
+**Description**
+
+```php
+public getEndDate (int $position)
+```
+
+Get End Date (NK1.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getEthnicGroup
+
+**Description**
+
+```php
+public getEthnicGroup (int $position)
+```
+
+Get Ethnic Group (NK1.28)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getHandicap
+
+**Description**
+
+```php
+public getHandicap (int $position)
+```
+
+Get Handicap (NK1.36)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (NK1.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getJobStatus
+
+**Description**
+
+```php
+public getJobStatus (int $position)
+```
+
+Get Job Status (NK1.34)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getLivingArrangement
+
+**Description**
+
+```php
+public getLivingArrangement (int $position)
+```
+
+Get Living Arrangement (NK1.21)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getLivingDependency
+
+**Description**
+
+```php
+public getLivingDependency (int $position)
+```
+
+Get Living Dependency (NK1.17)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getMaritalStatus
+
+**Description**
+
+```php
+public getMaritalStatus (int $position)
+```
+
+Get Marital Status (NK1.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getMothersMaidenName
+
+**Description**
+
+```php
+public getMothersMaidenName (int $position)
+```
+
+Get Mothers Maiden Name (NK1.26)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNKName
+
+**Description**
+
+```php
+public getNKName (int $position)
+```
+
+Get NKName (NK1.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNationality
+
+**Description**
+
+```php
+public getNationality (int $position)
+```
+
+Get Nationality (NK1.27)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNextOfKinBirthPlace
+
+**Description**
+
+```php
+public getNextOfKinBirthPlace (int $position)
+```
+
+Get Next Of Kin Birth Place (NK1.38)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNextOfKinOrAssociatedPartiesEmployeeNumber
+
+**Description**
+
+```php
+public getNextOfKinOrAssociatedPartiesEmployeeNumber (int $position)
+```
+
+Get Next Of Kin Or Associated Parties Employee Number (NK1.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNextOfKinOrAssociatedPartiesJobCodeOrClass
+
+**Description**
+
+```php
+public getNextOfKinOrAssociatedPartiesJobCodeOrClass (int $position)
+```
+
+Get Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNextOfKinOrAssociatedPartiesJobTitle
+
+**Description**
+
+```php
+public getNextOfKinOrAssociatedPartiesJobTitle (int $position)
+```
+
+Get Next Of Kin Or Associated Parties Job Title (NK1.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getNextOfKinOrAssociatedPartysIdentifiers
+
+**Description**
+
+```php
+public getNextOfKinOrAssociatedPartysIdentifiers (int $position)
+```
+
+Get Next Of Kin Or Associated Partys Identifiers (NK1.33)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getOrganizationName
+
+**Description**
+
+```php
+public getOrganizationName (int $position)
+```
+
+Get Organization Name (NK1.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getPhoneNumber
+
+**Description**
+
+```php
+public getPhoneNumber (int $position)
+```
+
+Get Phone Number (NK1.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getPrimaryLanguage
+
+**Description**
+
+```php
+public getPrimaryLanguage (int $position)
+```
+
+Get Primary Language (NK1.20)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getProtectionIndicator
+
+**Description**
+
+```php
+public getProtectionIndicator (int $position)
+```
+
+Get Protection Indicator (NK1.23)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getPublicityCode
+
+**Description**
+
+```php
+public getPublicityCode (int $position)
+```
+
+Get Publicity Code (NK1.22)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getRace
+
+**Description**
+
+```php
+public getRace (int $position)
+```
+
+Get Race (NK1.35)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getRelationship
+
+**Description**
+
+```php
+public getRelationship (int $position)
+```
+
+Get Relationship (NK1.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getReligion
+
+**Description**
+
+```php
+public getReligion (int $position)
+```
+
+Get Religion (NK1.25)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getStartDate
+
+**Description**
+
+```php
+public getStartDate (int $position)
+```
+
+Get Start Date (NK1.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getStudentIndicator
+
+**Description**
+
+```php
+public getStudentIndicator (int $position)
+```
+
+Get Student Indicator (NK1.24)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::getVipIndicator
+
+**Description**
+
+```php
+public getVipIndicator (int $position)
+```
+
+Get Vip Indicator (NK1.39)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NK1::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### NK1::setAddress
+
+**Description**
+
+```php
+public setAddress (string|int|array|null $value, int $position)
+```
+
+Set Address (NK1.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setAdministrativeSex
+
+**Description**
+
+```php
+public setAdministrativeSex (string|int|array|null $value, int $position)
+```
+
+Set Administrative Sex (NK1.15)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setAmbulatoryStatus
+
+**Description**
+
+```php
+public setAmbulatoryStatus (string|int|array|null $value, int $position)
+```
+
+Set Ambulatory Status (NK1.18)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setBusinessPhoneNumber
+
+**Description**
+
+```php
+public setBusinessPhoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Business Phone Number (NK1.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setCitizenship
+
+**Description**
+
+```php
+public setCitizenship (string|int|array|null $value, int $position)
+```
+
+Set Citizenship (NK1.19)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactPersonSocialSecurityNumber
+
+**Description**
+
+```php
+public setContactPersonSocialSecurityNumber (string|int|array|null $value, int $position)
+```
+
+Set Contact Person Social Security Number (NK1.37)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactPersonsAddress
+
+**Description**
+
+```php
+public setContactPersonsAddress (string|int|array|null $value, int $position)
+```
+
+Set Contact Persons Address (NK1.32)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactPersonsName
+
+**Description**
+
+```php
+public setContactPersonsName (string|int|array|null $value, int $position)
+```
+
+Set Contact Persons Name (NK1.30)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactPersonsTelephoneNumber
+
+**Description**
+
+```php
+public setContactPersonsTelephoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Contact Persons Telephone Number (NK1.31)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactReason
+
+**Description**
+
+```php
+public setContactReason (string|int|array|null $value, int $position)
+```
+
+Set Contact Reason (NK1.29)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setContactRole
+
+**Description**
+
+```php
+public setContactRole (string|int|array|null $value, int $position)
+```
+
+Set Contact Role (NK1.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setDateTimeOfBirth
+
+**Description**
+
+```php
+public setDateTimeOfBirth (string|int|array|null $value, int $position)
+```
+
+Set Date Time Of Birth (NK1.16)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setEndDate
+
+**Description**
+
+```php
+public setEndDate (string|int|array|null $value, int $position)
+```
+
+Set End Date (NK1.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setEthnicGroup
+
+**Description**
+
+```php
+public setEthnicGroup (string|int|array|null $value, int $position)
+```
+
+Set Ethnic Group (NK1.28)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setHandicap
+
+**Description**
+
+```php
+public setHandicap (string|int|array|null $value, int $position)
+```
+
+Set Handicap (NK1.36)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (NK1.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setJobStatus
+
+**Description**
+
+```php
+public setJobStatus (string|int|array|null $value, int $position)
+```
+
+Set Job Status (NK1.34)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setLivingArrangement
+
+**Description**
+
+```php
+public setLivingArrangement (string|int|array|null $value, int $position)
+```
+
+Set Living Arrangement (NK1.21)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setLivingDependency
+
+**Description**
+
+```php
+public setLivingDependency (string|int|array|null $value, int $position)
+```
+
+Set Living Dependency (NK1.17)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setMaritalStatus
+
+**Description**
+
+```php
+public setMaritalStatus (string|int|array|null $value, int $position)
+```
+
+Set Marital Status (NK1.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setMothersMaidenName
+
+**Description**
+
+```php
+public setMothersMaidenName (string|int|array|null $value, int $position)
+```
+
+Set Mothers Maiden Name (NK1.26)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNKName
+
+**Description**
+
+```php
+public setNKName (string|int|array|null $value, int $position)
+```
+
+Set NKName (NK1.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNationality
+
+**Description**
+
+```php
+public setNationality (string|int|array|null $value, int $position)
+```
+
+Set Nationality (NK1.27)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNextOfKinBirthPlace
+
+**Description**
+
+```php
+public setNextOfKinBirthPlace (string|int|array|null $value, int $position)
+```
+
+Set Next Of Kin Birth Place (NK1.38)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNextOfKinOrAssociatedPartiesEmployeeNumber
+
+**Description**
+
+```php
+public setNextOfKinOrAssociatedPartiesEmployeeNumber (string|int|array|null $value, int $position)
+```
+
+Set Next Of Kin Or Associated Parties Employee Number (NK1.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNextOfKinOrAssociatedPartiesJobCodeOrClass
+
+**Description**
+
+```php
+public setNextOfKinOrAssociatedPartiesJobCodeOrClass (string|int|array|null $value, int $position)
+```
+
+Set Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNextOfKinOrAssociatedPartiesJobTitle
+
+**Description**
+
+```php
+public setNextOfKinOrAssociatedPartiesJobTitle (string|int|array|null $value, int $position)
+```
+
+Set Next Of Kin Or Associated Parties Job Title (NK1.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setNextOfKinOrAssociatedPartysIdentifiers
+
+**Description**
+
+```php
+public setNextOfKinOrAssociatedPartysIdentifiers (string|int|array|null $value, int $position)
+```
+
+Set Next Of Kin Or Associated Partys Identifiers (NK1.33)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setOrganizationName
+
+**Description**
+
+```php
+public setOrganizationName (string|int|array|null $value, int $position)
+```
+
+Set Organization Name (NK1.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setPhoneNumber
+
+**Description**
+
+```php
+public setPhoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Phone Number (NK1.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setPrimaryLanguage
+
+**Description**
+
+```php
+public setPrimaryLanguage (string|int|array|null $value, int $position)
+```
+
+Set Primary Language (NK1.20)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setProtectionIndicator
+
+**Description**
+
+```php
+public setProtectionIndicator (string|int|array|null $value, int $position)
+```
+
+Set Protection Indicator (NK1.23)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setPublicityCode
+
+**Description**
+
+```php
+public setPublicityCode (string|int|array|null $value, int $position)
+```
+
+Set Publicity Code (NK1.22)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setRace
+
+**Description**
+
+```php
+public setRace (string|int|array|null $value, int $position)
+```
+
+Set Race (NK1.35)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setRelationship
+
+**Description**
+
+```php
+public setRelationship (string|int|array|null $value, int $position)
+```
+
+Set Relationship (NK1.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setReligion
+
+**Description**
+
+```php
+public setReligion (string|int|array|null $value, int $position)
+```
+
+Set Religion (NK1.25)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setStartDate
+
+**Description**
+
+```php
+public setStartDate (string|int|array|null $value, int $position)
+```
+
+Set Start Date (NK1.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setStudentIndicator
+
+**Description**
+
+```php
+public setStudentIndicator (string|int|array|null $value, int $position)
+```
+
+Set Student Indicator (NK1.24)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### NK1::setVipIndicator
+
+**Description**
+
+```php
+public setVipIndicator (string|int|array|null $value, int $position)
+```
+
+Set Vip Indicator (NK1.39)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/NTE.md b/docs/Segments/NTE.md
index 6e09bbd..2bc148b 100644
--- a/docs/Segments/NTE.md
+++ b/docs/Segments/NTE.md
@@ -13,20 +13,23 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getComment](#ntegetcomment)||
-|[getCommentType](#ntegetcommenttype)||
-|[getID](#ntegetid)||
-|[getSourceOfComment](#ntegetsourceofcomment)||
-|[setComment](#ntesetcomment)||
-|[setCommentType](#ntesetcommenttype)||
-|[setID](#ntesetid)||
-|[setSourceOfComment](#ntesetsourceofcomment)||
+|[__destruct](#nte__destruct)||
+|[getComment](#ntegetcomment)|Get Comment (NTE.3)|
+|[getCommentType](#ntegetcommenttype)|Get Comment Type (NTE.4)|
+|[getID](#ntegetid)|Get ID (NTE.1)|
+|[getSourceOfComment](#ntegetsourceofcomment)|Get Source Of Comment (NTE.2)|
+|[resetIndex](#nteresetindex)|Reset index of this segment|
+|[setComment](#ntesetcomment)|Set Comment (NTE.3)|
+|[setCommentType](#ntesetcommenttype)|Set Comment Type (NTE.4)|
+|[setID](#ntesetid)|Set ID (NTE.1)|
+|[setSourceOfComment](#ntesetsourceofcomment)|Set Source Of Comment (NTE.2)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -35,12 +38,12 @@ Aranyasen\HL7\Segment
-### NTE::getComment
+### NTE::__destruct
**Description**
```php
-public getComment (void)
+ __destruct (void)
```
@@ -55,28 +58,60 @@ public getComment (void)
`void`
+
-### NTE::getCommentType
+### NTE::getComment
**Description**
```php
-public getCommentType (void)
+public getComment (int $position)
```
+Get Comment (NTE.3)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NTE::getCommentType
+
+**Description**
+
+```php
+public getCommentType (int $position)
+```
+
+Get Comment Type (NTE.4)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -86,20 +121,24 @@ public getCommentType (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (NTE.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -109,11 +148,38 @@ public getID (void)
**Description**
```php
-public getSourceOfComment (void)
+public getSourceOfComment (int $position)
```
+Get Source Of Comment (NTE.2)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### NTE::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -124,6 +190,7 @@ public getSourceOfComment (void)
`void`
+
@@ -132,20 +199,25 @@ public getSourceOfComment (void)
**Description**
```php
-public setComment (void)
+public setComment (string|int|array|null $value, int $position)
```
-
+Set Comment (NTE.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -155,20 +227,25 @@ public setComment (void)
**Description**
```php
-public setCommentType (void)
+public setCommentType (string|int|array|null $value, int $position)
```
-
+Set Comment Type (NTE.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -178,20 +255,25 @@ public setCommentType (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (NTE.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -201,20 +283,25 @@ public setID (void)
**Description**
```php
-public setSourceOfComment (void)
+public setSourceOfComment (string|int|array|null $value, int $position)
```
-
+Set Source Of Comment (NTE.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/OBR.md b/docs/Segments/OBR.md
index dca4f00..e4543c9 100644
--- a/docs/Segments/OBR.md
+++ b/docs/Segments/OBR.md
@@ -13,98 +13,101 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAssistantResultInterpreter](#obrgetassistantresultinterpreter)||
-|[getChargetoPractice](#obrgetchargetopractice)||
-|[getCollectionVolume](#obrgetcollectionvolume)||
-|[getCollectorIdentifier](#obrgetcollectoridentifier)||
-|[getCollectorsComment](#obrgetcollectorscomment)||
-|[getDangerCode](#obrgetdangercode)||
-|[getDiagnosticServSectID](#obrgetdiagnosticservsectid)||
-|[getEscortRequired](#obrgetescortrequired)||
-|[getFillerField1](#obrgetfillerfield1)||
-|[getFillerField2](#obrgetfillerfield2)||
-|[getFillerOrderNumber](#obrgetfillerordernumber)||
-|[getID](#obrgetid)||
-|[getNumberofSampleContainers](#obrgetnumberofsamplecontainers)||
-|[getObservationDateTime](#obrgetobservationdatetime)||
-|[getObservationEndDateTime](#obrgetobservationenddatetime)||
-|[getOrderCallbackPhoneNumber](#obrgetordercallbackphonenumber)||
-|[getOrderingProvider](#obrgetorderingprovider)||
-|[getParent](#obrgetparent)||
-|[getParentResult](#obrgetparentresult)||
-|[getPlacerOrderNumber](#obrgetplacerordernumber)||
-|[getPlacerfield1](#obrgetplacerfield1)||
-|[getPlacerfield2](#obrgetplacerfield2)||
-|[getPlannedPatientTransportComment](#obrgetplannedpatienttransportcomment)||
-|[getPrincipalResultInterpreter](#obrgetprincipalresultinterpreter)||
-|[getPriority](#obrgetpriority)||
-|[getQuantityTiming](#obrgetquantitytiming)||
-|[getReasonforStudy](#obrgetreasonforstudy)||
-|[getRelevantClinicalInfo](#obrgetrelevantclinicalinfo)||
-|[getRequestedDatetime](#obrgetrequesteddatetime)||
-|[getResultCopiesTo](#obrgetresultcopiesto)||
-|[getResultStatus](#obrgetresultstatus)||
-|[getResultsRptStatusChngDateTime](#obrgetresultsrptstatuschngdatetime)||
-|[getScheduledDateTime](#obrgetscheduleddatetime)||
-|[getSpecimenActionCode](#obrgetspecimenactioncode)||
-|[getSpecimenReceivedDateTime](#obrgetspecimenreceiveddatetime)||
-|[getSpecimenSource](#obrgetspecimensource)||
-|[getTechnician](#obrgettechnician)||
-|[getTranscriptionist](#obrgettranscriptionist)||
-|[getTransportArranged](#obrgettransportarranged)||
-|[getTransportArrangementResponsibility](#obrgettransportarrangementresponsibility)||
-|[getTransportLogisticsofCollectedSample](#obrgettransportlogisticsofcollectedsample)||
-|[getTransportationMode](#obrgettransportationmode)||
-|[getUniversalServiceID](#obrgetuniversalserviceid)||
-|[setAssistantResultInterpreter](#obrsetassistantresultinterpreter)||
-|[setChargetoPractice](#obrsetchargetopractice)||
-|[setCollectionVolume](#obrsetcollectionvolume)||
-|[setCollectorIdentifier](#obrsetcollectoridentifier)||
-|[setCollectorsComment](#obrsetcollectorscomment)||
-|[setDangerCode](#obrsetdangercode)||
-|[setDiagnosticServSectID](#obrsetdiagnosticservsectid)||
-|[setEscortRequired](#obrsetescortrequired)||
-|[setFillerField1](#obrsetfillerfield1)||
-|[setFillerField2](#obrsetfillerfield2)||
-|[setFillerOrderNumber](#obrsetfillerordernumber)||
-|[setID](#obrsetid)||
-|[setNumberofSampleContainers](#obrsetnumberofsamplecontainers)||
-|[setObservationDateTime](#obrsetobservationdatetime)||
-|[setObservationEndDateTime](#obrsetobservationenddatetime)||
-|[setOrderCallbackPhoneNumber](#obrsetordercallbackphonenumber)||
-|[setOrderingProvider](#obrsetorderingprovider)||
-|[setParent](#obrsetparent)||
-|[setParentResult](#obrsetparentresult)||
-|[setPlacerOrderNumber](#obrsetplacerordernumber)||
-|[setPlacerfield1](#obrsetplacerfield1)||
-|[setPlacerfield2](#obrsetplacerfield2)||
-|[setPlannedPatientTransportComment](#obrsetplannedpatienttransportcomment)||
-|[setPrincipalResultInterpreter](#obrsetprincipalresultinterpreter)||
-|[setPriority](#obrsetpriority)||
-|[setQuantityTiming](#obrsetquantitytiming)||
-|[setReasonforStudy](#obrsetreasonforstudy)||
-|[setRelevantClinicalInfo](#obrsetrelevantclinicalinfo)||
-|[setRequestedDatetime](#obrsetrequesteddatetime)||
-|[setResultCopiesTo](#obrsetresultcopiesto)||
-|[setResultStatus](#obrsetresultstatus)||
-|[setResultsRptStatusChngDateTime](#obrsetresultsrptstatuschngdatetime)||
-|[setScheduledDateTime](#obrsetscheduleddatetime)||
-|[setSpecimenActionCode](#obrsetspecimenactioncode)||
-|[setSpecimenReceivedDateTime](#obrsetspecimenreceiveddatetime)||
-|[setSpecimenSource](#obrsetspecimensource)||
-|[setTechnician](#obrsettechnician)||
-|[setTranscriptionist](#obrsettranscriptionist)||
-|[setTransportArranged](#obrsettransportarranged)||
-|[setTransportArrangementResponsibility](#obrsettransportarrangementresponsibility)||
-|[setTransportLogisticsofCollectedSample](#obrsettransportlogisticsofcollectedsample)||
-|[setTransportationMode](#obrsettransportationmode)||
-|[setUniversalServiceID](#obrsetuniversalserviceid)||
+|[__destruct](#obr__destruct)||
+|[getAssistantResultInterpreter](#obrgetassistantresultinterpreter)|Get Assistant Result Interpreter (OBR.33)|
+|[getChargetoPractice](#obrgetchargetopractice)|Get Chargeto Practice (OBR.23)|
+|[getCollectionVolume](#obrgetcollectionvolume)|Get Collection Volume (OBR.9)|
+|[getCollectorIdentifier](#obrgetcollectoridentifier)|Get Collector Identifier (OBR.10)|
+|[getCollectorsComment](#obrgetcollectorscomment)|Get Collectors Comment (OBR.39)|
+|[getDangerCode](#obrgetdangercode)|Get Danger Code (OBR.12)|
+|[getDiagnosticServSectID](#obrgetdiagnosticservsectid)|Get Diagnostic Serv Sect ID (OBR.24)|
+|[getEscortRequired](#obrgetescortrequired)|Get Escort Required (OBR.42)|
+|[getFillerField1](#obrgetfillerfield1)|Get Filler field 1 (OBR.20)|
+|[getFillerField2](#obrgetfillerfield2)|Get Filler field 2 (OBR.21)|
+|[getFillerOrderNumber](#obrgetfillerordernumber)|Get Filler Order Number (OBR.3)|
+|[getID](#obrgetid)|Get ID (OBR.1)|
+|[getNumberofSampleContainers](#obrgetnumberofsamplecontainers)|Get Numberof Sample Containers (OBR.37)|
+|[getObservationDateTime](#obrgetobservationdatetime)|Get Observation Date Time (OBR.7)|
+|[getObservationEndDateTime](#obrgetobservationenddatetime)|Get Observation End Date Time (OBR.8)|
+|[getOrderCallbackPhoneNumber](#obrgetordercallbackphonenumber)|Get Order Callback Phone Number (OBR.17)|
+|[getOrderingProvider](#obrgetorderingprovider)|Get Ordering Provider (OBR.16)|
+|[getParent](#obrgetparent)|Get Parent (OBR.29)|
+|[getParentResult](#obrgetparentresult)|Get Parent Result (OBR.26)|
+|[getPlacerOrderNumber](#obrgetplacerordernumber)|Get Placer Order Number (OBR.2)|
+|[getPlacerfield1](#obrgetplacerfield1)|Get Placer field 1 (OBR.18)|
+|[getPlacerfield2](#obrgetplacerfield2)|Get Placer field 2 (OBR.19)|
+|[getPlannedPatientTransportComment](#obrgetplannedpatienttransportcomment)|Get Planned Patient Transport Comment (OBR.43)|
+|[getPrincipalResultInterpreter](#obrgetprincipalresultinterpreter)|Get Principal Result Interpreter (OBR.32)|
+|[getPriority](#obrgetpriority)|Get Priority (OBR.5)|
+|[getQuantityTiming](#obrgetquantitytiming)|Get Quantity Timing (OBR.27)|
+|[getReasonforStudy](#obrgetreasonforstudy)|Get Reasonfor Study (OBR.31)|
+|[getRelevantClinicalInfo](#obrgetrelevantclinicalinfo)|Get Relevant Clinical Info (OBR.13)|
+|[getRequestedDatetime](#obrgetrequesteddatetime)|Get Requested Datetime (OBR.6)|
+|[getResultCopiesTo](#obrgetresultcopiesto)|Get Result Copies To (OBR.28)|
+|[getResultStatus](#obrgetresultstatus)|Get Result Status (OBR.25)|
+|[getResultsRptStatusChngDateTime](#obrgetresultsrptstatuschngdatetime)|Get Results Rpt Status Chng Date Time (OBR.22)|
+|[getScheduledDateTime](#obrgetscheduleddatetime)|Get Scheduled Date Time (OBR.36)|
+|[getSpecimenActionCode](#obrgetspecimenactioncode)|Get Specimen Action Code (OBR.11)|
+|[getSpecimenReceivedDateTime](#obrgetspecimenreceiveddatetime)|Get Specimen Received Date Time (OBR.14)|
+|[getSpecimenSource](#obrgetspecimensource)|Get Specimen Source (OBR.15)|
+|[getTechnician](#obrgettechnician)|Get Technician (OBR.34)|
+|[getTranscriptionist](#obrgettranscriptionist)|Get Transcriptionist (OBR.35)|
+|[getTransportArranged](#obrgettransportarranged)|Get Transport Arranged (OBR.41)|
+|[getTransportArrangementResponsibility](#obrgettransportarrangementresponsibility)|Get Transport Arrangement Responsibility (OBR.40)|
+|[getTransportLogisticsofCollectedSample](#obrgettransportlogisticsofcollectedsample)|Get Transport Logisticsof Collected Sample (OBR.38)|
+|[getTransportationMode](#obrgettransportationmode)|Get Transportation Mode (OBR.30)|
+|[getUniversalServiceID](#obrgetuniversalserviceid)|Get Universal Service ID (OBR.4)|
+|[resetIndex](#obrresetindex)|Reset index of this segment|
+|[setAssistantResultInterpreter](#obrsetassistantresultinterpreter)|Set Assistant Result Interpreter (OBR.33)|
+|[setChargetoPractice](#obrsetchargetopractice)|Set Chargeto Practice (OBR.23)|
+|[setCollectionVolume](#obrsetcollectionvolume)|Set Collection Volume (OBR.9)|
+|[setCollectorIdentifier](#obrsetcollectoridentifier)|Set Collector Identifier (OBR.10)|
+|[setCollectorsComment](#obrsetcollectorscomment)|Set Collectors Comment (OBR.39)|
+|[setDangerCode](#obrsetdangercode)|Set Danger Code (OBR.12)|
+|[setDiagnosticServSectID](#obrsetdiagnosticservsectid)|Set Diagnostic Serv Sect ID (OBR.24)|
+|[setEscortRequired](#obrsetescortrequired)|Set Escort Required (OBR.42)|
+|[setFillerField1](#obrsetfillerfield1)|Set Filler field 1 (OBR.20)|
+|[setFillerField2](#obrsetfillerfield2)|Set Filler field 2 (OBR.21)|
+|[setFillerOrderNumber](#obrsetfillerordernumber)|Set Filler Order Number (OBR.3)|
+|[setID](#obrsetid)|Set ID (OBR.1)|
+|[setNumberofSampleContainers](#obrsetnumberofsamplecontainers)|Set Numberof Sample Containers (OBR.37)|
+|[setObservationDateTime](#obrsetobservationdatetime)|Set Observation Date Time (OBR.7)|
+|[setObservationEndDateTime](#obrsetobservationenddatetime)|Set Observation End Date Time (OBR.8)|
+|[setOrderCallbackPhoneNumber](#obrsetordercallbackphonenumber)|Set Order Callback Phone Number (OBR.17)|
+|[setOrderingProvider](#obrsetorderingprovider)|Set Ordering Provider (OBR.16)|
+|[setParent](#obrsetparent)|Set Parent (OBR.29)|
+|[setParentResult](#obrsetparentresult)|Set Parent Result (OBR.26)|
+|[setPlacerOrderNumber](#obrsetplacerordernumber)|Set Placer Order Number (OBR.2)|
+|[setPlacerfield1](#obrsetplacerfield1)|Set Placer field 1 (OBR.18)|
+|[setPlacerfield2](#obrsetplacerfield2)|Set Placer field 1 (OBR.19)|
+|[setPlannedPatientTransportComment](#obrsetplannedpatienttransportcomment)|Set Planned Patient Transport Comment (OBR.43)|
+|[setPrincipalResultInterpreter](#obrsetprincipalresultinterpreter)|Set Principal Result Interpreter (OBR.32)|
+|[setPriority](#obrsetpriority)|Set Priority (OBR.5)|
+|[setQuantityTiming](#obrsetquantitytiming)|Set Quantity Timing (OBR.27)|
+|[setReasonforStudy](#obrsetreasonforstudy)|Set Reasonfor Study (OBR.31)|
+|[setRelevantClinicalInfo](#obrsetrelevantclinicalinfo)|Set Relevant Clinical Info (OBR.13)|
+|[setRequestedDatetime](#obrsetrequesteddatetime)|Set Requested Datetime (OBR.6)|
+|[setResultCopiesTo](#obrsetresultcopiesto)|Set Result Copies To (OBR.28)|
+|[setResultStatus](#obrsetresultstatus)|Set Result Status (OBR.25)|
+|[setResultsRptStatusChngDateTime](#obrsetresultsrptstatuschngdatetime)|Set Results Rpt Status Chng Date Time (OBR.22)|
+|[setScheduledDateTime](#obrsetscheduleddatetime)|Set Scheduled Date Time (OBR.36)|
+|[setSpecimenActionCode](#obrsetspecimenactioncode)|Set Specimen Action Code (OBR.11)|
+|[setSpecimenReceivedDateTime](#obrsetspecimenreceiveddatetime)|Set Specimen Received Date Time (OBR.14)|
+|[setSpecimenSource](#obrsetspecimensource)|Set Specimen Source (OBR.15)|
+|[setTechnician](#obrsettechnician)|Set Technician (OBR.34)|
+|[setTranscriptionist](#obrsettranscriptionist)|Set Transcriptionist (OBR.35)|
+|[setTransportArranged](#obrsettransportarranged)|Set Transport Arranged (OBR.41)|
+|[setTransportArrangementResponsibility](#obrsettransportarrangementresponsibility)|Set Transport Arrangement Responsibility (OBR.40)|
+|[setTransportLogisticsofCollectedSample](#obrsettransportlogisticsofcollectedsample)|Set Transport Logisticsof Collected Sample (OBR.38)|
+|[setTransportationMode](#obrsettransportationmode)|Set Transportation Mode (OBR.30)|
+|[setUniversalServiceID](#obrsetuniversalserviceid)|Set Universal Service ID (OBR.4)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -113,12 +116,12 @@ Aranyasen\HL7\Segment
-### OBR::getAssistantResultInterpreter
+### OBR::__destruct
**Description**
```php
-public getAssistantResultInterpreter (void)
+ __destruct (void)
```
@@ -133,28 +136,60 @@ public getAssistantResultInterpreter (void)
`void`
+
-### OBR::getChargetoPractice
+### OBR::getAssistantResultInterpreter
**Description**
```php
-public getChargetoPractice (void)
+public getAssistantResultInterpreter (int $position)
```
+Get Assistant Result Interpreter (OBR.33)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### OBR::getChargetoPractice
+
+**Description**
+
+```php
+public getChargetoPractice (int $position)
+```
+
+Get Chargeto Practice (OBR.23)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -164,20 +199,24 @@ public getChargetoPractice (void)
**Description**
```php
-public getCollectionVolume (void)
+public getCollectionVolume (int $position)
```
-
+Get Collection Volume (OBR.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -187,20 +226,24 @@ public getCollectionVolume (void)
**Description**
```php
-public getCollectorIdentifier (void)
+public getCollectorIdentifier (int $position)
```
-
+Get Collector Identifier (OBR.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -210,20 +253,24 @@ public getCollectorIdentifier (void)
**Description**
```php
-public getCollectorsComment (void)
+public getCollectorsComment (int $position)
```
-
+Get Collectors Comment (OBR.39)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -233,20 +280,24 @@ public getCollectorsComment (void)
**Description**
```php
-public getDangerCode (void)
+public getDangerCode (int $position)
```
-
+Get Danger Code (OBR.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -256,20 +307,24 @@ public getDangerCode (void)
**Description**
```php
-public getDiagnosticServSectID (void)
+public getDiagnosticServSectID (int $position)
```
-
+Get Diagnostic Serv Sect ID (OBR.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -279,20 +334,24 @@ public getDiagnosticServSectID (void)
**Description**
```php
-public getEscortRequired (void)
+public getEscortRequired (int $position)
```
-
+Get Escort Required (OBR.42)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -302,20 +361,24 @@ public getEscortRequired (void)
**Description**
```php
-public getFillerField1 (void)
+public getFillerField1 (int $position)
```
-
+Get Filler field 1 (OBR.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -325,20 +388,24 @@ public getFillerField1 (void)
**Description**
```php
-public getFillerField2 (void)
+public getFillerField2 (int $position)
```
-
+Get Filler field 2 (OBR.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -348,20 +415,24 @@ public getFillerField2 (void)
**Description**
```php
-public getFillerOrderNumber (void)
+public getFillerOrderNumber (int $position)
```
-
+Get Filler Order Number (OBR.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -371,20 +442,24 @@ public getFillerOrderNumber (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (OBR.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -394,20 +469,24 @@ public getID (void)
**Description**
```php
-public getNumberofSampleContainers (void)
+public getNumberofSampleContainers (int $position)
```
-
+Get Numberof Sample Containers (OBR.37)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -417,20 +496,24 @@ public getNumberofSampleContainers (void)
**Description**
```php
-public getObservationDateTime (void)
+public getObservationDateTime (int $position)
```
-
+Get Observation Date Time (OBR.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -440,20 +523,24 @@ public getObservationDateTime (void)
**Description**
```php
-public getObservationEndDateTime (void)
+public getObservationEndDateTime (int $position)
```
-
+Get Observation End Date Time (OBR.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -463,20 +550,24 @@ public getObservationEndDateTime (void)
**Description**
```php
-public getOrderCallbackPhoneNumber (void)
+public getOrderCallbackPhoneNumber (int $position)
```
-
+Get Order Callback Phone Number (OBR.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -486,20 +577,24 @@ public getOrderCallbackPhoneNumber (void)
**Description**
```php
-public getOrderingProvider (void)
+public getOrderingProvider (int $position)
```
-
+Get Ordering Provider (OBR.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -509,20 +604,24 @@ public getOrderingProvider (void)
**Description**
```php
-public getParent (void)
+public getParent (int $position)
```
-
+Get Parent (OBR.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -532,20 +631,24 @@ public getParent (void)
**Description**
```php
-public getParentResult (void)
+public getParentResult (int $position)
```
-
+Get Parent Result (OBR.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -555,20 +658,24 @@ public getParentResult (void)
**Description**
```php
-public getPlacerOrderNumber (void)
+public getPlacerOrderNumber (int $position)
```
-
+Get Placer Order Number (OBR.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -578,20 +685,24 @@ public getPlacerOrderNumber (void)
**Description**
```php
-public getPlacerfield1 (void)
+public getPlacerfield1 (int $position)
```
-
+Get Placer field 1 (OBR.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -601,20 +712,24 @@ public getPlacerfield1 (void)
**Description**
```php
-public getPlacerfield2 (void)
+public getPlacerfield2 (int $position)
```
-
+Get Placer field 2 (OBR.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -624,20 +739,24 @@ public getPlacerfield2 (void)
**Description**
```php
-public getPlannedPatientTransportComment (void)
+public getPlannedPatientTransportComment (int $position)
```
-
+Get Planned Patient Transport Comment (OBR.43)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -647,20 +766,24 @@ public getPlannedPatientTransportComment (void)
**Description**
```php
-public getPrincipalResultInterpreter (void)
+public getPrincipalResultInterpreter (int $position)
```
-
+Get Principal Result Interpreter (OBR.32)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -670,20 +793,24 @@ public getPrincipalResultInterpreter (void)
**Description**
```php
-public getPriority (void)
+public getPriority (int $position)
```
-
+Get Priority (OBR.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -693,20 +820,24 @@ public getPriority (void)
**Description**
```php
-public getQuantityTiming (void)
+public getQuantityTiming (int $position)
```
-
+Get Quantity Timing (OBR.27)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -716,20 +847,24 @@ public getQuantityTiming (void)
**Description**
```php
-public getReasonforStudy (void)
+public getReasonforStudy (int $position)
```
-
+Get Reasonfor Study (OBR.31)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -739,20 +874,24 @@ public getReasonforStudy (void)
**Description**
```php
-public getRelevantClinicalInfo (void)
+public getRelevantClinicalInfo (int $position)
```
-
+Get Relevant Clinical Info (OBR.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -762,20 +901,24 @@ public getRelevantClinicalInfo (void)
**Description**
```php
-public getRequestedDatetime (void)
+public getRequestedDatetime (int $position)
```
-
+Get Requested Datetime (OBR.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -785,20 +928,24 @@ public getRequestedDatetime (void)
**Description**
```php
-public getResultCopiesTo (void)
+public getResultCopiesTo (int $position)
```
-
+Get Result Copies To (OBR.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -808,20 +955,24 @@ public getResultCopiesTo (void)
**Description**
```php
-public getResultStatus (void)
+public getResultStatus (int $position)
```
-
+Get Result Status (OBR.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -831,20 +982,24 @@ public getResultStatus (void)
**Description**
```php
-public getResultsRptStatusChngDateTime (void)
+public getResultsRptStatusChngDateTime (int $position)
```
-
+Get Results Rpt Status Chng Date Time (OBR.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -854,20 +1009,24 @@ public getResultsRptStatusChngDateTime (void)
**Description**
```php
-public getScheduledDateTime (void)
+public getScheduledDateTime (int $position)
```
-
+Get Scheduled Date Time (OBR.36)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -877,20 +1036,24 @@ public getScheduledDateTime (void)
**Description**
```php
-public getSpecimenActionCode (void)
+public getSpecimenActionCode (int $position)
```
-
+Get Specimen Action Code (OBR.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -900,20 +1063,24 @@ public getSpecimenActionCode (void)
**Description**
```php
-public getSpecimenReceivedDateTime (void)
+public getSpecimenReceivedDateTime (int $position)
```
-
+Get Specimen Received Date Time (OBR.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -923,20 +1090,24 @@ public getSpecimenReceivedDateTime (void)
**Description**
```php
-public getSpecimenSource (void)
+public getSpecimenSource (int $position)
```
-
+Get Specimen Source (OBR.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -946,20 +1117,24 @@ public getSpecimenSource (void)
**Description**
```php
-public getTechnician (void)
+public getTechnician (int $position)
```
-
+Get Technician (OBR.34)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -969,20 +1144,24 @@ public getTechnician (void)
**Description**
```php
-public getTranscriptionist (void)
+public getTranscriptionist (int $position)
```
-
+Get Transcriptionist (OBR.35)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -992,20 +1171,24 @@ public getTranscriptionist (void)
**Description**
```php
-public getTransportArranged (void)
+public getTransportArranged (int $position)
```
-
+Get Transport Arranged (OBR.41)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1015,20 +1198,24 @@ public getTransportArranged (void)
**Description**
```php
-public getTransportArrangementResponsibility (void)
+public getTransportArrangementResponsibility (int $position)
```
-
+Get Transport Arrangement Responsibility (OBR.40)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1038,20 +1225,24 @@ public getTransportArrangementResponsibility (void)
**Description**
```php
-public getTransportLogisticsofCollectedSample (void)
+public getTransportLogisticsofCollectedSample (int $position)
```
-
+Get Transport Logisticsof Collected Sample (OBR.38)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1061,20 +1252,24 @@ public getTransportLogisticsofCollectedSample (void)
**Description**
```php
-public getTransportationMode (void)
+public getTransportationMode (int $position)
```
-
+Get Transportation Mode (OBR.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1084,11 +1279,38 @@ public getTransportationMode (void)
**Description**
```php
-public getUniversalServiceID (void)
+public getUniversalServiceID (int $position)
```
+Get Universal Service ID (OBR.4)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### OBR::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -1099,6 +1321,7 @@ public getUniversalServiceID (void)
`void`
+
@@ -1107,20 +1330,25 @@ public getUniversalServiceID (void)
**Description**
```php
-public setAssistantResultInterpreter (void)
+public setAssistantResultInterpreter (string|int|array|null $value, int $position)
```
-
+Set Assistant Result Interpreter (OBR.33)
-**Parameters**
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`bool`
-`This function has no parameters.`
-**Return Values**
-`void`
@@ -1130,20 +1358,25 @@ public setAssistantResultInterpreter (void)
**Description**
```php
-public setChargetoPractice (void)
+public setChargetoPractice (string|int|array|null $value, int $position)
```
-
+Set Chargeto Practice (OBR.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1153,20 +1386,25 @@ public setChargetoPractice (void)
**Description**
```php
-public setCollectionVolume (void)
+public setCollectionVolume (string|int|array|null $value, int $position)
```
-
+Set Collection Volume (OBR.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1176,20 +1414,25 @@ public setCollectionVolume (void)
**Description**
```php
-public setCollectorIdentifier (void)
+public setCollectorIdentifier (string|int|array|null $value, int $position)
```
-
+Set Collector Identifier (OBR.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1199,20 +1442,25 @@ public setCollectorIdentifier (void)
**Description**
```php
-public setCollectorsComment (void)
+public setCollectorsComment (string|int|array|null $value, int $position)
```
-
+Set Collectors Comment (OBR.39)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1222,20 +1470,25 @@ public setCollectorsComment (void)
**Description**
```php
-public setDangerCode (void)
+public setDangerCode (string|int|array|null $value, int $position)
```
-
+Set Danger Code (OBR.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1245,20 +1498,25 @@ public setDangerCode (void)
**Description**
```php
-public setDiagnosticServSectID (void)
+public setDiagnosticServSectID (string|int|array|null $value, int $position)
```
-
+Set Diagnostic Serv Sect ID (OBR.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1268,20 +1526,25 @@ public setDiagnosticServSectID (void)
**Description**
```php
-public setEscortRequired (void)
+public setEscortRequired (string|int|array|null $value, int $position)
```
-
+Set Escort Required (OBR.42)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1291,20 +1554,25 @@ public setEscortRequired (void)
**Description**
```php
-public setFillerField1 (void)
+public setFillerField1 (string|int|array|null $value, int $position)
```
-
+Set Filler field 1 (OBR.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1314,20 +1582,25 @@ public setFillerField1 (void)
**Description**
```php
-public setFillerField2 (void)
+public setFillerField2 (string|int|array|null $value, int $position)
```
-
+Set Filler field 2 (OBR.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1337,20 +1610,25 @@ public setFillerField2 (void)
**Description**
```php
-public setFillerOrderNumber (void)
+public setFillerOrderNumber (string|int|array|null $value, int $position)
```
-
+Set Filler Order Number (OBR.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1360,20 +1638,25 @@ public setFillerOrderNumber (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (OBR.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1383,20 +1666,25 @@ public setID (void)
**Description**
```php
-public setNumberofSampleContainers (void)
+public setNumberofSampleContainers (string|int|array|null $value, int $position)
```
-
+Set Numberof Sample Containers (OBR.37)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1406,20 +1694,25 @@ public setNumberofSampleContainers (void)
**Description**
```php
-public setObservationDateTime (void)
+public setObservationDateTime (string|int|array|null $value, int $position)
```
-
+Set Observation Date Time (OBR.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1429,20 +1722,25 @@ public setObservationDateTime (void)
**Description**
```php
-public setObservationEndDateTime (void)
+public setObservationEndDateTime (string|int|array|null $value, int $position)
```
-
+Set Observation End Date Time (OBR.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1452,20 +1750,25 @@ public setObservationEndDateTime (void)
**Description**
```php
-public setOrderCallbackPhoneNumber (void)
+public setOrderCallbackPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Order Callback Phone Number (OBR.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1475,20 +1778,25 @@ public setOrderCallbackPhoneNumber (void)
**Description**
```php
-public setOrderingProvider (void)
+public setOrderingProvider (string|int|array|null $value, int $position)
```
-
+Set Ordering Provider (OBR.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1498,20 +1806,25 @@ public setOrderingProvider (void)
**Description**
```php
-public setParent (void)
+public setParent (string|int|array|null $value, int $position)
```
-
+Set Parent (OBR.29)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1521,20 +1834,25 @@ public setParent (void)
**Description**
```php
-public setParentResult (void)
+public setParentResult (string|int|array|null $value, int $position)
```
-
+Set Parent Result (OBR.26)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1544,20 +1862,25 @@ public setParentResult (void)
**Description**
```php
-public setPlacerOrderNumber (void)
+public setPlacerOrderNumber (string|int|array|null $value, int $position)
```
-
+Set Placer Order Number (OBR.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1567,20 +1890,25 @@ public setPlacerOrderNumber (void)
**Description**
```php
-public setPlacerfield1 (void)
+public setPlacerfield1 (string|int|array|null $value, int $position)
```
-
+Set Placer field 1 (OBR.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1590,20 +1918,25 @@ public setPlacerfield1 (void)
**Description**
```php
-public setPlacerfield2 (void)
+public setPlacerfield2 (string|int|array|null $value, int $position)
```
-
+Set Placer field 1 (OBR.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1613,20 +1946,25 @@ public setPlacerfield2 (void)
**Description**
```php
-public setPlannedPatientTransportComment (void)
+public setPlannedPatientTransportComment (string|int|array|null $value, int $position)
```
-
+Set Planned Patient Transport Comment (OBR.43)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1636,20 +1974,25 @@ public setPlannedPatientTransportComment (void)
**Description**
```php
-public setPrincipalResultInterpreter (void)
+public setPrincipalResultInterpreter (string|int|array|null $value, int $position)
```
-
+Set Principal Result Interpreter (OBR.32)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1659,20 +2002,25 @@ public setPrincipalResultInterpreter (void)
**Description**
```php
-public setPriority (void)
+public setPriority (string|int|array|null $value, int $position)
```
-
+Set Priority (OBR.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1682,20 +2030,25 @@ public setPriority (void)
**Description**
```php
-public setQuantityTiming (void)
+public setQuantityTiming (string|int|array|null $value, int $position)
```
-
+Set Quantity Timing (OBR.27)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1705,20 +2058,25 @@ public setQuantityTiming (void)
**Description**
```php
-public setReasonforStudy (void)
+public setReasonforStudy (string|int|array|null $value, int $position)
```
-
+Set Reasonfor Study (OBR.31)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1728,20 +2086,25 @@ public setReasonforStudy (void)
**Description**
```php
-public setRelevantClinicalInfo (void)
+public setRelevantClinicalInfo (string|int|array|null $value, int $position)
```
-
+Set Relevant Clinical Info (OBR.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1751,20 +2114,25 @@ public setRelevantClinicalInfo (void)
**Description**
```php
-public setRequestedDatetime (void)
+public setRequestedDatetime (string|int|array|null $value, int $position)
```
-
+Set Requested Datetime (OBR.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1774,20 +2142,25 @@ public setRequestedDatetime (void)
**Description**
```php
-public setResultCopiesTo (void)
+public setResultCopiesTo (string|int|array|null $value, int $position)
```
-
+Set Result Copies To (OBR.28)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1797,20 +2170,25 @@ public setResultCopiesTo (void)
**Description**
```php
-public setResultStatus (void)
+public setResultStatus (string|int|array|null $value, int $position)
```
-
+Set Result Status (OBR.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1820,20 +2198,25 @@ public setResultStatus (void)
**Description**
```php
-public setResultsRptStatusChngDateTime (void)
+public setResultsRptStatusChngDateTime (string|int|array|null $value, int $position)
```
-
+Set Results Rpt Status Chng Date Time (OBR.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1843,20 +2226,25 @@ public setResultsRptStatusChngDateTime (void)
**Description**
```php
-public setScheduledDateTime (void)
+public setScheduledDateTime (string|int|array|null $value, int $position)
```
-
+Set Scheduled Date Time (OBR.36)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1866,20 +2254,25 @@ public setScheduledDateTime (void)
**Description**
```php
-public setSpecimenActionCode (void)
+public setSpecimenActionCode (string|int|array|null $value, int $position)
```
-
+Set Specimen Action Code (OBR.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1889,20 +2282,25 @@ public setSpecimenActionCode (void)
**Description**
```php
-public setSpecimenReceivedDateTime (void)
+public setSpecimenReceivedDateTime (string|int|array|null $value, int $position)
```
-
+Set Specimen Received Date Time (OBR.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1912,20 +2310,25 @@ public setSpecimenReceivedDateTime (void)
**Description**
```php
-public setSpecimenSource (void)
+public setSpecimenSource (string|int|array|null $value, int $position)
```
-
+Set Specimen Source (OBR.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1935,20 +2338,25 @@ public setSpecimenSource (void)
**Description**
```php
-public setTechnician (void)
+public setTechnician (string|int|array|null $value, int $position)
```
-
+Set Technician (OBR.34)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1958,20 +2366,25 @@ public setTechnician (void)
**Description**
```php
-public setTranscriptionist (void)
+public setTranscriptionist (string|int|array|null $value, int $position)
```
-
+Set Transcriptionist (OBR.35)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1981,20 +2394,25 @@ public setTranscriptionist (void)
**Description**
```php
-public setTransportArranged (void)
+public setTransportArranged (string|int|array|null $value, int $position)
```
-
+Set Transport Arranged (OBR.41)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2004,20 +2422,25 @@ public setTransportArranged (void)
**Description**
```php
-public setTransportArrangementResponsibility (void)
+public setTransportArrangementResponsibility (string|int|array|null $value, int $position)
```
-
+Set Transport Arrangement Responsibility (OBR.40)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2027,20 +2450,25 @@ public setTransportArrangementResponsibility (void)
**Description**
```php
-public setTransportLogisticsofCollectedSample (void)
+public setTransportLogisticsofCollectedSample (string|int|array|null $value, int $position)
```
-
+Set Transport Logisticsof Collected Sample (OBR.38)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2050,20 +2478,25 @@ public setTransportLogisticsofCollectedSample (void)
**Description**
```php
-public setTransportationMode (void)
+public setTransportationMode (string|int|array|null $value, int $position)
```
-
+Set Transportation Mode (OBR.30)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2073,20 +2506,25 @@ public setTransportationMode (void)
**Description**
```php
-public setUniversalServiceID (void)
+public setUniversalServiceID (string|int|array|null $value, int $position)
```
-
+Set Universal Service ID (OBR.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/OBX.md b/docs/Segments/OBX.md
index 44067c9..59f3967 100644
--- a/docs/Segments/OBX.md
+++ b/docs/Segments/OBX.md
@@ -1,7 +1,7 @@
# Aranyasen\HL7\Segments\OBX
OBX segment class
-Ref: https://corepointhealth.com/resource-center/hl7-resources/hl7-obx-segment
+Ref: https://hl7-definition.caristix.com/v2/HL7v2.5.1/Segments/OBX
@@ -13,46 +13,53 @@ Aranyasen\HL7\Segment
| 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)||
+|[__destruct](#obx__destruct)||
+|[getAbnormalFlags](#obxgetabnormalflags)|Get Abnormal Flags (OBX.8)|
+|[getDataLastObsNormalValues](#obxgetdatalastobsnormalvalues)|Get Data Last Obs Normal Values (OBX.12)|
+|[getDateTimeOfAnalysis](#obxgetdatetimeofanalysis)|Get Date Time Of Analysis (OBX.19)|
+|[getDateTimeOfTheObservation](#obxgetdatetimeoftheobservation)|Get Date Time Of The Observation (OBX.14)|
+|[getEquipmentInstanceIdentifier](#obxgetequipmentinstanceidentifier)|Get Equipment Instance Identifier (OBX.18)|
+|[getID](#obxgetid)|Get ID (OBX.1)|
+|[getNatureOfAbnormalTest](#obxgetnatureofabnormaltest)|Get Nature Of Abnormal Test (OBX.10)|
+|[getObservationIdentifier](#obxgetobservationidentifier)|Get Observation Identifier (OBX.3)|
+|[getObservationMethod](#obxgetobservationmethod)|Get Observation Method (OBX.17)|
+|[getObservationSubId](#obxgetobservationsubid)|Get Observation Sub Id (OBX.4)|
+|[getObservationValue](#obxgetobservationvalue)|Get Observation Value (OBX.5)|
+|[getObserveResultStatus](#obxgetobserveresultstatus)|Get Observe Result Status (OBX.11)|
+|[getProbability](#obxgetprobability)|Get Probability (OBX.9)|
+|[getProducersId](#obxgetproducersid)|Get Producers Id (OBX.15)|
+|[getReferenceRange](#obxgetreferencerange)|Get Reference Range (OBX.7)|
+|[getResponsibleObserver](#obxgetresponsibleobserver)|Get Responsible Observer (OBX.16)|
+|[getUnits](#obxgetunits)|Get Units (OBX.6)|
+|[getUserDefinedAccessChecks](#obxgetuserdefinedaccesschecks)|Get User Defined Access Checks (OBX.13)|
+|[getValueType](#obxgetvaluetype)|Get Value Type (OBX.2)|
+|[resetIndex](#obxresetindex)|Reset index of this segment|
+|[setAbnormalFlags](#obxsetabnormalflags)|Set Abnormal Flags (OBX.8)|
+|[setDataLastObsNormalValues](#obxsetdatalastobsnormalvalues)|Set Data Last Obs Normal Values (OBX.12)|
+|[setDateTimeOfAnalysis](#obxsetdatetimeofanalysis)|Set Date Time Of Analysis (OBX.19)|
+|[setDateTimeOfTheObservation](#obxsetdatetimeoftheobservation)|Set Date Time Of The Observation (OBX.14)|
+|[setEquipmentInstanceIdentifier](#obxsetequipmentinstanceidentifier)|Set Equipment Instance Identifier (OBX.18)|
+|[setID](#obxsetid)|Set ID (OBX.1)|
+|[setNatureOfAbnormalTest](#obxsetnatureofabnormaltest)|Set Nature Of Abnormal Test (OBX.10)|
+|[setObservationIdentifier](#obxsetobservationidentifier)|Set Observation Identifier (OBX.3)|
+|[setObservationMethod](#obxsetobservationmethod)|Set Observation Method (OBX.17)|
+|[setObservationSubId](#obxsetobservationsubid)|Set Observation Sub Id (OBX.4)|
+|[setObservationValue](#obxsetobservationvalue)|Set Observation Value (OBX.5)|
+|[setObserveResultStatus](#obxsetobserveresultstatus)|Set Observe Result Status (OBX.11)|
+|[setProbability](#obxsetprobability)|Set Probability (OBX.9)|
+|[setProducersId](#obxsetproducersid)|Set Producers Id (OBX.15)|
+|[setReferenceRange](#obxsetreferencerange)|Set Reference Range (OBX.7)|
+|[setResponsibleObserver](#obxsetresponsibleobserver)|Set Responsible Observer (OBX.16)|
+|[setUnits](#obxsetunits)|Set Units (OBX.6)|
+|[setUserDefinedAccessChecks](#obxsetuserdefinedaccesschecks)|Set User Defined Access Checks (OBX.13)|
+|[setValueType](#obxsetvaluetype)|Set Value Type (OBX.2)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -61,12 +68,12 @@ Aranyasen\HL7\Segment
-### OBX::getAbnormalFlags
+### OBX::__destruct
**Description**
```php
-public getAbnormalFlags (void)
+ __destruct (void)
```
@@ -81,6 +88,34 @@ public getAbnormalFlags (void)
`void`
+
+
+
+
+### OBX::getAbnormalFlags
+
+**Description**
+
+```php
+public getAbnormalFlags (int $position)
+```
+
+Get Abnormal Flags (OBX.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
@@ -89,20 +124,51 @@ public getAbnormalFlags (void)
**Description**
```php
-public getDataLastObsNormalValues (void)
+public getDataLastObsNormalValues (int $position)
```
+Get Data Last Obs Normal Values (OBX.12)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### OBX::getDateTimeOfAnalysis
+
+**Description**
+
+```php
+public getDateTimeOfAnalysis (int $position)
+```
+
+Get Date Time Of Analysis (OBX.19)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -112,20 +178,51 @@ public getDataLastObsNormalValues (void)
**Description**
```php
-public getDateTimeOfTheObservation (void)
+public getDateTimeOfTheObservation (int $position)
```
+Get Date Time Of The Observation (OBX.14)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### OBX::getEquipmentInstanceIdentifier
+
+**Description**
+
+```php
+public getEquipmentInstanceIdentifier (int $position)
+```
+
+Get Equipment Instance Identifier (OBX.18)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -135,20 +232,24 @@ public getDateTimeOfTheObservation (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (OBX.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -158,20 +259,24 @@ public getID (void)
**Description**
```php
-public getNatureOfAbnormalTest (void)
+public getNatureOfAbnormalTest (int $position)
```
-
+Get Nature Of Abnormal Test (OBX.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -181,20 +286,24 @@ public getNatureOfAbnormalTest (void)
**Description**
```php
-public getObservationIdentifier (void)
+public getObservationIdentifier (int $position)
```
-
+Get Observation Identifier (OBX.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -204,20 +313,24 @@ public getObservationIdentifier (void)
**Description**
```php
-public getObservationMethod (void)
+public getObservationMethod (int $position)
```
-
+Get Observation Method (OBX.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -227,20 +340,24 @@ public getObservationMethod (void)
**Description**
```php
-public getObservationSubId (void)
+public getObservationSubId (int $position)
```
-
+Get Observation Sub Id (OBX.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -250,20 +367,24 @@ public getObservationSubId (void)
**Description**
```php
-public getObservationValue (void)
+public getObservationValue (int $position)
```
-
+Get Observation Value (OBX.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -273,20 +394,24 @@ public getObservationValue (void)
**Description**
```php
-public getObserveResultStatus (void)
+public getObserveResultStatus (int $position)
```
-
+Get Observe Result Status (OBX.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -296,20 +421,24 @@ public getObserveResultStatus (void)
**Description**
```php
-public getProbability (void)
+public getProbability (int $position)
```
-
+Get Probability (OBX.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -319,20 +448,24 @@ public getProbability (void)
**Description**
```php
-public getProducersId (void)
+public getProducersId (int $position)
```
-
+Get Producers Id (OBX.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -342,20 +475,24 @@ public getProducersId (void)
**Description**
```php
-public getReferenceRange (void)
+public getReferenceRange (int $position)
```
-
+Get Reference Range (OBX.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -365,20 +502,24 @@ public getReferenceRange (void)
**Description**
```php
-public getResponsibleObserver (void)
+public getResponsibleObserver (int $position)
```
-
+Get Responsible Observer (OBX.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -388,20 +529,24 @@ public getResponsibleObserver (void)
**Description**
```php
-public getUnits (void)
+public getUnits (int $position)
```
-
+Get Units (OBX.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -411,20 +556,24 @@ public getUnits (void)
**Description**
```php
-public getUserDefinedAccessChecks (void)
+public getUserDefinedAccessChecks (int $position)
```
-
+Get User Defined Access Checks (OBX.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -434,11 +583,38 @@ public getUserDefinedAccessChecks (void)
**Description**
```php
-public getValueType (void)
+public getValueType (int $position)
```
+Get Value Type (OBX.2)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### OBX::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -449,6 +625,7 @@ public getValueType (void)
`void`
+
@@ -457,20 +634,25 @@ public getValueType (void)
**Description**
```php
-public setAbnormalFlags (void)
+public setAbnormalFlags (string|int|array|null $value, int $position)
```
-
+Set Abnormal Flags (OBX.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -480,20 +662,53 @@ public setAbnormalFlags (void)
**Description**
```php
-public setDataLastObsNormalValues (void)
+public setDataLastObsNormalValues (string|int|array|null $value, int $position)
```
+Set Data Last Obs Normal Values (OBX.12)
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### OBX::setDateTimeOfAnalysis
+
+**Description**
+
+```php
+public setDateTimeOfAnalysis (string|int|array|null $value, int $position)
+```
+
+Set Date Time Of Analysis (OBX.19)
+
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -503,20 +718,53 @@ public setDataLastObsNormalValues (void)
**Description**
```php
-public setDateTimeOfTheObservation (void)
+public setDateTimeOfTheObservation (string|int|array|null $value, int $position)
```
+Set Date Time Of The Observation (OBX.14)
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### OBX::setEquipmentInstanceIdentifier
+
+**Description**
+
+```php
+public setEquipmentInstanceIdentifier (string|int|array|null $value, int $position)
+```
+
+Set Equipment Instance Identifier (OBX.18)
+
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -526,20 +774,25 @@ public setDateTimeOfTheObservation (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (OBX.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -549,20 +802,25 @@ public setID (void)
**Description**
```php
-public setNatureOfAbnormalTest (void)
+public setNatureOfAbnormalTest (string|int|array|null $value, int $position)
```
-
+Set Nature Of Abnormal Test (OBX.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -572,20 +830,25 @@ public setNatureOfAbnormalTest (void)
**Description**
```php
-public setObservationIdentifier (void)
+public setObservationIdentifier (string|int|array|null $value, int $position)
```
-
+Set Observation Identifier (OBX.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -595,20 +858,25 @@ public setObservationIdentifier (void)
**Description**
```php
-public setObservationMethod (void)
+public setObservationMethod (string|int|array|null $value, int $position)
```
-
+Set Observation Method (OBX.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -618,20 +886,25 @@ public setObservationMethod (void)
**Description**
```php
-public setObservationSubId (void)
+public setObservationSubId (string|int|array|null $value, int $position)
```
-
+Set Observation Sub Id (OBX.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -641,20 +914,25 @@ public setObservationSubId (void)
**Description**
```php
-public setObservationValue (void)
+public setObservationValue (string|int|array|null $value, int $position)
```
-
+Set Observation Value (OBX.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -664,20 +942,25 @@ public setObservationValue (void)
**Description**
```php
-public setObserveResultStatus (void)
+public setObserveResultStatus (string|int|array|null $value, int $position)
```
-
+Set Observe Result Status (OBX.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -687,20 +970,25 @@ public setObserveResultStatus (void)
**Description**
```php
-public setProbability (void)
+public setProbability (string|int|array|null $value, int $position)
```
-
+Set Probability (OBX.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -710,20 +998,25 @@ public setProbability (void)
**Description**
```php
-public setProducersId (void)
+public setProducersId (string|int|array|null $value, int $position)
```
-
+Set Producers Id (OBX.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -733,20 +1026,25 @@ public setProducersId (void)
**Description**
```php
-public setReferenceRange (void)
+public setReferenceRange (string|int|array|null $value, int $position)
```
-
+Set Reference Range (OBX.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -756,20 +1054,25 @@ public setReferenceRange (void)
**Description**
```php
-public setResponsibleObserver (void)
+public setResponsibleObserver (string|int|array|null $value, int $position)
```
-
+Set Responsible Observer (OBX.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -779,20 +1082,25 @@ public setResponsibleObserver (void)
**Description**
```php
-public setUnits (void)
+public setUnits (string|int|array|null $value, int $position)
```
-
+Set Units (OBX.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -802,20 +1110,25 @@ public setUnits (void)
**Description**
```php
-public setUserDefinedAccessChecks (void)
+public setUserDefinedAccessChecks (string|int|array|null $value, int $position)
```
-
+Set User Defined Access Checks (OBX.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -825,20 +1138,25 @@ public setUserDefinedAccessChecks (void)
**Description**
```php
-public setValueType (void)
+public setValueType (string|int|array|null $value, int $position)
```
-
+Set Value Type (OBX.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/ORC.md b/docs/Segments/ORC.md
index 56eb178..2fbcdeb 100644
--- a/docs/Segments/ORC.md
+++ b/docs/Segments/ORC.md
@@ -13,74 +13,75 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getActionBy](#orcgetactionby)||
-|[getAdvancedBeneficiaryNoticeCode](#orcgetadvancedbeneficiarynoticecode)||
-|[getAdvancedBeneficiaryNoticeOverrideReason](#orcgetadvancedbeneficiarynoticeoverridereason)||
-|[getCallBackPhoneNumber](#orcgetcallbackphonenumber)||
-|[getConfidentialityCode](#orcgetconfidentialitycode)||
-|[getDateTimeofTransaction](#orcgetdatetimeoftransaction)||
-|[getEnteredBy](#orcgetenteredby)||
-|[getEntererAuthorizationMode](#orcgetentererauthorizationmode)||
-|[getEnterersLocation](#orcgetentererslocation)||
-|[getEnteringDevice](#orcgetenteringdevice)||
-|[getEnteringOrganization](#orcgetenteringorganization)||
-|[getFillerOrderNumber](#orcgetfillerordernumber)||
-|[getFillersExpectedAvailabilityDateTime](#orcgetfillersexpectedavailabilitydatetime)||
-|[getOrderControl](#orcgetordercontrol)||
-|[getOrderControlCodeReason](#orcgetordercontrolcodereason)||
-|[getOrderEffectiveDateTime](#orcgetordereffectivedatetime)||
-|[getOrderStatus](#orcgetorderstatus)||
-|[getOrderStatusModifier](#orcgetorderstatusmodifier)||
-|[getOrderType](#orcgetordertype)||
-|[getOrderingFacilityAddress](#orcgetorderingfacilityaddress)||
-|[getOrderingFacilityName](#orcgetorderingfacilityname)||
-|[getOrderingFacilityPhoneNumber](#orcgetorderingfacilityphonenumber)||
-|[getOrderingProvider](#orcgetorderingprovider)||
-|[getOrderingProviderAddress](#orcgetorderingprovideraddress)||
-|[getParentOrder](#orcgetparentorder)||
-|[getParentUniversalServiceIdentifier](#orcgetparentuniversalserviceidentifier)||
-|[getPlacerGroupNumber](#orcgetplacergroupnumber)||
-|[getPlacerOrderNumber](#orcgetplacerordernumber)||
-|[getQuantityTiming](#orcgetquantitytiming)||
-|[getResponseFlag](#orcgetresponseflag)||
-|[getVerifiedBy](#orcgetverifiedby)||
-|[setActionBy](#orcsetactionby)||
-|[setAdvancedBeneficiaryNoticeCode](#orcsetadvancedbeneficiarynoticecode)||
-|[setAdvancedBeneficiaryNoticeOverrideReason](#orcsetadvancedbeneficiarynoticeoverridereason)||
-|[setCallBackPhoneNumber](#orcsetcallbackphonenumber)||
-|[setConfidentialityCode](#orcsetconfidentialitycode)||
-|[setDateTimeofTransaction](#orcsetdatetimeoftransaction)||
-|[setEnteredBy](#orcsetenteredby)||
-|[setEntererAuthorizationMode](#orcsetentererauthorizationmode)||
-|[setEnterersLocation](#orcsetentererslocation)||
-|[setEnteringDevice](#orcsetenteringdevice)||
-|[setEnteringOrganization](#orcsetenteringorganization)||
-|[setFillerOrderNumber](#orcsetfillerordernumber)||
-|[setFillersExpectedAvailabilityDateTime](#orcsetfillersexpectedavailabilitydatetime)||
-|[setOrderControl](#orcsetordercontrol)||
-|[setOrderControlCodeReason](#orcsetordercontrolcodereason)||
-|[setOrderEffectiveDateTime](#orcsetordereffectivedatetime)||
-|[setOrderStatus](#orcsetorderstatus)||
-|[setOrderStatusModifier](#orcsetorderstatusmodifier)||
-|[setOrderType](#orcsetordertype)||
-|[setOrderingFacilityAddress](#orcsetorderingfacilityaddress)||
-|[setOrderingFacilityName](#orcsetorderingfacilityname)||
-|[setOrderingFacilityPhoneNumber](#orcsetorderingfacilityphonenumber)||
-|[setOrderingProvider](#orcsetorderingprovider)||
-|[setOrderingProviderAddress](#orcsetorderingprovideraddress)||
-|[setParentOrder](#orcsetparentorder)||
-|[setParentUniversalServiceIdentifier](#orcsetparentuniversalserviceidentifier)||
-|[setPlacerGroupNumber](#orcsetplacergroupnumber)||
-|[setPlacerOrderNumber](#orcsetplacerordernumber)||
-|[setQuantityTiming](#orcsetquantitytiming)||
-|[setResponseFlag](#orcsetresponseflag)||
-|[setVerifiedBy](#orcsetverifiedby)||
+|[getActionBy](#orcgetactionby)|Get Action By (ORC.19)|
+|[getAdvancedBeneficiaryNoticeCode](#orcgetadvancedbeneficiarynoticecode)|Get Advanced Beneficiary Notice Code (ORC.20)|
+|[getAdvancedBeneficiaryNoticeOverrideReason](#orcgetadvancedbeneficiarynoticeoverridereason)|Get Advanced Beneficiary Notice Override Reason (ORC.26)|
+|[getCallBackPhoneNumber](#orcgetcallbackphonenumber)|Get Call Back Phone Number (ORC.14)|
+|[getConfidentialityCode](#orcgetconfidentialitycode)|Get Confidentiality Code (ORC.28)|
+|[getDateTimeofTransaction](#orcgetdatetimeoftransaction)|Get Date Timeof Transaction (ORC.9)|
+|[getEnteredBy](#orcgetenteredby)|Get Entered By (ORC.10)|
+|[getEntererAuthorizationMode](#orcgetentererauthorizationmode)|Get Enterer Authorization Mode (ORC.30)|
+|[getEnterersLocation](#orcgetentererslocation)|Get Enterers Location (ORC.13)|
+|[getEnteringDevice](#orcgetenteringdevice)|Get Entering Device (ORC.18)|
+|[getEnteringOrganization](#orcgetenteringorganization)|Get Entering Organization (ORC.17)|
+|[getFillerOrderNumber](#orcgetfillerordernumber)|Get Filler Order Number (ORC.3)|
+|[getFillersExpectedAvailabilityDateTime](#orcgetfillersexpectedavailabilitydatetime)|Get Fillers Expected Availability Date Time (ORC.27)|
+|[getOrderControl](#orcgetordercontrol)|Get Order Control (ORC.1)|
+|[getOrderControlCodeReason](#orcgetordercontrolcodereason)|Get Order Control Code Reason (ORC.16)|
+|[getOrderEffectiveDateTime](#orcgetordereffectivedatetime)|Get Order Effective Date Time (ORC.15)|
+|[getOrderStatus](#orcgetorderstatus)|Get Order Status (ORC.5)|
+|[getOrderStatusModifier](#orcgetorderstatusmodifier)|Get Order Status Modifier (ORC.25)|
+|[getOrderType](#orcgetordertype)|Get Order Type (ORC.29)|
+|[getOrderingFacilityAddress](#orcgetorderingfacilityaddress)|Get Ordering Facility Address (ORC.22)|
+|[getOrderingFacilityName](#orcgetorderingfacilityname)|Get Ordering Facility Name (ORC.21)|
+|[getOrderingFacilityPhoneNumber](#orcgetorderingfacilityphonenumber)|Get Ordering Facility Phone Number (ORC.23)|
+|[getOrderingProvider](#orcgetorderingprovider)|Get Ordering Provider (ORC.12)|
+|[getOrderingProviderAddress](#orcgetorderingprovideraddress)|Get Ordering Provider Address (ORC.24)|
+|[getParentOrder](#orcgetparentorder)|Get Parent Order (ORC.8)|
+|[getParentUniversalServiceIdentifier](#orcgetparentuniversalserviceidentifier)|Get Parent Universal Service Identifier (ORC.31)|
+|[getPlacerGroupNumber](#orcgetplacergroupnumber)|Get Placer Group Number (ORC.4)|
+|[getPlacerOrderNumber](#orcgetplacerordernumber)|Get Placer Order Number (ORC.2)|
+|[getQuantityTiming](#orcgetquantitytiming)|Get Quantity Timing (ORC.7)|
+|[getResponseFlag](#orcgetresponseflag)|Get Response Flag (ORC.6)|
+|[getVerifiedBy](#orcgetverifiedby)|Get Verified By (ORC.11)|
+|[setActionBy](#orcsetactionby)|Set Action By (ORC.19)|
+|[setAdvancedBeneficiaryNoticeCode](#orcsetadvancedbeneficiarynoticecode)|Set Advanced Beneficiary Notice Code (ORC.20)|
+|[setAdvancedBeneficiaryNoticeOverrideReason](#orcsetadvancedbeneficiarynoticeoverridereason)|Set Advanced Beneficiary Notice Override Reason (ORC.26)|
+|[setCallBackPhoneNumber](#orcsetcallbackphonenumber)|Set Call Back Phone Number (ORC.14)|
+|[setConfidentialityCode](#orcsetconfidentialitycode)|Set Confidentiality Code (ORC.28)|
+|[setDateTimeofTransaction](#orcsetdatetimeoftransaction)|Set Date Timeof Transaction (ORC.9)|
+|[setEnteredBy](#orcsetenteredby)|Set Entered By (ORC.10)|
+|[setEntererAuthorizationMode](#orcsetentererauthorizationmode)|Set Enterer Authorization Mode (ORC.30)|
+|[setEnterersLocation](#orcsetentererslocation)|Set Enterers Location (ORC.13)|
+|[setEnteringDevice](#orcsetenteringdevice)|Set Entering Device (ORC.18)|
+|[setEnteringOrganization](#orcsetenteringorganization)|Set Entering Organization (ORC.17)|
+|[setFillerOrderNumber](#orcsetfillerordernumber)|Set Filler Order Number (ORC.3)|
+|[setFillersExpectedAvailabilityDateTime](#orcsetfillersexpectedavailabilitydatetime)|Set Fillers Expected Availability Date Time (ORC.27)|
+|[setOrderControl](#orcsetordercontrol)|Set Order Control (ORC.1)|
+|[setOrderControlCodeReason](#orcsetordercontrolcodereason)|Set Order Control Code Reason (ORC.16)|
+|[setOrderEffectiveDateTime](#orcsetordereffectivedatetime)|Set Order Effective Date Time (ORC.15)|
+|[setOrderStatus](#orcsetorderstatus)|Set Order Status (ORC.5)|
+|[setOrderStatusModifier](#orcsetorderstatusmodifier)|Set Order Status Modifier (ORC.25)|
+|[setOrderType](#orcsetordertype)|Set Order Type (ORC.29)|
+|[setOrderingFacilityAddress](#orcsetorderingfacilityaddress)|Set Ordering Facility Address (ORC.22)|
+|[setOrderingFacilityName](#orcsetorderingfacilityname)|Set Ordering Facility Name (ORC.21)|
+|[setOrderingFacilityPhoneNumber](#orcsetorderingfacilityphonenumber)|Set Ordering Facility Phone Number (ORC.23)|
+|[setOrderingProvider](#orcsetorderingprovider)|Set Ordering Provider (ORC.12)|
+|[setOrderingProviderAddress](#orcsetorderingprovideraddress)|Set Ordering Provider Address (ORC.24)|
+|[setParentOrder](#orcsetparentorder)|Set Parent Order (ORC.8)|
+|[setParentUniversalServiceIdentifier](#orcsetparentuniversalserviceidentifier)|Set Parent Universal Service Identifier (ORC.31)|
+|[setPlacerGroupNumber](#orcsetplacergroupnumber)|Set Placer Group Number (ORC.4)|
+|[setPlacerOrderNumber](#orcsetplacerordernumber)|Set Placer Order Number (ORC.2)|
+|[setQuantityTiming](#orcsetquantitytiming)|Set Quantity Timing (ORC.7)|
+|[setResponseFlag](#orcsetresponseflag)|Set Response Flag (ORC.6)|
+|[setVerifiedBy](#orcsetverifiedby)|Set Verified By (ORC.11)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -94,20 +95,24 @@ Aranyasen\HL7\Segment
**Description**
```php
-public getActionBy (void)
+public getActionBy (int $position)
```
-
+Get Action By (ORC.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -117,20 +122,24 @@ public getActionBy (void)
**Description**
```php
-public getAdvancedBeneficiaryNoticeCode (void)
+public getAdvancedBeneficiaryNoticeCode (int $position)
```
-
+Get Advanced Beneficiary Notice Code (ORC.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -140,20 +149,24 @@ public getAdvancedBeneficiaryNoticeCode (void)
**Description**
```php
-public getAdvancedBeneficiaryNoticeOverrideReason (void)
+public getAdvancedBeneficiaryNoticeOverrideReason (int $position)
```
-
+Get Advanced Beneficiary Notice Override Reason (ORC.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -163,20 +176,24 @@ public getAdvancedBeneficiaryNoticeOverrideReason (void)
**Description**
```php
-public getCallBackPhoneNumber (void)
+public getCallBackPhoneNumber (int $position)
```
-
+Get Call Back Phone Number (ORC.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -186,20 +203,24 @@ public getCallBackPhoneNumber (void)
**Description**
```php
-public getConfidentialityCode (void)
+public getConfidentialityCode (int $position)
```
-
+Get Confidentiality Code (ORC.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -209,20 +230,24 @@ public getConfidentialityCode (void)
**Description**
```php
-public getDateTimeofTransaction (void)
+public getDateTimeofTransaction (int $position)
```
-
+Get Date Timeof Transaction (ORC.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -232,20 +257,24 @@ public getDateTimeofTransaction (void)
**Description**
```php
-public getEnteredBy (void)
+public getEnteredBy (int $position)
```
-
+Get Entered By (ORC.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -255,20 +284,24 @@ public getEnteredBy (void)
**Description**
```php
-public getEntererAuthorizationMode (void)
+public getEntererAuthorizationMode (int $position)
```
-
+Get Enterer Authorization Mode (ORC.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -278,20 +311,24 @@ public getEntererAuthorizationMode (void)
**Description**
```php
-public getEnterersLocation (void)
+public getEnterersLocation (int $position)
```
-
+Get Enterers Location (ORC.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -301,20 +338,24 @@ public getEnterersLocation (void)
**Description**
```php
-public getEnteringDevice (void)
+public getEnteringDevice (int $position)
```
-
+Get Entering Device (ORC.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -324,20 +365,24 @@ public getEnteringDevice (void)
**Description**
```php
-public getEnteringOrganization (void)
+public getEnteringOrganization (int $position)
```
-
+Get Entering Organization (ORC.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -347,20 +392,24 @@ public getEnteringOrganization (void)
**Description**
```php
-public getFillerOrderNumber (void)
+public getFillerOrderNumber (int $position)
```
-
+Get Filler Order Number (ORC.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -370,20 +419,24 @@ public getFillerOrderNumber (void)
**Description**
```php
-public getFillersExpectedAvailabilityDateTime (void)
+public getFillersExpectedAvailabilityDateTime (int $position)
```
-
+Get Fillers Expected Availability Date Time (ORC.27)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -393,20 +446,24 @@ public getFillersExpectedAvailabilityDateTime (void)
**Description**
```php
-public getOrderControl (void)
+public getOrderControl (int $position)
```
-
+Get Order Control (ORC.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -416,20 +473,24 @@ public getOrderControl (void)
**Description**
```php
-public getOrderControlCodeReason (void)
+public getOrderControlCodeReason (int $position)
```
-
+Get Order Control Code Reason (ORC.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -439,20 +500,24 @@ public getOrderControlCodeReason (void)
**Description**
```php
-public getOrderEffectiveDateTime (void)
+public getOrderEffectiveDateTime (int $position)
```
-
+Get Order Effective Date Time (ORC.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -462,20 +527,24 @@ public getOrderEffectiveDateTime (void)
**Description**
```php
-public getOrderStatus (void)
+public getOrderStatus (int $position)
```
-
+Get Order Status (ORC.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -485,20 +554,24 @@ public getOrderStatus (void)
**Description**
```php
-public getOrderStatusModifier (void)
+public getOrderStatusModifier (int $position)
```
-
+Get Order Status Modifier (ORC.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -508,20 +581,24 @@ public getOrderStatusModifier (void)
**Description**
```php
-public getOrderType (void)
+public getOrderType (int $position)
```
-
+Get Order Type (ORC.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -531,20 +608,24 @@ public getOrderType (void)
**Description**
```php
-public getOrderingFacilityAddress (void)
+public getOrderingFacilityAddress (int $position)
```
-
+Get Ordering Facility Address (ORC.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -554,20 +635,24 @@ public getOrderingFacilityAddress (void)
**Description**
```php
-public getOrderingFacilityName (void)
+public getOrderingFacilityName (int $position)
```
-
+Get Ordering Facility Name (ORC.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -577,20 +662,24 @@ public getOrderingFacilityName (void)
**Description**
```php
-public getOrderingFacilityPhoneNumber (void)
+public getOrderingFacilityPhoneNumber (int $position)
```
-
+Get Ordering Facility Phone Number (ORC.23)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -600,20 +689,24 @@ public getOrderingFacilityPhoneNumber (void)
**Description**
```php
-public getOrderingProvider (void)
+public getOrderingProvider (int $position)
```
-
+Get Ordering Provider (ORC.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -623,20 +716,24 @@ public getOrderingProvider (void)
**Description**
```php
-public getOrderingProviderAddress (void)
+public getOrderingProviderAddress (int $position)
```
-
+Get Ordering Provider Address (ORC.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -646,20 +743,24 @@ public getOrderingProviderAddress (void)
**Description**
```php
-public getParentOrder (void)
+public getParentOrder (int $position)
```
-
+Get Parent Order (ORC.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -669,20 +770,24 @@ public getParentOrder (void)
**Description**
```php
-public getParentUniversalServiceIdentifier (void)
+public getParentUniversalServiceIdentifier (int $position)
```
-
+Get Parent Universal Service Identifier (ORC.31)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -692,20 +797,24 @@ public getParentUniversalServiceIdentifier (void)
**Description**
```php
-public getPlacerGroupNumber (void)
+public getPlacerGroupNumber (int $position)
```
-
+Get Placer Group Number (ORC.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -715,20 +824,24 @@ public getPlacerGroupNumber (void)
**Description**
```php
-public getPlacerOrderNumber (void)
+public getPlacerOrderNumber (int $position)
```
-
+Get Placer Order Number (ORC.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -738,20 +851,24 @@ public getPlacerOrderNumber (void)
**Description**
```php
-public getQuantityTiming (void)
+public getQuantityTiming (int $position)
```
-
+Get Quantity Timing (ORC.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -761,20 +878,24 @@ public getQuantityTiming (void)
**Description**
```php
-public getResponseFlag (void)
+public getResponseFlag (int $position)
```
-
+Get Response Flag (ORC.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -784,20 +905,24 @@ public getResponseFlag (void)
**Description**
```php
-public getVerifiedBy (void)
+public getVerifiedBy (int $position)
```
-
+Get Verified By (ORC.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -807,20 +932,25 @@ public getVerifiedBy (void)
**Description**
```php
-public setActionBy (void)
+public setActionBy (string|int|array|null $value, int $position)
```
-
+Set Action By (ORC.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -830,20 +960,25 @@ public setActionBy (void)
**Description**
```php
-public setAdvancedBeneficiaryNoticeCode (void)
+public setAdvancedBeneficiaryNoticeCode (string|int|array|null $value, int $position)
```
-
+Set Advanced Beneficiary Notice Code (ORC.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
+
@@ -853,20 +988,25 @@ public setAdvancedBeneficiaryNoticeCode (void)
**Description**
```php
-public setAdvancedBeneficiaryNoticeOverrideReason (void)
+public setAdvancedBeneficiaryNoticeOverrideReason (string|int|array|null $value, int $position)
```
-
+Set Advanced Beneficiary Notice Override Reason (ORC.26)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`bool`
+
+
+
@@ -876,20 +1016,25 @@ public setAdvancedBeneficiaryNoticeOverrideReason (void)
**Description**
```php
-public setCallBackPhoneNumber (void)
+public setCallBackPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Call Back Phone Number (ORC.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -899,20 +1044,25 @@ public setCallBackPhoneNumber (void)
**Description**
```php
-public setConfidentialityCode (void)
+public setConfidentialityCode (string|int|array|null $value, int $position)
```
-
+Set Confidentiality Code (ORC.28)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`bool`
+
+
+
@@ -922,20 +1072,25 @@ public setConfidentialityCode (void)
**Description**
```php
-public setDateTimeofTransaction (void)
+public setDateTimeofTransaction (string|int|array|null $value, int $position)
```
-
+Set Date Timeof Transaction (ORC.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -945,20 +1100,25 @@ public setDateTimeofTransaction (void)
**Description**
```php
-public setEnteredBy (void)
+public setEnteredBy (string|int|array|null $value, int $position)
```
-
+Set Entered By (ORC.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -968,20 +1128,25 @@ public setEnteredBy (void)
**Description**
```php
-public setEntererAuthorizationMode (void)
+public setEntererAuthorizationMode (string|int|array|null $value, int $position)
```
-
+Set Enterer Authorization Mode (ORC.30)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`bool`
+
+
+
@@ -991,20 +1156,25 @@ public setEntererAuthorizationMode (void)
**Description**
```php
-public setEnterersLocation (void)
+public setEnterersLocation (string|int|array|null $value, int $position)
```
-
+Set Enterers Location (ORC.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1014,20 +1184,25 @@ public setEnterersLocation (void)
**Description**
```php
-public setEnteringDevice (void)
+public setEnteringDevice (string|int|array|null $value, int $position)
```
-
+Set Entering Device (ORC.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1037,20 +1212,25 @@ public setEnteringDevice (void)
**Description**
```php
-public setEnteringOrganization (void)
+public setEnteringOrganization (string|int|array|null $value, int $position)
```
-
+Set Entering Organization (ORC.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1060,20 +1240,25 @@ public setEnteringOrganization (void)
**Description**
```php
-public setFillerOrderNumber (void)
+public setFillerOrderNumber (string|int|array|null $value, int $position)
```
-
+Set Filler Order Number (ORC.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1083,20 +1268,25 @@ public setFillerOrderNumber (void)
**Description**
```php
-public setFillersExpectedAvailabilityDateTime (void)
+public setFillersExpectedAvailabilityDateTime (string|int|array|null $value, int $position)
```
-
+Set Fillers Expected Availability Date Time (ORC.27)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1106,20 +1296,25 @@ public setFillersExpectedAvailabilityDateTime (void)
**Description**
```php
-public setOrderControl (void)
+public setOrderControl (string|int|array|null $value, int $position)
```
-
+Set Order Control (ORC.1)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1129,20 +1324,25 @@ public setOrderControl (void)
**Description**
```php
-public setOrderControlCodeReason (void)
+public setOrderControlCodeReason (string|int|array|null $value, int $position)
```
-
+Set Order Control Code Reason (ORC.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1152,20 +1352,25 @@ public setOrderControlCodeReason (void)
**Description**
```php
-public setOrderEffectiveDateTime (void)
+public setOrderEffectiveDateTime (string|int|array|null $value, int $position)
```
-
+Set Order Effective Date Time (ORC.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1175,20 +1380,25 @@ public setOrderEffectiveDateTime (void)
**Description**
```php
-public setOrderStatus (void)
+public setOrderStatus (string|int|array|null $value, int $position)
```
-
+Set Order Status (ORC.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1198,20 +1408,25 @@ public setOrderStatus (void)
**Description**
```php
-public setOrderStatusModifier (void)
+public setOrderStatusModifier (string|int|array|null $value, int $position)
```
-
+Set Order Status Modifier (ORC.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1221,20 +1436,25 @@ public setOrderStatusModifier (void)
**Description**
```php
-public setOrderType (void)
+public setOrderType (string|int|array|null $value, int $position)
```
-
+Set Order Type (ORC.29)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1244,20 +1464,25 @@ public setOrderType (void)
**Description**
```php
-public setOrderingFacilityAddress (void)
+public setOrderingFacilityAddress (string|int|array|null $value, int $position)
```
-
+Set Ordering Facility Address (ORC.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1267,20 +1492,25 @@ public setOrderingFacilityAddress (void)
**Description**
```php
-public setOrderingFacilityName (void)
+public setOrderingFacilityName (string|int|array|null $value, int $position)
```
-
+Set Ordering Facility Name (ORC.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1290,20 +1520,25 @@ public setOrderingFacilityName (void)
**Description**
```php
-public setOrderingFacilityPhoneNumber (void)
+public setOrderingFacilityPhoneNumber (string|int|array|null $value, int $position)
```
-
+Set Ordering Facility Phone Number (ORC.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1313,20 +1548,25 @@ public setOrderingFacilityPhoneNumber (void)
**Description**
```php
-public setOrderingProvider (void)
+public setOrderingProvider (string|int|array|null $value, int $position)
```
-
+Set Ordering Provider (ORC.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1336,20 +1576,25 @@ public setOrderingProvider (void)
**Description**
```php
-public setOrderingProviderAddress (void)
+public setOrderingProviderAddress (string|int|array|null $value, int $position)
```
-
+Set Ordering Provider Address (ORC.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1359,20 +1604,25 @@ public setOrderingProviderAddress (void)
**Description**
```php
-public setParentOrder (void)
+public setParentOrder (string|int|array|null $value, int $position)
```
-
+Set Parent Order (ORC.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1382,20 +1632,25 @@ public setParentOrder (void)
**Description**
```php
-public setParentUniversalServiceIdentifier (void)
+public setParentUniversalServiceIdentifier (string|int|array|null $value, int $position)
```
-
+Set Parent Universal Service Identifier (ORC.31)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1405,20 +1660,25 @@ public setParentUniversalServiceIdentifier (void)
**Description**
```php
-public setPlacerGroupNumber (void)
+public setPlacerGroupNumber (string|int|array|null $value, int $position)
```
-
+Set Placer Group Number (ORC.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1428,20 +1688,25 @@ public setPlacerGroupNumber (void)
**Description**
```php
-public setPlacerOrderNumber (void)
+public setPlacerOrderNumber (string|int|array|null $value, int $position)
```
-
+Set Placer Order Number (ORC.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1451,20 +1716,25 @@ public setPlacerOrderNumber (void)
**Description**
```php
-public setQuantityTiming (void)
+public setQuantityTiming (string|int|array|null $value, int $position)
```
-
+Set Quantity Timing (ORC.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1474,20 +1744,25 @@ public setQuantityTiming (void)
**Description**
```php
-public setResponseFlag (void)
+public setResponseFlag (string|int|array|null $value, int $position)
```
-
+Set Response Flag (ORC.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1497,20 +1772,25 @@ public setResponseFlag (void)
**Description**
```php
-public setVerifiedBy (void)
+public setVerifiedBy (string|int|array|null $value, int $position)
```
-
+Set Verified By (ORC.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/PID.md b/docs/Segments/PID.md
index 715aace..7620ab3 100644
--- a/docs/Segments/PID.md
+++ b/docs/Segments/PID.md
@@ -1,6 +1,7 @@
# Aranyasen\HL7\Segments\PID
PID segment class
+Reference: https://corepointhealth.com/resource-center/hl7-resources/hl7-pid-segment
@@ -12,72 +13,75 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAlternatePatientID](#pidgetalternatepatientid)||
-|[getBirthOrder](#pidgetbirthorder)||
-|[getBirthPlace](#pidgetbirthplace)||
-|[getCitizenship](#pidgetcitizenship)||
-|[getCountryCode](#pidgetcountrycode)||
-|[getDateTimeOfBirth](#pidgetdatetimeofbirth)||
-|[getDriversLicenseNumber](#pidgetdriverslicensenumber)||
-|[getEthnicGroup](#pidgetethnicgroup)||
-|[getID](#pidgetid)||
-|[getMaritalStatus](#pidgetmaritalstatus)||
-|[getMothersIdentifier](#pidgetmothersidentifier)||
-|[getMothersMaidenName](#pidgetmothersmaidenname)||
-|[getMultipleBirthIndicator](#pidgetmultiplebirthindicator)||
-|[getNationality](#pidgetnationality)||
-|[getPatientAccountNumber](#pidgetpatientaccountnumber)||
-|[getPatientAddress](#pidgetpatientaddress)||
-|[getPatientAlias](#pidgetpatientalias)||
-|[getPatientDeathDateAndTime](#pidgetpatientdeathdateandtime)||
-|[getPatientDeathIndicator](#pidgetpatientdeathindicator)||
-|[getPatientID](#pidgetpatientid)||
-|[getPatientIdentifierList](#pidgetpatientidentifierlist)|Patient ID (Internal ID)|
-|[getPatientName](#pidgetpatientname)||
-|[getPhoneNumberBusiness](#pidgetphonenumberbusiness)||
-|[getPhoneNumberHome](#pidgetphonenumberhome)||
-|[getPrimaryLanguage](#pidgetprimarylanguage)||
-|[getRace](#pidgetrace)||
-|[getReligion](#pidgetreligion)||
-|[getSSNNumber](#pidgetssnnumber)||
-|[getSex](#pidgetsex)||
-|[getVeteransMilitaryStatus](#pidgetveteransmilitarystatus)||
-|[setAlternatePatientID](#pidsetalternatepatientid)||
-|[setBirthOrder](#pidsetbirthorder)||
-|[setBirthPlace](#pidsetbirthplace)||
-|[setCitizenship](#pidsetcitizenship)||
-|[setCountryCode](#pidsetcountrycode)||
-|[setDateTimeOfBirth](#pidsetdatetimeofbirth)||
-|[setDriversLicenseNumber](#pidsetdriverslicensenumber)||
-|[setEthnicGroup](#pidsetethnicgroup)||
-|[setID](#pidsetid)||
-|[setMaritalStatus](#pidsetmaritalstatus)||
-|[setMothersIdentifier](#pidsetmothersidentifier)||
-|[setMothersMaidenName](#pidsetmothersmaidenname)||
-|[setMultipleBirthIndicator](#pidsetmultiplebirthindicator)||
-|[setNationality](#pidsetnationality)||
-|[setPatientAccountNumber](#pidsetpatientaccountnumber)||
-|[setPatientAddress](#pidsetpatientaddress)||
-|[setPatientAlias](#pidsetpatientalias)||
-|[setPatientDeathDateAndTime](#pidsetpatientdeathdateandtime)||
-|[setPatientDeathIndicator](#pidsetpatientdeathindicator)||
-|[setPatientID](#pidsetpatientid)||
-|[setPatientIdentifierList](#pidsetpatientidentifierlist)|Patient ID (Internal ID)|
-|[setPatientName](#pidsetpatientname)||
-|[setPhoneNumberBusiness](#pidsetphonenumberbusiness)||
-|[setPhoneNumberHome](#pidsetphonenumberhome)||
-|[setPrimaryLanguage](#pidsetprimarylanguage)||
-|[setRace](#pidsetrace)||
-|[setReligion](#pidsetreligion)||
-|[setSSNNumber](#pidsetssnnumber)||
+|[__destruct](#pid__destruct)||
+|[getAlternatePatientID](#pidgetalternatepatientid)|Get Alternate Patient ID (PID.4)|
+|[getBirthOrder](#pidgetbirthorder)|Get Birth Order (PID.25)|
+|[getBirthPlace](#pidgetbirthplace)|Get Birth Place (PID.23)|
+|[getCitizenship](#pidgetcitizenship)|Get Citizenship (PID.26)|
+|[getCountryCode](#pidgetcountrycode)|Get Country Code (PID.12)|
+|[getDateTimeOfBirth](#pidgetdatetimeofbirth)|Get Date Time Of Birth (PID.7)|
+|[getDriversLicenseNumber](#pidgetdriverslicensenumber)|Get Drivers License Number (PID.20)|
+|[getEthnicGroup](#pidgetethnicgroup)|Get Ethnic Group (PID.22)|
+|[getID](#pidgetid)|Get ID (PID.1)|
+|[getMaritalStatus](#pidgetmaritalstatus)|Get Marital Status (PID.16)|
+|[getMothersIdentifier](#pidgetmothersidentifier)|Get Mothers Identifier (PID.21)|
+|[getMothersMaidenName](#pidgetmothersmaidenname)|Get Mothers Maiden Name (PID.6)|
+|[getMultipleBirthIndicator](#pidgetmultiplebirthindicator)|Get Multiple Birth Indicator (PID.24)|
+|[getNationality](#pidgetnationality)|Get Nationality (PID.28)|
+|[getPatientAccountNumber](#pidgetpatientaccountnumber)|Get Patient Account Number (PID.18)|
+|[getPatientAddress](#pidgetpatientaddress)|Get Patient Address (PID.11)|
+|[getPatientAlias](#pidgetpatientalias)|Get Patient Alias (PID.9)|
+|[getPatientDeathDateAndTime](#pidgetpatientdeathdateandtime)|Get Patient Death Date And Time (PID.29)|
+|[getPatientDeathIndicator](#pidgetpatientdeathindicator)|Get Patient Death Indicator (PID.30)|
+|[getPatientID](#pidgetpatientid)|Get Patient ID (PID.2)|
+|[getPatientIdentifierList](#pidgetpatientidentifierlist)|Get Patient Identifier List (PID.3)|
+|[getPatientName](#pidgetpatientname)|Get Patient Name (PID.5)|
+|[getPhoneNumberBusiness](#pidgetphonenumberbusiness)|Get Phone Number Business (PID.14)|
+|[getPhoneNumberHome](#pidgetphonenumberhome)|Get Phone Number Home (PID.13)|
+|[getPrimaryLanguage](#pidgetprimarylanguage)|Get Primary Language (PID.15)|
+|[getRace](#pidgetrace)|Get Race (PID.10)|
+|[getReligion](#pidgetreligion)|Get Religion (PID.17)|
+|[getSSNNumber](#pidgetssnnumber)|Get SSNNumber (PID.19)|
+|[getSex](#pidgetsex)|Get Sex (PID.8)|
+|[getVeteransMilitaryStatus](#pidgetveteransmilitarystatus)|Get Veterans Military Status (PID.27)|
+|[resetIndex](#pidresetindex)|Reset index of this segment|
+|[setAlternatePatientID](#pidsetalternatepatientid)|Set Alternate Patient ID (PID.4)|
+|[setBirthOrder](#pidsetbirthorder)|Set Birth Order (PID.25)|
+|[setBirthPlace](#pidsetbirthplace)|Set Birth Place (PID.23)|
+|[setCitizenship](#pidsetcitizenship)|Set Citizenship (PID.26)|
+|[setCountryCode](#pidsetcountrycode)|Set Country Code (PID.12)|
+|[setDateTimeOfBirth](#pidsetdatetimeofbirth)|Set Date Time Of Birth (PID.7)|
+|[setDriversLicenseNumber](#pidsetdriverslicensenumber)|Set Drivers License Number (PID.20)|
+|[setEthnicGroup](#pidsetethnicgroup)|Set Ethnic Group (PID.22)|
+|[setID](#pidsetid)|Set ID (PID.1)|
+|[setMaritalStatus](#pidsetmaritalstatus)|Set Marital Status (PID.16)|
+|[setMothersIdentifier](#pidsetmothersidentifier)|Set Mothers Identifier (PID.21)|
+|[setMothersMaidenName](#pidsetmothersmaidenname)|Set Mothers Maiden Name (PID.6)|
+|[setMultipleBirthIndicator](#pidsetmultiplebirthindicator)|Set Multiple Birth Indicator (PID.24)|
+|[setNationality](#pidsetnationality)|Set Nationality (PID.28)|
+|[setPatientAccountNumber](#pidsetpatientaccountnumber)|Set Patient Account Number (PID.18)|
+|[setPatientAddress](#pidsetpatientaddress)|Set Patient Address (PID.11)|
+|[setPatientAlias](#pidsetpatientalias)|Set Patient Alias (PID.9)|
+|[setPatientDeathDateAndTime](#pidsetpatientdeathdateandtime)|Set Patient Death Date And Time (PID.29)|
+|[setPatientDeathIndicator](#pidsetpatientdeathindicator)|Set Patient Death Indicator (PID.30)|
+|[setPatientID](#pidsetpatientid)|Set Patient ID (PID.2)|
+|[setPatientIdentifierList](#pidsetpatientidentifierlist)|Set Patient Identifier List (PID.3)|
+|[setPatientName](#pidsetpatientname)|Set Patient Name (PID.5)|
+|[setPhoneNumberBusiness](#pidsetphonenumberbusiness)|Set Phone Number Business (PID.14)|
+|[setPhoneNumberHome](#pidsetphonenumberhome)|Set Phone Number Home (PID.13)|
+|[setPrimaryLanguage](#pidsetprimarylanguage)|Set Primary Language (PID.15)|
+|[setRace](#pidsetrace)|Set Race (PID.10)|
+|[setReligion](#pidsetreligion)|Set Religion (PID.17)|
+|[setSSNNumber](#pidsetssnnumber)|Set SSNNumber (PID.19)|
|[setSex](#pidsetsex)||
-|[setVeteransMilitaryStatus](#pidsetveteransmilitarystatus)||
+|[setVeteransMilitaryStatus](#pidsetveteransmilitarystatus)|Set Veterans Military Status (PID.27)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -86,12 +90,12 @@ Aranyasen\HL7\Segment
-### PID::getAlternatePatientID
+### PID::__destruct
**Description**
```php
-public getAlternatePatientID (void)
+ __destruct (void)
```
@@ -106,28 +110,60 @@ public getAlternatePatientID (void)
`void`
+
-### PID::getBirthOrder
+### PID::getAlternatePatientID
**Description**
```php
-public getBirthOrder (void)
+public getAlternatePatientID (int $position)
```
+Get Alternate Patient ID (PID.4)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PID::getBirthOrder
+
+**Description**
+
+```php
+public getBirthOrder (int $position)
+```
+
+Get Birth Order (PID.25)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -137,20 +173,24 @@ public getBirthOrder (void)
**Description**
```php
-public getBirthPlace (void)
+public getBirthPlace (int $position)
```
-
+Get Birth Place (PID.23)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -160,20 +200,24 @@ public getBirthPlace (void)
**Description**
```php
-public getCitizenship (void)
+public getCitizenship (int $position)
```
-
+Get Citizenship (PID.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -183,20 +227,24 @@ public getCitizenship (void)
**Description**
```php
-public getCountryCode (void)
+public getCountryCode (int $position)
```
-
+Get Country Code (PID.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -206,20 +254,24 @@ public getCountryCode (void)
**Description**
```php
-public getDateTimeOfBirth (void)
+public getDateTimeOfBirth (int $position)
```
-
+Get Date Time Of Birth (PID.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -229,20 +281,24 @@ public getDateTimeOfBirth (void)
**Description**
```php
-public getDriversLicenseNumber (void)
+public getDriversLicenseNumber (int $position)
```
-
+Get Drivers License Number (PID.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -252,20 +308,24 @@ public getDriversLicenseNumber (void)
**Description**
```php
-public getEthnicGroup (void)
+public getEthnicGroup (int $position)
```
-
+Get Ethnic Group (PID.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -275,20 +335,24 @@ public getEthnicGroup (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (PID.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -298,20 +362,24 @@ public getID (void)
**Description**
```php
-public getMaritalStatus (void)
+public getMaritalStatus (int $position)
```
-
+Get Marital Status (PID.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -321,20 +389,24 @@ public getMaritalStatus (void)
**Description**
```php
-public getMothersIdentifier (void)
+public getMothersIdentifier (int $position)
```
-
+Get Mothers Identifier (PID.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -344,20 +416,24 @@ public getMothersIdentifier (void)
**Description**
```php
-public getMothersMaidenName (void)
+public getMothersMaidenName (int $position)
```
-
+Get Mothers Maiden Name (PID.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -367,20 +443,24 @@ public getMothersMaidenName (void)
**Description**
```php
-public getMultipleBirthIndicator (void)
+public getMultipleBirthIndicator (int $position)
```
-
+Get Multiple Birth Indicator (PID.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -390,20 +470,24 @@ public getMultipleBirthIndicator (void)
**Description**
```php
-public getNationality (void)
+public getNationality (int $position)
```
-
+Get Nationality (PID.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -413,20 +497,24 @@ public getNationality (void)
**Description**
```php
-public getPatientAccountNumber (void)
+public getPatientAccountNumber (int $position)
```
-
+Get Patient Account Number (PID.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -436,20 +524,24 @@ public getPatientAccountNumber (void)
**Description**
```php
-public getPatientAddress (void)
+public getPatientAddress (int $position)
```
-
+Get Patient Address (PID.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -459,20 +551,24 @@ public getPatientAddress (void)
**Description**
```php
-public getPatientAlias (void)
+public getPatientAlias (int $position)
```
-
+Get Patient Alias (PID.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -482,20 +578,24 @@ public getPatientAlias (void)
**Description**
```php
-public getPatientDeathDateAndTime (void)
+public getPatientDeathDateAndTime (int $position)
```
-
+Get Patient Death Date And Time (PID.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -505,20 +605,24 @@ public getPatientDeathDateAndTime (void)
**Description**
```php
-public getPatientDeathIndicator (void)
+public getPatientDeathIndicator (int $position)
```
-
+Get Patient Death Indicator (PID.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -528,20 +632,24 @@ public getPatientDeathIndicator (void)
**Description**
```php
-public getPatientID (void)
+public getPatientID (int $position)
```
-
+Get Patient ID (PID.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -554,17 +662,19 @@ public getPatientID (void)
public getPatientIdentifierList (int $position)
```
-Patient ID (Internal ID)
+Get Patient Identifier List (PID.3)
**Parameters**
* `(int) $position`
+: Defaults to 3
**Return Values**
-`array|null|string`
+`array|string|int|null`
+
@@ -576,20 +686,24 @@ Patient ID (Internal ID)
**Description**
```php
-public getPatientName (void)
+public getPatientName (int $position)
```
-
+Get Patient Name (PID.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -599,20 +713,24 @@ public getPatientName (void)
**Description**
```php
-public getPhoneNumberBusiness (void)
+public getPhoneNumberBusiness (int $position)
```
-
+Get Phone Number Business (PID.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -622,20 +740,24 @@ public getPhoneNumberBusiness (void)
**Description**
```php
-public getPhoneNumberHome (void)
+public getPhoneNumberHome (int $position)
```
-
+Get Phone Number Home (PID.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -645,20 +767,24 @@ public getPhoneNumberHome (void)
**Description**
```php
-public getPrimaryLanguage (void)
+public getPrimaryLanguage (int $position)
```
-
+Get Primary Language (PID.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -668,20 +794,24 @@ public getPrimaryLanguage (void)
**Description**
```php
-public getRace (void)
+public getRace (int $position)
```
-
+Get Race (PID.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -691,20 +821,24 @@ public getRace (void)
**Description**
```php
-public getReligion (void)
+public getReligion (int $position)
```
-
+Get Religion (PID.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -714,20 +848,24 @@ public getReligion (void)
**Description**
```php
-public getSSNNumber (void)
+public getSSNNumber (int $position)
```
-
+Get SSNNumber (PID.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -737,20 +875,24 @@ public getSSNNumber (void)
**Description**
```php
-public getSex (void)
+public getSex (int $position)
```
-
+Get Sex (PID.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -760,11 +902,38 @@ public getSex (void)
**Description**
```php
-public getVeteransMilitaryStatus (void)
+public getVeteransMilitaryStatus (int $position)
```
+Get Veterans Military Status (PID.27)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PID::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -775,6 +944,7 @@ public getVeteransMilitaryStatus (void)
`void`
+
@@ -783,20 +953,25 @@ public getVeteransMilitaryStatus (void)
**Description**
```php
-public setAlternatePatientID (void)
+public setAlternatePatientID (string|int|array|null $value, int $position)
```
-
+Set Alternate Patient ID (PID.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
+
@@ -806,20 +981,25 @@ public setAlternatePatientID (void)
**Description**
```php
-public setBirthOrder (void)
+public setBirthOrder (string|int|array|null $value, int $position)
```
-
+Set Birth Order (PID.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
+
@@ -829,20 +1009,25 @@ public setBirthOrder (void)
**Description**
```php
-public setBirthPlace (void)
+public setBirthPlace (string|int|array|null $value, int $position)
```
-
+Set Birth Place (PID.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
+
@@ -852,20 +1037,25 @@ public setBirthPlace (void)
**Description**
```php
-public setCitizenship (void)
+public setCitizenship (string|int|array|null $value, int $position)
```
-
+Set Citizenship (PID.26)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`bool`
+
+
+
@@ -875,20 +1065,25 @@ public setCitizenship (void)
**Description**
```php
-public setCountryCode (void)
+public setCountryCode (string|int|array|null $value, int $position)
```
-
+Set Country Code (PID.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
+
@@ -898,20 +1093,25 @@ public setCountryCode (void)
**Description**
```php
-public setDateTimeOfBirth (void)
+public setDateTimeOfBirth (string|int|array|null $value, int $position)
```
-
+Set Date Time Of Birth (PID.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
+
@@ -921,20 +1121,25 @@ public setDateTimeOfBirth (void)
**Description**
```php
-public setDriversLicenseNumber (void)
+public setDriversLicenseNumber (string|int|array|null $value, int $position)
```
-
+Set Drivers License Number (PID.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
+
@@ -944,20 +1149,25 @@ public setDriversLicenseNumber (void)
**Description**
```php
-public setEthnicGroup (void)
+public setEthnicGroup (string|int|array|null $value, int $position)
```
-
+Set Ethnic Group (PID.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
+
@@ -967,20 +1177,25 @@ public setEthnicGroup (void)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (PID.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -990,20 +1205,25 @@ public setID (void)
**Description**
```php
-public setMaritalStatus (void)
+public setMaritalStatus (string|int|array|null $value, int $position)
```
-
+Set Marital Status (PID.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1013,20 +1233,25 @@ public setMaritalStatus (void)
**Description**
```php
-public setMothersIdentifier (void)
+public setMothersIdentifier (string|int|array|null $value, int $position)
```
-
+Set Mothers Identifier (PID.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1036,20 +1261,25 @@ public setMothersIdentifier (void)
**Description**
```php
-public setMothersMaidenName (void)
+public setMothersMaidenName (string|int|array|null $value, int $position)
```
-
+Set Mothers Maiden Name (PID.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1059,20 +1289,25 @@ public setMothersMaidenName (void)
**Description**
```php
-public setMultipleBirthIndicator (void)
+public setMultipleBirthIndicator (string|int|array|null $value, int $position)
```
-
+Set Multiple Birth Indicator (PID.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1082,20 +1317,25 @@ public setMultipleBirthIndicator (void)
**Description**
```php
-public setNationality (void)
+public setNationality (string|int|array|null $value, int $position)
```
-
+Set Nationality (PID.28)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1105,20 +1345,25 @@ public setNationality (void)
**Description**
```php
-public setPatientAccountNumber (void)
+public setPatientAccountNumber (string|int|array|null $value, int $position)
```
-
+Set Patient Account Number (PID.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1128,20 +1373,25 @@ public setPatientAccountNumber (void)
**Description**
```php
-public setPatientAddress (void)
+public setPatientAddress (string|int|array|null $value, int $position)
```
-
+Set Patient Address (PID.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1151,20 +1401,25 @@ public setPatientAddress (void)
**Description**
```php
-public setPatientAlias (void)
+public setPatientAlias (string|int|array|null $value, int $position)
```
-
+Set Patient Alias (PID.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1174,20 +1429,25 @@ public setPatientAlias (void)
**Description**
```php
-public setPatientDeathDateAndTime (void)
+public setPatientDeathDateAndTime (string|int|array|null $value, int $position)
```
-
+Set Patient Death Date And Time (PID.29)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1197,20 +1457,25 @@ public setPatientDeathDateAndTime (void)
**Description**
```php
-public setPatientDeathIndicator (void)
+public setPatientDeathIndicator (string|int|array|null $value, int $position)
```
-
+Set Patient Death Indicator (PID.30)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1220,20 +1485,25 @@ public setPatientDeathIndicator (void)
**Description**
```php
-public setPatientID (void)
+public setPatientID (string|int|array|null $value, int $position)
```
-
+Set Patient ID (PID.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1243,17 +1513,18 @@ public setPatientID (void)
**Description**
```php
-public setPatientIdentifierList (string $value, int $position)
+public setPatientIdentifierList (string|int|array|null $value, int $position)
```
-Patient ID (Internal ID)
+Set Patient Identifier List (PID.3)
**Parameters**
-* `(string) $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 3
**Return Values**
@@ -1261,6 +1532,7 @@ Patient ID (Internal ID)
+
@@ -1269,20 +1541,25 @@ Patient ID (Internal ID)
**Description**
```php
-public setPatientName (void)
+public setPatientName (string|int|array|null $value, int $position)
```
-
+Set Patient Name (PID.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1292,20 +1569,25 @@ public setPatientName (void)
**Description**
```php
-public setPhoneNumberBusiness (void)
+public setPhoneNumberBusiness (string|int|array|null $value, int $position)
```
-
+Set Phone Number Business (PID.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1315,20 +1597,25 @@ public setPhoneNumberBusiness (void)
**Description**
```php
-public setPhoneNumberHome (void)
+public setPhoneNumberHome (string|int|array|null $value, int $position)
```
-
+Set Phone Number Home (PID.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1338,20 +1625,25 @@ public setPhoneNumberHome (void)
**Description**
```php
-public setPrimaryLanguage (void)
+public setPrimaryLanguage (string|int|array|null $value, int $position)
```
-
+Set Primary Language (PID.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1361,20 +1653,25 @@ public setPrimaryLanguage (void)
**Description**
```php
-public setRace (void)
+public setRace (string|int|array|null $value, int $position)
```
-
+Set Race (PID.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1384,20 +1681,25 @@ public setRace (void)
**Description**
```php
-public setReligion (void)
+public setReligion (string|int|array|null $value, int $position)
```
-
+Set Religion (PID.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1407,20 +1709,25 @@ public setReligion (void)
**Description**
```php
-public setSSNNumber (void)
+public setSSNNumber (string|int|array|null $value, int $position)
```
-
+Set SSNNumber (PID.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1430,7 +1737,7 @@ public setSSNNumber (void)
**Description**
```php
-public setSex (void)
+ setSex (void)
```
@@ -1445,6 +1752,7 @@ public setSex (void)
`void`
+
@@ -1453,20 +1761,25 @@ public setSex (void)
**Description**
```php
-public setVeteransMilitaryStatus (void)
+public setVeteransMilitaryStatus (string|int|array|null $value, int $position)
```
-
+Set Veterans Military Status (PID.27)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`bool`
+
+
+
diff --git a/docs/Segments/PV1.md b/docs/Segments/PV1.md
index 0749cc7..f1562aa 100644
--- a/docs/Segments/PV1.md
+++ b/docs/Segments/PV1.md
@@ -13,116 +13,119 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAccountStatus](#pv1getaccountstatus)||
-|[getAdmissionType](#pv1getadmissiontype)||
-|[getAdmitDateTime](#pv1getadmitdatetime)||
-|[getAdmitSource](#pv1getadmitsource)||
-|[getAdmittingDoctor](#pv1getadmittingdoctor)||
-|[getAlternateVisitID](#pv1getalternatevisitid)||
-|[getAmbulatoryStatus](#pv1getambulatorystatus)||
-|[getAssignedPatientLocation](#pv1getassignedpatientlocation)||
-|[getAttendingDoctor](#pv1getattendingdoctor)||
-|[getBadDebtAgencyCode](#pv1getbaddebtagencycode)||
-|[getBadDebtRecoveryAmount](#pv1getbaddebtrecoveryamount)||
-|[getBadDebtTransferAmount](#pv1getbaddebttransferamount)||
-|[getBedStatus](#pv1getbedstatus)||
-|[getChargePriceIndicator](#pv1getchargepriceindicator)||
-|[getConsultingDoctor](#pv1getconsultingdoctor)||
-|[getContractAmount](#pv1getcontractamount)||
-|[getContractCode](#pv1getcontractcode)||
-|[getContractEffectiveDate](#pv1getcontracteffectivedate)||
-|[getContractPeriod](#pv1getcontractperiod)||
-|[getCourtesyCode](#pv1getcourtesycode)||
-|[getCreditRating](#pv1getcreditrating)||
-|[getCurrentPatientBalance](#pv1getcurrentpatientbalance)||
-|[getDeleteAccountDate](#pv1getdeleteaccountdate)||
-|[getDeleteAccountIndicator](#pv1getdeleteaccountindicator)||
-|[getDietType](#pv1getdiettype)||
-|[getDischargeDateTime](#pv1getdischargedatetime)||
-|[getDischargeDisposition](#pv1getdischargedisposition)||
-|[getDischargedToLocation](#pv1getdischargedtolocation)||
-|[getFinancialClass](#pv1getfinancialclass)||
-|[getHospitalService](#pv1gethospitalservice)||
-|[getID](#pv1getid)||
-|[getInterestCode](#pv1getinterestcode)||
-|[getOtherHealthcareProvider](#pv1getotherhealthcareprovider)||
-|[getPatientClass](#pv1getpatientclass)||
-|[getPatientType](#pv1getpatienttype)||
-|[getPendingLocation](#pv1getpendinglocation)||
-|[getPreAdmitNumber](#pv1getpreadmitnumber)||
-|[getPreAdmitTestIndicator](#pv1getpreadmittestindicator)||
-|[getPriorPatientLocation](#pv1getpriorpatientlocation)||
-|[getPriorTemporaryLocation](#pv1getpriortemporarylocation)||
-|[getReAdmissionIndicator](#pv1getreadmissionindicator)||
-|[getReferringDoctor](#pv1getreferringdoctor)||
-|[getServicingFacility](#pv1getservicingfacility)||
-|[getTemporaryLocation](#pv1gettemporarylocation)||
-|[getTotalAdjustments](#pv1gettotaladjustments)||
-|[getTotalCharges](#pv1gettotalcharges)||
-|[getTotalPayments](#pv1gettotalpayments)||
-|[getTransferToBadDebtCode](#pv1gettransfertobaddebtcode)||
-|[getTransferToBadDebtDate](#pv1gettransfertobaddebtdate)||
-|[getVipIndicator](#pv1getvipindicator)||
-|[getVisitIndicator](#pv1getvisitindicator)||
-|[getVisitNumber](#pv1getvisitnumber)||
-|[setAccountStatus](#pv1setaccountstatus)||
-|[setAdmissionType](#pv1setadmissiontype)||
-|[setAdmitDateTime](#pv1setadmitdatetime)||
-|[setAdmitSource](#pv1setadmitsource)||
-|[setAdmittingDoctor](#pv1setadmittingdoctor)||
-|[setAlternateVisitID](#pv1setalternatevisitid)||
-|[setAmbulatoryStatus](#pv1setambulatorystatus)||
-|[setAssignedPatientLocation](#pv1setassignedpatientlocation)||
-|[setAttendingDoctor](#pv1setattendingdoctor)||
-|[setBadDebtAgencyCode](#pv1setbaddebtagencycode)||
-|[setBadDebtRecoveryAmount](#pv1setbaddebtrecoveryamount)||
-|[setBadDebtTransferAmount](#pv1setbaddebttransferamount)||
-|[setBedStatus](#pv1setbedstatus)||
-|[setChargePriceIndicator](#pv1setchargepriceindicator)||
-|[setConsultingDoctor](#pv1setconsultingdoctor)||
-|[setContractAmount](#pv1setcontractamount)||
-|[setContractCode](#pv1setcontractcode)||
-|[setContractEffectiveDate](#pv1setcontracteffectivedate)||
-|[setContractPeriod](#pv1setcontractperiod)||
-|[setCourtesyCode](#pv1setcourtesycode)||
-|[setCreditRating](#pv1setcreditrating)||
-|[setCurrentPatientBalance](#pv1setcurrentpatientbalance)||
-|[setDeleteAccountDate](#pv1setdeleteaccountdate)||
-|[setDeleteAccountIndicator](#pv1setdeleteaccountindicator)||
-|[setDietType](#pv1setdiettype)||
-|[setDischargeDateTime](#pv1setdischargedatetime)||
-|[setDischargeDisposition](#pv1setdischargedisposition)||
-|[setDischargedToLocation](#pv1setdischargedtolocation)||
-|[setFinancialClass](#pv1setfinancialclass)||
-|[setHospitalService](#pv1sethospitalservice)||
-|[setID](#pv1setid)||
-|[setInterestCode](#pv1setinterestcode)||
-|[setOtherHealthcareProvider](#pv1setotherhealthcareprovider)||
-|[setPatientClass](#pv1setpatientclass)||
-|[setPatientType](#pv1setpatienttype)||
-|[setPendingLocation](#pv1setpendinglocation)||
-|[setPreAdmitNumber](#pv1setpreadmitnumber)||
-|[setPreAdmitTestIndicator](#pv1setpreadmittestindicator)||
-|[setPriorPatientLocation](#pv1setpriorpatientlocation)||
-|[setPriorTemporaryLocation](#pv1setpriortemporarylocation)||
-|[setReAdmissionIndicator](#pv1setreadmissionindicator)||
-|[setReferringDoctor](#pv1setreferringdoctor)||
-|[setServicingFacility](#pv1setservicingfacility)||
-|[setTemporaryLocation](#pv1settemporarylocation)||
-|[setTotalAdjustments](#pv1settotaladjustments)||
-|[setTotalCharges](#pv1settotalcharges)||
-|[setTotalPayments](#pv1settotalpayments)||
-|[setTransferToBadDebtCode](#pv1settransfertobaddebtcode)||
-|[setTransferToBadDebtDate](#pv1settransfertobaddebtdate)||
-|[setVipIndicator](#pv1setvipindicator)||
-|[setVisitIndicator](#pv1setvisitindicator)||
-|[setVisitNumber](#pv1setvisitnumber)||
+|[__destruct](#pv1__destruct)||
+|[getAccountStatus](#pv1getaccountstatus)|Get Account Status (PV1.41)|
+|[getAdmissionType](#pv1getadmissiontype)|Get Admission Type (PV1.4)|
+|[getAdmitDateTime](#pv1getadmitdatetime)|Get Admit Date Time (PV1.44)|
+|[getAdmitSource](#pv1getadmitsource)|Get Admit Source (PV1.14)|
+|[getAdmittingDoctor](#pv1getadmittingdoctor)|Get Admitting Doctor (PV1.17)|
+|[getAlternateVisitID](#pv1getalternatevisitid)|Get Alternate Visit ID (PV1.50)|
+|[getAmbulatoryStatus](#pv1getambulatorystatus)|Get Ambulatory Status (PV1.15)|
+|[getAssignedPatientLocation](#pv1getassignedpatientlocation)|Get Assigned Patient Location (PV1.3)|
+|[getAttendingDoctor](#pv1getattendingdoctor)|Get Attending Doctor (PV1.7)|
+|[getBadDebtAgencyCode](#pv1getbaddebtagencycode)|Get Bad Debt Agency Code (PV1.31)|
+|[getBadDebtRecoveryAmount](#pv1getbaddebtrecoveryamount)|Get Bad Debt Recovery Amount (PV1.33)|
+|[getBadDebtTransferAmount](#pv1getbaddebttransferamount)|Get Bad Debt Transfer Amount (PV1.32)|
+|[getBedStatus](#pv1getbedstatus)|Get Bed Status (PV1.40)|
+|[getChargePriceIndicator](#pv1getchargepriceindicator)|Get Charge Price Indicator (PV1.21)|
+|[getConsultingDoctor](#pv1getconsultingdoctor)|Get Consulting Doctor (PV1.9)|
+|[getContractAmount](#pv1getcontractamount)|Get Contract Amount (PV1.26)|
+|[getContractCode](#pv1getcontractcode)|Get Contract Code (PV1.24)|
+|[getContractEffectiveDate](#pv1getcontracteffectivedate)|Get Contract Effective Date (PV1.25)|
+|[getContractPeriod](#pv1getcontractperiod)|Get Contract Period (PV1.27)|
+|[getCourtesyCode](#pv1getcourtesycode)|Get Courtesy Code (PV1.22)|
+|[getCreditRating](#pv1getcreditrating)|Get Credit Rating (PV1.23)|
+|[getCurrentPatientBalance](#pv1getcurrentpatientbalance)|Get Current Patient Balance (PV1.46)|
+|[getDeleteAccountDate](#pv1getdeleteaccountdate)|Get Delete Account Date (PV1.35)|
+|[getDeleteAccountIndicator](#pv1getdeleteaccountindicator)|Get Delete Account Indicator (PV1.34)|
+|[getDietType](#pv1getdiettype)|Get Diet Type (PV1.38)|
+|[getDischargeDateTime](#pv1getdischargedatetime)|Get Discharge Date Time (PV1.45)|
+|[getDischargeDisposition](#pv1getdischargedisposition)|Get Discharge Disposition (PV1.36)|
+|[getDischargedToLocation](#pv1getdischargedtolocation)|Get Discharged To Location (PV1.37)|
+|[getFinancialClass](#pv1getfinancialclass)|Get Financial Class (PV1.20)|
+|[getHospitalService](#pv1gethospitalservice)|Get Hospital Service (PV1.10)|
+|[getID](#pv1getid)|Get ID (PV1.1)|
+|[getInterestCode](#pv1getinterestcode)|Get Interest Code (PV1.28)|
+|[getOtherHealthcareProvider](#pv1getotherhealthcareprovider)|Get Other Healthcare Provider (PV1.52)|
+|[getPatientClass](#pv1getpatientclass)|Get Patient Class (PV1.2)|
+|[getPatientType](#pv1getpatienttype)|Get Patient Type (PV1.18)|
+|[getPendingLocation](#pv1getpendinglocation)|Get Pending Location (PV1.42)|
+|[getPreAdmitNumber](#pv1getpreadmitnumber)|Get Pre Admit Number (PV1.5)|
+|[getPreAdmitTestIndicator](#pv1getpreadmittestindicator)|Get Pre Admit Test Indicator (PV1.12)|
+|[getPriorPatientLocation](#pv1getpriorpatientlocation)|Get Prior Patient Location (PV1.6)|
+|[getPriorTemporaryLocation](#pv1getpriortemporarylocation)|Get Prior Temporary Location (PV1.43)|
+|[getReAdmissionIndicator](#pv1getreadmissionindicator)|Get Re Admission Indicator (PV1.13)|
+|[getReferringDoctor](#pv1getreferringdoctor)|Get Referring Doctor (PV1.8)|
+|[getServicingFacility](#pv1getservicingfacility)|Get Servicing Facility (PV1.39)|
+|[getTemporaryLocation](#pv1gettemporarylocation)|Get Temporary Location (PV1.11)|
+|[getTotalAdjustments](#pv1gettotaladjustments)|Get Total Adjustments (PV1.48)|
+|[getTotalCharges](#pv1gettotalcharges)|Get Total Charges (PV1.47)|
+|[getTotalPayments](#pv1gettotalpayments)|Get Total Payments (PV1.49)|
+|[getTransferToBadDebtCode](#pv1gettransfertobaddebtcode)|Get Transfer To Bad Debt Code (PV1.29)|
+|[getTransferToBadDebtDate](#pv1gettransfertobaddebtdate)|Get Transfer To Bad Debt Date (PV1.30)|
+|[getVipIndicator](#pv1getvipindicator)|Get Vip Indicator (PV1.16)|
+|[getVisitIndicator](#pv1getvisitindicator)|Get Visit Indicator (PV1.51)|
+|[getVisitNumber](#pv1getvisitnumber)|Get Visit Number (PV1.19)|
+|[resetIndex](#pv1resetindex)|Reset index of this segment|
+|[setAccountStatus](#pv1setaccountstatus)|Set Account Status (PV1.41)|
+|[setAdmissionType](#pv1setadmissiontype)|Set Admission Type (PV1.4)|
+|[setAdmitDateTime](#pv1setadmitdatetime)|Set Admit Date Time (PV1.44)|
+|[setAdmitSource](#pv1setadmitsource)|Set Admit Source (PV1.14)|
+|[setAdmittingDoctor](#pv1setadmittingdoctor)|Set Admitting Doctor (PV1.17)|
+|[setAlternateVisitID](#pv1setalternatevisitid)|Set Alternate Visit ID (PV1.50)|
+|[setAmbulatoryStatus](#pv1setambulatorystatus)|Set Ambulatory Status (PV1.15)|
+|[setAssignedPatientLocation](#pv1setassignedpatientlocation)|Set Assigned Patient Location (PV1.3)|
+|[setAttendingDoctor](#pv1setattendingdoctor)|Set Attending Doctor (PV1.7)|
+|[setBadDebtAgencyCode](#pv1setbaddebtagencycode)|Set Bad Debt Agency Code (PV1.31)|
+|[setBadDebtRecoveryAmount](#pv1setbaddebtrecoveryamount)|Set Bad Debt Recovery Amount (PV1.33)|
+|[setBadDebtTransferAmount](#pv1setbaddebttransferamount)|Set Bad Debt Transfer Amount (PV1.32)|
+|[setBedStatus](#pv1setbedstatus)|Set Bed Status (PV1.40)|
+|[setChargePriceIndicator](#pv1setchargepriceindicator)|Set Charge Price Indicator (PV1.21)|
+|[setConsultingDoctor](#pv1setconsultingdoctor)|Set Consulting Doctor (PV1.9)|
+|[setContractAmount](#pv1setcontractamount)|Set Contract Amount (PV1.26)|
+|[setContractCode](#pv1setcontractcode)|Set Contract Code (PV1.24)|
+|[setContractEffectiveDate](#pv1setcontracteffectivedate)|Set Contract Effective Date (PV1.25)|
+|[setContractPeriod](#pv1setcontractperiod)|Set Contract Period (PV1.27)|
+|[setCourtesyCode](#pv1setcourtesycode)|Set Courtesy Code (PV1.22)|
+|[setCreditRating](#pv1setcreditrating)|Set Credit Rating (PV1.23)|
+|[setCurrentPatientBalance](#pv1setcurrentpatientbalance)|Set Current Patient Balance (PV1.46)|
+|[setDeleteAccountDate](#pv1setdeleteaccountdate)|Set Delete Account Date (PV1.35)|
+|[setDeleteAccountIndicator](#pv1setdeleteaccountindicator)|Set Delete Account Indicator (PV1.34)|
+|[setDietType](#pv1setdiettype)|Set Diet Type (PV1.38)|
+|[setDischargeDateTime](#pv1setdischargedatetime)|Set Discharge Date Time (PV1.45)|
+|[setDischargeDisposition](#pv1setdischargedisposition)|Set Discharge Disposition (PV1.36)|
+|[setDischargedToLocation](#pv1setdischargedtolocation)|Set Discharged To Location (PV1.37)|
+|[setFinancialClass](#pv1setfinancialclass)|Set Financial Class (PV1.20)|
+|[setHospitalService](#pv1sethospitalservice)|Set Hospital Service (PV1.10)|
+|[setID](#pv1setid)|Set ID (PV1.1)|
+|[setInterestCode](#pv1setinterestcode)|Set Interest Code (PV1.28)|
+|[setOtherHealthcareProvider](#pv1setotherhealthcareprovider)|Set Other Healthcare Provider (PV1.52)|
+|[setPatientClass](#pv1setpatientclass)|Set Patient Class (PV1.2)|
+|[setPatientType](#pv1setpatienttype)|Set Patient Type (PV1.18)|
+|[setPendingLocation](#pv1setpendinglocation)|Set Pending Location (PV1.42)|
+|[setPreAdmitNumber](#pv1setpreadmitnumber)|Set Pre Admit Number (PV1.5)|
+|[setPreAdmitTestIndicator](#pv1setpreadmittestindicator)|Set Pre Admit Test Indicator (PV1.12)|
+|[setPriorPatientLocation](#pv1setpriorpatientlocation)|Set Prior Patient Location (PV1.6)|
+|[setPriorTemporaryLocation](#pv1setpriortemporarylocation)|Set Prior Temporary Location (PV1.43)|
+|[setReAdmissionIndicator](#pv1setreadmissionindicator)|Set Re Admission Indicator (PV1.13)|
+|[setReferringDoctor](#pv1setreferringdoctor)|Set Referring Doctor (PV1.8)|
+|[setServicingFacility](#pv1setservicingfacility)|Set Servicing Facility (PV1.39)|
+|[setTemporaryLocation](#pv1settemporarylocation)|Set Temporary Location (PV1.11)|
+|[setTotalAdjustments](#pv1settotaladjustments)|Set Total Adjustments (PV1.48)|
+|[setTotalCharges](#pv1settotalcharges)|Set Total Charges (PV1.47)|
+|[setTotalPayments](#pv1settotalpayments)|Set Total Payments (PV1.49)|
+|[setTransferToBadDebtCode](#pv1settransfertobaddebtcode)|Set Transfer To Bad Debt Code (PV1.29)|
+|[setTransferToBadDebtDate](#pv1settransfertobaddebtdate)|Set Transfer To Bad Debt Date (PV1.30)|
+|[setVipIndicator](#pv1setvipindicator)|Set Vip Indicator (PV1.16)|
+|[setVisitIndicator](#pv1setvisitindicator)|Set Visit Indicator (PV1.51)|
+|[setVisitNumber](#pv1setvisitnumber)|Set Visit Number (PV1.19)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -131,12 +134,12 @@ Aranyasen\HL7\Segment
-### PV1::getAccountStatus
+### PV1::__destruct
**Description**
```php
-public getAccountStatus (void)
+ __destruct (void)
```
@@ -151,28 +154,60 @@ public getAccountStatus (void)
`void`
+
-### PV1::getAdmissionType
+### PV1::getAccountStatus
**Description**
```php
-public getAdmissionType (void)
+public getAccountStatus (int $position)
```
+Get Account Status (PV1.41)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 41
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV1::getAdmissionType
+
+**Description**
+
+```php
+public getAdmissionType (int $position)
+```
+
+Get Admission Type (PV1.4)
+
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -182,20 +217,24 @@ public getAdmissionType (void)
**Description**
```php
-public getAdmitDateTime (void)
+public getAdmitDateTime (int $position)
```
-
+Get Admit Date Time (PV1.44)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 44
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -205,20 +244,24 @@ public getAdmitDateTime (void)
**Description**
```php
-public getAdmitSource (void)
+public getAdmitSource (int $position)
```
-
+Get Admit Source (PV1.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -228,20 +271,24 @@ public getAdmitSource (void)
**Description**
```php
-public getAdmittingDoctor (void)
+public getAdmittingDoctor (int $position)
```
-
+Get Admitting Doctor (PV1.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -251,20 +298,24 @@ public getAdmittingDoctor (void)
**Description**
```php
-public getAlternateVisitID (void)
+public getAlternateVisitID (int $position)
```
-
+Get Alternate Visit ID (PV1.50)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 50
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -274,20 +325,24 @@ public getAlternateVisitID (void)
**Description**
```php
-public getAmbulatoryStatus (void)
+public getAmbulatoryStatus (int $position)
```
-
+Get Ambulatory Status (PV1.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -297,20 +352,24 @@ public getAmbulatoryStatus (void)
**Description**
```php
-public getAssignedPatientLocation (void)
+public getAssignedPatientLocation (int $position)
```
-
+Get Assigned Patient Location (PV1.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -320,20 +379,24 @@ public getAssignedPatientLocation (void)
**Description**
```php
-public getAttendingDoctor (void)
+public getAttendingDoctor (int $position)
```
-
+Get Attending Doctor (PV1.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -343,20 +406,24 @@ public getAttendingDoctor (void)
**Description**
```php
-public getBadDebtAgencyCode (void)
+public getBadDebtAgencyCode (int $position)
```
-
+Get Bad Debt Agency Code (PV1.31)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -366,20 +433,24 @@ public getBadDebtAgencyCode (void)
**Description**
```php
-public getBadDebtRecoveryAmount (void)
+public getBadDebtRecoveryAmount (int $position)
```
-
+Get Bad Debt Recovery Amount (PV1.33)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 33
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -389,20 +460,24 @@ public getBadDebtRecoveryAmount (void)
**Description**
```php
-public getBadDebtTransferAmount (void)
+public getBadDebtTransferAmount (int $position)
```
-
+Get Bad Debt Transfer Amount (PV1.32)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -412,20 +487,24 @@ public getBadDebtTransferAmount (void)
**Description**
```php
-public getBedStatus (void)
+public getBedStatus (int $position)
```
-
+Get Bed Status (PV1.40)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -435,20 +514,24 @@ public getBedStatus (void)
**Description**
```php
-public getChargePriceIndicator (void)
+public getChargePriceIndicator (int $position)
```
-
+Get Charge Price Indicator (PV1.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -458,20 +541,24 @@ public getChargePriceIndicator (void)
**Description**
```php
-public getConsultingDoctor (void)
+public getConsultingDoctor (int $position)
```
-
+Get Consulting Doctor (PV1.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -481,20 +568,24 @@ public getConsultingDoctor (void)
**Description**
```php
-public getContractAmount (void)
+public getContractAmount (int $position)
```
-
+Get Contract Amount (PV1.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -504,20 +595,24 @@ public getContractAmount (void)
**Description**
```php
-public getContractCode (void)
+public getContractCode (int $position)
```
-
+Get Contract Code (PV1.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -527,20 +622,24 @@ public getContractCode (void)
**Description**
```php
-public getContractEffectiveDate (void)
+public getContractEffectiveDate (int $position)
```
-
+Get Contract Effective Date (PV1.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -550,20 +649,24 @@ public getContractEffectiveDate (void)
**Description**
```php
-public getContractPeriod (void)
+public getContractPeriod (int $position)
```
-
+Get Contract Period (PV1.27)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -573,20 +676,24 @@ public getContractPeriod (void)
**Description**
```php
-public getCourtesyCode (void)
+public getCourtesyCode (int $position)
```
-
+Get Courtesy Code (PV1.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -596,20 +703,24 @@ public getCourtesyCode (void)
**Description**
```php
-public getCreditRating (void)
+public getCreditRating (int $position)
```
-
+Get Credit Rating (PV1.23)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -619,20 +730,24 @@ public getCreditRating (void)
**Description**
```php
-public getCurrentPatientBalance (void)
+public getCurrentPatientBalance (int $position)
```
-
+Get Current Patient Balance (PV1.46)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 46
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -642,20 +757,24 @@ public getCurrentPatientBalance (void)
**Description**
```php
-public getDeleteAccountDate (void)
+public getDeleteAccountDate (int $position)
```
-
+Get Delete Account Date (PV1.35)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -665,20 +784,24 @@ public getDeleteAccountDate (void)
**Description**
```php
-public getDeleteAccountIndicator (void)
+public getDeleteAccountIndicator (int $position)
```
-
+Get Delete Account Indicator (PV1.34)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -688,20 +811,24 @@ public getDeleteAccountIndicator (void)
**Description**
```php
-public getDietType (void)
+public getDietType (int $position)
```
-
+Get Diet Type (PV1.38)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -711,20 +838,24 @@ public getDietType (void)
**Description**
```php
-public getDischargeDateTime (void)
+public getDischargeDateTime (int $position)
```
-
+Get Discharge Date Time (PV1.45)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 45
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -734,20 +865,24 @@ public getDischargeDateTime (void)
**Description**
```php
-public getDischargeDisposition (void)
+public getDischargeDisposition (int $position)
```
-
+Get Discharge Disposition (PV1.36)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -757,20 +892,24 @@ public getDischargeDisposition (void)
**Description**
```php
-public getDischargedToLocation (void)
+public getDischargedToLocation (int $position)
```
-
+Get Discharged To Location (PV1.37)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -780,20 +919,24 @@ public getDischargedToLocation (void)
**Description**
```php
-public getFinancialClass (void)
+public getFinancialClass (int $position)
```
-
+Get Financial Class (PV1.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -803,20 +946,24 @@ public getFinancialClass (void)
**Description**
```php
-public getHospitalService (void)
+public getHospitalService (int $position)
```
-
+Get Hospital Service (PV1.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -826,20 +973,24 @@ public getHospitalService (void)
**Description**
```php
-public getID (void)
+public getID (int $position)
```
-
+Get ID (PV1.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -849,20 +1000,24 @@ public getID (void)
**Description**
```php
-public getInterestCode (void)
+public getInterestCode (int $position)
```
-
+Get Interest Code (PV1.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -872,20 +1027,24 @@ public getInterestCode (void)
**Description**
```php
-public getOtherHealthcareProvider (void)
+public getOtherHealthcareProvider (int $position)
```
-
+Get Other Healthcare Provider (PV1.52)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 52
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -895,20 +1054,24 @@ public getOtherHealthcareProvider (void)
**Description**
```php
-public getPatientClass (void)
+public getPatientClass (int $position)
```
-
+Get Patient Class (PV1.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -918,20 +1081,24 @@ public getPatientClass (void)
**Description**
```php
-public getPatientType (void)
+public getPatientType (int $position)
```
-
+Get Patient Type (PV1.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -941,20 +1108,24 @@ public getPatientType (void)
**Description**
```php
-public getPendingLocation (void)
+public getPendingLocation (int $position)
```
-
+Get Pending Location (PV1.42)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -964,20 +1135,24 @@ public getPendingLocation (void)
**Description**
```php
-public getPreAdmitNumber (void)
+public getPreAdmitNumber (int $position)
```
-
+Get Pre Admit Number (PV1.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -987,20 +1162,24 @@ public getPreAdmitNumber (void)
**Description**
```php
-public getPreAdmitTestIndicator (void)
+public getPreAdmitTestIndicator (int $position)
```
-
+Get Pre Admit Test Indicator (PV1.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1010,20 +1189,24 @@ public getPreAdmitTestIndicator (void)
**Description**
```php
-public getPriorPatientLocation (void)
+public getPriorPatientLocation (int $position)
```
-
+Get Prior Patient Location (PV1.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1033,20 +1216,24 @@ public getPriorPatientLocation (void)
**Description**
```php
-public getPriorTemporaryLocation (void)
+public getPriorTemporaryLocation (int $position)
```
-
+Get Prior Temporary Location (PV1.43)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1056,20 +1243,24 @@ public getPriorTemporaryLocation (void)
**Description**
```php
-public getReAdmissionIndicator (void)
+public getReAdmissionIndicator (int $position)
```
-
+Get Re Admission Indicator (PV1.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1079,20 +1270,24 @@ public getReAdmissionIndicator (void)
**Description**
```php
-public getReferringDoctor (void)
+public getReferringDoctor (int $position)
```
-
+Get Referring Doctor (PV1.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1102,20 +1297,24 @@ public getReferringDoctor (void)
**Description**
```php
-public getServicingFacility (void)
+public getServicingFacility (int $position)
```
-
+Get Servicing Facility (PV1.39)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1125,20 +1324,24 @@ public getServicingFacility (void)
**Description**
```php
-public getTemporaryLocation (void)
+public getTemporaryLocation (int $position)
```
-
+Get Temporary Location (PV1.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1148,20 +1351,24 @@ public getTemporaryLocation (void)
**Description**
```php
-public getTotalAdjustments (void)
+public getTotalAdjustments (int $position)
```
-
+Get Total Adjustments (PV1.48)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 48
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1171,20 +1378,24 @@ public getTotalAdjustments (void)
**Description**
```php
-public getTotalCharges (void)
+public getTotalCharges (int $position)
```
-
+Get Total Charges (PV1.47)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 47
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1194,20 +1405,24 @@ public getTotalCharges (void)
**Description**
```php
-public getTotalPayments (void)
+public getTotalPayments (int $position)
```
-
+Get Total Payments (PV1.49)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 49
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1217,20 +1432,24 @@ public getTotalPayments (void)
**Description**
```php
-public getTransferToBadDebtCode (void)
+public getTransferToBadDebtCode (int $position)
```
-
+Get Transfer To Bad Debt Code (PV1.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1240,20 +1459,24 @@ public getTransferToBadDebtCode (void)
**Description**
```php
-public getTransferToBadDebtDate (void)
+public getTransferToBadDebtDate (int $position)
```
-
+Get Transfer To Bad Debt Date (PV1.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1263,20 +1486,24 @@ public getTransferToBadDebtDate (void)
**Description**
```php
-public getVipIndicator (void)
+public getVipIndicator (int $position)
```
-
+Get Vip Indicator (PV1.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1286,20 +1513,24 @@ public getVipIndicator (void)
**Description**
```php
-public getVisitIndicator (void)
+public getVisitIndicator (int $position)
```
-
+Get Visit Indicator (PV1.51)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 51
**Return Values**
-`void`
+`array|string|int|null`
+
+
+
@@ -1309,11 +1540,38 @@ public getVisitIndicator (void)
**Description**
```php
-public getVisitNumber (void)
+public getVisitNumber (int $position)
```
+Get Visit Number (PV1.19)
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV1::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
**Parameters**
@@ -1324,6 +1582,7 @@ public getVisitNumber (void)
`void`
+
@@ -1332,17 +1591,18 @@ public getVisitNumber (void)
**Description**
```php
-public setAccountStatus ( $value, int $position)
+public setAccountStatus (string|int|array|null $value, int $position)
```
-
+Set Account Status (PV1.41)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 41
**Return Values**
@@ -1350,6 +1610,7 @@ public setAccountStatus ( $value, int $position)
+
@@ -1358,17 +1619,18 @@ public setAccountStatus ( $value, int $position)
**Description**
```php
-public setAdmissionType ( $value, int $position)
+public setAdmissionType (string|int|array|null $value, int $position)
```
-
+Set Admission Type (PV1.4)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 4
**Return Values**
@@ -1376,6 +1638,7 @@ public setAdmissionType ( $value, int $position)
+
@@ -1384,17 +1647,18 @@ public setAdmissionType ( $value, int $position)
**Description**
```php
-public setAdmitDateTime ( $value, int $position)
+public setAdmitDateTime (string|int|array|null $value, int $position)
```
-
+Set Admit Date Time (PV1.44)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 44
**Return Values**
@@ -1402,6 +1666,7 @@ public setAdmitDateTime ( $value, int $position)
+
@@ -1410,17 +1675,18 @@ public setAdmitDateTime ( $value, int $position)
**Description**
```php
-public setAdmitSource ( $value, int $position)
+public setAdmitSource (string|int|array|null $value, int $position)
```
-
+Set Admit Source (PV1.14)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 14
**Return Values**
@@ -1428,6 +1694,7 @@ public setAdmitSource ( $value, int $position)
+
@@ -1436,17 +1703,18 @@ public setAdmitSource ( $value, int $position)
**Description**
```php
-public setAdmittingDoctor ( $value, int $position)
+public setAdmittingDoctor (string|int|array|null $value, int $position)
```
-
+Set Admitting Doctor (PV1.17)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 17
**Return Values**
@@ -1454,6 +1722,7 @@ public setAdmittingDoctor ( $value, int $position)
+
@@ -1462,17 +1731,18 @@ public setAdmittingDoctor ( $value, int $position)
**Description**
```php
-public setAlternateVisitID ( $value, int $position)
+public setAlternateVisitID (string|int|array|null $value, int $position)
```
-
+Set Alternate Visit ID (PV1.50)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 50
**Return Values**
@@ -1480,6 +1750,7 @@ public setAlternateVisitID ( $value, int $position)
+
@@ -1488,17 +1759,18 @@ public setAlternateVisitID ( $value, int $position)
**Description**
```php
-public setAmbulatoryStatus ( $value, int $position)
+public setAmbulatoryStatus (string|int|array|null $value, int $position)
```
-
+Set Ambulatory Status (PV1.15)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 15
**Return Values**
@@ -1506,6 +1778,7 @@ public setAmbulatoryStatus ( $value, int $position)
+
@@ -1514,20 +1787,25 @@ public setAmbulatoryStatus ( $value, int $position)
**Description**
```php
-public setAssignedPatientLocation (void)
+public setAssignedPatientLocation (string|int|array|null $value, int $position)
```
-
+Set Assigned Patient Location (PV1.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
+
@@ -1537,17 +1815,18 @@ public setAssignedPatientLocation (void)
**Description**
```php
-public setAttendingDoctor ( $value, int $position)
+public setAttendingDoctor (string|int|array|null $value, int $position)
```
-
+Set Attending Doctor (PV1.7)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 7
**Return Values**
@@ -1555,6 +1834,7 @@ public setAttendingDoctor ( $value, int $position)
+
@@ -1563,17 +1843,18 @@ public setAttendingDoctor ( $value, int $position)
**Description**
```php
-public setBadDebtAgencyCode ( $value, int $position)
+public setBadDebtAgencyCode (string|int|array|null $value, int $position)
```
-
+Set Bad Debt Agency Code (PV1.31)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 31
**Return Values**
@@ -1581,6 +1862,7 @@ public setBadDebtAgencyCode ( $value, int $position)
+
@@ -1589,17 +1871,18 @@ public setBadDebtAgencyCode ( $value, int $position)
**Description**
```php
-public setBadDebtRecoveryAmount ( $value, int $position)
+public setBadDebtRecoveryAmount (string|int|array|null $value, int $position)
```
-
+Set Bad Debt Recovery Amount (PV1.33)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 33
**Return Values**
@@ -1607,6 +1890,7 @@ public setBadDebtRecoveryAmount ( $value, int $position)
+
@@ -1615,17 +1899,18 @@ public setBadDebtRecoveryAmount ( $value, int $position)
**Description**
```php
-public setBadDebtTransferAmount ( $value, int $position)
+public setBadDebtTransferAmount (string|int|array|null $value, int $position)
```
-
+Set Bad Debt Transfer Amount (PV1.32)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 32
**Return Values**
@@ -1633,6 +1918,7 @@ public setBadDebtTransferAmount ( $value, int $position)
+
@@ -1641,17 +1927,18 @@ public setBadDebtTransferAmount ( $value, int $position)
**Description**
```php
-public setBedStatus ( $value, int $position)
+public setBedStatus (string|int|array|null $value, int $position)
```
-
+Set Bed Status (PV1.40)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 40
**Return Values**
@@ -1659,6 +1946,7 @@ public setBedStatus ( $value, int $position)
+
@@ -1667,17 +1955,18 @@ public setBedStatus ( $value, int $position)
**Description**
```php
-public setChargePriceIndicator ( $value, int $position)
+public setChargePriceIndicator (string|int|array|null $value, int $position)
```
-
+Set Charge Price Indicator (PV1.21)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 21
**Return Values**
@@ -1685,6 +1974,7 @@ public setChargePriceIndicator ( $value, int $position)
+
@@ -1693,17 +1983,18 @@ public setChargePriceIndicator ( $value, int $position)
**Description**
```php
-public setConsultingDoctor ( $value, int $position)
+public setConsultingDoctor (string|int|array|null $value, int $position)
```
-
+Set Consulting Doctor (PV1.9)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 9
**Return Values**
@@ -1711,6 +2002,7 @@ public setConsultingDoctor ( $value, int $position)
+
@@ -1719,17 +2011,18 @@ public setConsultingDoctor ( $value, int $position)
**Description**
```php
-public setContractAmount ( $value, int $position)
+public setContractAmount (string|int|array|null $value, int $position)
```
-
+Set Contract Amount (PV1.26)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 26
**Return Values**
@@ -1737,6 +2030,7 @@ public setContractAmount ( $value, int $position)
+
@@ -1745,17 +2039,18 @@ public setContractAmount ( $value, int $position)
**Description**
```php
-public setContractCode ( $value, int $position)
+public setContractCode (string|int|array|null $value, int $position)
```
-
+Set Contract Code (PV1.24)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 24
**Return Values**
@@ -1763,6 +2058,7 @@ public setContractCode ( $value, int $position)
+
@@ -1771,17 +2067,18 @@ public setContractCode ( $value, int $position)
**Description**
```php
-public setContractEffectiveDate ( $value, int $position)
+public setContractEffectiveDate (string|int|array|null $value, int $position)
```
-
+Set Contract Effective Date (PV1.25)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 25
**Return Values**
@@ -1789,6 +2086,7 @@ public setContractEffectiveDate ( $value, int $position)
+
@@ -1797,17 +2095,18 @@ public setContractEffectiveDate ( $value, int $position)
**Description**
```php
-public setContractPeriod ( $value, int $position)
+public setContractPeriod (string|int|array|null $value, int $position)
```
-
+Set Contract Period (PV1.27)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 27
**Return Values**
@@ -1815,6 +2114,7 @@ public setContractPeriod ( $value, int $position)
+
@@ -1823,17 +2123,18 @@ public setContractPeriod ( $value, int $position)
**Description**
```php
-public setCourtesyCode ( $value, int $position)
+public setCourtesyCode (string|int|array|null $value, int $position)
```
-
+Set Courtesy Code (PV1.22)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 22
**Return Values**
@@ -1841,6 +2142,7 @@ public setCourtesyCode ( $value, int $position)
+
@@ -1849,17 +2151,18 @@ public setCourtesyCode ( $value, int $position)
**Description**
```php
-public setCreditRating ( $value, int $position)
+public setCreditRating (string|int|array|null $value, int $position)
```
-
+Set Credit Rating (PV1.23)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 23
**Return Values**
@@ -1867,6 +2170,7 @@ public setCreditRating ( $value, int $position)
+
@@ -1875,17 +2179,18 @@ public setCreditRating ( $value, int $position)
**Description**
```php
-public setCurrentPatientBalance ( $value, int $position)
+public setCurrentPatientBalance (string|int|array|null $value, int $position)
```
-
+Set Current Patient Balance (PV1.46)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 46
**Return Values**
@@ -1893,6 +2198,7 @@ public setCurrentPatientBalance ( $value, int $position)
+
@@ -1901,17 +2207,18 @@ public setCurrentPatientBalance ( $value, int $position)
**Description**
```php
-public setDeleteAccountDate ( $value, int $position)
+public setDeleteAccountDate (string|int|array|null $value, int $position)
```
-
+Set Delete Account Date (PV1.35)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 35
**Return Values**
@@ -1919,6 +2226,7 @@ public setDeleteAccountDate ( $value, int $position)
+
@@ -1927,17 +2235,18 @@ public setDeleteAccountDate ( $value, int $position)
**Description**
```php
-public setDeleteAccountIndicator ( $value, int $position)
+public setDeleteAccountIndicator (string|int|array|null $value, int $position)
```
-
+Set Delete Account Indicator (PV1.34)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 34
**Return Values**
@@ -1945,6 +2254,7 @@ public setDeleteAccountIndicator ( $value, int $position)
+
@@ -1953,17 +2263,18 @@ public setDeleteAccountIndicator ( $value, int $position)
**Description**
```php
-public setDietType ( $value, int $position)
+public setDietType (string|int|array|null $value, int $position)
```
-
+Set Diet Type (PV1.38)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 38
**Return Values**
@@ -1971,6 +2282,7 @@ public setDietType ( $value, int $position)
+
@@ -1979,17 +2291,18 @@ public setDietType ( $value, int $position)
**Description**
```php
-public setDischargeDateTime ( $value, int $position)
+public setDischargeDateTime (string|int|array|null $value, int $position)
```
-
+Set Discharge Date Time (PV1.45)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 45
**Return Values**
@@ -1997,6 +2310,7 @@ public setDischargeDateTime ( $value, int $position)
+
@@ -2005,17 +2319,18 @@ public setDischargeDateTime ( $value, int $position)
**Description**
```php
-public setDischargeDisposition ( $value, int $position)
+public setDischargeDisposition (string|int|array|null $value, int $position)
```
-
+Set Discharge Disposition (PV1.36)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 36
**Return Values**
@@ -2023,6 +2338,7 @@ public setDischargeDisposition ( $value, int $position)
+
@@ -2031,17 +2347,18 @@ public setDischargeDisposition ( $value, int $position)
**Description**
```php
-public setDischargedToLocation ( $value, int $position)
+public setDischargedToLocation (string|int|array|null $value, int $position)
```
-
+Set Discharged To Location (PV1.37)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 37
**Return Values**
@@ -2049,6 +2366,7 @@ public setDischargedToLocation ( $value, int $position)
+
@@ -2057,17 +2375,18 @@ public setDischargedToLocation ( $value, int $position)
**Description**
```php
-public setFinancialClass ( $value, int $position)
+public setFinancialClass (string|int|array|null $value, int $position)
```
-
+Set Financial Class (PV1.20)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 20
**Return Values**
@@ -2075,6 +2394,7 @@ public setFinancialClass ( $value, int $position)
+
@@ -2083,17 +2403,18 @@ public setFinancialClass ( $value, int $position)
**Description**
```php
-public setHospitalService ( $value, int $position)
+public setHospitalService (string|int|array|null $value, int $position)
```
-
+Set Hospital Service (PV1.10)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 10
**Return Values**
@@ -2101,6 +2422,7 @@ public setHospitalService ( $value, int $position)
+
@@ -2109,20 +2431,25 @@ public setHospitalService ( $value, int $position)
**Description**
```php
-public setID (void)
+public setID (int $value, int $position)
```
-
+Set ID (PV1.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2132,17 +2459,18 @@ public setID (void)
**Description**
```php
-public setInterestCode ( $value, int $position)
+public setInterestCode (string|int|array|null $value, int $position)
```
-
+Set Interest Code (PV1.28)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 28
**Return Values**
@@ -2150,6 +2478,7 @@ public setInterestCode ( $value, int $position)
+
@@ -2158,17 +2487,18 @@ public setInterestCode ( $value, int $position)
**Description**
```php
-public setOtherHealthcareProvider ( $value, int $position)
+public setOtherHealthcareProvider (string|int|array|null $value, int $position)
```
-
+Set Other Healthcare Provider (PV1.52)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 52
**Return Values**
@@ -2176,6 +2506,7 @@ public setOtherHealthcareProvider ( $value, int $position)
+
@@ -2184,20 +2515,25 @@ public setOtherHealthcareProvider ( $value, int $position)
**Description**
```php
-public setPatientClass (void)
+public setPatientClass (string|int|array|null $value, int $position)
```
-
+Set Patient Class (PV1.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
+
@@ -2207,17 +2543,18 @@ public setPatientClass (void)
**Description**
```php
-public setPatientType ( $value, int $position)
+public setPatientType (string|int|array|null $value, int $position)
```
-
+Set Patient Type (PV1.18)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 18
**Return Values**
@@ -2225,6 +2562,7 @@ public setPatientType ( $value, int $position)
+
@@ -2233,17 +2571,18 @@ public setPatientType ( $value, int $position)
**Description**
```php
-public setPendingLocation ( $value, int $position)
+public setPendingLocation (string|int|array|null $value, int $position)
```
-
+Set Pending Location (PV1.42)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 42
**Return Values**
@@ -2251,6 +2590,7 @@ public setPendingLocation ( $value, int $position)
+
@@ -2259,17 +2599,18 @@ public setPendingLocation ( $value, int $position)
**Description**
```php
-public setPreAdmitNumber ( $value, int $position)
+public setPreAdmitNumber (string|int|array|null $value, int $position)
```
-
+Set Pre Admit Number (PV1.5)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 5
**Return Values**
@@ -2277,6 +2618,7 @@ public setPreAdmitNumber ( $value, int $position)
+
@@ -2285,17 +2627,18 @@ public setPreAdmitNumber ( $value, int $position)
**Description**
```php
-public setPreAdmitTestIndicator ( $value, int $position)
+public setPreAdmitTestIndicator (string|int|array|null $value, int $position)
```
-
+Set Pre Admit Test Indicator (PV1.12)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 12
**Return Values**
@@ -2303,6 +2646,7 @@ public setPreAdmitTestIndicator ( $value, int $position)
+
@@ -2311,17 +2655,18 @@ public setPreAdmitTestIndicator ( $value, int $position)
**Description**
```php
-public setPriorPatientLocation ( $value, int $position)
+public setPriorPatientLocation (string|int|array|null $value, int $position)
```
-
+Set Prior Patient Location (PV1.6)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 6
**Return Values**
@@ -2329,6 +2674,7 @@ public setPriorPatientLocation ( $value, int $position)
+
@@ -2337,17 +2683,18 @@ public setPriorPatientLocation ( $value, int $position)
**Description**
```php
-public setPriorTemporaryLocation ( $value, int $position)
+public setPriorTemporaryLocation (string|int|array|null $value, int $position)
```
-
+Set Prior Temporary Location (PV1.43)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 43
**Return Values**
@@ -2355,6 +2702,7 @@ public setPriorTemporaryLocation ( $value, int $position)
+
@@ -2363,17 +2711,18 @@ public setPriorTemporaryLocation ( $value, int $position)
**Description**
```php
-public setReAdmissionIndicator ( $value, int $position)
+public setReAdmissionIndicator (string|int|array|null $value, int $position)
```
-
+Set Re Admission Indicator (PV1.13)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 13
**Return Values**
@@ -2381,6 +2730,7 @@ public setReAdmissionIndicator ( $value, int $position)
+
@@ -2389,17 +2739,18 @@ public setReAdmissionIndicator ( $value, int $position)
**Description**
```php
-public setReferringDoctor ( $value, int $position)
+public setReferringDoctor (string|int|array|null $value, int $position)
```
-
+Set Referring Doctor (PV1.8)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 8
**Return Values**
@@ -2407,6 +2758,7 @@ public setReferringDoctor ( $value, int $position)
+
@@ -2415,17 +2767,18 @@ public setReferringDoctor ( $value, int $position)
**Description**
```php
-public setServicingFacility ( $value, int $position)
+public setServicingFacility (string|int|array|null $value, int $position)
```
-
+Set Servicing Facility (PV1.39)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 39
**Return Values**
@@ -2433,6 +2786,7 @@ public setServicingFacility ( $value, int $position)
+
@@ -2441,17 +2795,18 @@ public setServicingFacility ( $value, int $position)
**Description**
```php
-public setTemporaryLocation ( $value, int $position)
+public setTemporaryLocation (string|int|array|null $value, int $position)
```
-
+Set Temporary Location (PV1.11)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 11
**Return Values**
@@ -2459,6 +2814,7 @@ public setTemporaryLocation ( $value, int $position)
+
@@ -2467,17 +2823,18 @@ public setTemporaryLocation ( $value, int $position)
**Description**
```php
-public setTotalAdjustments ( $value, int $position)
+public setTotalAdjustments (string|int|array|null $value, int $position)
```
-
+Set Total Adjustments (PV1.48)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 48
**Return Values**
@@ -2485,6 +2842,7 @@ public setTotalAdjustments ( $value, int $position)
+
@@ -2493,17 +2851,18 @@ public setTotalAdjustments ( $value, int $position)
**Description**
```php
-public setTotalCharges ( $value, int $position)
+public setTotalCharges (string|int|array|null $value, int $position)
```
-
+Set Total Charges (PV1.47)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 47
**Return Values**
@@ -2511,6 +2870,7 @@ public setTotalCharges ( $value, int $position)
+
@@ -2519,17 +2879,18 @@ public setTotalCharges ( $value, int $position)
**Description**
```php
-public setTotalPayments ( $value, int $position)
+public setTotalPayments (string|int|array|null $value, int $position)
```
-
+Set Total Payments (PV1.49)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 49
**Return Values**
@@ -2537,6 +2898,7 @@ public setTotalPayments ( $value, int $position)
+
@@ -2545,17 +2907,18 @@ public setTotalPayments ( $value, int $position)
**Description**
```php
-public setTransferToBadDebtCode ( $value, int $position)
+public setTransferToBadDebtCode (string|int|array|null $value, int $position)
```
-
+Set Transfer To Bad Debt Code (PV1.29)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 29
**Return Values**
@@ -2563,6 +2926,7 @@ public setTransferToBadDebtCode ( $value, int $position)
+
@@ -2571,17 +2935,18 @@ public setTransferToBadDebtCode ( $value, int $position)
**Description**
```php
-public setTransferToBadDebtDate ( $value, int $position)
+public setTransferToBadDebtDate (string|int|array|null $value, int $position)
```
-
+Set Transfer To Bad Debt Date (PV1.30)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 30
**Return Values**
@@ -2589,6 +2954,7 @@ public setTransferToBadDebtDate ( $value, int $position)
+
@@ -2597,17 +2963,18 @@ public setTransferToBadDebtDate ( $value, int $position)
**Description**
```php
-public setVipIndicator ( $value, int $position)
+public setVipIndicator (string|int|array|null $value, int $position)
```
-
+Set Vip Indicator (PV1.16)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 16
**Return Values**
@@ -2615,6 +2982,7 @@ public setVipIndicator ( $value, int $position)
+
@@ -2623,17 +2991,18 @@ public setVipIndicator ( $value, int $position)
**Description**
```php
-public setVisitIndicator ( $value, int $position)
+public setVisitIndicator (string|int|array|null $value, int $position)
```
-
+Set Visit Indicator (PV1.51)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 51
**Return Values**
@@ -2641,6 +3010,7 @@ public setVisitIndicator ( $value, int $position)
+
@@ -2649,17 +3019,18 @@ public setVisitIndicator ( $value, int $position)
**Description**
```php
-public setVisitNumber ( $value, int $position)
+public setVisitNumber (string|int|array|null $value, int $position)
```
-
+Set Visit Number (PV1.19)
**Parameters**
-* `() $value`
+* `(string|int|array|null) $value`
* `(int) $position`
+: Defaults to 19
**Return Values**
@@ -2667,5 +3038,6 @@ public setVisitNumber ( $value, int $position)
+
diff --git a/docs/Segments/PV2.md b/docs/Segments/PV2.md
new file mode 100644
index 0000000..ed0d3c2
--- /dev/null
+++ b/docs/Segments/PV2.md
@@ -0,0 +1,2680 @@
+# Aranyasen\HL7\Segments\PV2
+
+PV2 segment class
+Ref: https://hl7-definition.caristix.com/v2/HL7v2.4/Segments/PV2
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getAccommodationCode](#pv2getaccommodationcode)|Get Accommodation Code (PV2.2)|
+|[getActualLengthOfInpatientStay](#pv2getactuallengthofinpatientstay)|Get Actual Length Of Inpatient Stay (PV2.11)|
+|[getAdmissionLevelOfCareCode](#pv2getadmissionlevelofcarecode)|Get Admission Level Of Care Code (PV2.40)|
+|[getAdmitReason](#pv2getadmitreason)|Get Admit Reason (PV2.3)|
+|[getAdvanceDirectiveCode](#pv2getadvancedirectivecode)|Get Advance Directive Code (PV2.45)|
+|[getBabyDetainedIndicator](#pv2getbabydetainedindicator)|Get Baby Detained Indicator (PV2.37)|
+|[getBillingMediaCode](#pv2getbillingmediacode)|Get Billing Media Code (PV2.32)|
+|[getClinicOrganizationName](#pv2getclinicorganizationname)|Get Clinic Organization Name (PV2.23)|
+|[getEmploymentIllnessRelatedIndicator](#pv2getemploymentillnessrelatedindicator)|Get Employment Illness Related Indicator (PV2.15)|
+|[getEstimatedLengthofInpatientStay](#pv2getestimatedlengthofinpatientstay)|Get Estimated Lengthof Inpatient Stay (PV2.10)|
+|[getExpectedAdmitDateTime](#pv2getexpectedadmitdatetime)|Get Expected Admit Date Time (PV2.8)|
+|[getExpectedDischargeDateTime](#pv2getexpecteddischargedatetime)|Get Expected Discharge Date Time (PV2.9)|
+|[getExpectedDischargeDisposition](#pv2getexpecteddischargedisposition)|Get Expected Discharge Disposition (PV2.27)|
+|[getExpectedLOAReturnDateTime](#pv2getexpectedloareturndatetime)|Get Expected LOAReturn Date Time (PV2.47)|
+|[getExpectedNumberOfInsurancePlans](#pv2getexpectednumberofinsuranceplans)|Get Expected Number Of Insurance Plans (PV2.20)|
+|[getExpectedSurgeryDateAndTime](#pv2getexpectedsurgerydateandtime)|Get Expected Surgery Date And Time (PV2.33)|
+|[getFirstSimilarIllnessDate](#pv2getfirstsimilarillnessdate)|Get First Similar Illness Date (PV2.29)|
+|[getLivingWillCode](#pv2getlivingwillcode)|Get Living Will Code (PV2.43)|
+|[getMilitaryNonAvailabilityCode](#pv2getmilitarynonavailabilitycode)|Get Military Non Availability Code (PV2.35)|
+|[getMilitaryPartnershipCode](#pv2getmilitarypartnershipcode)|Get Military Partnership Code (PV2.34)|
+|[getModeOfArrivalCode](#pv2getmodeofarrivalcode)|Get Mode Of Arrival Code (PV2.38)|
+|[getNewbornBabyIndicator](#pv2getnewbornbabyindicator)|Get Newborn Baby Indicator (PV2.36)|
+|[getOrganDonorCode](#pv2getorgandonorcode)|Get Organ Donor Code (PV2.44)|
+|[getPatientChargeAdjustmentCode](#pv2getpatientchargeadjustmentcode)|Get Patient Charge Adjustment Code (PV2.30)|
+|[getPatientConditionCode](#pv2getpatientconditioncode)|Get Patient Condition Code (PV2.42)|
+|[getPatientStatusCode](#pv2getpatientstatuscode)|Get Patient Status Code (PV2.24)|
+|[getPatientStatusEffectiveDate](#pv2getpatientstatuseffectivedate)|Get Patient Status Effective Date (PV2.46)|
+|[getPatientValuables](#pv2getpatientvaluables)|Get Patient Valuables (PV2.5)|
+|[getPatientValuablesLocation](#pv2getpatientvaluableslocation)|Get Patient Valuables Location (PV2.6)|
+|[getPrecautionCode](#pv2getprecautioncode)|Get Precaution Code (PV2.41)|
+|[getPreviousServiceDate](#pv2getpreviousservicedate)|Get Previous Service Date (PV2.14)|
+|[getPreviousTreatmentDate](#pv2getprevioustreatmentdate)|Get Previous Treatment Date (PV2.26)|
+|[getPurgeStatusCode](#pv2getpurgestatuscode)|Get Purge Status Code (PV2.16)|
+|[getPurgeStatusDate](#pv2getpurgestatusdate)|Get Purge Status Date (PV2.17)|
+|[getRecreationalDrugUseCode](#pv2getrecreationaldrugusecode)|Get Recreational Drug Use Code (PV2.39)|
+|[getRecurringServiceCode](#pv2getrecurringservicecode)|Get Recurring Service Code (PV2.31)|
+|[getReferralSourceCode](#pv2getreferralsourcecode)|Get Referral Source Code (PV2.13)|
+|[getRetentionIndicator](#pv2getretentionindicator)|Get Retention Indicator (PV2.19)|
+|[getSignatureOnFileDate](#pv2getsignatureonfiledate)|Get Signature On File Date (PV2.28)|
+|[getSpecialProgramCode](#pv2getspecialprogramcode)|Get Special Program Code (PV2.18)|
+|[getTransferReason](#pv2gettransferreason)|Get Transfer Reason (PV2.4)|
+|[getVisitDescription](#pv2getvisitdescription)|Get Visit Description (PV2.12)|
+|[getVisitPriorityCode](#pv2getvisitprioritycode)|Get Visit Priority Code (PV2.25)|
+|[getVisitProtectionIndicator](#pv2getvisitprotectionindicator)|Get Visit Protection Indicator (PV2.22)|
+|[getVisitPublicityCode](#pv2getvisitpublicitycode)|Get Visit Publicity Code (PV2.21)|
+|[getVisitUserCode](#pv2getvisitusercode)|Get Visit User Code (PV2.7)|
+|[setAccommodationCode](#pv2setaccommodationcode)|Set Accommodation Code (PV2.2)|
+|[setActualLengthOfInpatientStay](#pv2setactuallengthofinpatientstay)|Set Actual Length Of Inpatient Stay (PV2.11)|
+|[setAdmissionLevelOfCareCode](#pv2setadmissionlevelofcarecode)|Set Admission Level Of Care Code (PV2.40)|
+|[setAdmitReason](#pv2setadmitreason)|Set Admit Reason (PV2.3)|
+|[setAdvanceDirectiveCode](#pv2setadvancedirectivecode)|Set Advance Directive Code (PV2.45)|
+|[setBabyDetainedIndicator](#pv2setbabydetainedindicator)|Set Baby Detained Indicator (PV2.37)|
+|[setBillingMediaCode](#pv2setbillingmediacode)|Set Billing Media Code (PV2.32)|
+|[setClinicOrganizationName](#pv2setclinicorganizationname)|Set Clinic Organization Name (PV2.23)|
+|[setEmploymentIllnessRelatedIndicator](#pv2setemploymentillnessrelatedindicator)|Set Employment Illness Related Indicator (PV2.15)|
+|[setEstimatedLengthofInpatientStay](#pv2setestimatedlengthofinpatientstay)|Set Estimated Lengthof Inpatient Stay (PV2.10)|
+|[setExpectedAdmitDateTime](#pv2setexpectedadmitdatetime)|Set Expected Admit Date Time (PV2.8)|
+|[setExpectedDischargeDateTime](#pv2setexpecteddischargedatetime)|Set Expected Discharge Date Time (PV2.9)|
+|[setExpectedDischargeDisposition](#pv2setexpecteddischargedisposition)|Set Expected Discharge Disposition (PV2.27)|
+|[setExpectedLOAReturnDateTime](#pv2setexpectedloareturndatetime)|Set Expected LOAReturn Date Time (PV2.47)|
+|[setExpectedNumberOfInsurancePlans](#pv2setexpectednumberofinsuranceplans)|Set Expected Number Of Insurance Plans (PV2.20)|
+|[setExpectedSurgeryDateAndTime](#pv2setexpectedsurgerydateandtime)|Set Expected Surgery Date And Time (PV2.33)|
+|[setFirstSimilarIllnessDate](#pv2setfirstsimilarillnessdate)|Set First Similar Illness Date (PV2.29)|
+|[setLivingWillCode](#pv2setlivingwillcode)|Set Living Will Code (PV2.43)|
+|[setMilitaryNonAvailabilityCode](#pv2setmilitarynonavailabilitycode)|Set Military Non Availability Code (PV2.35)|
+|[setMilitaryPartnershipCode](#pv2setmilitarypartnershipcode)|Set Military Partnership Code (PV2.34)|
+|[setModeOfArrivalCode](#pv2setmodeofarrivalcode)|Set Mode Of Arrival Code (PV2.38)|
+|[setNewbornBabyIndicator](#pv2setnewbornbabyindicator)|Set Newborn Baby Indicator (PV2.36)|
+|[setOrganDonorCode](#pv2setorgandonorcode)|Set Organ Donor Code (PV2.44)|
+|[setPatientChargeAdjustmentCode](#pv2setpatientchargeadjustmentcode)|Set Patient Charge Adjustment Code (PV2.30)|
+|[setPatientConditionCode](#pv2setpatientconditioncode)|Set Patient Condition Code (PV2.42)|
+|[setPatientStatusCode](#pv2setpatientstatuscode)|Set Patient Status Code (PV2.24)|
+|[setPatientStatusEffectiveDate](#pv2setpatientstatuseffectivedate)|Set Patient Status Effective Date (PV2.46)|
+|[setPatientValuables](#pv2setpatientvaluables)|Set Patient Valuables (PV2.5)|
+|[setPatientValuablesLocation](#pv2setpatientvaluableslocation)|Set Patient Valuables Location (PV2.6)|
+|[setPrecautionCode](#pv2setprecautioncode)|Set Precaution Code (PV2.41)|
+|[setPreviousServiceDate](#pv2setpreviousservicedate)|Set Previous Service Date (PV2.14)|
+|[setPreviousTreatmentDate](#pv2setprevioustreatmentdate)|Set Previous Treatment Date (PV2.26)|
+|[setPriorPendingLocation](#pv2setpriorpendinglocation)|Set Prior Pending Location (PV2.1)|
+|[setPurgeStatusCode](#pv2setpurgestatuscode)|Set Purge Status Code (PV2.16)|
+|[setPurgeStatusDate](#pv2setpurgestatusdate)|Set Purge Status Date (PV2.17)|
+|[setRecreationalDrugUseCode](#pv2setrecreationaldrugusecode)|Set Recreational Drug Use Code (PV2.39)|
+|[setRecurringServiceCode](#pv2setrecurringservicecode)|Set Recurring Service Code (PV2.31)|
+|[setReferralSourceCode](#pv2setreferralsourcecode)|Set Referral Source Code (PV2.13)|
+|[setRetentionIndicator](#pv2setretentionindicator)|Set Retention Indicator (PV2.19)|
+|[setSignatureOnFileDate](#pv2setsignatureonfiledate)|Set Signature On File Date (PV2.28)|
+|[setSpecialProgramCode](#pv2setspecialprogramcode)|Set Special Program Code (PV2.18)|
+|[setTransferReason](#pv2settransferreason)|Set Transfer Reason (PV2.4)|
+|[setVisitDescription](#pv2setvisitdescription)|Set Visit Description (PV2.12)|
+|[setVisitPriorityCode](#pv2setvisitprioritycode)|Set Visit Priority Code (PV2.25)|
+|[setVisitProtectionIndicator](#pv2setvisitprotectionindicator)|Set Visit Protection Indicator (PV2.22)|
+|[setVisitPublicityCode](#pv2setvisitpublicitycode)|Set Visit Publicity Code (PV2.21)|
+|[setVisitUserCode](#pv2setvisitusercode)|Set Visit User Code (PV2.7)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### PV2::getAccommodationCode
+
+**Description**
+
+```php
+public getAccommodationCode (int $position)
+```
+
+Get Accommodation Code (PV2.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getActualLengthOfInpatientStay
+
+**Description**
+
+```php
+public getActualLengthOfInpatientStay (int $position)
+```
+
+Get Actual Length Of Inpatient Stay (PV2.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getAdmissionLevelOfCareCode
+
+**Description**
+
+```php
+public getAdmissionLevelOfCareCode (int $position)
+```
+
+Get Admission Level Of Care Code (PV2.40)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 40
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getAdmitReason
+
+**Description**
+
+```php
+public getAdmitReason (int $position)
+```
+
+Get Admit Reason (PV2.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getAdvanceDirectiveCode
+
+**Description**
+
+```php
+public getAdvanceDirectiveCode (int $position)
+```
+
+Get Advance Directive Code (PV2.45)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 45
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getBabyDetainedIndicator
+
+**Description**
+
+```php
+public getBabyDetainedIndicator (int $position)
+```
+
+Get Baby Detained Indicator (PV2.37)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getBillingMediaCode
+
+**Description**
+
+```php
+public getBillingMediaCode (int $position)
+```
+
+Get Billing Media Code (PV2.32)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getClinicOrganizationName
+
+**Description**
+
+```php
+public getClinicOrganizationName (int $position)
+```
+
+Get Clinic Organization Name (PV2.23)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getEmploymentIllnessRelatedIndicator
+
+**Description**
+
+```php
+public getEmploymentIllnessRelatedIndicator (int $position)
+```
+
+Get Employment Illness Related Indicator (PV2.15)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getEstimatedLengthofInpatientStay
+
+**Description**
+
+```php
+public getEstimatedLengthofInpatientStay (int $position)
+```
+
+Get Estimated Lengthof Inpatient Stay (PV2.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedAdmitDateTime
+
+**Description**
+
+```php
+public getExpectedAdmitDateTime (int $position)
+```
+
+Get Expected Admit Date Time (PV2.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedDischargeDateTime
+
+**Description**
+
+```php
+public getExpectedDischargeDateTime (int $position)
+```
+
+Get Expected Discharge Date Time (PV2.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedDischargeDisposition
+
+**Description**
+
+```php
+public getExpectedDischargeDisposition (int $position)
+```
+
+Get Expected Discharge Disposition (PV2.27)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedLOAReturnDateTime
+
+**Description**
+
+```php
+public getExpectedLOAReturnDateTime (int $position)
+```
+
+Get Expected LOAReturn Date Time (PV2.47)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 47
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedNumberOfInsurancePlans
+
+**Description**
+
+```php
+public getExpectedNumberOfInsurancePlans (int $position)
+```
+
+Get Expected Number Of Insurance Plans (PV2.20)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getExpectedSurgeryDateAndTime
+
+**Description**
+
+```php
+public getExpectedSurgeryDateAndTime (int $position)
+```
+
+Get Expected Surgery Date And Time (PV2.33)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getFirstSimilarIllnessDate
+
+**Description**
+
+```php
+public getFirstSimilarIllnessDate (int $position)
+```
+
+Get First Similar Illness Date (PV2.29)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getLivingWillCode
+
+**Description**
+
+```php
+public getLivingWillCode (int $position)
+```
+
+Get Living Will Code (PV2.43)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 43
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getMilitaryNonAvailabilityCode
+
+**Description**
+
+```php
+public getMilitaryNonAvailabilityCode (int $position)
+```
+
+Get Military Non Availability Code (PV2.35)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getMilitaryPartnershipCode
+
+**Description**
+
+```php
+public getMilitaryPartnershipCode (int $position)
+```
+
+Get Military Partnership Code (PV2.34)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getModeOfArrivalCode
+
+**Description**
+
+```php
+public getModeOfArrivalCode (int $position)
+```
+
+Get Mode Of Arrival Code (PV2.38)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getNewbornBabyIndicator
+
+**Description**
+
+```php
+public getNewbornBabyIndicator (int $position)
+```
+
+Get Newborn Baby Indicator (PV2.36)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getOrganDonorCode
+
+**Description**
+
+```php
+public getOrganDonorCode (int $position)
+```
+
+Get Organ Donor Code (PV2.44)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 44
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientChargeAdjustmentCode
+
+**Description**
+
+```php
+public getPatientChargeAdjustmentCode (int $position)
+```
+
+Get Patient Charge Adjustment Code (PV2.30)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientConditionCode
+
+**Description**
+
+```php
+public getPatientConditionCode (int $position)
+```
+
+Get Patient Condition Code (PV2.42)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 42
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientStatusCode
+
+**Description**
+
+```php
+public getPatientStatusCode (int $position)
+```
+
+Get Patient Status Code (PV2.24)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientStatusEffectiveDate
+
+**Description**
+
+```php
+public getPatientStatusEffectiveDate (int $position)
+```
+
+Get Patient Status Effective Date (PV2.46)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 46
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientValuables
+
+**Description**
+
+```php
+public getPatientValuables (int $position)
+```
+
+Get Patient Valuables (PV2.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPatientValuablesLocation
+
+**Description**
+
+```php
+public getPatientValuablesLocation (int $position)
+```
+
+Get Patient Valuables Location (PV2.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPrecautionCode
+
+**Description**
+
+```php
+public getPrecautionCode (int $position)
+```
+
+Get Precaution Code (PV2.41)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 41
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPreviousServiceDate
+
+**Description**
+
+```php
+public getPreviousServiceDate (int $position)
+```
+
+Get Previous Service Date (PV2.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPreviousTreatmentDate
+
+**Description**
+
+```php
+public getPreviousTreatmentDate (int $position)
+```
+
+Get Previous Treatment Date (PV2.26)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPurgeStatusCode
+
+**Description**
+
+```php
+public getPurgeStatusCode (int $position)
+```
+
+Get Purge Status Code (PV2.16)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getPurgeStatusDate
+
+**Description**
+
+```php
+public getPurgeStatusDate (int $position)
+```
+
+Get Purge Status Date (PV2.17)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getRecreationalDrugUseCode
+
+**Description**
+
+```php
+public getRecreationalDrugUseCode (int $position)
+```
+
+Get Recreational Drug Use Code (PV2.39)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getRecurringServiceCode
+
+**Description**
+
+```php
+public getRecurringServiceCode (int $position)
+```
+
+Get Recurring Service Code (PV2.31)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getReferralSourceCode
+
+**Description**
+
+```php
+public getReferralSourceCode (int $position)
+```
+
+Get Referral Source Code (PV2.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getRetentionIndicator
+
+**Description**
+
+```php
+public getRetentionIndicator (int $position)
+```
+
+Get Retention Indicator (PV2.19)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getSignatureOnFileDate
+
+**Description**
+
+```php
+public getSignatureOnFileDate (int $position)
+```
+
+Get Signature On File Date (PV2.28)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getSpecialProgramCode
+
+**Description**
+
+```php
+public getSpecialProgramCode (int $position)
+```
+
+Get Special Program Code (PV2.18)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getTransferReason
+
+**Description**
+
+```php
+public getTransferReason (int $position)
+```
+
+Get Transfer Reason (PV2.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getVisitDescription
+
+**Description**
+
+```php
+public getVisitDescription (int $position)
+```
+
+Get Visit Description (PV2.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getVisitPriorityCode
+
+**Description**
+
+```php
+public getVisitPriorityCode (int $position)
+```
+
+Get Visit Priority Code (PV2.25)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getVisitProtectionIndicator
+
+**Description**
+
+```php
+public getVisitProtectionIndicator (int $position)
+```
+
+Get Visit Protection Indicator (PV2.22)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getVisitPublicityCode
+
+**Description**
+
+```php
+public getVisitPublicityCode (int $position)
+```
+
+Get Visit Publicity Code (PV2.21)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::getVisitUserCode
+
+**Description**
+
+```php
+public getVisitUserCode (int $position)
+```
+
+Get Visit User Code (PV2.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### PV2::setAccommodationCode
+
+**Description**
+
+```php
+public setAccommodationCode (string|int|array|null $value, int $position)
+```
+
+Set Accommodation Code (PV2.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setActualLengthOfInpatientStay
+
+**Description**
+
+```php
+public setActualLengthOfInpatientStay (string|int|array|null $value, int $position)
+```
+
+Set Actual Length Of Inpatient Stay (PV2.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setAdmissionLevelOfCareCode
+
+**Description**
+
+```php
+public setAdmissionLevelOfCareCode (string|int|array|null $value, int $position)
+```
+
+Set Admission Level Of Care Code (PV2.40)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 40
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setAdmitReason
+
+**Description**
+
+```php
+public setAdmitReason (string|int|array|null $value, int $position)
+```
+
+Set Admit Reason (PV2.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setAdvanceDirectiveCode
+
+**Description**
+
+```php
+public setAdvanceDirectiveCode (string|int|array|null $value, int $position)
+```
+
+Set Advance Directive Code (PV2.45)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 45
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setBabyDetainedIndicator
+
+**Description**
+
+```php
+public setBabyDetainedIndicator (string|int|array|null $value, int $position)
+```
+
+Set Baby Detained Indicator (PV2.37)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setBillingMediaCode
+
+**Description**
+
+```php
+public setBillingMediaCode (string|int|array|null $value, int $position)
+```
+
+Set Billing Media Code (PV2.32)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setClinicOrganizationName
+
+**Description**
+
+```php
+public setClinicOrganizationName (string|int|array|null $value, int $position)
+```
+
+Set Clinic Organization Name (PV2.23)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setEmploymentIllnessRelatedIndicator
+
+**Description**
+
+```php
+public setEmploymentIllnessRelatedIndicator (string|int|array|null $value, int $position)
+```
+
+Set Employment Illness Related Indicator (PV2.15)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setEstimatedLengthofInpatientStay
+
+**Description**
+
+```php
+public setEstimatedLengthofInpatientStay (string|int|array|null $value, int $position)
+```
+
+Set Estimated Lengthof Inpatient Stay (PV2.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedAdmitDateTime
+
+**Description**
+
+```php
+public setExpectedAdmitDateTime (string|int|array|null $value, int $position)
+```
+
+Set Expected Admit Date Time (PV2.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedDischargeDateTime
+
+**Description**
+
+```php
+public setExpectedDischargeDateTime (string|int|array|null $value, int $position)
+```
+
+Set Expected Discharge Date Time (PV2.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedDischargeDisposition
+
+**Description**
+
+```php
+public setExpectedDischargeDisposition (string|int|array|null $value, int $position)
+```
+
+Set Expected Discharge Disposition (PV2.27)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedLOAReturnDateTime
+
+**Description**
+
+```php
+public setExpectedLOAReturnDateTime (string|int|array|null $value, int $position)
+```
+
+Set Expected LOAReturn Date Time (PV2.47)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 47
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedNumberOfInsurancePlans
+
+**Description**
+
+```php
+public setExpectedNumberOfInsurancePlans (string|int|array|null $value, int $position)
+```
+
+Set Expected Number Of Insurance Plans (PV2.20)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setExpectedSurgeryDateAndTime
+
+**Description**
+
+```php
+public setExpectedSurgeryDateAndTime (string|int|array|null $value, int $position)
+```
+
+Set Expected Surgery Date And Time (PV2.33)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setFirstSimilarIllnessDate
+
+**Description**
+
+```php
+public setFirstSimilarIllnessDate (string|int|array|null $value, int $position)
+```
+
+Set First Similar Illness Date (PV2.29)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setLivingWillCode
+
+**Description**
+
+```php
+public setLivingWillCode (string|int|array|null $value, int $position)
+```
+
+Set Living Will Code (PV2.43)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 43
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setMilitaryNonAvailabilityCode
+
+**Description**
+
+```php
+public setMilitaryNonAvailabilityCode (string|int|array|null $value, int $position)
+```
+
+Set Military Non Availability Code (PV2.35)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setMilitaryPartnershipCode
+
+**Description**
+
+```php
+public setMilitaryPartnershipCode (string|int|array|null $value, int $position)
+```
+
+Set Military Partnership Code (PV2.34)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setModeOfArrivalCode
+
+**Description**
+
+```php
+public setModeOfArrivalCode (string|int|array|null $value, int $position)
+```
+
+Set Mode Of Arrival Code (PV2.38)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setNewbornBabyIndicator
+
+**Description**
+
+```php
+public setNewbornBabyIndicator (string|int|array|null $value, int $position)
+```
+
+Set Newborn Baby Indicator (PV2.36)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setOrganDonorCode
+
+**Description**
+
+```php
+public setOrganDonorCode (string|int|array|null $value, int $position)
+```
+
+Set Organ Donor Code (PV2.44)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 44
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientChargeAdjustmentCode
+
+**Description**
+
+```php
+public setPatientChargeAdjustmentCode (string|int|array|null $value, int $position)
+```
+
+Set Patient Charge Adjustment Code (PV2.30)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientConditionCode
+
+**Description**
+
+```php
+public setPatientConditionCode (string|int|array|null $value, int $position)
+```
+
+Set Patient Condition Code (PV2.42)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 42
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientStatusCode
+
+**Description**
+
+```php
+public setPatientStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Patient Status Code (PV2.24)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientStatusEffectiveDate
+
+**Description**
+
+```php
+public setPatientStatusEffectiveDate (string|int|array|null $value, int $position)
+```
+
+Set Patient Status Effective Date (PV2.46)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 46
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientValuables
+
+**Description**
+
+```php
+public setPatientValuables (string|int|array|null $value, int $position)
+```
+
+Set Patient Valuables (PV2.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPatientValuablesLocation
+
+**Description**
+
+```php
+public setPatientValuablesLocation (string|int|array|null $value, int $position)
+```
+
+Set Patient Valuables Location (PV2.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPrecautionCode
+
+**Description**
+
+```php
+public setPrecautionCode (string|int|array|null $value, int $position)
+```
+
+Set Precaution Code (PV2.41)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 41
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPreviousServiceDate
+
+**Description**
+
+```php
+public setPreviousServiceDate (string|int|array|null $value, int $position)
+```
+
+Set Previous Service Date (PV2.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPreviousTreatmentDate
+
+**Description**
+
+```php
+public setPreviousTreatmentDate (string|int|array|null $value, int $position)
+```
+
+Set Previous Treatment Date (PV2.26)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPriorPendingLocation
+
+**Description**
+
+```php
+public setPriorPendingLocation (string|int|array|null $value, int $position)
+```
+
+Set Prior Pending Location (PV2.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPurgeStatusCode
+
+**Description**
+
+```php
+public setPurgeStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Purge Status Code (PV2.16)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setPurgeStatusDate
+
+**Description**
+
+```php
+public setPurgeStatusDate (string|int|array|null $value, int $position)
+```
+
+Set Purge Status Date (PV2.17)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setRecreationalDrugUseCode
+
+**Description**
+
+```php
+public setRecreationalDrugUseCode (string|int|array|null $value, int $position)
+```
+
+Set Recreational Drug Use Code (PV2.39)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setRecurringServiceCode
+
+**Description**
+
+```php
+public setRecurringServiceCode (string|int|array|null $value, int $position)
+```
+
+Set Recurring Service Code (PV2.31)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setReferralSourceCode
+
+**Description**
+
+```php
+public setReferralSourceCode (string|int|array|null $value, int $position)
+```
+
+Set Referral Source Code (PV2.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setRetentionIndicator
+
+**Description**
+
+```php
+public setRetentionIndicator (string|int|array|null $value, int $position)
+```
+
+Set Retention Indicator (PV2.19)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setSignatureOnFileDate
+
+**Description**
+
+```php
+public setSignatureOnFileDate (string|int|array|null $value, int $position)
+```
+
+Set Signature On File Date (PV2.28)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setSpecialProgramCode
+
+**Description**
+
+```php
+public setSpecialProgramCode (string|int|array|null $value, int $position)
+```
+
+Set Special Program Code (PV2.18)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setTransferReason
+
+**Description**
+
+```php
+public setTransferReason (string|int|array|null $value, int $position)
+```
+
+Set Transfer Reason (PV2.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setVisitDescription
+
+**Description**
+
+```php
+public setVisitDescription (string|int|array|null $value, int $position)
+```
+
+Set Visit Description (PV2.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setVisitPriorityCode
+
+**Description**
+
+```php
+public setVisitPriorityCode (string|int|array|null $value, int $position)
+```
+
+Set Visit Priority Code (PV2.25)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setVisitProtectionIndicator
+
+**Description**
+
+```php
+public setVisitProtectionIndicator (string|int|array|null $value, int $position)
+```
+
+Set Visit Protection Indicator (PV2.22)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setVisitPublicityCode
+
+**Description**
+
+```php
+public setVisitPublicityCode (string|int|array|null $value, int $position)
+```
+
+Set Visit Publicity Code (PV2.21)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### PV2::setVisitUserCode
+
+**Description**
+
+```php
+public setVisitUserCode (string|int|array|null $value, int $position)
+```
+
+Set Visit User Code (PV2.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/RGS.md b/docs/Segments/RGS.md
new file mode 100644
index 0000000..11225bb
--- /dev/null
+++ b/docs/Segments/RGS.md
@@ -0,0 +1,250 @@
+# Aranyasen\HL7\Segments\RGS
+
+RGS segment class
+Ref: http://hl7-definition.caristix.com:9010/Default.aspx?version=HL7+v2.5.1&segment=RGS
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[__destruct](#rgs__destruct)||
+|[getID](#rgsgetid)|Get ID (RGS.1)|
+|[getResourceGroupID](#rgsgetresourcegroupid)|Get Resource Group ID (RGS.3)|
+|[getSegmentActionCode](#rgsgetsegmentactioncode)|Get Segment Action Code (RGS.2)|
+|[resetIndex](#rgsresetindex)|Reset index of this segment|
+|[setID](#rgssetid)|Set ID (RGS.1)|
+|[setResourceGroupID](#rgssetresourcegroupid)|Set Resource Group ID (RGS.3)|
+|[setSegmentActionCode](#rgssetsegmentactioncode)|Set Segment Action Code (RGS.2)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### RGS::__destruct
+
+**Description**
+
+```php
+ __destruct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### RGS::getID
+
+**Description**
+
+```php
+public getID (int $position)
+```
+
+Get ID (RGS.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### RGS::getResourceGroupID
+
+**Description**
+
+```php
+public getResourceGroupID (int $position)
+```
+
+Get Resource Group ID (RGS.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### RGS::getSegmentActionCode
+
+**Description**
+
+```php
+public getSegmentActionCode (int $position)
+```
+
+Get Segment Action Code (RGS.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### RGS::resetIndex
+
+**Description**
+
+```php
+public static resetIndex (void)
+```
+
+Reset index of this segment
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### RGS::setID
+
+**Description**
+
+```php
+public setID (int $value, int $position)
+```
+
+Set ID (RGS.1)
+
+
+
+**Parameters**
+
+* `(int) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### RGS::setResourceGroupID
+
+**Description**
+
+```php
+public setResourceGroupID (string|int|array|null $value, int $position)
+```
+
+Set Resource Group ID (RGS.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### RGS::setSegmentActionCode
+
+**Description**
+
+```php
+public setSegmentActionCode (string|int|array|null $value, int $position)
+```
+
+Set Segment Action Code (RGS.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/SAC.md b/docs/Segments/SAC.md
index e67cfc1..68c0015 100644
--- a/docs/Segments/SAC.md
+++ b/docs/Segments/SAC.md
@@ -13,101 +13,102 @@ Aranyasen\HL7\Segment
| Name | Description |
|------|-------------|
-|[getAccessionIdentifier](#sacgetaccessionidentifier)||
-|[getAdditive](#sacgetadditive)||
-|[getArtificialBlood](#sacgetartificialblood)||
-|[getAvailableSpecimenVolume](#sacgetavailablespecimenvolume)||
-|[getBarrierDelta](#sacgetbarrierdelta)||
-|[getBottomDelta](#sacgetbottomdelta)||
-|[getCapType](#sacgetcaptype)||
-|[getCarrierIdentifier](#sacgetcarrieridentifier)||
-|[getCarrierType](#sacgetcarriertype)||
-|[getContainerDiameter](#sacgetcontainerdiameter)||
-|[getContainerHeight](#sacgetcontainerheight)||
-|[getContainerIdentifier](#sacgetcontaineridentifier)||
-|[getContainerSizeUnits](#sacgetcontainersizeunits)||
-|[getContainerStatus](#sacgetcontainerstatus)||
-|[getContainerVolume](#sacgetcontainervolume)||
-|[getDilutionFactor](#sacgetdilutionfactor)||
-|[getDrugInterference](#sacgetdruginterference)||
-|[getEquipmentContainerIdentifier](#sacgetequipmentcontaineridentifier)||
-|[getExternalAccessionIdentifier](#sacgetexternalaccessionidentifier)||
-|[getFibrinIndex](#sacgetfibrinindex)||
-|[getFibrinIndexUnits](#sacgetfibrinindexunits)||
-|[getHemolysisIndex](#sacgethemolysisindex)||
-|[getHemolysisIndexUnits](#sacgethemolysisindexunits)||
-|[getIcterusIndex](#sacgeticterusindex)||
-|[getIcterusIndexUnits](#sacgeticterusindexunits)||
-|[getInitialSpecimenVolume](#sacgetinitialspecimenvolume)||
-|[getLepemiaIndex](#sacgetlepemiaindex)||
-|[getLepemiaIndexUnits](#sacgetlepemiaindexunits)||
-|[getLocation](#sacgetlocation)||
-|[getOtherEnvironmentalFactors](#sacgetotherenvironmentalfactors)||
-|[getPositionInCarrier](#sacgetpositionincarrier)||
-|[getPositionInTray](#sacgetpositionintray)||
-|[getPrimaryContainerIdentifier](#sacgetprimarycontaineridentifier)||
-|[getRegistrationDateTime](#sacgetregistrationdatetime)||
-|[getSeparatorType](#sacgetseparatortype)||
-|[getSpecialHandlingCode](#sacgetspecialhandlingcode)||
-|[getSpecimenComponent](#sacgetspecimencomponent)||
-|[getSpecimenSource](#sacgetspecimensource)||
-|[getSystemInducedContaminants](#sacgetsysteminducedcontaminants)||
-|[getTemperature](#sacgettemperature)||
-|[getTrayIdentifier](#sacgettrayidentifier)||
-|[getTrayTypeSAC](#sacgettraytypesac)||
-|[getTreatment](#sacgettreatment)||
-|[getVolumeUnits](#sacgetvolumeunits)||
+|[getAccessionIdentifier](#sacgetaccessionidentifier)|Get Accession Identifier (SAC.2)|
+|[getAdditive](#sacgetadditive)|Get Additive (SAC.27)|
+|[getArtificialBlood](#sacgetartificialblood)|Get Artificial Blood (SAC.42)|
+|[getAvailableSpecimenVolume](#sacgetavailablespecimenvolume)|Get Available Specimen Volume (SAC.22)|
+|[getBarrierDelta](#sacgetbarrierdelta)|Get Barrier Delta (SAC.18)|
+|[getBottomDelta](#sacgetbottomdelta)|Get Bottom Delta (SAC.19)|
+|[getCapType](#sacgetcaptype)|Get Cap Type (SAC.26)|
+|[getCarrierIdentifier](#sacgetcarrieridentifier)|Get Carrier Identifier (SAC.10)|
+|[getCarrierType](#sacgetcarriertype)|Get Carrier Type (SAC.9)|
+|[getContainerDiameter](#sacgetcontainerdiameter)|Get Container Diameter (SAC.17)|
+|[getContainerHeight](#sacgetcontainerheight)|Get Container Height (SAC.16)|
+|[getContainerIdentifier](#sacgetcontaineridentifier)|Get Container Identifier (SAC.3)|
+|[getContainerSizeUnits](#sacgetcontainersizeunits)|Get Container Size Units (SAC.20)|
+|[getContainerStatus](#sacgetcontainerstatus)|Get Container Status (SAC.8)|
+|[getContainerVolume](#sacgetcontainervolume)|Get Container Volume (SAC.21)|
+|[getDilutionFactor](#sacgetdilutionfactor)|Get Dilution Factor (SAC.29)|
+|[getDrugInterference](#sacgetdruginterference)|Get Drug Interference (SAC.41)|
+|[getEquipmentContainerIdentifier](#sacgetequipmentcontaineridentifier)|Get Equipment Container Identifier (SAC.5)|
+|[getExternalAccessionIdentifier](#sacgetexternalaccessionidentifier)|Get External Accession Identifier (SAC.1)|
+|[getFibrinIndex](#sacgetfibrinindex)|Get Fibrin Index (SAC.38)|
+|[getFibrinIndexUnits](#sacgetfibrinindexunits)|Get Fibrin Index Units (SAC.39)|
+|[getHemolysisIndex](#sacgethemolysisindex)|Get Hemolysis Index (SAC.32)|
+|[getHemolysisIndexUnits](#sacgethemolysisindexunits)|Get Hemolysis Index Units (SAC.33)|
+|[getIcterusIndex](#sacgeticterusindex)|Get Icterus Index (SAC.36)|
+|[getIcterusIndexUnits](#sacgeticterusindexunits)|Get Icterus Index Units (SAC.37)|
+|[getInitialSpecimenVolume](#sacgetinitialspecimenvolume)|Get Initial Specimen Volume (SAC.23)|
+|[getLepemiaIndex](#sacgetlepemiaindex)|Get Lepemia Index (SAC.34)|
+|[getLepemiaIndexUnits](#sacgetlepemiaindexunits)|Get Lepemia Index Units (SAC.35)|
+|[getLocation](#sacgetlocation)|Get Location (SAC.15)|
+|[getOtherEnvironmentalFactors](#sacgetotherenvironmentalfactors)|Get Other Environmental Factors (SAC.44)|
+|[getPositionInCarrier](#sacgetpositionincarrier)|Get Position In Carrier (SAC.11)|
+|[getPositionInTray](#sacgetpositionintray)|Get Position In Tray (SAC.14)|
+|[getPrimaryContainerIdentifier](#sacgetprimarycontaineridentifier)|Get Primary Container Identifier (SAC.4)|
+|[getRegistrationDateTime](#sacgetregistrationdatetime)|Get Registration Date Time (SAC.7)|
+|[getSeparatorType](#sacgetseparatortype)|Get Separator Type (SAC.25)|
+|[getSpecialHandlingCode](#sacgetspecialhandlingcode)|Get Special Handling Code (SAC.43)|
+|[getSpecimenComponent](#sacgetspecimencomponent)|Get Specimen Component (SAC.28)|
+|[getSpecimenSource](#sacgetspecimensource)|Get Specimen Source (SAC.6)|
+|[getSystemInducedContaminants](#sacgetsysteminducedcontaminants)|Get System Induced Contaminants (SAC.40)|
+|[getTemperature](#sacgettemperature)|Get Temperature (SAC.31)|
+|[getTrayIdentifier](#sacgettrayidentifier)|Get Tray Identifier (SAC.13)|
+|[getTrayTypeSAC](#sacgettraytypesac)|Get Tray Type SAC (SAC.12)|
+|[getTreatment](#sacgettreatment)|Get Treatment (SAC.30)|
+|[getVolumeUnits](#sacgetvolumeunits)|Get Volume Units (SAC.24)|
|[resetIndex](#sacresetindex)|Reset index of this segment|
-|[setAccessionIdentifier](#sacsetaccessionidentifier)||
-|[setAdditive](#sacsetadditive)||
-|[setArtificialBlood](#sacsetartificialblood)||
-|[setAvailableSpecimenVolume](#sacsetavailablespecimenvolume)||
-|[setBarrierDelta](#sacsetbarrierdelta)||
-|[setBottomDelta](#sacsetbottomdelta)||
-|[setCapType](#sacsetcaptype)||
-|[setCarrierIdentifier](#sacsetcarrieridentifier)||
-|[setCarrierType](#sacsetcarriertype)||
-|[setContainerDiameter](#sacsetcontainerdiameter)||
-|[setContainerHeight](#sacsetcontainerheight)||
-|[setContainerIdentifier](#sacsetcontaineridentifier)||
-|[setContainerSizeUnits](#sacsetcontainersizeunits)||
-|[setContainerStatus](#sacsetcontainerstatus)||
-|[setContainerVolume](#sacsetcontainervolume)||
-|[setDilutionFactor](#sacsetdilutionfactor)||
-|[setDrugInterference](#sacsetdruginterference)||
-|[setEquipmentContainerIdentifier](#sacsetequipmentcontaineridentifier)||
+|[setAccessionIdentifier](#sacsetaccessionidentifier)|Set Accession Identifier (SAC.2)|
+|[setAdditive](#sacsetadditive)|Set Additive (SAC.27)|
+|[setArtificialBlood](#sacsetartificialblood)|Set Artificial Blood (SAC.42)|
+|[setAvailableSpecimenVolume](#sacsetavailablespecimenvolume)|Set Available Specimen Volume (SAC.22)|
+|[setBarrierDelta](#sacsetbarrierdelta)|Set Barrier Delta (SAC.18)|
+|[setBottomDelta](#sacsetbottomdelta)|Set Bottom Delta (SAC.19)|
+|[setCapType](#sacsetcaptype)|Set Cap Type (SAC.26)|
+|[setCarrierIdentifier](#sacsetcarrieridentifier)|Set Carrier Identifier (SAC.10)|
+|[setCarrierType](#sacsetcarriertype)|Set Carrier Type (SAC.9)|
+|[setContainerDiameter](#sacsetcontainerdiameter)|Set Container Diameter (SAC.17)|
+|[setContainerHeight](#sacsetcontainerheight)|Set Container Height (SAC.16)|
+|[setContainerIdentifier](#sacsetcontaineridentifier)|Set Container Identifier (SAC.3)|
+|[setContainerSizeUnits](#sacsetcontainersizeunits)|Set Container Size Units (SAC.20)|
+|[setContainerStatus](#sacsetcontainerstatus)|Set Container Status (SAC.8)|
+|[setContainerVolume](#sacsetcontainervolume)|Set Container Volume (SAC.21)|
+|[setDilutionFactor](#sacsetdilutionfactor)|Set Dilution Factor (SAC.29)|
+|[setDrugInterference](#sacsetdruginterference)|Set Drug Interference (SAC.41)|
+|[setEquipmentContainerIdentifier](#sacsetequipmentcontaineridentifier)|Set Equipment Container Identifier (SAC.5)|
|[setExternalAccessionIdentifier](#sacsetexternalaccessionidentifier)||
-|[setFibrinIndex](#sacsetfibrinindex)||
-|[setFibrinIndexUnits](#sacsetfibrinindexunits)||
-|[setHemolysisIndex](#sacsethemolysisindex)||
-|[setHemolysisIndexUnits](#sacsethemolysisindexunits)||
-|[setIcterusIndex](#sacseticterusindex)||
-|[setIcterusIndexUnits](#sacseticterusindexunits)||
-|[setInitialSpecimenVolume](#sacsetinitialspecimenvolume)||
-|[setLepemiaIndex](#sacsetlepemiaindex)||
-|[setLepemiaIndexUnits](#sacsetlepemiaindexunits)||
-|[setLocation](#sacsetlocation)||
-|[setOtherEnvironmentalFactors](#sacsetotherenvironmentalfactors)||
-|[setPositionInCarrier](#sacsetpositionincarrier)||
-|[setPositionInTray](#sacsetpositionintray)||
-|[setPrimaryContainerIdentifier](#sacsetprimarycontaineridentifier)||
-|[setRegistrationDateTime](#sacsetregistrationdatetime)||
-|[setSeparatorType](#sacsetseparatortype)||
-|[setSpecialHandlingCode](#sacsetspecialhandlingcode)||
-|[setSpecimenComponent](#sacsetspecimencomponent)||
-|[setSpecimenSource](#sacsetspecimensource)||
-|[setSystemInducedContaminants](#sacsetsysteminducedcontaminants)||
-|[setTemperature](#sacsettemperature)||
-|[setTrayIdentifier](#sacsettrayidentifier)||
-|[setTrayTypeSAC](#sacsettraytypesac)||
-|[setTreatment](#sacsettreatment)||
-|[setVolumeUnits](#sacsetvolumeunits)||
+|[setFibrinIndex](#sacsetfibrinindex)|Set Fibrin Index (SAC.38)|
+|[setFibrinIndexUnits](#sacsetfibrinindexunits)|Set Fibrin Index Units (SAC.39)|
+|[setHemolysisIndex](#sacsethemolysisindex)|Set Hemolysis Index (SAC.32)|
+|[setHemolysisIndexUnits](#sacsethemolysisindexunits)|Set Hemolysis Index Units (SAC.33)|
+|[setIcterusIndex](#sacseticterusindex)|Set Icterus Index (SAC.36)|
+|[setIcterusIndexUnits](#sacseticterusindexunits)|Set Icterus Index Units (SAC.37)|
+|[setInitialSpecimenVolume](#sacsetinitialspecimenvolume)|Set Initial Specimen Volume (SAC.23)|
+|[setLepemiaIndex](#sacsetlepemiaindex)|Set Lepemia Index (SAC.34)|
+|[setLepemiaIndexUnits](#sacsetlepemiaindexunits)|Set Lepemia Index Units (SAC.35)|
+|[setLocation](#sacsetlocation)|Set Location (SAC.15)|
+|[setOtherEnvironmentalFactors](#sacsetotherenvironmentalfactors)|Set Other Environmental Factors (SAC.44)|
+|[setPositionInCarrier](#sacsetpositionincarrier)|Set Position In Carrier (SAC.11)|
+|[setPositionInTray](#sacsetpositionintray)|Set Position In Tray (SAC.14)|
+|[setPrimaryContainerIdentifier](#sacsetprimarycontaineridentifier)|Set Primary Container Identifier (SAC.4)|
+|[setRegistrationDateTime](#sacsetregistrationdatetime)|Set Registration Date Time (SAC.7)|
+|[setSeparatorType](#sacsetseparatortype)|Set Separator Type (SAC.25)|
+|[setSpecialHandlingCode](#sacsetspecialhandlingcode)|Set Special Handling Code (SAC.43)|
+|[setSpecimenComponent](#sacsetspecimencomponent)|Set Specimen Component (SAC.28)|
+|[setSpecimenSource](#sacsetspecimensource)|Set Specimen Source (SAC.6)|
+|[setSystemInducedContaminants](#sacsetsysteminducedcontaminants)|Set System Induced Contaminants (SAC.40)|
+|[setTemperature](#sacsettemperature)|Set Temperature (SAC.31)|
+|[setTrayIdentifier](#sacsettrayidentifier)|Set Tray Identifier (SAC.13)|
+|[setTrayTypeSAC](#sacsettraytypesac)|Set Tray Type SAC (SAC.12)|
+|[setTreatment](#sacsettreatment)|Set Treatment (SAC.30)|
+|[setVolumeUnits](#sacsetvolumeunits)|Set Volume Units (SAC.24)|
## Inherited methods
| Name | Description |
|------|-------------|
|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
|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|
@@ -121,20 +122,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getAccessionIdentifier (void)
+public getAccessionIdentifier (int $position)
```
-
+Get Accession Identifier (SAC.2)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -145,20 +149,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getAdditive (void)
+public getAdditive (int $position)
```
-
+Get Additive (SAC.27)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -169,20 +176,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getArtificialBlood (void)
+public getArtificialBlood (int $position)
```
-
+Get Artificial Blood (SAC.42)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -193,20 +203,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getAvailableSpecimenVolume (void)
+public getAvailableSpecimenVolume (int $position)
```
-
+Get Available Specimen Volume (SAC.22)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -217,20 +230,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getBarrierDelta (void)
+public getBarrierDelta (int $position)
```
-
+Get Barrier Delta (SAC.18)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -241,20 +257,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getBottomDelta (void)
+public getBottomDelta (int $position)
```
-
+Get Bottom Delta (SAC.19)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -265,20 +284,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getCapType (void)
+public getCapType (int $position)
```
-
+Get Cap Type (SAC.26)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -289,20 +311,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getCarrierIdentifier (void)
+public getCarrierIdentifier (int $position)
```
-
+Get Carrier Identifier (SAC.10)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -313,20 +338,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getCarrierType (void)
+public getCarrierType (int $position)
```
-
+Get Carrier Type (SAC.9)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -337,20 +365,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerDiameter (void)
+public getContainerDiameter (int $position)
```
-
+Get Container Diameter (SAC.17)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -361,20 +392,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerHeight (void)
+public getContainerHeight (int $position)
```
-
+Get Container Height (SAC.16)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -385,20 +419,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerIdentifier (void)
+public getContainerIdentifier (int $position)
```
-
+Get Container Identifier (SAC.3)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -409,20 +446,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerSizeUnits (void)
+public getContainerSizeUnits (int $position)
```
-
+Get Container Size Units (SAC.20)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -433,20 +473,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerStatus (void)
+public getContainerStatus (int $position)
```
-
+Get Container Status (SAC.8)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -457,20 +500,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getContainerVolume (void)
+public getContainerVolume (int $position)
```
-
+Get Container Volume (SAC.21)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -481,20 +527,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getDilutionFactor (void)
+public getDilutionFactor (int $position)
```
-
+Get Dilution Factor (SAC.29)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -505,20 +554,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getDrugInterference (void)
+public getDrugInterference (int $position)
```
-
+Get Drug Interference (SAC.41)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -529,20 +581,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getEquipmentContainerIdentifier (void)
+public getEquipmentContainerIdentifier (int $position)
```
-
+Get Equipment Container Identifier (SAC.5)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -553,20 +608,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getExternalAccessionIdentifier (void)
+public getExternalAccessionIdentifier (int $position)
```
-
+Get External Accession Identifier (SAC.1)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 1
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -577,20 +635,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getFibrinIndex (void)
+public getFibrinIndex (int $position)
```
-
+Get Fibrin Index (SAC.38)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -601,20 +662,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getFibrinIndexUnits (void)
+public getFibrinIndexUnits (int $position)
```
-
+Get Fibrin Index Units (SAC.39)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -625,20 +689,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getHemolysisIndex (void)
+public getHemolysisIndex (int $position)
```
-
+Get Hemolysis Index (SAC.32)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -649,20 +716,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getHemolysisIndexUnits (void)
+public getHemolysisIndexUnits (int $position)
```
-
+Get Hemolysis Index Units (SAC.33)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 33
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -673,20 +743,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getIcterusIndex (void)
+public getIcterusIndex (int $position)
```
-
+Get Icterus Index (SAC.36)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -697,20 +770,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getIcterusIndexUnits (void)
+public getIcterusIndexUnits (int $position)
```
-
+Get Icterus Index Units (SAC.37)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -721,20 +797,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getInitialSpecimenVolume (void)
+public getInitialSpecimenVolume (int $position)
```
-
+Get Initial Specimen Volume (SAC.23)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -745,20 +824,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getLepemiaIndex (void)
+public getLepemiaIndex (int $position)
```
-
+Get Lepemia Index (SAC.34)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -769,20 +851,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getLepemiaIndexUnits (void)
+public getLepemiaIndexUnits (int $position)
```
-
+Get Lepemia Index Units (SAC.35)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -793,20 +878,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getLocation (void)
+public getLocation (int $position)
```
-
+Get Location (SAC.15)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -817,20 +905,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getOtherEnvironmentalFactors (void)
+public getOtherEnvironmentalFactors (int $position)
```
-
+Get Other Environmental Factors (SAC.44)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 44
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -841,20 +932,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getPositionInCarrier (void)
+public getPositionInCarrier (int $position)
```
-
+Get Position In Carrier (SAC.11)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -865,20 +959,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getPositionInTray (void)
+public getPositionInTray (int $position)
```
-
+Get Position In Tray (SAC.14)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -889,20 +986,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getPrimaryContainerIdentifier (void)
+public getPrimaryContainerIdentifier (int $position)
```
-
+Get Primary Container Identifier (SAC.4)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -913,20 +1013,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getRegistrationDateTime (void)
+public getRegistrationDateTime (int $position)
```
-
+Get Registration Date Time (SAC.7)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -937,20 +1040,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getSeparatorType (void)
+public getSeparatorType (int $position)
```
-
+Get Separator Type (SAC.25)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -961,20 +1067,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getSpecialHandlingCode (void)
+public getSpecialHandlingCode (int $position)
```
-
+Get Special Handling Code (SAC.43)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -985,20 +1094,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getSpecimenComponent (void)
+public getSpecimenComponent (int $position)
```
-
+Get Specimen Component (SAC.28)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1009,20 +1121,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getSpecimenSource (void)
+public getSpecimenSource (int $position)
```
-
+Get Specimen Source (SAC.6)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1033,20 +1148,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getSystemInducedContaminants (void)
+public getSystemInducedContaminants (int $position)
```
-
+Get System Induced Contaminants (SAC.40)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1057,20 +1175,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getTemperature (void)
+public getTemperature (int $position)
```
-
+Get Temperature (SAC.31)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1081,20 +1202,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getTrayIdentifier (void)
+public getTrayIdentifier (int $position)
```
-
+Get Tray Identifier (SAC.13)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1105,20 +1229,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getTrayTypeSAC (void)
+public getTrayTypeSAC (int $position)
```
-
+Get Tray Type SAC (SAC.12)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1129,20 +1256,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getTreatment (void)
+public getTreatment (int $position)
```
-
+Get Treatment (SAC.30)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1153,20 +1283,23 @@ Aranyasen\HL7\Segment
**Description**
```php
- getVolumeUnits (void)
+public getVolumeUnits (int $position)
```
-
+Get Volume Units (SAC.24)
**Parameters**
-`This function has no parameters.`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`array|string|int|null`
+
+
@@ -1177,7 +1310,7 @@ Aranyasen\HL7\Segment
**Description**
```php
-public static resetIndex (int $index)
+public static resetIndex (void)
```
Reset index of this segment
@@ -1186,7 +1319,7 @@ Reset index of this segment
**Parameters**
-* `(int) $index`
+`This function has no parameters.`
**Return Values**
@@ -1201,20 +1334,24 @@ Reset index of this segment
**Description**
```php
- setAccessionIdentifier (void)
+public setAccessionIdentifier (string|int|array|null $value, int $position)
```
-
+Set Accession Identifier (SAC.2)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
**Return Values**
-`void`
+`bool`
+
+
@@ -1225,20 +1362,24 @@ Reset index of this segment
**Description**
```php
- setAdditive (void)
+public setAdditive (string|int|array|null $value, int $position)
```
-
+Set Additive (SAC.27)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 27
**Return Values**
-`void`
+`bool`
+
+
@@ -1249,20 +1390,24 @@ Reset index of this segment
**Description**
```php
- setArtificialBlood (void)
+public setArtificialBlood (string|int|array|null $value, int $position)
```
-
+Set Artificial Blood (SAC.42)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 42
**Return Values**
-`void`
+`bool`
+
+
@@ -1273,20 +1418,24 @@ Reset index of this segment
**Description**
```php
- setAvailableSpecimenVolume (void)
+public setAvailableSpecimenVolume (string|int|array|null $value, int $position)
```
-
+Set Available Specimen Volume (SAC.22)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
**Return Values**
-`void`
+`bool`
+
+
@@ -1297,20 +1446,24 @@ Reset index of this segment
**Description**
```php
- setBarrierDelta (void)
+public setBarrierDelta (string|int|array|null $value, int $position)
```
-
+Set Barrier Delta (SAC.18)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
**Return Values**
-`void`
+`bool`
+
+
@@ -1321,20 +1474,24 @@ Reset index of this segment
**Description**
```php
- setBottomDelta (void)
+public setBottomDelta (string|int|array|null $value, int $position)
```
-
+Set Bottom Delta (SAC.19)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
**Return Values**
-`void`
+`bool`
+
+
@@ -1345,20 +1502,24 @@ Reset index of this segment
**Description**
```php
- setCapType (void)
+public setCapType (string|int|array|null $value, int $position)
```
-
+Set Cap Type (SAC.26)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 26
**Return Values**
-`void`
+`bool`
+
+
@@ -1369,20 +1530,24 @@ Reset index of this segment
**Description**
```php
- setCarrierIdentifier (void)
+public setCarrierIdentifier (string|int|array|null $value, int $position)
```
-
+Set Carrier Identifier (SAC.10)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
**Return Values**
-`void`
+`bool`
+
+
@@ -1393,20 +1558,24 @@ Reset index of this segment
**Description**
```php
- setCarrierType (void)
+public setCarrierType (string|int|array|null $value, int $position)
```
-
+Set Carrier Type (SAC.9)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
**Return Values**
-`void`
+`bool`
+
+
@@ -1417,20 +1586,24 @@ Reset index of this segment
**Description**
```php
- setContainerDiameter (void)
+public setContainerDiameter (string|int|array|null $value, int $position)
```
-
+Set Container Diameter (SAC.17)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
**Return Values**
-`void`
+`bool`
+
+
@@ -1441,20 +1614,24 @@ Reset index of this segment
**Description**
```php
- setContainerHeight (void)
+public setContainerHeight (string|int|array|null $value, int $position)
```
-
+Set Container Height (SAC.16)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
**Return Values**
-`void`
+`bool`
+
+
@@ -1465,20 +1642,24 @@ Reset index of this segment
**Description**
```php
- setContainerIdentifier (void)
+public setContainerIdentifier (string|int|array|null $value, int $position)
```
-
+Set Container Identifier (SAC.3)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
**Return Values**
-`void`
+`bool`
+
+
@@ -1489,20 +1670,24 @@ Reset index of this segment
**Description**
```php
- setContainerSizeUnits (void)
+public setContainerSizeUnits (string|int|array|null $value, int $position)
```
-
+Set Container Size Units (SAC.20)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
**Return Values**
-`void`
+`bool`
+
+
@@ -1513,20 +1698,24 @@ Reset index of this segment
**Description**
```php
- setContainerStatus (void)
+public setContainerStatus (string|int|array|null $value, int $position)
```
-
+Set Container Status (SAC.8)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
**Return Values**
-`void`
+`bool`
+
+
@@ -1537,20 +1726,24 @@ Reset index of this segment
**Description**
```php
- setContainerVolume (void)
+public setContainerVolume (string|int|array|null $value, int $position)
```
-
+Set Container Volume (SAC.21)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
**Return Values**
-`void`
+`bool`
+
+
@@ -1561,20 +1754,24 @@ Reset index of this segment
**Description**
```php
- setDilutionFactor (void)
+public setDilutionFactor (string|int|array|null $value, int $position)
```
-
+Set Dilution Factor (SAC.29)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 29
**Return Values**
-`void`
+`bool`
+
+
@@ -1585,20 +1782,24 @@ Reset index of this segment
**Description**
```php
- setDrugInterference (void)
+public setDrugInterference (string|int|array|null $value, int $position)
```
-
+Set Drug Interference (SAC.41)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 41
**Return Values**
-`void`
+`bool`
+
+
@@ -1609,20 +1810,24 @@ Reset index of this segment
**Description**
```php
- setEquipmentContainerIdentifier (void)
+public setEquipmentContainerIdentifier (string|int|array|null $value, int $position)
```
-
+Set Equipment Container Identifier (SAC.5)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
**Return Values**
-`void`
+`bool`
+
+
@@ -1657,20 +1862,24 @@ Reset index of this segment
**Description**
```php
- setFibrinIndex (void)
+public setFibrinIndex (string|int|array|null $value, int $position)
```
-
+Set Fibrin Index (SAC.38)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 38
**Return Values**
-`void`
+`bool`
+
+
@@ -1681,20 +1890,24 @@ Reset index of this segment
**Description**
```php
- setFibrinIndexUnits (void)
+public setFibrinIndexUnits (string|int|array|null $value, int $position)
```
-
+Set Fibrin Index Units (SAC.39)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 39
**Return Values**
-`void`
+`bool`
+
+
@@ -1705,20 +1918,24 @@ Reset index of this segment
**Description**
```php
- setHemolysisIndex (void)
+public setHemolysisIndex (string|int|array|null $value, int $position)
```
-
+Set Hemolysis Index (SAC.32)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 32
**Return Values**
-`void`
+`bool`
+
+
@@ -1729,20 +1946,24 @@ Reset index of this segment
**Description**
```php
- setHemolysisIndexUnits (void)
+public setHemolysisIndexUnits (string|int|array|null $value, int $position)
```
-
+Set Hemolysis Index Units (SAC.33)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 33
**Return Values**
-`void`
+`bool`
+
+
@@ -1753,20 +1974,24 @@ Reset index of this segment
**Description**
```php
- setIcterusIndex (void)
+public setIcterusIndex (string|int|array|null $value, int $position)
```
-
+Set Icterus Index (SAC.36)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 36
**Return Values**
-`void`
+`bool`
+
+
@@ -1777,20 +2002,24 @@ Reset index of this segment
**Description**
```php
- setIcterusIndexUnits (void)
+public setIcterusIndexUnits (string|int|array|null $value, int $position)
```
-
+Set Icterus Index Units (SAC.37)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 37
**Return Values**
-`void`
+`bool`
+
+
@@ -1801,20 +2030,24 @@ Reset index of this segment
**Description**
```php
- setInitialSpecimenVolume (void)
+public setInitialSpecimenVolume (string|int|array|null $value, int $position)
```
-
+Set Initial Specimen Volume (SAC.23)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
**Return Values**
-`void`
+`bool`
+
+
@@ -1825,20 +2058,24 @@ Reset index of this segment
**Description**
```php
- setLepemiaIndex (void)
+public setLepemiaIndex (string|int|array|null $value, int $position)
```
-
+Set Lepemia Index (SAC.34)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 34
**Return Values**
-`void`
+`bool`
+
+
@@ -1849,20 +2086,24 @@ Reset index of this segment
**Description**
```php
- setLepemiaIndexUnits (void)
+public setLepemiaIndexUnits (string|int|array|null $value, int $position)
```
-
+Set Lepemia Index Units (SAC.35)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 35
**Return Values**
-`void`
+`bool`
+
+
@@ -1873,20 +2114,24 @@ Reset index of this segment
**Description**
```php
- setLocation (void)
+public setLocation (string|int|array|null $value, int $position)
```
-
+Set Location (SAC.15)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
**Return Values**
-`void`
+`bool`
+
+
@@ -1897,20 +2142,24 @@ Reset index of this segment
**Description**
```php
- setOtherEnvironmentalFactors (void)
+public setOtherEnvironmentalFactors (string|int|array|null $value, int $position)
```
-
+Set Other Environmental Factors (SAC.44)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 44
**Return Values**
-`void`
+`bool`
+
+
@@ -1921,20 +2170,24 @@ Reset index of this segment
**Description**
```php
- setPositionInCarrier (void)
+public setPositionInCarrier (string|int|array|null $value, int $position)
```
-
+Set Position In Carrier (SAC.11)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
**Return Values**
-`void`
+`bool`
+
+
@@ -1945,20 +2198,24 @@ Reset index of this segment
**Description**
```php
- setPositionInTray (void)
+public setPositionInTray (string|int|array|null $value, int $position)
```
-
+Set Position In Tray (SAC.14)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
**Return Values**
-`void`
+`bool`
+
+
@@ -1969,20 +2226,24 @@ Reset index of this segment
**Description**
```php
- setPrimaryContainerIdentifier (void)
+public setPrimaryContainerIdentifier (string|int|array|null $value, int $position)
```
-
+Set Primary Container Identifier (SAC.4)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
**Return Values**
-`void`
+`bool`
+
+
@@ -1993,20 +2254,24 @@ Reset index of this segment
**Description**
```php
- setRegistrationDateTime (void)
+public setRegistrationDateTime (string|int|array|null $value, int $position)
```
-
+Set Registration Date Time (SAC.7)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
**Return Values**
-`void`
+`bool`
+
+
@@ -2017,20 +2282,24 @@ Reset index of this segment
**Description**
```php
- setSeparatorType (void)
+public setSeparatorType (string|int|array|null $value, int $position)
```
-
+Set Separator Type (SAC.25)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
**Return Values**
-`void`
+`bool`
+
+
@@ -2041,20 +2310,24 @@ Reset index of this segment
**Description**
```php
- setSpecialHandlingCode (void)
+public setSpecialHandlingCode (string|int|array|null $value, int $position)
```
-
+Set Special Handling Code (SAC.43)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 43
**Return Values**
-`void`
+`bool`
+
+
@@ -2065,20 +2338,24 @@ Reset index of this segment
**Description**
```php
- setSpecimenComponent (void)
+public setSpecimenComponent (string|int|array|null $value, int $position)
```
-
+Set Specimen Component (SAC.28)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 28
**Return Values**
-`void`
+`bool`
+
+
@@ -2089,20 +2366,24 @@ Reset index of this segment
**Description**
```php
- setSpecimenSource (void)
+public setSpecimenSource (string|int|array|null $value, int $position)
```
-
+Set Specimen Source (SAC.6)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
**Return Values**
-`void`
+`bool`
+
+
@@ -2113,20 +2394,24 @@ Reset index of this segment
**Description**
```php
- setSystemInducedContaminants (void)
+public setSystemInducedContaminants (string|int|array|null $value, int $position)
```
-
+Set System Induced Contaminants (SAC.40)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 40
**Return Values**
-`void`
+`bool`
+
+
@@ -2137,20 +2422,24 @@ Reset index of this segment
**Description**
```php
- setTemperature (void)
+public setTemperature (string|int|array|null $value, int $position)
```
-
+Set Temperature (SAC.31)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 31
**Return Values**
-`void`
+`bool`
+
+
@@ -2161,20 +2450,24 @@ Reset index of this segment
**Description**
```php
- setTrayIdentifier (void)
+public setTrayIdentifier (string|int|array|null $value, int $position)
```
-
+Set Tray Identifier (SAC.13)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
**Return Values**
-`void`
+`bool`
+
+
@@ -2185,20 +2478,24 @@ Reset index of this segment
**Description**
```php
- setTrayTypeSAC (void)
+public setTrayTypeSAC (string|int|array|null $value, int $position)
```
-
+Set Tray Type SAC (SAC.12)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
**Return Values**
-`void`
+`bool`
+
+
@@ -2209,20 +2506,24 @@ Reset index of this segment
**Description**
```php
- setTreatment (void)
+public setTreatment (string|int|array|null $value, int $position)
```
-
+Set Treatment (SAC.30)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 30
**Return Values**
-`void`
+`bool`
+
+
@@ -2233,20 +2534,24 @@ Reset index of this segment
**Description**
```php
- setVolumeUnits (void)
+public setVolumeUnits (string|int|array|null $value, int $position)
```
-
+Set Volume Units (SAC.24)
**Parameters**
-`This function has no parameters.`
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
**Return Values**
-`void`
+`bool`
+
+
diff --git a/docs/Segments/SCH.md b/docs/Segments/SCH.md
new file mode 100644
index 0000000..c698f23
--- /dev/null
+++ b/docs/Segments/SCH.md
@@ -0,0 +1,1455 @@
+# Aranyasen\HL7\Segments\SCH
+
+SCH segment class
+Ref: https://corepointhealth.com/resource-center/hl7-resources/hl7-siu-message
+http://hl7-definition.caristix.com:9010/HL7%20v2.3.1/segment/SCH
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getAppointmentDuration](#schgetappointmentduration)|Get Appointment Duration (SCH.9)|
+|[getAppointmentDurationUnits](#schgetappointmentdurationunits)|Get Appointment Duration Units (SCH.10)|
+|[getAppointmentReason](#schgetappointmentreason)|Get Appointment Reason (SCH.7)|
+|[getAppointmentTimingQuantity](#schgetappointmenttimingquantity)|Get Appointment Timing Quantity (SCH.11)|
+|[getAppointmentType](#schgetappointmenttype)|Get Appointment Type (SCH.8)|
+|[getEnteredbyLocation](#schgetenteredbylocation)|Get Enteredby Location (SCH.22)|
+|[getEnteredbyPerson](#schgetenteredbyperson)|Get Enteredby Person (SCH.20)|
+|[getEnteredbyPhoneNumber](#schgetenteredbyphonenumber)|Get Enteredby Phone Number (SCH.21)|
+|[getEventReason](#schgeteventreason)|Get Event Reason (SCH.6)|
+|[getFillerAppointmentID](#schgetfillerappointmentid)|Get Filler Appointment ID (SCH.2)|
+|[getFillerContactAddress](#schgetfillercontactaddress)|Get Filler Contact Address (SCH.18)|
+|[getFillerContactLocation](#schgetfillercontactlocation)|Get Filler Contact Location (SCH.19)|
+|[getFillerContactPerson](#schgetfillercontactperson)|Get Filler Contact Person (SCH.16)|
+|[getFillerContactPhoneNumber](#schgetfillercontactphonenumber)|Get Filler Contact Phone Number (SCH.17)|
+|[getFillerStatusCode](#schgetfillerstatuscode)|Get Filler Status Code (SCH.25)|
+|[getOccurrenceNumber](#schgetoccurrencenumber)|Get Occurrence Number (SCH.3)|
+|[getParentFillerAppointmentID](#schgetparentfillerappointmentid)|Get Parent Filler Appointment ID (SCH.24)|
+|[getParentPlacerAppointmentID](#schgetparentplacerappointmentid)|Get Parent Placer Appointment ID (SCH.23)|
+|[getPlacerAppointmentID](#schgetplacerappointmentid)|Get Placer Appointment ID (SCH.1)|
+|[getPlacerContactAddress](#schgetplacercontactaddress)|Get Placer Contact Address (SCH.14)|
+|[getPlacerContactLocation](#schgetplacercontactlocation)|Get Placer Contact Location (SCH.15)|
+|[getPlacerContactPerson](#schgetplacercontactperson)|Get Placer Contact Person (SCH.12)|
+|[getPlacerContactPhoneNumber](#schgetplacercontactphonenumber)|Get Placer Contact Phone Number (SCH.13)|
+|[getPlacerGroupNumber](#schgetplacergroupnumber)|Get Placer Group Number (SCH.4)|
+|[getScheduleID](#schgetscheduleid)|Get Schedule ID (SCH.5)|
+|[setAppointmentDuration](#schsetappointmentduration)|Set Appointment Duration (SCH.9)|
+|[setAppointmentDurationUnits](#schsetappointmentdurationunits)|Set Appointment Duration Units (SCH.10)|
+|[setAppointmentReason](#schsetappointmentreason)|Set Appointment Reason (SCH.7)|
+|[setAppointmentTimingQuantity](#schsetappointmenttimingquantity)|Set Appointment Timing Quantity (SCH.11)|
+|[setAppointmentType](#schsetappointmenttype)|Set Appointment Type (SCH.8)|
+|[setEnteredbyLocation](#schsetenteredbylocation)|Set Enteredby Location (SCH.22)|
+|[setEnteredbyPerson](#schsetenteredbyperson)|Set Enteredby Person (SCH.20)|
+|[setEnteredbyPhoneNumber](#schsetenteredbyphonenumber)|Set Enteredby Phone Number (SCH.21)|
+|[setEventReason](#schseteventreason)|Set Event Reason (SCH.6)|
+|[setFillerAppointmentID](#schsetfillerappointmentid)|Set Filler Appointment ID (SCH.2)|
+|[setFillerContactAddress](#schsetfillercontactaddress)|Set Filler Contact Address (SCH.18)|
+|[setFillerContactLocation](#schsetfillercontactlocation)|Set Filler Contact Location (SCH.19)|
+|[setFillerContactPerson](#schsetfillercontactperson)|Set Filler Contact Person (SCH.16)|
+|[setFillerContactPhoneNumber](#schsetfillercontactphonenumber)|Set Filler Contact Phone Number (SCH.17)|
+|[setFillerStatusCode](#schsetfillerstatuscode)|Set Filler Status Code (SCH.25)|
+|[setOccurrenceNumber](#schsetoccurrencenumber)|Set Occurrence Number (SCH.3)|
+|[setParentFillerAppointmentID](#schsetparentfillerappointmentid)|Set Parent Filler Appointment ID (SCH.24)|
+|[setParentPlacerAppointmentID](#schsetparentplacerappointmentid)|Set Parent Placer Appointment ID (SCH.23)|
+|[setPlacerAppointmentID](#schsetplacerappointmentid)|Set Placer Appointment ID (SCH.1)|
+|[setPlacerContactAddress](#schsetplacercontactaddress)|Set Placer Contact Address (SCH.14)|
+|[setPlacerContactLocation](#schsetplacercontactlocation)|Set Placer Contact Location (SCH.15)|
+|[setPlacerContactPerson](#schsetplacercontactperson)|Set Placer Contact Person (SCH.12)|
+|[setPlacerContactPhoneNumber](#schsetplacercontactphonenumber)|Set Placer Contact Phone Number (SCH.13)|
+|[setPlacerGroupNumber](#schsetplacergroupnumber)|Set Placer Group Number (SCH.4)|
+|[setScheduleID](#schsetscheduleid)|Set Schedule ID (SCH.5)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### SCH::getAppointmentDuration
+
+**Description**
+
+```php
+public getAppointmentDuration (int $position)
+```
+
+Get Appointment Duration (SCH.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getAppointmentDurationUnits
+
+**Description**
+
+```php
+public getAppointmentDurationUnits (int $position)
+```
+
+Get Appointment Duration Units (SCH.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getAppointmentReason
+
+**Description**
+
+```php
+public getAppointmentReason (int $position)
+```
+
+Get Appointment Reason (SCH.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getAppointmentTimingQuantity
+
+**Description**
+
+```php
+public getAppointmentTimingQuantity (int $position)
+```
+
+Get Appointment Timing Quantity (SCH.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getAppointmentType
+
+**Description**
+
+```php
+public getAppointmentType (int $position)
+```
+
+Get Appointment Type (SCH.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getEnteredbyLocation
+
+**Description**
+
+```php
+public getEnteredbyLocation (int $position)
+```
+
+Get Enteredby Location (SCH.22)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getEnteredbyPerson
+
+**Description**
+
+```php
+public getEnteredbyPerson (int $position)
+```
+
+Get Enteredby Person (SCH.20)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getEnteredbyPhoneNumber
+
+**Description**
+
+```php
+public getEnteredbyPhoneNumber (int $position)
+```
+
+Get Enteredby Phone Number (SCH.21)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getEventReason
+
+**Description**
+
+```php
+public getEventReason (int $position)
+```
+
+Get Event Reason (SCH.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerAppointmentID
+
+**Description**
+
+```php
+public getFillerAppointmentID (int $position)
+```
+
+Get Filler Appointment ID (SCH.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerContactAddress
+
+**Description**
+
+```php
+public getFillerContactAddress (int $position)
+```
+
+Get Filler Contact Address (SCH.18)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerContactLocation
+
+**Description**
+
+```php
+public getFillerContactLocation (int $position)
+```
+
+Get Filler Contact Location (SCH.19)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerContactPerson
+
+**Description**
+
+```php
+public getFillerContactPerson (int $position)
+```
+
+Get Filler Contact Person (SCH.16)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerContactPhoneNumber
+
+**Description**
+
+```php
+public getFillerContactPhoneNumber (int $position)
+```
+
+Get Filler Contact Phone Number (SCH.17)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getFillerStatusCode
+
+**Description**
+
+```php
+public getFillerStatusCode (int $position)
+```
+
+Get Filler Status Code (SCH.25)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getOccurrenceNumber
+
+**Description**
+
+```php
+public getOccurrenceNumber (int $position)
+```
+
+Get Occurrence Number (SCH.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getParentFillerAppointmentID
+
+**Description**
+
+```php
+public getParentFillerAppointmentID (int $position)
+```
+
+Get Parent Filler Appointment ID (SCH.24)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getParentPlacerAppointmentID
+
+**Description**
+
+```php
+public getParentPlacerAppointmentID (int $position)
+```
+
+Get Parent Placer Appointment ID (SCH.23)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerAppointmentID
+
+**Description**
+
+```php
+public getPlacerAppointmentID (int $position)
+```
+
+Get Placer Appointment ID (SCH.1)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerContactAddress
+
+**Description**
+
+```php
+public getPlacerContactAddress (int $position)
+```
+
+Get Placer Contact Address (SCH.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerContactLocation
+
+**Description**
+
+```php
+public getPlacerContactLocation (int $position)
+```
+
+Get Placer Contact Location (SCH.15)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerContactPerson
+
+**Description**
+
+```php
+public getPlacerContactPerson (int $position)
+```
+
+Get Placer Contact Person (SCH.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerContactPhoneNumber
+
+**Description**
+
+```php
+public getPlacerContactPhoneNumber (int $position)
+```
+
+Get Placer Contact Phone Number (SCH.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getPlacerGroupNumber
+
+**Description**
+
+```php
+public getPlacerGroupNumber (int $position)
+```
+
+Get Placer Group Number (SCH.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::getScheduleID
+
+**Description**
+
+```php
+public getScheduleID (int $position)
+```
+
+Get Schedule ID (SCH.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### SCH::setAppointmentDuration
+
+**Description**
+
+```php
+public setAppointmentDuration (string|int|array|null $value, int $position)
+```
+
+Set Appointment Duration (SCH.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setAppointmentDurationUnits
+
+**Description**
+
+```php
+public setAppointmentDurationUnits (string|int|array|null $value, int $position)
+```
+
+Set Appointment Duration Units (SCH.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setAppointmentReason
+
+**Description**
+
+```php
+public setAppointmentReason (string|int|array|null $value, int $position)
+```
+
+Set Appointment Reason (SCH.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setAppointmentTimingQuantity
+
+**Description**
+
+```php
+public setAppointmentTimingQuantity (string|int|array|null $value, int $position)
+```
+
+Set Appointment Timing Quantity (SCH.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setAppointmentType
+
+**Description**
+
+```php
+public setAppointmentType (string|int|array|null $value, int $position)
+```
+
+Set Appointment Type (SCH.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setEnteredbyLocation
+
+**Description**
+
+```php
+public setEnteredbyLocation (string|int|array|null $value, int $position)
+```
+
+Set Enteredby Location (SCH.22)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 22
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setEnteredbyPerson
+
+**Description**
+
+```php
+public setEnteredbyPerson (string|int|array|null $value, int $position)
+```
+
+Set Enteredby Person (SCH.20)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 20
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setEnteredbyPhoneNumber
+
+**Description**
+
+```php
+public setEnteredbyPhoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Enteredby Phone Number (SCH.21)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 21
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setEventReason
+
+**Description**
+
+```php
+public setEventReason (string|int|array|null $value, int $position)
+```
+
+Set Event Reason (SCH.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerAppointmentID
+
+**Description**
+
+```php
+public setFillerAppointmentID (string|int|array|null $value, int $position)
+```
+
+Set Filler Appointment ID (SCH.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerContactAddress
+
+**Description**
+
+```php
+public setFillerContactAddress (string|int|array|null $value, int $position)
+```
+
+Set Filler Contact Address (SCH.18)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 18
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerContactLocation
+
+**Description**
+
+```php
+public setFillerContactLocation (string|int|array|null $value, int $position)
+```
+
+Set Filler Contact Location (SCH.19)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 19
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerContactPerson
+
+**Description**
+
+```php
+public setFillerContactPerson (string|int|array|null $value, int $position)
+```
+
+Set Filler Contact Person (SCH.16)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 16
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerContactPhoneNumber
+
+**Description**
+
+```php
+public setFillerContactPhoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Filler Contact Phone Number (SCH.17)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 17
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setFillerStatusCode
+
+**Description**
+
+```php
+public setFillerStatusCode (string|int|array|null $value, int $position)
+```
+
+Set Filler Status Code (SCH.25)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 25
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setOccurrenceNumber
+
+**Description**
+
+```php
+public setOccurrenceNumber (string|int|array|null $value, int $position)
+```
+
+Set Occurrence Number (SCH.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setParentFillerAppointmentID
+
+**Description**
+
+```php
+public setParentFillerAppointmentID (string|int|array|null $value, int $position)
+```
+
+Set Parent Filler Appointment ID (SCH.24)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 24
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setParentPlacerAppointmentID
+
+**Description**
+
+```php
+public setParentPlacerAppointmentID (string|int|array|null $value, int $position)
+```
+
+Set Parent Placer Appointment ID (SCH.23)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 23
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerAppointmentID
+
+**Description**
+
+```php
+public setPlacerAppointmentID (string|int|array|null $value, int $position)
+```
+
+Set Placer Appointment ID (SCH.1)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 1
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerContactAddress
+
+**Description**
+
+```php
+public setPlacerContactAddress (string|int|array|null $value, int $position)
+```
+
+Set Placer Contact Address (SCH.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerContactLocation
+
+**Description**
+
+```php
+public setPlacerContactLocation (string|int|array|null $value, int $position)
+```
+
+Set Placer Contact Location (SCH.15)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 15
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerContactPerson
+
+**Description**
+
+```php
+public setPlacerContactPerson (string|int|array|null $value, int $position)
+```
+
+Set Placer Contact Person (SCH.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerContactPhoneNumber
+
+**Description**
+
+```php
+public setPlacerContactPhoneNumber (string|int|array|null $value, int $position)
+```
+
+Set Placer Contact Phone Number (SCH.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setPlacerGroupNumber
+
+**Description**
+
+```php
+public setPlacerGroupNumber (string|int|array|null $value, int $position)
+```
+
+Set Placer Group Number (SCH.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### SCH::setScheduleID
+
+**Description**
+
+```php
+public setScheduleID (string|int|array|null $value, int $position)
+```
+
+Set Schedule ID (SCH.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/docs/Segments/TQ1.md b/docs/Segments/TQ1.md
new file mode 100644
index 0000000..0a967a5
--- /dev/null
+++ b/docs/Segments/TQ1.md
@@ -0,0 +1,820 @@
+# Aranyasen\HL7\Segments\TQ1
+
+TQ1 segment class
+Ref: http://hl7-definition.caristix.com:9010/HL7%20v2.5.1/dataType/Default.aspx?version=HL7+v2.5.1&dataType=TQ1
+
+
+
+## Extend:
+
+Aranyasen\HL7\Segment
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[getConditionText](#tq1getconditiontext)|Get Condition Text (TQ1.10)|
+|[getConjunction](#tq1getconjunction)|Get Conjunction (TQ1.12)|
+|[getEndDateTime](#tq1getenddatetime)|Get End Date Time (TQ1.8)|
+|[getExplicitTime](#tq1getexplicittime)|Get Explicit Time (TQ1.4)|
+|[getOccurrenceDuration](#tq1getoccurrenceduration)|Get Occurrence Duration (TQ1.13)|
+|[getPriority](#tq1getpriority)|Get Priority (TQ1.9)|
+|[getQuantity](#tq1getquantity)|Get Quantity (TQ1.2)|
+|[getRelativeTimeAndUnits](#tq1getrelativetimeandunits)|Get Relative Time And Units (TQ1.5)|
+|[getRepeatPattern](#tq1getrepeatpattern)|Get Repeat Pattern (TQ1.3)|
+|[getServiceDuration](#tq1getserviceduration)|Get Service Duration (TQ1.6)|
+|[getSetIdTQ1](#tq1getsetidtq1)||
+|[getStartDateTime](#tq1getstartdatetime)|Get Start Date Time (TQ1.7)|
+|[getTextInstruction](#tq1gettextinstruction)|Get Text Instruction (TQ1.11)|
+|[getTotalOccurrences](#tq1gettotaloccurrences)|Get Total Occurrences (TQ1.14)|
+|[setConditionText](#tq1setconditiontext)|Set Condition Text (TQ1.10)|
+|[setConjunction](#tq1setconjunction)|Set Conjunction (TQ1.12)|
+|[setEndDateTime](#tq1setenddatetime)|Set End Date Time (TQ1.8)|
+|[setExplicitTime](#tq1setexplicittime)|Set Explicit Time (TQ1.4)|
+|[setOccurrenceDuration](#tq1setoccurrenceduration)|Set Occurrence Duration (TQ1.13)|
+|[setPriority](#tq1setpriority)|Set Priority (TQ1.9)|
+|[setQuantity](#tq1setquantity)|Set Quantity (TQ1.2)|
+|[setRelativeTimeAndUnits](#tq1setrelativetimeandunits)|Set Relative Time And Units (TQ1.5)|
+|[setRepeatPattern](#tq1setrepeatpattern)|Set Repeat Pattern (TQ1.3)|
+|[setServiceDuration](#tq1setserviceduration)|Set Service Duration (TQ1.6)|
+|[setSetIdTQ1](#tq1setsetidtq1)||
+|[setStartDateTime](#tq1setstartdatetime)|Set Start Date Time (TQ1.7)|
+|[setTextInstruction](#tq1settextinstruction)|Set Text Instruction (TQ1.11)|
+|[setTotalOccurrences](#tq1settotaloccurrences)|Set Total Occurrences (TQ1.14)|
+
+## Inherited methods
+
+| Name | Description |
+|------|-------------|
+|__construct|Create a segment.|
+|clearField|Remove any existing value from the field|
+|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|
+
+
+
+### TQ1::getConditionText
+
+**Description**
+
+```php
+public getConditionText (int $position)
+```
+
+Get Condition Text (TQ1.10)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getConjunction
+
+**Description**
+
+```php
+public getConjunction (int $position)
+```
+
+Get Conjunction (TQ1.12)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getEndDateTime
+
+**Description**
+
+```php
+public getEndDateTime (int $position)
+```
+
+Get End Date Time (TQ1.8)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getExplicitTime
+
+**Description**
+
+```php
+public getExplicitTime (int $position)
+```
+
+Get Explicit Time (TQ1.4)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getOccurrenceDuration
+
+**Description**
+
+```php
+public getOccurrenceDuration (int $position)
+```
+
+Get Occurrence Duration (TQ1.13)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getPriority
+
+**Description**
+
+```php
+public getPriority (int $position)
+```
+
+Get Priority (TQ1.9)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getQuantity
+
+**Description**
+
+```php
+public getQuantity (int $position)
+```
+
+Get Quantity (TQ1.2)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getRelativeTimeAndUnits
+
+**Description**
+
+```php
+public getRelativeTimeAndUnits (int $position)
+```
+
+Get Relative Time And Units (TQ1.5)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getRepeatPattern
+
+**Description**
+
+```php
+public getRepeatPattern (int $position)
+```
+
+Get Repeat Pattern (TQ1.3)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getServiceDuration
+
+**Description**
+
+```php
+public getServiceDuration (int $position)
+```
+
+Get Service Duration (TQ1.6)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getSetIdTQ1
+
+**Description**
+
+```php
+ getSetIdTQ1 (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### TQ1::getStartDateTime
+
+**Description**
+
+```php
+public getStartDateTime (int $position)
+```
+
+Get Start Date Time (TQ1.7)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getTextInstruction
+
+**Description**
+
+```php
+public getTextInstruction (int $position)
+```
+
+Get Text Instruction (TQ1.11)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::getTotalOccurrences
+
+**Description**
+
+```php
+public getTotalOccurrences (int $position)
+```
+
+Get Total Occurrences (TQ1.14)
+
+
+
+**Parameters**
+
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`array|string|int|null`
+
+
+
+
+
+
+
+### TQ1::setConditionText
+
+**Description**
+
+```php
+public setConditionText (string|int|array|null $value, int $position)
+```
+
+Set Condition Text (TQ1.10)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 10
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setConjunction
+
+**Description**
+
+```php
+public setConjunction (string|int|array|null $value, int $position)
+```
+
+Set Conjunction (TQ1.12)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 12
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setEndDateTime
+
+**Description**
+
+```php
+public setEndDateTime (string|int|array|null $value, int $position)
+```
+
+Set End Date Time (TQ1.8)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 8
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setExplicitTime
+
+**Description**
+
+```php
+public setExplicitTime (string|int|array|null $value, int $position)
+```
+
+Set Explicit Time (TQ1.4)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 4
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setOccurrenceDuration
+
+**Description**
+
+```php
+public setOccurrenceDuration (string|int|array|null $value, int $position)
+```
+
+Set Occurrence Duration (TQ1.13)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 13
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setPriority
+
+**Description**
+
+```php
+public setPriority (string|int|array|null $value, int $position)
+```
+
+Set Priority (TQ1.9)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 9
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setQuantity
+
+**Description**
+
+```php
+public setQuantity (string|int|array|null $value, int $position)
+```
+
+Set Quantity (TQ1.2)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 2
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setRelativeTimeAndUnits
+
+**Description**
+
+```php
+public setRelativeTimeAndUnits (string|int|array|null $value, int $position)
+```
+
+Set Relative Time And Units (TQ1.5)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 5
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setRepeatPattern
+
+**Description**
+
+```php
+public setRepeatPattern (string|int|array|null $value, int $position)
+```
+
+Set Repeat Pattern (TQ1.3)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 3
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setServiceDuration
+
+**Description**
+
+```php
+public setServiceDuration (string|int|array|null $value, int $position)
+```
+
+Set Service Duration (TQ1.6)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 6
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setSetIdTQ1
+
+**Description**
+
+```php
+ setSetIdTQ1 (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+
+
+
+### TQ1::setStartDateTime
+
+**Description**
+
+```php
+public setStartDateTime (string|int|array|null $value, int $position)
+```
+
+Set Start Date Time (TQ1.7)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 7
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setTextInstruction
+
+**Description**
+
+```php
+public setTextInstruction (string|int|array|null $value, int $position)
+```
+
+Set Text Instruction (TQ1.11)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 11
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
+
+### TQ1::setTotalOccurrences
+
+**Description**
+
+```php
+public setTotalOccurrences (string|int|array|null $value, int $position)
+```
+
+Set Total Occurrences (TQ1.14)
+
+
+
+**Parameters**
+
+* `(string|int|array|null) $value`
+* `(int) $position`
+: Defaults to 14
+
+**Return Values**
+
+`bool`
+
+
+
+
+
+
diff --git a/src/HL7/Segments/AIG.php b/src/HL7/Segments/AIG.php
index e789340..741cb82 100644
--- a/src/HL7/Segments/AIG.php
+++ b/src/HL7/Segments/AIG.php
@@ -45,141 +45,379 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (AIG.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Segment Action Code (AIG.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setSegmentActionCode($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource ID (AIG.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setResourceID($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Type (AIG.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setResourceType($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Group (AIG.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setResourceGroup($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Quantity (AIG.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setResourceQuantity($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Quantity Units (AIG.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setResourceQuantityUnits($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time (AIG.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setStartDateTime($value, int $position = 8): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset (AIG.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffset($value, int $position = 9): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset Units (AIG.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffsetUnits($value, int $position = 10): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration (AIG.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setDuration($value, int $position = 11): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration Units (AIG.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setDurationUnits($value, int $position = 12): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Allow Substitution Code (AIG.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setAllowSubstitutionCode($value, int $position = 13): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Status Code (AIG.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setFillerStatusCode($value, int $position = 14): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (AIG.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Segment Action Code (AIG.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSegmentActionCode(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Resource ID (AIG.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceID(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Type (AIG.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceType(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Group (AIG.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceGroup(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Quantity (AIG.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceQuantity(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Quantity Units (AIG.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceQuantityUnits(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time (AIG.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTime(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset (AIG.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffset(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset Units (AIG.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffsetUnits(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Duration (AIG.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDuration(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Duration Units (AIG.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDurationUnits(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Allow Substitution Code (AIG.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAllowSubstitutionCode(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Status Code (AIG.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerStatusCode(int $position = 14)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/AIL.php b/src/HL7/Segments/AIL.php
index bb5907d..327028d 100644
--- a/src/HL7/Segments/AIL.php
+++ b/src/HL7/Segments/AIL.php
@@ -46,121 +46,325 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (AIL.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Segment Action Code (AIL.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setSegmentActionCode($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Location Resource ID (AIL.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setLocationResourceID($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Location Type AIL (AIL.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setLocationTypeAIL($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Location Group (AIL.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setLocationGroup($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time (AIL.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setStartDateTime($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset (AIL.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffset($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset Units (AIL.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffsetUnits($value, int $position = 8): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration (AIL.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setDuration($value, int $position = 9): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration Units (AIL.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setDurationUnits($value, int $position = 10): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Allow Substitution Code (AIL.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setAllowSubstitutionCode($value, int $position = 11): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Status Code (AIL.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setFillerStatusCode($value, int $position = 12): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (AIL.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Segment Action Code (AIL.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSegmentActionCode(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Location Resource ID (AIL.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLocationResourceID(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Location Type AIL (AIL.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLocationTypeAIL(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Location Group (AIL.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLocationGroup(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time (AIL.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTime(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset (AIL.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffset(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset Units (AIL.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffsetUnits(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Duration (AIL.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDuration(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Duration Units (AIL.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDurationUnits(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Allow Substitution Code (AIL.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAllowSubstitutionCode(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Status Code (AIL.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerStatusCode(int $position = 12)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/AIP.php b/src/HL7/Segments/AIP.php
index facc15d..3b13f33 100644
--- a/src/HL7/Segments/AIP.php
+++ b/src/HL7/Segments/AIP.php
@@ -46,121 +46,325 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (AIP.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Segment Action Code (AIP.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setSegmentActionCode($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Personnel Resource ID (AIP.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setPersonnelResourceID($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Type (AIP.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setResourceType($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Group (AIP.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setResourceGroup($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time (AIP.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setStartDateTime($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset (AIP.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffset($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time Offset Units (AIP.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setStartDateTimeOffsetUnits($value, int $position = 8): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration (AIP.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setDuration($value, int $position = 9): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Duration Units (AIP.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setDurationUnits($value, int $position = 10): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Allow Substitution Code (AIP.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setAllowSubstitutionCode($value, int $position = 11): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Status Code (AIP.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setFillerStatusCode($value, int $position = 12): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (AIP.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Segment Action Code (AIP.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSegmentActionCode(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Personnel Resource ID (AIP.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPersonnelResourceID(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Type (AIP.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceType(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Group (AIP.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceGroup(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time (AIP.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTime(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset (AIP.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffset(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time Offset Units (AIP.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTimeOffsetUnits(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Duration (AIP.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDuration(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Duration Units (AIP.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDurationUnits(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Allow Substitution Code (AIP.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAllowSubstitutionCode(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Status Code (AIP.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerStatusCode(int $position = 12)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/DG1.php b/src/HL7/Segments/DG1.php
index 66b78b0..3ae22f7 100644
--- a/src/HL7/Segments/DG1.php
+++ b/src/HL7/Segments/DG1.php
@@ -38,11 +38,29 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (DG1.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Coding Method (DG1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisCodingMethod($value, int $position = 2)
{
return $this->setField($position, $value);
@@ -53,176 +71,472 @@ public function setDiagnosisCodeDG1($value, int $position = 3)
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Description (DG1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisDescription($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Date Time (DG1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisDateTime($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Type (DG1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisType($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Major Diagnostic Category (DG1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setMajorDiagnosticCategory($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnostic Related Group (DG1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setDiagnosticRelatedGroup($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set DRGApproval Indicator (DG1.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setDRGApprovalIndicator($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set DRGGrouper Review Code (DG1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setDRGGrouperReviewCode($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Outlier Type (DG1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setOutlierType($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Outlier Days (DG1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setOutlierDays($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Outlier Cost (DG1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setOutlierCost($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Grouper Version And Type (DG1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setGrouperVersionAndType($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Priority (DG1.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisPriority($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosing Clinician (DG1.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setDiagnosingClinician($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnosis Classification (DG1.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setDiagnosisClassification($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Confidential Indicator (DG1.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setConfidentialIndicator($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Attestation Date Time (DG1.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setAttestationDateTime($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (DG1.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Coding Method (DG1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisCodingMethod(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Code DG1 (DG1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisCodeDG1(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Description (DG1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisDescription(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Date Time (DG1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisDateTime(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Type (DG1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisType(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Major Diagnostic Category (DG1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMajorDiagnosticCategory(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnostic Related Group (DG1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosticRelatedGroup(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get DRGApproval Indicator (DG1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDRGApprovalIndicator(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get DRGGrouper Review Code (DG1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDRGGrouperReviewCode(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Outlier Type (DG1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOutlierType(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Outlier Days (DG1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOutlierDays(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Outlier Cost (DG1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOutlierCost(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Grouper Version And Type (DG1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGrouperVersionAndType(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Priority (DG1.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisPriority(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosing Clinician (DG1.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosingClinician(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnosis Classification (DG1.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosisClassification(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Confidential Indicator (DG1.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getConfidentialIndicator(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Attestation Date Time (DG1.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAttestationDateTime(int $position = 19)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/EQU.php b/src/HL7/Segments/EQU.php
index 816c02b..d7ea9ee 100644
--- a/src/HL7/Segments/EQU.php
+++ b/src/HL7/Segments/EQU.php
@@ -36,46 +36,122 @@ public function setEquipmentInstanceIdentifier(int $value, int $position = 1)
return $this->setField($position, $value);
}
+ /**
+ * Set Event Date Time (EQU.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setEventDateTime($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Equipment State (EQU.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setEquipmentState($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Local Remote Control State (EQU.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setLocalRemoteControlState($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Alert Level (EQU.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setAlertLevel($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Get Equipment Instance Identifier (EQU.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEquipmentInstanceIdentifier(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Event Date Time (EQU.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEventDateTime(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Equipment State (EQU.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEquipmentState(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Local Remote Control State (EQU.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLocalRemoteControlState(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Alert Level (EQU.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAlertLevel(int $position = 4)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/EVN.php b/src/HL7/Segments/EVN.php
index 92a1171..174db65 100644
--- a/src/HL7/Segments/EVN.php
+++ b/src/HL7/Segments/EVN.php
@@ -16,61 +16,163 @@ public function __construct(array $fields = null)
parent::__construct('EVN', $fields);
}
+ /**
+ * Set Event Type Code (EVN.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setEventTypeCode($value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Recorded Date Time (EVN.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setRecordedDateTime($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Planned Event (EVN.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setDateTimePlannedEvent($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Event Reason Code (EVN.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setEventReasonCode($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Operator ID (EVN.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setOperatorID($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Event Occurred (EVN.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setEventOccurred($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get Event Type Code (EVN.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEventTypeCode(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Recorded Date Time (EVN.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRecordedDateTime(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Planned Event (EVN.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimePlannedEvent(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Event Reason Code (EVN.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEventReasonCode(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Operator ID (EVN.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOperatorID(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Event Occurred (EVN.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEventOccurred(int $position = 6)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/FHS.php b/src/HL7/Segments/FHS.php
index 6b119a1..f85c406 100644
--- a/src/HL7/Segments/FHS.php
+++ b/src/HL7/Segments/FHS.php
@@ -17,61 +17,169 @@ public function __construct(array $fields = null)
parent::__construct('FHS', $fields);
}
+ /**
+ * Set File Field Separator (FHS.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setFileFieldSeparator($value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Encoding Characters (FHS.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setFileEncodingCharacters($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Sending Application (FHS.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setFileSendingApplication($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Sending Facility (FHS.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setFileSendingFacility($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Recieving Application (FHS.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setFileRecievingApplication($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Recieving Facility (FHS.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setFileRecievingFacility($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Creation Date Time (FHS.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setFileCreationDateTime($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Security (FHS.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setFileSecurity($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Name Id (FHS.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setFileNameId($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Header Comment (FHS.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setFileHeaderComment($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Control Id (FHS.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setFileControlId($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Reference File Control Id (FHS.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setReferenceFileControlId($value, int $position = 12)
{
return $this->setField($position, $value);
@@ -79,61 +187,157 @@ public function setReferenceFileControlId($value, int $position = 12)
// -------------------- Getter Methods ------------------------------
+ /**
+ * Get File Field Separator (FHS.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileFieldSeparator(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get File Encoding Characters (FHS.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileEncodingCharacters(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get File Sending Application (FHS.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileSendingApplication(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get File Sending Facility (FHS.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileSendingFacility(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get File Recieving Application (FHS.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileRecievingApplication(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get File Recieving Facility (FHS.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileRecievingFacility(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get File Creation Date Time (FHS.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileCreationDateTime(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get File Security (FHS.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileSecurity(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get File Name Id (FHS.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileNameId(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get File Header Comment (FHS.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileHeaderComment(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get File Control Id (FHS.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileControlId(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Reference File Control Id (FHS.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReferenceFileControlId(int $position = 12)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/FTS.php b/src/HL7/Segments/FTS.php
index f4a01c0..2a2f5b8 100644
--- a/src/HL7/Segments/FTS.php
+++ b/src/HL7/Segments/FTS.php
@@ -17,11 +17,29 @@ public function __construct(array $fields = null)
parent::__construct('FTS', $fields);
}
+ /**
+ * Set File Batch Count (FTS.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setFileBatchCount($value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set File Trailer Comment (FTS.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setFileTrailerComment($value, int $position = 2)
{
return $this->setField($position, $value);
@@ -29,11 +47,27 @@ public function setFileTrailerComment($value, int $position = 2)
// -------------------- Getter Methods ------------------------------
+ /**
+ * Get File Batch Count (FTS.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileBatchCount(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get File Trailer Comment (FTS.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFileTrailerComment(int $position = 2)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/GT1.php b/src/HL7/Segments/GT1.php
index 5eb06e2..14241de 100644
--- a/src/HL7/Segments/GT1.php
+++ b/src/HL7/Segments/GT1.php
@@ -40,41 +40,113 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (GT1.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Number (GT1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setGuarantorNumber($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Name (GT1.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setGuarantorName($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Spouse Name (GT1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setGuarantorSpouseName($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Address (GT1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setGuarantorAddress($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Home Phone (GT1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setGuarantorHomePhone($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Business Phone (GT1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setGuarantorBusinessPhone($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Date Of Birth (GT1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setGuarantorDateOfBirth($value, int $position = 8)
{
return $this->setField($position, $value);
@@ -89,526 +161,1414 @@ public function setGuarantorSex(string $value, int $position = 9)
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Type (GT1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setGuarantorType($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Relationship (GT1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setGuarantorRelationship($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor SSN (GT1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setGuarantorSSN($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Begin Date (GT1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setGuarantorBeginDate($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor End Date (GT1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEndDate($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Priority (GT1.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setGuarantorPriority($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employer Name (GT1.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployerName($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employer Address (GT1.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployerAddress($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employer Phone (GT1.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployerPhone($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employee ID (GT1.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployeeID($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employment Status (GT1.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmploymentStatus($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Organization Name (GT1.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setGuarantorOrganizationName($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Billing Hold Flag (GT1.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setGuarantorBillingHoldFlag($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Credit Rating Code (GT1.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setGuarantorCreditRatingCode($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Death Date And Time (GT1.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setGuarantorDeathDateAndTime($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Death Flag (GT1.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setGuarantorDeathFlag($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Charge Adjustment Code (GT1.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setGuarantorChargeAdjustmentCode($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Annual Income (GT1.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setGuarantorAnnualIncome($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Household Size (GT1.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setGuarantorHouseholdSize($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employer ID (GT1.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployerID($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Marital Status Code (GT1.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setGuarantorMaritalStatusCode($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Hire Effective Date (GT1.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setGuarantorHireEffectiveDate($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Employment Stop Date (GT1.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setEmploymentStopDate($value, int $position = 32)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Living Dependency (GT1.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setLivingDependency($value, int $position = 33)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ambulatory Status (GT1.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setAmbulatoryStatus($value, int $position = 34)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Citizenship (GT1.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setCitizenship($value, int $position = 35)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Primary Language (GT1.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setPrimaryLanguage($value, int $position = 36)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Living Arrangement (GT1.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setLivingArrangement($value, int $position = 37)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Publicity Code (GT1.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setPublicityCode($value, int $position = 38)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Protection Indicator (GT1.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setProtectionIndicator($value, int $position = 39)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Student Indicator (GT1.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setStudentIndicator($value, int $position = 40)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Religion (GT1.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setReligion($value, int $position = 41)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Mother Maiden Name (GT1.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setMotherMaidenName($value, int $position = 42)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Nationality (GT1.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setNationality($value, int $position = 43)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ethnic Group (GT1.44)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 44
+ *
+ * @return bool
+ *
+ */
public function setEthnicGroup($value, int $position = 44)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Persons Name (GT1.45)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 45
+ *
+ * @return bool
+ *
+ */
public function setContactPersonsName($value, int $position = 45)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Persons Phone (GT1.46)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 46
+ *
+ * @return bool
+ *
+ */
public function setContactPersonsPhone($value, int $position = 46)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Reason (GT1.47)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 47
+ *
+ * @return bool
+ *
+ */
public function setContactReason($value, int $position = 47)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Relationship (GT1.48)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 48
+ *
+ * @return bool
+ *
+ */
public function setContactRelationship($value, int $position = 48)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Job Title (GT1.49)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 49
+ *
+ * @return bool
+ *
+ */
public function setJobTitle($value, int $position = 49)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Job Class (GT1.50)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 50
+ *
+ * @return bool
+ *
+ */
public function setJobClass($value, int $position = 50)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Employers Organization Name (GT1.51)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 51
+ *
+ * @return bool
+ *
+ */
public function setGuarantorEmployersOrganizationName($value, int $position = 51)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Handicap (GT1.52)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 52
+ *
+ * @return bool
+ *
+ */
public function setHandicap($value, int $position = 52)
{
return $this->setField($position, $value);
}
- public function setJobStatus($value, int $position = 53)
+ /**
+ * Set Job Status (GT1.53)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 53
+ *
+ * @return bool
+ *
+ */
+ public function setJobStatus($value, int $position = 53)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Financial Class (GT1.54)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 54
+ *
+ * @return bool
+ *
+ */
public function setGuarantorFinancialClass($value, int $position = 54)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Race (GT1.55)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 55
+ *
+ * @return bool
+ *
+ */
public function setGuarantorRace($value, int $position = 55)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Guarantor Birth Place (GT1.56)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 56
+ *
+ * @return bool
+ *
+ */
public function setGuarantorBirthPlace($value, int $position = 56)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Vip Indicator (GT1.57)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 57
+ *
+ * @return bool
+ *
+ */
public function setVipIndicator($value, int $position = 57)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (GT1.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Number (GT1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorNumber(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Name (GT1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorName(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Spouse Name (GT1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorSpouseName(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Address (GT1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorAddress(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Home Phone (GT1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorHomePhone(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Business Phone (GT1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorBusinessPhone(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Date Of Birth (GT1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorDateOfBirth(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Sex (GT1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorSex(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Type (GT1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorType(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Relationship (GT1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorRelationship(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor SSN (GT1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorSSN(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Begin Date (GT1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorBeginDate(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor End Date (GT1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEndDate(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Priority (GT1.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorPriority(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employer Name (GT1.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployerName(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employer Address (GT1.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployerAddress(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employer Phone (GT1.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployerPhone(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employee ID (GT1.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployeeID(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employment Status (GT1.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmploymentStatus(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Organization Name (GT1.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorOrganizationName(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Billing Hold Flag (GT1.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorBillingHoldFlag(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Credit Rating Code (GT1.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorCreditRatingCode(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Death Date And Time (GT1.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorDeathDateAndTime(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Death Flag (GT1.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorDeathFlag(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Charge Adjustment Code (GT1.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorChargeAdjustmentCode(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Annual Income (GT1.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorAnnualIncome(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Household Size (GT1.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorHouseholdSize(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employer ID (GT1.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployerID(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Marital Status Code (GT1.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorMaritalStatusCode(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Hire Effective Date (GT1.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorHireEffectiveDate(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Employment Stop Date (GT1.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEmploymentStopDate(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Living Dependency (GT1.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLivingDependency(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Ambulatory Status (GT1.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAmbulatoryStatus(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Citizenship (GT1.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCitizenship(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Primary Language (GT1.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrimaryLanguage(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Living Arrangement (GT1.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLivingArrangement(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Publicity Code (GT1.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPublicityCode(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Protection Indicator (GT1.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getProtectionIndicator(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get Student Indicator (GT1.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStudentIndicator(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Religion (GT1.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReligion(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Mother Maiden Name (GT1.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMotherMaidenName(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Nationality (GT1.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNationality(int $position = 43)
{
return $this->getField($position);
}
+ /**
+ * Get Ethnic Group (GT1.44)
+ *
+ * @param int $position Defaults to 44
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEthnicGroup(int $position = 44)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Persons Name (GT1.45)
+ *
+ * @param int $position Defaults to 45
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonsName(int $position = 45)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Persons Phone (GT1.46)
+ *
+ * @param int $position Defaults to 46
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonsPhone(int $position = 46)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Reason (GT1.47)
+ *
+ * @param int $position Defaults to 47
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactReason(int $position = 47)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Relationship (GT1.48)
+ *
+ * @param int $position Defaults to 48
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactRelationship(int $position = 48)
{
return $this->getField($position);
}
+ /**
+ * Get Job Title (GT1.49)
+ *
+ * @param int $position Defaults to 49
+ *
+ * @return array|string|int|null
+ *
+ */
public function getJobTitle(int $position = 49)
{
return $this->getField($position);
}
+ /**
+ * Get Job Class (GT1.50)
+ *
+ * @param int $position Defaults to 50
+ *
+ * @return array|string|int|null
+ *
+ */
public function getJobClass(int $position = 50)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Employers Organization Name (GT1.51)
+ *
+ * @param int $position Defaults to 51
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorEmployersOrganizationName(int $position = 51)
{
return $this->getField($position);
}
+ /**
+ * Get Handicap (GT1.52)
+ *
+ * @param int $position Defaults to 52
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHandicap(int $position = 52)
{
return $this->getField($position);
}
+ /**
+ * Get Job Status (GT1.53)
+ *
+ * @param int $position Defaults to 53
+ *
+ * @return array|string|int|null
+ *
+ */
public function getJobStatus(int $position = 53)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Financial Class (GT1.54)
+ *
+ * @param int $position Defaults to 54
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorFinancialClass(int $position = 54)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Race (GT1.55)
+ *
+ * @param int $position Defaults to 55
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorRace(int $position = 55)
{
return $this->getField($position);
}
+ /**
+ * Get Guarantor Birth Place (GT1.56)
+ *
+ * @param int $position Defaults to 56
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGuarantorBirthPlace(int $position = 56)
{
return $this->getField($position);
}
+ /**
+ * Get Vip Indicator (GT1.57)
+ *
+ * @param int $position Defaults to 57
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVipIndicator(int $position = 57)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/IN1.php b/src/HL7/Segments/IN1.php
index 7785db5..090cf58 100644
--- a/src/HL7/Segments/IN1.php
+++ b/src/HL7/Segments/IN1.php
@@ -44,486 +44,1310 @@ public function setID(int $value, int $position = 1)
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Plan ID (IN1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setInsurancePlanID($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Company ID (IN1.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setInsuranceCompanyID($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Company Name (IN1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setInsuranceCompanyName($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Company Address (IN1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setInsuranceCompanyAddress($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Co Contact Person (IN1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setInsuranceCoContactPerson($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insurance Co Phone Number (IN1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setInsuranceCoPhoneNumber($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Group Number (IN1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setGroupNumber($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Group Name (IN1.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setGroupName($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Group Emp ID (IN1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setInsuredsGroupEmpID($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Group Emp Name (IN1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setInsuredsGroupEmpName($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Plan Effective Date (IN1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setPlanEffectiveDate($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Plan Expiration Date (IN1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setPlanExpirationDate($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Authorization Information (IN1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setAuthorizationInformation($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Plan Type (IN1.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setPlanType($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Name Of Insured (IN1.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setNameOfInsured($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Relationship To Patient (IN1.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setInsuredsRelationshipToPatient($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Date Of Birth (IN1.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setInsuredsDateOfBirth($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Address (IN1.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setInsuredsAddress($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Assignment Of Benefits (IN1.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setAssignmentOfBenefits($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Coordination Of Benefits (IN1.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setCoordinationOfBenefits($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Coord Of Ben Priority (IN1.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setCoordOfBenPriority($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Notice Of Admission Flag (IN1.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setNoticeOfAdmissionFlag($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Notice Of Admission Date (IN1.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setNoticeOfAdmissionDate($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Report Of Eligibility Flag (IN1.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setReportOfEligibilityFlag($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Report Of Eligibility Date (IN1.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setReportOfEligibilityDate($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Release Information Code (IN1.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setReleaseInformationCode($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Pre Admit Cert PAC (IN1.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setPreAdmitCertPAC($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Verification Date Time (IN1.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setVerificationDateTime($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Verification By (IN1.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setVerificationBy($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Type Of Agreement Code (IN1.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setTypeOfAgreementCode($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Billing Status (IN1.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setBillingStatus($value, int $position = 32)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Lifetime Reserve Days (IN1.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setLifetimeReserveDays($value, int $position = 33)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Delay Before LRDay (IN1.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setDelayBeforeLRDay($value, int $position = 34)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Company Plan Code (IN1.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setCompanyPlanCode($value, int $position = 35)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Policy Number (IN1.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setPolicyNumber($value, int $position = 36)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Policy Deductible (IN1.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setPolicyDeductible($value, int $position = 37)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Policy Limit Amount (IN1.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setPolicyLimitAmount($value, int $position = 38)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Policy Limit Days (IN1.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setPolicyLimitDays($value, int $position = 39)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Room Rate Semi Private (IN1.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setRoomRateSemiPrivate($value, int $position = 40)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Room Rate Private (IN1.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setRoomRatePrivate($value, int $position = 41)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Employment Status (IN1.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setInsuredsEmploymentStatus($value, int $position = 42)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Sex (IN1.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setInsuredsSex($value, int $position = 43)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds Employers Address (IN1.44)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 44
+ *
+ * @return bool
+ *
+ */
public function setInsuredsEmployersAddress($value, int $position = 44)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Verification Status (IN1.45)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 45
+ *
+ * @return bool
+ *
+ */
public function setVerificationStatus($value, int $position = 45)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Insurance Plan ID (IN1.46)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 46
+ *
+ * @return bool
+ *
+ */
public function setPriorInsurancePlanID($value, int $position = 46)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Coverage Type (IN1.47)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 47
+ *
+ * @return bool
+ *
+ */
public function setCoverageType($value, int $position = 47)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Handicap (IN1.48)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 48
+ *
+ * @return bool
+ *
+ */
public function setHandicap($value, int $position = 48)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Insureds IDNumber (IN1.49)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 49
+ *
+ * @return bool
+ *
+ */
public function setInsuredsIDNumber($value, int $position = 49)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (IN1.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Plan ID (IN1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsurancePlanID(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Company ID (IN1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuranceCompanyID(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Company Name (IN1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuranceCompanyName(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Company Address (IN1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuranceCompanyAddress(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Co Contact Person (IN1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuranceCoContactPerson(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Insurance Co Phone Number (IN1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuranceCoPhoneNumber(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Group Number (IN1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGroupNumber(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Group Name (IN1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getGroupName(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Group Emp ID (IN1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsGroupEmpID(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Group Emp Name (IN1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsGroupEmpName(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Plan Effective Date (IN1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlanEffectiveDate(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Plan Expiration Date (IN1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlanExpirationDate(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Authorization Information (IN1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAuthorizationInformation(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Plan Type (IN1.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlanType(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Name Of Insured (IN1.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNameOfInsured(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Relationship To Patient (IN1.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsRelationshipToPatient(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Date Of Birth (IN1.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsDateOfBirth(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Address (IN1.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsAddress(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Assignment Of Benefits (IN1.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAssignmentOfBenefits(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Coordination Of Benefits (IN1.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCoordinationOfBenefits(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Coord Of Ben Priority (IN1.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCoordOfBenPriority(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Notice Of Admission Flag (IN1.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNoticeOfAdmissionFlag(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Notice Of Admission Date (IN1.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNoticeOfAdmissionDate(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Report Of Eligibility Flag (IN1.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReportOfEligibilityFlag(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Report Of Eligibility Date (IN1.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReportOfEligibilityDate(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Release Information Code (IN1.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReleaseInformationCode(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Pre Admit Cert PAC (IN1.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreAdmitCertPAC(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Verification Date Time (IN1.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVerificationDateTime(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Verification By (IN1.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVerificationBy(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Type Of Agreement Code (IN1.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTypeOfAgreementCode(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Billing Status (IN1.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBillingStatus(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Lifetime Reserve Days (IN1.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLifetimeReserveDays(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Delay Before LRDay (IN1.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDelayBeforeLRDay(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Company Plan Code (IN1.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCompanyPlanCode(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Policy Number (IN1.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPolicyNumber(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Policy Deductible (IN1.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPolicyDeductible(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Policy Limit Amount (IN1.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPolicyLimitAmount(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Policy Limit Days (IN1.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPolicyLimitDays(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get Room Rate Semi Private (IN1.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRoomRateSemiPrivate(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Room Rate Private (IN1.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRoomRatePrivate(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Employment Status (IN1.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsEmploymentStatus(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Sex (IN1.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsSex(int $position = 43)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds Employers Address (IN1.44)
+ *
+ * @param int $position Defaults to 44
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsEmployersAddress(int $position = 44)
{
return $this->getField($position);
}
+ /**
+ * Get Verification Status (IN1.45)
+ *
+ * @param int $position Defaults to 45
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVerificationStatus(int $position = 45)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Insurance Plan ID (IN1.46)
+ *
+ * @param int $position Defaults to 46
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorInsurancePlanID(int $position = 46)
{
return $this->getField($position);
}
+ /**
+ * Get Coverage Type (IN1.47)
+ *
+ * @param int $position Defaults to 47
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCoverageType(int $position = 47)
{
return $this->getField($position);
}
+ /**
+ * Get Handicap (IN1.48)
+ *
+ * @param int $position Defaults to 48
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHandicap(int $position = 48)
{
return $this->getField($position);
}
+ /**
+ * Get Insureds IDNumber (IN1.49)
+ *
+ * @param int $position Defaults to 49
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInsuredsIDNumber(int $position = 49)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/IN3.php b/src/HL7/Segments/IN3.php
index 7dea517..99d35f9 100644
--- a/src/HL7/Segments/IN3.php
+++ b/src/HL7/Segments/IN3.php
@@ -39,251 +39,676 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (IN3.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Number (IN3.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setCertificationNumber($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certified By (IN3.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setCertifiedBy($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Required (IN3.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setCertificationRequired($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Penalty (IN3.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPenalty($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Date Time (IN3.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setCertificationDateTime($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Modify Date Time (IN3.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setCertificationModifyDateTime($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Operator (IN3.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setOperator($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Begin Date (IN3.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setCertificationBeginDate($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification End Date (IN3.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setCertificationEndDate($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Days (IN3.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setDays($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Non Concur Code Description (IN3.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setNonConcurCodeDescription($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Non Concur Effective Date Time (IN3.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setNonConcurEffectiveDateTime($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Physician Reviewer (IN3.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setPhysicianReviewer($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Contact (IN3.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setCertificationContact($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Contact Phone Number (IN3.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setCertificationContactPhoneNumber($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appeal Reason (IN3.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setAppealReason($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Agency (IN3.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setCertificationAgency($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Certification Agency Phone Number (IN3.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setCertificationAgencyPhoneNumber($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Pre Certification Requirement (IN3.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setPreCertificationRequirement($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Case Manager (IN3.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setCaseManager($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Second Opinion Date (IN3.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setSecondOpinionDate($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Second Opinion Status (IN3.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setSecondOpinionStatus($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Second Opinion Documentation Received (IN3.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setSecondOpinionDocumentationReceived($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Second Opinion Physician (IN3.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setSecondOpinionPhysician($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (IN3.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Number (IN3.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationNumber(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Certified By (IN3.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertifiedBy(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Required (IN3.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationRequired(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Penalty (IN3.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPenalty(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Date Time (IN3.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationDateTime(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Modify Date Time (IN3.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationModifyDateTime(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Operator (IN3.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOperator(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Begin Date (IN3.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationBeginDate(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Certification End Date (IN3.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationEndDate(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Days (IN3.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDays(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Non Concur Code Description (IN3.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNonConcurCodeDescription(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Non Concur Effective Date Time (IN3.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNonConcurEffectiveDateTime(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Physician Reviewer (IN3.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPhysicianReviewer(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Contact (IN3.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationContact(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Contact Phone Number (IN3.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationContactPhoneNumber(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Appeal Reason (IN3.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppealReason(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Agency (IN3.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationAgency(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Certification Agency Phone Number (IN3.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCertificationAgencyPhoneNumber(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Pre Certification Requirement (IN3.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreCertificationRequirement(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Case Manager (IN3.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCaseManager(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Second Opinion Date (IN3.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSecondOpinionDate(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Second Opinion Status (IN3.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSecondOpinionStatus(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Second Opinion Documentation Received (IN3.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSecondOpinionDocumentationReceived(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Second Opinion Physician (IN3.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSecondOpinionPhysician(int $position = 25)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/MRG.php b/src/HL7/Segments/MRG.php
index c709bb8..233c916 100644
--- a/src/HL7/Segments/MRG.php
+++ b/src/HL7/Segments/MRG.php
@@ -17,71 +17,190 @@ public function __construct(array $fields = null)
parent::__construct('MRG', $fields);
}
+ /**
+ * Set Prior Patient Identifier List (MRG.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setPriorPatientIdentifierList($value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Alternate Patient ID (MRG.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setPriorAlternatePatientID($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Patient Account Number (MRG.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setPriorPatientAccountNumber($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Patient ID (MRG.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setPriorPatientID($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Visit Number (MRG.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPriorVisitNumber($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Alternate Visit ID (MRG.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setPriorAlternateVisitID($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Prior Patient Name (MRG.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setPriorPatientName($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get Prior Patient Identifier List (MRG.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorPatientIdentifierList(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Alternate Patient ID (MRG.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorAlternatePatientID(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Patient Account Number (MRG.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorPatientAccountNumber(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Patient ID (MRG.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorPatientID(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Visit Number (MRG.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorVisitNumber(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Alternate Visit ID (MRG.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorAlternateVisitID(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Patient Name (MRG.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorPatientName(int $position = 7)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/MSA.php b/src/HL7/Segments/MSA.php
index 45a3b55..3c885ad 100644
--- a/src/HL7/Segments/MSA.php
+++ b/src/HL7/Segments/MSA.php
@@ -17,31 +17,85 @@ public function __construct(array $fields = null)
parent::__construct('MSA', $fields);
}
+ /**
+ * Set Acknowledgement Code (MSA.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setAcknowledgementCode($value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Message Control ID (MSA.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setMessageControlID($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Text Message (MSA.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setTextMessage($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Expected Sequence Number (MSA.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setExpectedSequenceNumber($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Delayed Acknowledgement Type (MSA.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setDelayedAcknowledgementType($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Error Condition (MSA.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setErrorCondition($value, int $position = 6)
{
return $this->setField($position, $value);
@@ -49,31 +103,79 @@ public function setErrorCondition($value, int $position = 6)
// -------------------- Getter Methods ------------------------------
+ /**
+ * Get Acknowledgement Code (MSA.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAcknowledgementCode(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Message Control ID (MSA.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMessageControlID(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Text Message (MSA.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTextMessage(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Sequence Number (MSA.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedSequenceNumber(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Delayed Acknowledgement Type (MSA.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDelayedAcknowledgementType(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Error Condition (MSA.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getErrorCondition(int $position = 6)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/MSH.php b/src/HL7/Segments/MSH.php
index b196096..63eba77 100644
--- a/src/HL7/Segments/MSH.php
+++ b/src/HL7/Segments/MSH.php
@@ -94,31 +94,85 @@ public function setField(int $index, $value = ''): bool
// -------------------- Setter Methods ------------------------------
+ /**
+ * Set Sending Application (MSH.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setSendingApplication($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Sending Facility (MSH.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setSendingFacility($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Receiving Application (MSH.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setReceivingApplication($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Receiving Facility (MSH.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setReceivingFacility($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Of Message (MSH.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setDateTimeOfMessage($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Security (MSH.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setSecurity($value, int $position = 8)
{
return $this->setField($position, $value);
@@ -126,7 +180,11 @@ public function setSecurity($value, int $position = 8)
/**
*
- * Sets message type to MSH segment.
+ *
+ * @param string $value
+ */
+ /**
+ * Sets message type to MSH segment. (MSH.9)
*
* If trigger event is already set, then it is preserved
*
@@ -141,7 +199,11 @@ public function setSecurity($value, int $position = 8)
* Then the new field value will be ORM^R01.
* If it was empty then the new value will be just ORM.
*
- * @param string $value
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
*/
public function setMessageType($value, int $position = 9): bool
{
@@ -153,8 +215,7 @@ public function setMessageType($value, int $position = 9): bool
}
/**
- *
- * Sets trigger event to MSH segment.
+ * Sets trigger event to MSH segment. (MSH.9)
*
* If meessage type is already set, then it is preserved
*
@@ -169,7 +230,11 @@ public function setMessageType($value, int $position = 9): bool
* Then the new field value will be ORU^R30.
* If trigger event was not set then it will set the new value.
*
- * @param string $value
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
*/
public function setTriggerEvent($value, int $position = 9): bool
{
@@ -182,51 +247,141 @@ public function setTriggerEvent($value, int $position = 9): bool
return $this->setField($position, $value);
}
+ /**
+ * Set Message Control Id (MSH.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setMessageControlId($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Processing Id (MSH.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setProcessingId($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Version Id (MSH.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setVersionId($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Sequence Number (MSH.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setSequenceNumber($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Continuation Pointer (MSH.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setContinuationPointer($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Accept Acknowledgement Type (MSH.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setAcceptAcknowledgementType($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Application Acknowledgement Type (MSH.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setApplicationAcknowledgementType($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Country Code (MSH.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setCountryCode($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Character Set (MSH.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setCharacterSet($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Principal Language (MSH.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setPrincipalLanguage($value, int $position = 19)
{
return $this->setField($position, $value);
@@ -234,26 +389,66 @@ public function setPrincipalLanguage($value, int $position = 19)
// -------------------- Getter Methods ------------------------------
+ /**
+ * Get Sending Application (MSH.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSendingApplication(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Sending Facility (MSH.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSendingFacility(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Receiving Application (MSH.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReceivingApplication(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Receiving Facility (MSH.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReceivingFacility(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Of Message (MSH.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeOfMessage(int $position = 7)
{
return $this->getField($position);
@@ -262,6 +457,14 @@ public function getDateTimeOfMessage(int $position = 7)
/**
* ORM / ORU etc.
*/
+ /**
+ * Get Message Type (MSH.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMessageType(int $position = 9): string
{
$typeField = $this->getField($position);
@@ -271,6 +474,14 @@ public function getMessageType(int $position = 9): string
return (string) $typeField;
}
+ /**
+ * Get Trigger Event (MSH.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTriggerEvent(int $position = 9): string|bool
{
$triggerField = $this->getField($position);
@@ -280,11 +491,27 @@ public function getTriggerEvent(int $position = 9): string|bool
return false;
}
+ /**
+ * Get Message Control Id (MSH.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMessageControlId(int $position = 10): string
{
return $this->getField($position);
}
+ /**
+ * Get Processing Id (MSH.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getProcessingId(int $position = 11)
{
return $this->getField($position);
@@ -293,6 +520,14 @@ public function getProcessingId(int $position = 11)
/**
* Get HL7 version, e.g. 2.1, 2.3, 3.0 etc.
*/
+ /**
+ * Get Version Id (MSH.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVersionId(int $position = 12): string|array
{
return $this->getField($position);
diff --git a/src/HL7/Segments/NK1.php b/src/HL7/Segments/NK1.php
index 06afb5b..ecd2803 100644
--- a/src/HL7/Segments/NK1.php
+++ b/src/HL7/Segments/NK1.php
@@ -42,391 +42,1054 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (NK1.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set NKName (NK1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setNKName($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Relationship (NK1.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setRelationship($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Address (NK1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setAddress($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Phone Number (NK1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPhoneNumber($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Business Phone Number (NK1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setBusinessPhoneNumber($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Role (NK1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setContactRole($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date (NK1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setStartDate($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set End Date (NK1.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setEndDate($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Next Of Kin Or Associated Parties Job Title (NK1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setNextOfKinOrAssociatedPartiesJobTitle($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setNextOfKinOrAssociatedPartiesJobCodeOrClass($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Next Of Kin Or Associated Parties Employee Number (NK1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setNextOfKinOrAssociatedPartiesEmployeeNumber($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Organization Name (NK1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setOrganizationName($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Marital Status (NK1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setMaritalStatus($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Administrative Sex (NK1.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setAdministrativeSex($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Of Birth (NK1.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setDateTimeOfBirth($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Living Dependency (NK1.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setLivingDependency($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ambulatory Status (NK1.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setAmbulatoryStatus($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Citizenship (NK1.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setCitizenship($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Primary Language (NK1.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setPrimaryLanguage($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Living Arrangement (NK1.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setLivingArrangement($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Publicity Code (NK1.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setPublicityCode($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Protection Indicator (NK1.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setProtectionIndicator($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Student Indicator (NK1.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setStudentIndicator($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Religion (NK1.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setReligion($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Mothers Maiden Name (NK1.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setMothersMaidenName($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Nationality (NK1.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setNationality($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ethnic Group (NK1.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setEthnicGroup($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Reason (NK1.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setContactReason($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Persons Name (NK1.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setContactPersonsName($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Persons Telephone Number (NK1.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setContactPersonsTelephoneNumber($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Persons Address (NK1.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setContactPersonsAddress($value, int $position = 32)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Next Of Kin Or Associated Partys Identifiers (NK1.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setNextOfKinOrAssociatedPartysIdentifiers($value, int $position = 33)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Job Status (NK1.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setJobStatus($value, int $position = 34)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Race (NK1.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setRace($value, int $position = 35)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Handicap (NK1.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setHandicap($value, int $position = 36)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Contact Person Social Security Number (NK1.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setContactPersonSocialSecurityNumber($value, int $position = 37)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Next Of Kin Birth Place (NK1.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setNextOfKinBirthPlace($value, int $position = 38)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Vip Indicator (NK1.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setVipIndicator($value, int $position = 39)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (NK1.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get NKName (NK1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNKName(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Relationship (NK1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRelationship(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Address (NK1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAddress(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Phone Number (NK1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPhoneNumber(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Business Phone Number (NK1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBusinessPhoneNumber(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Role (NK1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactRole(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date (NK1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDate(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get End Date (NK1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEndDate(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Next Of Kin Or Associated Parties Job Title (NK1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNextOfKinOrAssociatedPartiesJobTitle(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Next Of Kin Or Associated Parties Job Code Or Class (NK1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNextOfKinOrAssociatedPartiesJobCodeOrClass(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Next Of Kin Or Associated Parties Employee Number (NK1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNextOfKinOrAssociatedPartiesEmployeeNumber(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Organization Name (NK1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrganizationName(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Marital Status (NK1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMaritalStatus(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Administrative Sex (NK1.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdministrativeSex(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Of Birth (NK1.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeOfBirth(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Living Dependency (NK1.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLivingDependency(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Ambulatory Status (NK1.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAmbulatoryStatus(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Citizenship (NK1.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCitizenship(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Primary Language (NK1.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrimaryLanguage(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Living Arrangement (NK1.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLivingArrangement(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Publicity Code (NK1.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPublicityCode(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Protection Indicator (NK1.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getProtectionIndicator(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Student Indicator (NK1.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStudentIndicator(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Religion (NK1.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReligion(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Mothers Maiden Name (NK1.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMothersMaidenName(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Nationality (NK1.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNationality(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Ethnic Group (NK1.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEthnicGroup(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Reason (NK1.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactReason(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Persons Name (NK1.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonsName(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Persons Telephone Number (NK1.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonsTelephoneNumber(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Persons Address (NK1.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonsAddress(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Next Of Kin Or Associated Partys Identifiers (NK1.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNextOfKinOrAssociatedPartysIdentifiers(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Job Status (NK1.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getJobStatus(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Race (NK1.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRace(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Handicap (NK1.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHandicap(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Contact Person Social Security Number (NK1.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContactPersonSocialSecurityNumber(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Next Of Kin Birth Place (NK1.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNextOfKinBirthPlace(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Vip Indicator (NK1.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVipIndicator(int $position = 39)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/NTE.php b/src/HL7/Segments/NTE.php
index 68cd2e0..2342f7b 100644
--- a/src/HL7/Segments/NTE.php
+++ b/src/HL7/Segments/NTE.php
@@ -39,41 +39,109 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (NTE.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Source Of Comment (NTE.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setSourceOfComment($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Comment (NTE.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setComment($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Comment Type (NTE.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setCommentType($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (NTE.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Source Of Comment (NTE.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSourceOfComment(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Comment (NTE.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getComment(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Comment Type (NTE.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCommentType(int $position = 4)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/OBR.php b/src/HL7/Segments/OBR.php
index 2f296b3..138b132 100644
--- a/src/HL7/Segments/OBR.php
+++ b/src/HL7/Segments/OBR.php
@@ -39,106 +39,295 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (OBR.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Order Number (OBR.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setPlacerOrderNumber($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Order Number (OBR.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setFillerOrderNumber($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Universal Service ID (OBR.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setUniversalServiceID($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Priority (OBR.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPriority($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Requested Datetime (OBR.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setRequestedDatetime($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation Date Time (OBR.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setObservationDateTime($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation End Date Time (OBR.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setObservationEndDateTime($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Collection Volume (OBR.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setCollectionVolume($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Collector Identifier (OBR.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setCollectorIdentifier($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Specimen Action Code (OBR.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setSpecimenActionCode($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Danger Code (OBR.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setDangerCode($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Relevant Clinical Info (OBR.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setRelevantClinicalInfo($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Specimen Received Date Time (OBR.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setSpecimenReceivedDateTime($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Specimen Source (OBR.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setSpecimenSource($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Provider (OBR.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setOrderingProvider($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Callback Phone Number (OBR.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setOrderCallbackPhoneNumber($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer field 1 (OBR.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setPlacerfield1($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer field 1 (OBR.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setPlacerfield2($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler field 1 (OBR.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setFillerField1($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler field 2 (OBR.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setFillerField2($value, int $position = 21)
{
return $this->setField($position, $value);
@@ -155,326 +344,868 @@ public function setFillerField2($value, int $position = 21)
*
* @return bool
*/
+ /**
+ * Set Results Rpt Status Chng Date Time (OBR.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setResultsRptStatusChngDateTime($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Chargeto Practice (OBR.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setChargetoPractice($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Diagnostic Serv Sect ID (OBR.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setDiagnosticServSectID($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Result Status (OBR.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setResultStatus($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent Result (OBR.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setParentResult($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Quantity Timing (OBR.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setQuantityTiming($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Result Copies To (OBR.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setResultCopiesTo($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent (OBR.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setParent($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Transportation Mode (OBR.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setTransportationMode($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Reasonfor Study (OBR.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setReasonforStudy($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Principal Result Interpreter (OBR.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setPrincipalResultInterpreter($value, int $position = 32)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Assistant Result Interpreter (OBR.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setAssistantResultInterpreter($value, int $position = 33)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Technician (OBR.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setTechnician($value, int $position = 34)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Transcriptionist (OBR.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setTranscriptionist($value, int $position = 35)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Scheduled Date Time (OBR.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setScheduledDateTime($value, int $position = 36)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Numberof Sample Containers (OBR.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setNumberofSampleContainers($value, int $position = 37)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Transport Logisticsof Collected Sample (OBR.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setTransportLogisticsofCollectedSample($value, int $position = 38)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Collectors Comment (OBR.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setCollectorsComment($value, int $position = 39)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Transport Arrangement Responsibility (OBR.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setTransportArrangementResponsibility($value, int $position = 40)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Transport Arranged (OBR.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setTransportArranged($value, int $position = 41)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Escort Required (OBR.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setEscortRequired($value, int $position = 42)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Planned Patient Transport Comment (OBR.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setPlannedPatientTransportComment($value, int $position = 43)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (OBR.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Order Number (OBR.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerOrderNumber(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Order Number (OBR.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerOrderNumber(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Universal Service ID (OBR.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getUniversalServiceID(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Priority (OBR.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriority(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Requested Datetime (OBR.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRequestedDatetime(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Observation Date Time (OBR.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationDateTime(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Observation End Date Time (OBR.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationEndDateTime(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Collection Volume (OBR.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCollectionVolume(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Collector Identifier (OBR.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCollectorIdentifier(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Specimen Action Code (OBR.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecimenActionCode(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Danger Code (OBR.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDangerCode(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Relevant Clinical Info (OBR.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRelevantClinicalInfo(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Specimen Received Date Time (OBR.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecimenReceivedDateTime(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Specimen Source (OBR.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecimenSource(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Provider (OBR.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingProvider(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Order Callback Phone Number (OBR.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderCallbackPhoneNumber(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Placer field 1 (OBR.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerfield1(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Placer field 2 (OBR.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerfield2(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Filler field 1 (OBR.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerField1(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Filler field 2 (OBR.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerField2(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Results Rpt Status Chng Date Time (OBR.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResultsRptStatusChngDateTime(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Chargeto Practice (OBR.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getChargetoPractice(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Diagnostic Serv Sect ID (OBR.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDiagnosticServSectID(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Result Status (OBR.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResultStatus(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Parent Result (OBR.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParentResult(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Quantity Timing (OBR.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getQuantityTiming(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Result Copies To (OBR.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResultCopiesTo(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Parent (OBR.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParent(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Transportation Mode (OBR.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransportationMode(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Reasonfor Study (OBR.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReasonforStudy(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Principal Result Interpreter (OBR.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrincipalResultInterpreter(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Assistant Result Interpreter (OBR.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAssistantResultInterpreter(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Technician (OBR.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTechnician(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Transcriptionist (OBR.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTranscriptionist(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Scheduled Date Time (OBR.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getScheduledDateTime(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Numberof Sample Containers (OBR.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNumberofSampleContainers(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Transport Logisticsof Collected Sample (OBR.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransportLogisticsofCollectedSample(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Collectors Comment (OBR.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCollectorsComment(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get Transport Arrangement Responsibility (OBR.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransportArrangementResponsibility(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Transport Arranged (OBR.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransportArranged(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Escort Required (OBR.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEscortRequired(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Planned Patient Transport Comment (OBR.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlannedPatientTransportComment(int $position = 43)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/OBX.php b/src/HL7/Segments/OBX.php
index dc3ea59..8dbafd6 100644
--- a/src/HL7/Segments/OBX.php
+++ b/src/HL7/Segments/OBX.php
@@ -38,191 +38,514 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (OBX.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Value Type (OBX.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setValueType($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation Identifier (OBX.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setObservationIdentifier($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation Sub Id (OBX.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setObservationSubId($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation Value (OBX.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setObservationValue($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Units (OBX.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setUnits($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Reference Range (OBX.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setReferenceRange($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Abnormal Flags (OBX.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setAbnormalFlags($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Probability (OBX.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setProbability($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Nature Of Abnormal Test (OBX.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setNatureOfAbnormalTest($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observe Result Status (OBX.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setObserveResultStatus($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Data Last Obs Normal Values (OBX.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setDataLastObsNormalValues($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set User Defined Access Checks (OBX.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setUserDefinedAccessChecks($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Of The Observation (OBX.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setDateTimeOfTheObservation($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Producers Id (OBX.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setProducersId($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Responsible Observer (OBX.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setResponsibleObserver($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Observation Method (OBX.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setObservationMethod($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Equipment Instance Identifier (OBX.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setEquipmentInstanceIdentifier($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Of Analysis (OBX.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setDateTimeOfAnalysis($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (OBX.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Value Type (OBX.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getValueType(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Observation Identifier (OBX.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationIdentifier(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Observation Sub Id (OBX.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationSubId(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Observation Value (OBX.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationValue(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Units (OBX.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getUnits(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Reference Range (OBX.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReferenceRange(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Abnormal Flags (OBX.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAbnormalFlags(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Probability (OBX.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getProbability(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Nature Of Abnormal Test (OBX.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNatureOfAbnormalTest(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Observe Result Status (OBX.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObserveResultStatus(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Data Last Obs Normal Values (OBX.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDataLastObsNormalValues(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get User Defined Access Checks (OBX.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getUserDefinedAccessChecks(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Of The Observation (OBX.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeOfTheObservation(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Producers Id (OBX.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getProducersId(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Responsible Observer (OBX.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResponsibleObserver(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Observation Method (OBX.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getObservationMethod(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Equipment Instance Identifier (OBX.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEquipmentInstanceIdentifier(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Of Analysis (OBX.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeOfAnalysis(int $position = 19)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/ORC.php b/src/HL7/Segments/ORC.php
index e604316..c5fedf1 100644
--- a/src/HL7/Segments/ORC.php
+++ b/src/HL7/Segments/ORC.php
@@ -17,311 +17,838 @@ public function __construct(array $fields = null)
parent::__construct('ORC', $fields);
}
+ /**
+ * Set Order Control (ORC.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setOrderControl($value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Order Number (ORC.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setPlacerOrderNumber($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Order Number (ORC.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setFillerOrderNumber($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Group Number (ORC.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setPlacerGroupNumber($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Status (ORC.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setOrderStatus($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Response Flag (ORC.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setResponseFlag($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Quantity Timing (ORC.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setQuantityTiming($value, int $position = 7)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent Order (ORC.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setParentOrder($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Timeof Transaction (ORC.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setDateTimeofTransaction($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Entered By (ORC.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setEnteredBy($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Verified By (ORC.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setVerifiedBy($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Provider (ORC.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setOrderingProvider($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Enterers Location (ORC.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setEnterersLocation($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Call Back Phone Number (ORC.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setCallBackPhoneNumber($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Effective Date Time (ORC.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setOrderEffectiveDateTime($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Control Code Reason (ORC.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setOrderControlCodeReason($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Entering Organization (ORC.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setEnteringOrganization($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Entering Device (ORC.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setEnteringDevice($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Action By (ORC.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setActionBy($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Advanced Beneficiary Notice Code (ORC.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setAdvancedBeneficiaryNoticeCode($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Facility Name (ORC.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setOrderingFacilityName($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Facility Address (ORC.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setOrderingFacilityAddress($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Facility Phone Number (ORC.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setOrderingFacilityPhoneNumber($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ordering Provider Address (ORC.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setOrderingProviderAddress($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Status Modifier (ORC.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setOrderStatusModifier($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Advanced Beneficiary Notice Override Reason (ORC.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setAdvancedBeneficiaryNoticeOverrideReason($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Fillers Expected Availability Date Time (ORC.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setFillersExpectedAvailabilityDateTime($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Confidentiality Code (ORC.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setConfidentialityCode($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Order Type (ORC.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setOrderType($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Enterer Authorization Mode (ORC.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setEntererAuthorizationMode($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent Universal Service Identifier (ORC.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setParentUniversalServiceIdentifier($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Get Order Control (ORC.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderControl(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Order Number (ORC.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerOrderNumber(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Order Number (ORC.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerOrderNumber(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Group Number (ORC.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerGroupNumber(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Order Status (ORC.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderStatus(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Response Flag (ORC.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResponseFlag(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Quantity Timing (ORC.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getQuantityTiming(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Parent Order (ORC.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParentOrder(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Date Timeof Transaction (ORC.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeofTransaction(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Entered By (ORC.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteredBy(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Verified By (ORC.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVerifiedBy(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Provider (ORC.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingProvider(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Enterers Location (ORC.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnterersLocation(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Call Back Phone Number (ORC.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCallBackPhoneNumber(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Order Effective Date Time (ORC.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderEffectiveDateTime(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Order Control Code Reason (ORC.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderControlCodeReason(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Entering Organization (ORC.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteringOrganization(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Entering Device (ORC.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteringDevice(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Action By (ORC.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getActionBy(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Advanced Beneficiary Notice Code (ORC.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdvancedBeneficiaryNoticeCode(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Facility Name (ORC.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingFacilityName(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Facility Address (ORC.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingFacilityAddress(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Facility Phone Number (ORC.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingFacilityPhoneNumber(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Ordering Provider Address (ORC.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderingProviderAddress(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Order Status Modifier (ORC.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderStatusModifier(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Advanced Beneficiary Notice Override Reason (ORC.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdvancedBeneficiaryNoticeOverrideReason(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Fillers Expected Availability Date Time (ORC.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillersExpectedAvailabilityDateTime(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Confidentiality Code (ORC.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getConfidentialityCode(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Order Type (ORC.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrderType(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Enterer Authorization Mode (ORC.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEntererAuthorizationMode(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Parent Universal Service Identifier (ORC.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParentUniversalServiceIdentifier(int $position = 31)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/PID.php b/src/HL7/Segments/PID.php
index 03cfec7..c0fc3a6 100644
--- a/src/HL7/Segments/PID.php
+++ b/src/HL7/Segments/PID.php
@@ -39,11 +39,29 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (PID.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient ID (PID.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setPatientID($value, int $position = 2)
{
return $this->setField($position, $value);
@@ -53,26 +71,71 @@ public function setPatientID($value, int $position = 2)
* Patient ID (Internal ID)
* @param string $value
*/
+ /**
+ * Set Patient Identifier List (PID.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setPatientIdentifierList($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Alternate Patient ID (PID.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setAlternatePatientID($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Name (PID.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPatientName($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Mothers Maiden Name (PID.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setMothersMaidenName($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Date Time Of Birth (PID.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setDateTimeOfBirth($value, int $position = 7)
{
// TODO: Validate if $value is of the form %Y%m%d%H%M%S
@@ -91,121 +154,335 @@ public function setSex(string $value, int $position = 8)
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Alias (PID.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setPatientAlias($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Race (PID.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setRace($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Address (PID.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setPatientAddress($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Country Code (PID.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setCountryCode($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Phone Number Home (PID.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setPhoneNumberHome($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Phone Number Business (PID.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setPhoneNumberBusiness($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Primary Language (PID.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setPrimaryLanguage($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Marital Status (PID.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setMaritalStatus($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Religion (PID.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setReligion($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Account Number (PID.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setPatientAccountNumber($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set SSNNumber (PID.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setSSNNumber($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Drivers License Number (PID.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setDriversLicenseNumber($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Mothers Identifier (PID.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setMothersIdentifier($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Ethnic Group (PID.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setEthnicGroup($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Birth Place (PID.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setBirthPlace($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Multiple Birth Indicator (PID.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setMultipleBirthIndicator($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Birth Order (PID.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setBirthOrder($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Citizenship (PID.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setCitizenship($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Veterans Military Status (PID.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setVeteransMilitaryStatus($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Nationality (PID.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setNationality($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Death Date And Time (PID.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setPatientDeathDateAndTime($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Death Indicator (PID.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setPatientDeathIndicator($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (PID.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Patient ID (PID.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientID(int $position = 2)
{
return $this->getField($position);
@@ -215,141 +492,365 @@ public function getPatientID(int $position = 2)
* Patient ID (Internal ID)
* @return array|null|string
*/
+ /**
+ * Get Patient Identifier List (PID.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientIdentifierList(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Alternate Patient ID (PID.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAlternatePatientID(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Name (PID.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientName(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Mothers Maiden Name (PID.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMothersMaidenName(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Date Time Of Birth (PID.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDateTimeOfBirth(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Sex (PID.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSex(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Alias (PID.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientAlias(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Race (PID.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRace(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Address (PID.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientAddress(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Country Code (PID.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCountryCode(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Phone Number Home (PID.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPhoneNumberHome(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Phone Number Business (PID.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPhoneNumberBusiness(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Primary Language (PID.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrimaryLanguage(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Marital Status (PID.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMaritalStatus(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Religion (PID.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReligion(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Account Number (PID.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientAccountNumber(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get SSNNumber (PID.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSSNNumber(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Drivers License Number (PID.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDriversLicenseNumber(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Mothers Identifier (PID.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMothersIdentifier(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Ethnic Group (PID.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEthnicGroup(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Birth Place (PID.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBirthPlace(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Multiple Birth Indicator (PID.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMultipleBirthIndicator(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Birth Order (PID.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBirthOrder(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Citizenship (PID.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCitizenship(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Veterans Military Status (PID.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVeteransMilitaryStatus(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Nationality (PID.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNationality(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Death Date And Time (PID.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientDeathDateAndTime(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Death Indicator (PID.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientDeathIndicator(int $position = 30)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/PV1.php b/src/HL7/Segments/PV1.php
index 598b2e5..449601b 100644
--- a/src/HL7/Segments/PV1.php
+++ b/src/HL7/Segments/PV1.php
@@ -39,16 +39,43 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (PV1.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Patient Class (PV1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setPatientClass($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Assigned Patient Location (PV1.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setAssignedPatientLocation($value, int $position = 3)
{
return $this->setField($position, $value);
@@ -57,6 +84,15 @@ public function setAssignedPatientLocation($value, int $position = 3)
/**
* @return bool
*/
+ /**
+ * Set Admission Type (PV1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setAdmissionType($value, int $position = 4)
{
return $this->setField($position, $value);
@@ -65,6 +101,15 @@ public function setAdmissionType($value, int $position = 4)
/**
* @return bool
*/
+ /**
+ * Set Pre Admit Number (PV1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPreAdmitNumber($value, int $position = 5)
{
return $this->setField($position, $value);
@@ -73,6 +118,15 @@ public function setPreAdmitNumber($value, int $position = 5)
/**
* @return bool
*/
+ /**
+ * Set Prior Patient Location (PV1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setPriorPatientLocation($value, int $position = 6)
{
return $this->setField($position, $value);
@@ -81,6 +135,15 @@ public function setPriorPatientLocation($value, int $position = 6)
/**
* @return bool
*/
+ /**
+ * Set Attending Doctor (PV1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setAttendingDoctor($value, int $position = 7)
{
return $this->setField($position, $value);
@@ -89,6 +152,15 @@ public function setAttendingDoctor($value, int $position = 7)
/**
* @return bool
*/
+ /**
+ * Set Referring Doctor (PV1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setReferringDoctor($value, int $position = 8)
{
return $this->setField($position, $value);
@@ -97,6 +169,15 @@ public function setReferringDoctor($value, int $position = 8)
/**
* @return bool
*/
+ /**
+ * Set Consulting Doctor (PV1.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setConsultingDoctor($value, int $position = 9)
{
return $this->setField($position, $value);
@@ -105,6 +186,15 @@ public function setConsultingDoctor($value, int $position = 9)
/**
* @return bool
*/
+ /**
+ * Set Hospital Service (PV1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setHospitalService($value, int $position = 10)
{
return $this->setField($position, $value);
@@ -113,6 +203,15 @@ public function setHospitalService($value, int $position = 10)
/**
* @return bool
*/
+ /**
+ * Set Temporary Location (PV1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setTemporaryLocation($value, int $position = 11)
{
return $this->setField($position, $value);
@@ -121,6 +220,15 @@ public function setTemporaryLocation($value, int $position = 11)
/**
* @return bool
*/
+ /**
+ * Set Pre Admit Test Indicator (PV1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setPreAdmitTestIndicator($value, int $position = 12)
{
return $this->setField($position, $value);
@@ -129,6 +237,15 @@ public function setPreAdmitTestIndicator($value, int $position = 12)
/**
* @return bool
*/
+ /**
+ * Set Re Admission Indicator (PV1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setReAdmissionIndicator($value, int $position = 13)
{
return $this->setField($position, $value);
@@ -137,6 +254,15 @@ public function setReAdmissionIndicator($value, int $position = 13)
/**
* @return bool
*/
+ /**
+ * Set Admit Source (PV1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setAdmitSource($value, int $position = 14)
{
return $this->setField($position, $value);
@@ -145,6 +271,15 @@ public function setAdmitSource($value, int $position = 14)
/**
* @return bool
*/
+ /**
+ * Set Ambulatory Status (PV1.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setAmbulatoryStatus($value, int $position = 15)
{
return $this->setField($position, $value);
@@ -153,6 +288,15 @@ public function setAmbulatoryStatus($value, int $position = 15)
/**
* @return bool
*/
+ /**
+ * Set Vip Indicator (PV1.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setVipIndicator($value, int $position = 16)
{
return $this->setField($position, $value);
@@ -161,6 +305,15 @@ public function setVipIndicator($value, int $position = 16)
/**
* @return bool
*/
+ /**
+ * Set Admitting Doctor (PV1.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setAdmittingDoctor($value, int $position = 17)
{
return $this->setField($position, $value);
@@ -169,6 +322,15 @@ public function setAdmittingDoctor($value, int $position = 17)
/**
* @return bool
*/
+ /**
+ * Set Patient Type (PV1.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setPatientType($value, int $position = 18)
{
return $this->setField($position, $value);
@@ -177,6 +339,15 @@ public function setPatientType($value, int $position = 18)
/**
* @return bool
*/
+ /**
+ * Set Visit Number (PV1.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setVisitNumber($value, int $position = 19)
{
return $this->setField($position, $value);
@@ -185,6 +356,15 @@ public function setVisitNumber($value, int $position = 19)
/**
* @return bool
*/
+ /**
+ * Set Financial Class (PV1.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setFinancialClass($value, int $position = 20)
{
return $this->setField($position, $value);
@@ -193,6 +373,15 @@ public function setFinancialClass($value, int $position = 20)
/**
* @return bool
*/
+ /**
+ * Set Charge Price Indicator (PV1.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setChargePriceIndicator($value, int $position = 21)
{
return $this->setField($position, $value);
@@ -201,6 +390,15 @@ public function setChargePriceIndicator($value, int $position = 21)
/**
* @return bool
*/
+ /**
+ * Set Courtesy Code (PV1.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setCourtesyCode($value, int $position = 22)
{
return $this->setField($position, $value);
@@ -209,6 +407,15 @@ public function setCourtesyCode($value, int $position = 22)
/**
* @return bool
*/
+ /**
+ * Set Credit Rating (PV1.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setCreditRating($value, int $position = 23)
{
return $this->setField($position, $value);
@@ -217,6 +424,15 @@ public function setCreditRating($value, int $position = 23)
/**
* @return bool
*/
+ /**
+ * Set Contract Code (PV1.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setContractCode($value, int $position = 24)
{
return $this->setField($position, $value);
@@ -225,6 +441,15 @@ public function setContractCode($value, int $position = 24)
/**
* @return bool
*/
+ /**
+ * Set Contract Effective Date (PV1.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setContractEffectiveDate($value, int $position = 25)
{
return $this->setField($position, $value);
@@ -233,6 +458,15 @@ public function setContractEffectiveDate($value, int $position = 25)
/**
* @return bool
*/
+ /**
+ * Set Contract Amount (PV1.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setContractAmount($value, int $position = 26)
{
return $this->setField($position, $value);
@@ -241,6 +475,15 @@ public function setContractAmount($value, int $position = 26)
/**
* @return bool
*/
+ /**
+ * Set Contract Period (PV1.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setContractPeriod($value, int $position = 27)
{
return $this->setField($position, $value);
@@ -249,6 +492,15 @@ public function setContractPeriod($value, int $position = 27)
/**
* @return bool
*/
+ /**
+ * Set Interest Code (PV1.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setInterestCode($value, int $position = 28)
{
return $this->setField($position, $value);
@@ -257,6 +509,15 @@ public function setInterestCode($value, int $position = 28)
/**
* @return bool
*/
+ /**
+ * Set Transfer To Bad Debt Code (PV1.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setTransferToBadDebtCode($value, int $position = 29)
{
return $this->setField($position, $value);
@@ -265,6 +526,15 @@ public function setTransferToBadDebtCode($value, int $position = 29)
/**
* @return bool
*/
+ /**
+ * Set Transfer To Bad Debt Date (PV1.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setTransferToBadDebtDate($value, int $position = 30)
{
return $this->setField($position, $value);
@@ -273,6 +543,15 @@ public function setTransferToBadDebtDate($value, int $position = 30)
/**
* @return bool
*/
+ /**
+ * Set Bad Debt Agency Code (PV1.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setBadDebtAgencyCode($value, int $position = 31)
{
return $this->setField($position, $value);
@@ -281,6 +560,15 @@ public function setBadDebtAgencyCode($value, int $position = 31)
/**
* @return bool
*/
+ /**
+ * Set Bad Debt Transfer Amount (PV1.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setBadDebtTransferAmount($value, int $position = 32)
{
return $this->setField($position, $value);
@@ -289,6 +577,15 @@ public function setBadDebtTransferAmount($value, int $position = 32)
/**
* @return bool
*/
+ /**
+ * Set Bad Debt Recovery Amount (PV1.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setBadDebtRecoveryAmount($value, int $position = 33)
{
return $this->setField($position, $value);
@@ -297,6 +594,15 @@ public function setBadDebtRecoveryAmount($value, int $position = 33)
/**
* @return bool
*/
+ /**
+ * Set Delete Account Indicator (PV1.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setDeleteAccountIndicator($value, int $position = 34)
{
return $this->setField($position, $value);
@@ -305,6 +611,15 @@ public function setDeleteAccountIndicator($value, int $position = 34)
/**
* @return bool
*/
+ /**
+ * Set Delete Account Date (PV1.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setDeleteAccountDate($value, int $position = 35)
{
return $this->setField($position, $value);
@@ -313,6 +628,15 @@ public function setDeleteAccountDate($value, int $position = 35)
/**
* @return bool
*/
+ /**
+ * Set Discharge Disposition (PV1.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setDischargeDisposition($value, int $position = 36)
{
return $this->setField($position, $value);
@@ -321,6 +645,15 @@ public function setDischargeDisposition($value, int $position = 36)
/**
* @return bool
*/
+ /**
+ * Set Discharged To Location (PV1.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setDischargedToLocation($value, int $position = 37)
{
return $this->setField($position, $value);
@@ -329,6 +662,15 @@ public function setDischargedToLocation($value, int $position = 37)
/**
* @return bool
*/
+ /**
+ * Set Diet Type (PV1.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setDietType($value, int $position = 38)
{
return $this->setField($position, $value);
@@ -337,6 +679,15 @@ public function setDietType($value, int $position = 38)
/**
* @return bool
*/
+ /**
+ * Set Servicing Facility (PV1.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setServicingFacility($value, int $position = 39)
{
return $this->setField($position, $value);
@@ -345,6 +696,15 @@ public function setServicingFacility($value, int $position = 39)
/**
* @return bool
*/
+ /**
+ * Set Bed Status (PV1.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setBedStatus($value, int $position = 40)
{
return $this->setField($position, $value);
@@ -353,6 +713,15 @@ public function setBedStatus($value, int $position = 40)
/**
* @return bool
*/
+ /**
+ * Set Account Status (PV1.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setAccountStatus($value, int $position = 41)
{
return $this->setField($position, $value);
@@ -361,6 +730,15 @@ public function setAccountStatus($value, int $position = 41)
/**
* @return bool
*/
+ /**
+ * Set Pending Location (PV1.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setPendingLocation($value, int $position = 42)
{
return $this->setField($position, $value);
@@ -369,6 +747,15 @@ public function setPendingLocation($value, int $position = 42)
/**
* @return bool
*/
+ /**
+ * Set Prior Temporary Location (PV1.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setPriorTemporaryLocation($value, int $position = 43)
{
return $this->setField($position, $value);
@@ -377,6 +764,15 @@ public function setPriorTemporaryLocation($value, int $position = 43)
/**
* @return bool
*/
+ /**
+ * Set Admit Date Time (PV1.44)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 44
+ *
+ * @return bool
+ *
+ */
public function setAdmitDateTime($value, int $position = 44)
{
return $this->setField($position, $value);
@@ -385,6 +781,15 @@ public function setAdmitDateTime($value, int $position = 44)
/**
* @return bool
*/
+ /**
+ * Set Discharge Date Time (PV1.45)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 45
+ *
+ * @return bool
+ *
+ */
public function setDischargeDateTime($value, int $position = 45)
{
return $this->setField($position, $value);
@@ -393,6 +798,15 @@ public function setDischargeDateTime($value, int $position = 45)
/**
* @return bool
*/
+ /**
+ * Set Current Patient Balance (PV1.46)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 46
+ *
+ * @return bool
+ *
+ */
public function setCurrentPatientBalance($value, int $position = 46)
{
return $this->setField($position, $value);
@@ -401,6 +815,15 @@ public function setCurrentPatientBalance($value, int $position = 46)
/**
* @return bool
*/
+ /**
+ * Set Total Charges (PV1.47)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 47
+ *
+ * @return bool
+ *
+ */
public function setTotalCharges($value, int $position = 47)
{
return $this->setField($position, $value);
@@ -409,6 +832,15 @@ public function setTotalCharges($value, int $position = 47)
/**
* @return bool
*/
+ /**
+ * Set Total Adjustments (PV1.48)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 48
+ *
+ * @return bool
+ *
+ */
public function setTotalAdjustments($value, int $position = 48)
{
return $this->setField($position, $value);
@@ -417,6 +849,15 @@ public function setTotalAdjustments($value, int $position = 48)
/**
* @return bool
*/
+ /**
+ * Set Total Payments (PV1.49)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 49
+ *
+ * @return bool
+ *
+ */
public function setTotalPayments($value, int $position = 49)
{
return $this->setField($position, $value);
@@ -425,6 +866,15 @@ public function setTotalPayments($value, int $position = 49)
/**
* @return bool
*/
+ /**
+ * Set Alternate Visit ID (PV1.50)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 50
+ *
+ * @return bool
+ *
+ */
public function setAlternateVisitID($value, int $position = 50)
{
return $this->setField($position, $value);
@@ -433,6 +883,15 @@ public function setAlternateVisitID($value, int $position = 50)
/**
* @return bool
*/
+ /**
+ * Set Visit Indicator (PV1.51)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 51
+ *
+ * @return bool
+ *
+ */
public function setVisitIndicator($value, int $position = 51)
{
return $this->setField($position, $value);
@@ -441,266 +900,691 @@ public function setVisitIndicator($value, int $position = 51)
/**
* @return bool
*/
+ /**
+ * Set Other Healthcare Provider (PV1.52)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 52
+ *
+ * @return bool
+ *
+ */
public function setOtherHealthcareProvider($value, int $position = 52)
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (PV1.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Class (PV1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientClass(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Assigned Patient Location (PV1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAssignedPatientLocation(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Admission Type (PV1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmissionType(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Pre Admit Number (PV1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreAdmitNumber(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Patient Location (PV1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorPatientLocation(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Attending Doctor (PV1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAttendingDoctor(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Referring Doctor (PV1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReferringDoctor(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Consulting Doctor (PV1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getConsultingDoctor(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Hospital Service (PV1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHospitalService(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Temporary Location (PV1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTemporaryLocation(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Pre Admit Test Indicator (PV1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreAdmitTestIndicator(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Re Admission Indicator (PV1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReAdmissionIndicator(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Admit Source (PV1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmitSource(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Ambulatory Status (PV1.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAmbulatoryStatus(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Vip Indicator (PV1.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVipIndicator(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Admitting Doctor (PV1.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmittingDoctor(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Type (PV1.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientType(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Number (PV1.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitNumber(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Financial Class (PV1.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFinancialClass(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Charge Price Indicator (PV1.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getChargePriceIndicator(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Courtesy Code (PV1.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCourtesyCode(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Credit Rating (PV1.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCreditRating(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Contract Code (PV1.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContractCode(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Contract Effective Date (PV1.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContractEffectiveDate(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Contract Amount (PV1.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContractAmount(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Contract Period (PV1.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContractPeriod(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Interest Code (PV1.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInterestCode(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Transfer To Bad Debt Code (PV1.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransferToBadDebtCode(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Transfer To Bad Debt Date (PV1.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransferToBadDebtDate(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Bad Debt Agency Code (PV1.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBadDebtAgencyCode(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Bad Debt Transfer Amount (PV1.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBadDebtTransferAmount(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Bad Debt Recovery Amount (PV1.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBadDebtRecoveryAmount(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Delete Account Indicator (PV1.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDeleteAccountIndicator(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Delete Account Date (PV1.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDeleteAccountDate(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Discharge Disposition (PV1.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDischargeDisposition(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Discharged To Location (PV1.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDischargedToLocation(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Diet Type (PV1.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDietType(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Servicing Facility (PV1.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getServicingFacility(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get Bed Status (PV1.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBedStatus(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Account Status (PV1.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAccountStatus(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Pending Location (PV1.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPendingLocation(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Prior Temporary Location (PV1.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriorTemporaryLocation(int $position = 43)
{
return $this->getField($position);
}
+ /**
+ * Get Admit Date Time (PV1.44)
+ *
+ * @param int $position Defaults to 44
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmitDateTime(int $position = 44)
{
return $this->getField($position);
}
+ /**
+ * Get Discharge Date Time (PV1.45)
+ *
+ * @param int $position Defaults to 45
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDischargeDateTime(int $position = 45)
{
return $this->getField($position);
}
+ /**
+ * Get Current Patient Balance (PV1.46)
+ *
+ * @param int $position Defaults to 46
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCurrentPatientBalance(int $position = 46)
{
return $this->getField($position);
}
+ /**
+ * Get Total Charges (PV1.47)
+ *
+ * @param int $position Defaults to 47
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTotalCharges(int $position = 47)
{
return $this->getField($position);
}
+ /**
+ * Get Total Adjustments (PV1.48)
+ *
+ * @param int $position Defaults to 48
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTotalAdjustments(int $position = 48)
{
return $this->getField($position);
}
+ /**
+ * Get Total Payments (PV1.49)
+ *
+ * @param int $position Defaults to 49
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTotalPayments(int $position = 49)
{
return $this->getField($position);
}
+ /**
+ * Get Alternate Visit ID (PV1.50)
+ *
+ * @param int $position Defaults to 50
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAlternateVisitID(int $position = 50)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Indicator (PV1.51)
+ *
+ * @param int $position Defaults to 51
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitIndicator(int $position = 51)
{
return $this->getField($position);
}
+ /**
+ * Get Other Healthcare Provider (PV1.52)
+ *
+ * @param int $position Defaults to 52
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOtherHealthcareProvider(int $position = 52)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/PV2.php b/src/HL7/Segments/PV2.php
index cc2b55c..38bf4f1 100644
--- a/src/HL7/Segments/PV2.php
+++ b/src/HL7/Segments/PV2.php
@@ -23,6 +23,15 @@ public function __construct(array $fields = null)
/**
* @return bool
*/
+ /**
+ * Set Prior Pending Location (PV2.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setPriorPendingLocation($value, int $position = 1)
{
return $this->setField($position, $value);
@@ -31,6 +40,15 @@ public function setPriorPendingLocation($value, int $position = 1)
/**
* @return bool
*/
+ /**
+ * Set Accommodation Code (PV2.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setAccommodationCode($value, int $position = 2)
{
return $this->setField($position, $value);
@@ -39,6 +57,15 @@ public function setAccommodationCode($value, int $position = 2)
/**
* @return bool
*/
+ /**
+ * Set Admit Reason (PV2.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setAdmitReason($value, int $position = 3)
{
return $this->setField($position, $value);
@@ -47,6 +74,15 @@ public function setAdmitReason($value, int $position = 3)
/**
* @return bool
*/
+ /**
+ * Set Transfer Reason (PV2.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setTransferReason($value, int $position = 4)
{
return $this->setField($position, $value);
@@ -55,6 +91,15 @@ public function setTransferReason($value, int $position = 4)
/**
* @return bool
*/
+ /**
+ * Set Patient Valuables (PV2.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setPatientValuables($value, int $position = 5)
{
return $this->setField($position, $value);
@@ -63,6 +108,15 @@ public function setPatientValuables($value, int $position = 5)
/**
* @return bool
*/
+ /**
+ * Set Patient Valuables Location (PV2.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setPatientValuablesLocation($value, int $position = 6)
{
return $this->setField($position, $value);
@@ -71,6 +125,15 @@ public function setPatientValuablesLocation($value, int $position = 6)
/**
* @return bool
*/
+ /**
+ * Set Visit User Code (PV2.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setVisitUserCode($value, int $position = 7)
{
return $this->setField($position, $value);
@@ -79,6 +142,15 @@ public function setVisitUserCode($value, int $position = 7)
/**
* @return bool
*/
+ /**
+ * Set Expected Admit Date Time (PV2.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setExpectedAdmitDateTime($value, int $position = 8)
{
return $this->setField($position, $value);
@@ -87,6 +159,15 @@ public function setExpectedAdmitDateTime($value, int $position = 8)
/**
* @return bool
*/
+ /**
+ * Set Expected Discharge Date Time (PV2.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setExpectedDischargeDateTime($value, int $position = 9)
{
return $this->setField($position, $value);
@@ -95,6 +176,15 @@ public function setExpectedDischargeDateTime($value, int $position = 9)
/**
* @return bool
*/
+ /**
+ * Set Estimated Lengthof Inpatient Stay (PV2.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setEstimatedLengthofInpatientStay($value, int $position = 10)
{
return $this->setField($position, $value);
@@ -103,6 +193,15 @@ public function setEstimatedLengthofInpatientStay($value, int $position = 10)
/**
* @return bool
*/
+ /**
+ * Set Actual Length Of Inpatient Stay (PV2.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setActualLengthOfInpatientStay($value, int $position = 11)
{
return $this->setField($position, $value);
@@ -111,6 +210,15 @@ public function setActualLengthOfInpatientStay($value, int $position = 11)
/**
* @return bool
*/
+ /**
+ * Set Visit Description (PV2.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setVisitDescription($value, int $position = 12)
{
return $this->setField($position, $value);
@@ -119,6 +227,15 @@ public function setVisitDescription($value, int $position = 12)
/**
* @return bool
*/
+ /**
+ * Set Referral Source Code (PV2.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setReferralSourceCode($value, int $position = 13)
{
return $this->setField($position, $value);
@@ -127,6 +244,15 @@ public function setReferralSourceCode($value, int $position = 13)
/**
* @return bool
*/
+ /**
+ * Set Previous Service Date (PV2.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setPreviousServiceDate($value, int $position = 14)
{
return $this->setField($position, $value);
@@ -135,6 +261,15 @@ public function setPreviousServiceDate($value, int $position = 14)
/**
* @return bool
*/
+ /**
+ * Set Employment Illness Related Indicator (PV2.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setEmploymentIllnessRelatedIndicator($value, int $position = 15)
{
return $this->setField($position, $value);
@@ -143,6 +278,15 @@ public function setEmploymentIllnessRelatedIndicator($value, int $position = 15)
/**
* @return bool
*/
+ /**
+ * Set Purge Status Code (PV2.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setPurgeStatusCode($value, int $position = 16)
{
return $this->setField($position, $value);
@@ -151,6 +295,15 @@ public function setPurgeStatusCode($value, int $position = 16)
/**
* @return bool
*/
+ /**
+ * Set Purge Status Date (PV2.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setPurgeStatusDate($value, int $position = 17)
{
return $this->setField($position, $value);
@@ -159,6 +312,15 @@ public function setPurgeStatusDate($value, int $position = 17)
/**
* @return bool
*/
+ /**
+ * Set Special Program Code (PV2.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setSpecialProgramCode($value, int $position = 18)
{
return $this->setField($position, $value);
@@ -167,6 +329,15 @@ public function setSpecialProgramCode($value, int $position = 18)
/**
* @return bool
*/
+ /**
+ * Set Retention Indicator (PV2.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setRetentionIndicator($value, int $position = 19)
{
return $this->setField($position, $value);
@@ -175,6 +346,15 @@ public function setRetentionIndicator($value, int $position = 19)
/**
* @return bool
*/
+ /**
+ * Set Expected Number Of Insurance Plans (PV2.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setExpectedNumberOfInsurancePlans($value, int $position = 20)
{
return $this->setField($position, $value);
@@ -183,6 +363,15 @@ public function setExpectedNumberOfInsurancePlans($value, int $position = 20)
/**
* @return bool
*/
+ /**
+ * Set Visit Publicity Code (PV2.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setVisitPublicityCode($value, int $position = 21)
{
return $this->setField($position, $value);
@@ -191,6 +380,15 @@ public function setVisitPublicityCode($value, int $position = 21)
/**
* @return bool
*/
+ /**
+ * Set Visit Protection Indicator (PV2.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setVisitProtectionIndicator($value, int $position = 22)
{
return $this->setField($position, $value);
@@ -199,6 +397,15 @@ public function setVisitProtectionIndicator($value, int $position = 22)
/**
* @return bool
*/
+ /**
+ * Set Clinic Organization Name (PV2.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setClinicOrganizationName($value, int $position = 23)
{
return $this->setField($position, $value);
@@ -207,6 +414,15 @@ public function setClinicOrganizationName($value, int $position = 23)
/**
* @return bool
*/
+ /**
+ * Set Patient Status Code (PV2.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setPatientStatusCode($value, int $position = 24)
{
return $this->setField($position, $value);
@@ -215,6 +431,15 @@ public function setPatientStatusCode($value, int $position = 24)
/**
* @return bool
*/
+ /**
+ * Set Visit Priority Code (PV2.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setVisitPriorityCode($value, int $position = 25)
{
return $this->setField($position, $value);
@@ -223,6 +448,15 @@ public function setVisitPriorityCode($value, int $position = 25)
/**
* @return bool
*/
+ /**
+ * Set Previous Treatment Date (PV2.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setPreviousTreatmentDate($value, int $position = 26)
{
return $this->setField($position, $value);
@@ -231,6 +465,15 @@ public function setPreviousTreatmentDate($value, int $position = 26)
/**
* @return bool
*/
+ /**
+ * Set Expected Discharge Disposition (PV2.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setExpectedDischargeDisposition($value, int $position = 27)
{
return $this->setField($position, $value);
@@ -239,6 +482,15 @@ public function setExpectedDischargeDisposition($value, int $position = 27)
/**
* @return bool
*/
+ /**
+ * Set Signature On File Date (PV2.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setSignatureOnFileDate($value, int $position = 28)
{
return $this->setField($position, $value);
@@ -247,6 +499,15 @@ public function setSignatureOnFileDate($value, int $position = 28)
/**
* @return bool
*/
+ /**
+ * Set First Similar Illness Date (PV2.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setFirstSimilarIllnessDate($value, int $position = 29)
{
return $this->setField($position, $value);
@@ -255,6 +516,15 @@ public function setFirstSimilarIllnessDate($value, int $position = 29)
/**
* @return bool
*/
+ /**
+ * Set Patient Charge Adjustment Code (PV2.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setPatientChargeAdjustmentCode($value, int $position = 30)
{
return $this->setField($position, $value);
@@ -263,6 +533,15 @@ public function setPatientChargeAdjustmentCode($value, int $position = 30)
/**
* @return bool
*/
+ /**
+ * Set Recurring Service Code (PV2.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setRecurringServiceCode($value, int $position = 31)
{
return $this->setField($position, $value);
@@ -271,6 +550,15 @@ public function setRecurringServiceCode($value, int $position = 31)
/**
* @return bool
*/
+ /**
+ * Set Billing Media Code (PV2.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setBillingMediaCode($value, int $position = 32)
{
return $this->setField($position, $value);
@@ -279,6 +567,15 @@ public function setBillingMediaCode($value, int $position = 32)
/**
* @return bool
*/
+ /**
+ * Set Expected Surgery Date And Time (PV2.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setExpectedSurgeryDateAndTime($value, int $position = 33)
{
return $this->setField($position, $value);
@@ -287,6 +584,15 @@ public function setExpectedSurgeryDateAndTime($value, int $position = 33)
/**
* @return bool
*/
+ /**
+ * Set Military Partnership Code (PV2.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setMilitaryPartnershipCode($value, int $position = 34)
{
return $this->setField($position, $value);
@@ -295,6 +601,15 @@ public function setMilitaryPartnershipCode($value, int $position = 34)
/**
* @return bool
*/
+ /**
+ * Set Military Non Availability Code (PV2.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setMilitaryNonAvailabilityCode($value, int $position = 35)
{
return $this->setField($position, $value);
@@ -303,6 +618,15 @@ public function setMilitaryNonAvailabilityCode($value, int $position = 35)
/**
* @return bool
*/
+ /**
+ * Set Newborn Baby Indicator (PV2.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setNewbornBabyIndicator($value, int $position = 36)
{
return $this->setField($position, $value);
@@ -311,6 +635,15 @@ public function setNewbornBabyIndicator($value, int $position = 36)
/**
* @return bool
*/
+ /**
+ * Set Baby Detained Indicator (PV2.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setBabyDetainedIndicator($value, int $position = 37)
{
return $this->setField($position, $value);
@@ -319,6 +652,15 @@ public function setBabyDetainedIndicator($value, int $position = 37)
/**
* @return bool
*/
+ /**
+ * Set Mode Of Arrival Code (PV2.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setModeOfArrivalCode($value, int $position = 38)
{
return $this->setField($position, $value);
@@ -327,6 +669,15 @@ public function setModeOfArrivalCode($value, int $position = 38)
/**
* @return bool
*/
+ /**
+ * Set Recreational Drug Use Code (PV2.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setRecreationalDrugUseCode($value, int $position = 39)
{
return $this->setField($position, $value);
@@ -335,6 +686,15 @@ public function setRecreationalDrugUseCode($value, int $position = 39)
/**
* @return bool
*/
+ /**
+ * Set Admission Level Of Care Code (PV2.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setAdmissionLevelOfCareCode($value, int $position = 40)
{
return $this->setField($position, $value);
@@ -343,6 +703,15 @@ public function setAdmissionLevelOfCareCode($value, int $position = 40)
/**
* @return bool
*/
+ /**
+ * Set Precaution Code (PV2.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setPrecautionCode($value, int $position = 41)
{
return $this->setField($position, $value);
@@ -351,6 +720,15 @@ public function setPrecautionCode($value, int $position = 41)
/**
* @return bool
*/
+ /**
+ * Set Patient Condition Code (PV2.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setPatientConditionCode($value, int $position = 42)
{
return $this->setField($position, $value);
@@ -359,6 +737,15 @@ public function setPatientConditionCode($value, int $position = 42)
/**
* @return bool
*/
+ /**
+ * Set Living Will Code (PV2.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setLivingWillCode($value, int $position = 43)
{
return $this->setField($position, $value);
@@ -367,6 +754,15 @@ public function setLivingWillCode($value, int $position = 43)
/**
* @return bool
*/
+ /**
+ * Set Organ Donor Code (PV2.44)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 44
+ *
+ * @return bool
+ *
+ */
public function setOrganDonorCode($value, int $position = 44)
{
return $this->setField($position, $value);
@@ -375,6 +771,15 @@ public function setOrganDonorCode($value, int $position = 44)
/**
* @return bool
*/
+ /**
+ * Set Advance Directive Code (PV2.45)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 45
+ *
+ * @return bool
+ *
+ */
public function setAdvanceDirectiveCode($value, int $position = 45)
{
return $this->setField($position, $value);
@@ -383,6 +788,15 @@ public function setAdvanceDirectiveCode($value, int $position = 45)
/**
* @return bool
*/
+ /**
+ * Set Patient Status Effective Date (PV2.46)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 46
+ *
+ * @return bool
+ *
+ */
public function setPatientStatusEffectiveDate($value, int $position = 46)
{
return $this->setField($position, $value);
@@ -391,6 +805,15 @@ public function setPatientStatusEffectiveDate($value, int $position = 46)
/**
* @return bool
*/
+ /**
+ * Set Expected LOAReturn Date Time (PV2.47)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 47
+ *
+ * @return bool
+ *
+ */
public function setExpectedLOAReturnDateTime($value, int $position = 47)
{
return $this->setField($position, $value);
@@ -398,231 +821,599 @@ public function setExpectedLOAReturnDateTime($value, int $position = 47)
// -------------------- Getter Methods ------------------------------
+ /**
+ * Get Accommodation Code (PV2.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAccommodationCode(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Admit Reason (PV2.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmitReason(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Transfer Reason (PV2.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTransferReason(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Valuables (PV2.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientValuables(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Valuables Location (PV2.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientValuablesLocation(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Visit User Code (PV2.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitUserCode(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Admit Date Time (PV2.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedAdmitDateTime(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Discharge Date Time (PV2.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedDischargeDateTime(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Estimated Lengthof Inpatient Stay (PV2.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEstimatedLengthofInpatientStay(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Actual Length Of Inpatient Stay (PV2.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getActualLengthOfInpatientStay(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Description (PV2.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitDescription(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Referral Source Code (PV2.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getReferralSourceCode(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Previous Service Date (PV2.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreviousServiceDate(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Employment Illness Related Indicator (PV2.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEmploymentIllnessRelatedIndicator(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Purge Status Code (PV2.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPurgeStatusCode(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Purge Status Date (PV2.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPurgeStatusDate(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Special Program Code (PV2.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecialProgramCode(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Retention Indicator (PV2.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRetentionIndicator(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Number Of Insurance Plans (PV2.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedNumberOfInsurancePlans(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Publicity Code (PV2.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitPublicityCode(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Protection Indicator (PV2.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitProtectionIndicator(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Clinic Organization Name (PV2.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getClinicOrganizationName(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Status Code (PV2.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientStatusCode(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Visit Priority Code (PV2.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVisitPriorityCode(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Previous Treatment Date (PV2.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPreviousTreatmentDate(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Discharge Disposition (PV2.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedDischargeDisposition(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Signature On File Date (PV2.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSignatureOnFileDate(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get First Similar Illness Date (PV2.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFirstSimilarIllnessDate(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Charge Adjustment Code (PV2.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientChargeAdjustmentCode(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Recurring Service Code (PV2.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRecurringServiceCode(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Billing Media Code (PV2.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBillingMediaCode(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Expected Surgery Date And Time (PV2.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedSurgeryDateAndTime(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Military Partnership Code (PV2.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMilitaryPartnershipCode(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Military Non Availability Code (PV2.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getMilitaryNonAvailabilityCode(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Newborn Baby Indicator (PV2.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getNewbornBabyIndicator(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Baby Detained Indicator (PV2.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBabyDetainedIndicator(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Mode Of Arrival Code (PV2.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getModeOfArrivalCode(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Recreational Drug Use Code (PV2.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRecreationalDrugUseCode(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get Admission Level Of Care Code (PV2.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdmissionLevelOfCareCode(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Precaution Code (PV2.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrecautionCode(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Condition Code (PV2.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientConditionCode(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Living Will Code (PV2.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLivingWillCode(int $position = 43)
{
return $this->getField($position);
}
+ /**
+ * Get Organ Donor Code (PV2.44)
+ *
+ * @param int $position Defaults to 44
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOrganDonorCode(int $position = 44)
{
return $this->getField($position);
}
+ /**
+ * Get Advance Directive Code (PV2.45)
+ *
+ * @param int $position Defaults to 45
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdvanceDirectiveCode(int $position = 45)
{
return $this->getField($position);
}
+ /**
+ * Get Patient Status Effective Date (PV2.46)
+ *
+ * @param int $position Defaults to 46
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPatientStatusEffectiveDate(int $position = 46)
{
return $this->getField($position);
}
+ /**
+ * Get Expected LOAReturn Date Time (PV2.47)
+ *
+ * @param int $position Defaults to 47
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExpectedLOAReturnDateTime(int $position = 47)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/RGS.php b/src/HL7/Segments/RGS.php
index 112194e..422f479 100644
--- a/src/HL7/Segments/RGS.php
+++ b/src/HL7/Segments/RGS.php
@@ -38,31 +38,82 @@ public static function resetIndex(int $index = 1): void
self::$setId = $index;
}
+ /**
+ * Set ID (RGS.1)
+ *
+ * @param int $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setID(int $value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Segment Action Code (RGS.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setSegmentActionCode($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Resource Group ID (RGS.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setResourceGroupID($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get ID (RGS.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Segment Action Code (RGS.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSegmentActionCode(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Resource Group ID (RGS.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getResourceGroupID(int $position = 3)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/SAC.php b/src/HL7/Segments/SAC.php
index 2e5d475..d230b32 100644
--- a/src/HL7/Segments/SAC.php
+++ b/src/HL7/Segments/SAC.php
@@ -36,31 +36,85 @@ public function setExternalAccessionIdentifier(int $value, int $position = 1)
return $this->setField($position, $value);
}
+ /**
+ * Set Accession Identifier (SAC.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setAccessionIdentifier($value, int $position = 2)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Container Identifier (SAC.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setContainerIdentifier($value, int $position = 3)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Primary Container Identifier (SAC.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setPrimaryContainerIdentifier($value, int $position = 4)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Equipment Container Identifier (SAC.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setEquipmentContainerIdentifier($value, int $position = 5)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Specimen Source (SAC.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setSpecimenSource($value, int $position = 6)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Registration Date Time (SAC.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setRegistrationDateTime($value, int $position = 7)
{
return $this->setField($position, $value);
@@ -79,406 +133,1091 @@ public function setRegistrationDateTime($value, int $position = 7)
* X : Container Unavailable
* U : Unknown
*/
+ /**
+ * Set Container Status (SAC.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setContainerStatus($value, int $position = 8)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Carrier Type (SAC.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setCarrierType($value, int $position = 9)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Carrier Identifier (SAC.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setCarrierIdentifier($value, int $position = 10)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Position In Carrier (SAC.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setPositionInCarrier($value, int $position = 11)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Tray Type SAC (SAC.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setTrayTypeSAC($value, int $position = 12)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Tray Identifier (SAC.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setTrayIdentifier($value, int $position = 13)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Position In Tray (SAC.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setPositionInTray($value, int $position = 14)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Location (SAC.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setLocation($value, int $position = 15)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Container Height (SAC.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setContainerHeight($value, int $position = 16)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Container Diameter (SAC.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setContainerDiameter($value, int $position = 17)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Barrier Delta (SAC.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setBarrierDelta($value, int $position = 18)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Bottom Delta (SAC.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setBottomDelta($value, int $position = 19)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Container Size Units (SAC.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setContainerSizeUnits($value, int $position = 20)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Container Volume (SAC.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setContainerVolume($value, int $position = 21)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Available Specimen Volume (SAC.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setAvailableSpecimenVolume($value, int $position = 22)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Initial Specimen Volume (SAC.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setInitialSpecimenVolume($value, int $position = 23)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Volume Units (SAC.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setVolumeUnits($value, int $position = 24)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Separator Type (SAC.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setSeparatorType($value, int $position = 25)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Cap Type (SAC.26)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 26
+ *
+ * @return bool
+ *
+ */
public function setCapType($value, int $position = 26)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Additive (SAC.27)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 27
+ *
+ * @return bool
+ *
+ */
public function setAdditive($value, int $position = 27)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Specimen Component (SAC.28)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 28
+ *
+ * @return bool
+ *
+ */
public function setSpecimenComponent($value, int $position = 28)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Dilution Factor (SAC.29)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 29
+ *
+ * @return bool
+ *
+ */
public function setDilutionFactor($value, int $position = 29)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Treatment (SAC.30)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 30
+ *
+ * @return bool
+ *
+ */
public function setTreatment($value, int $position = 30)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Temperature (SAC.31)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 31
+ *
+ * @return bool
+ *
+ */
public function setTemperature($value, int $position = 31)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Hemolysis Index (SAC.32)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 32
+ *
+ * @return bool
+ *
+ */
public function setHemolysisIndex($value, int $position = 32)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Hemolysis Index Units (SAC.33)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 33
+ *
+ * @return bool
+ *
+ */
public function setHemolysisIndexUnits($value, int $position = 33)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Lepemia Index (SAC.34)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 34
+ *
+ * @return bool
+ *
+ */
public function setLepemiaIndex($value, int $position = 34)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Lepemia Index Units (SAC.35)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 35
+ *
+ * @return bool
+ *
+ */
public function setLepemiaIndexUnits($value, int $position = 35)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Icterus Index (SAC.36)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 36
+ *
+ * @return bool
+ *
+ */
public function setIcterusIndex($value, int $position = 36)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Icterus Index Units (SAC.37)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 37
+ *
+ * @return bool
+ *
+ */
public function setIcterusIndexUnits($value, int $position = 37)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Fibrin Index (SAC.38)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 38
+ *
+ * @return bool
+ *
+ */
public function setFibrinIndex($value, int $position = 38)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Fibrin Index Units (SAC.39)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 39
+ *
+ * @return bool
+ *
+ */
public function setFibrinIndexUnits($value, int $position = 39)
{
return $this->setField($position, $value);
}
+ /**
+ * Set System Induced Contaminants (SAC.40)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 40
+ *
+ * @return bool
+ *
+ */
public function setSystemInducedContaminants($value, int $position = 40)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Drug Interference (SAC.41)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 41
+ *
+ * @return bool
+ *
+ */
public function setDrugInterference($value, int $position = 41)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Artificial Blood (SAC.42)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 42
+ *
+ * @return bool
+ *
+ */
public function setArtificialBlood($value, int $position = 42)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Special Handling Code (SAC.43)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 43
+ *
+ * @return bool
+ *
+ */
public function setSpecialHandlingCode($value, int $position = 43)
{
return $this->setField($position, $value);
}
+ /**
+ * Set Other Environmental Factors (SAC.44)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 44
+ *
+ * @return bool
+ *
+ */
public function setOtherEnvironmentalFactors($value, int $position = 44)
{
return $this->setField($position, $value);
}
+ /**
+ * Get External Accession Identifier (SAC.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExternalAccessionIdentifier(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Accession Identifier (SAC.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAccessionIdentifier(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Container Identifier (SAC.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerIdentifier(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Primary Container Identifier (SAC.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPrimaryContainerIdentifier(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Equipment Container Identifier (SAC.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEquipmentContainerIdentifier(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Specimen Source (SAC.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecimenSource(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Registration Date Time (SAC.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRegistrationDateTime(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Container Status (SAC.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerStatus(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Carrier Type (SAC.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCarrierType(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Carrier Identifier (SAC.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCarrierIdentifier(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Position In Carrier (SAC.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPositionInCarrier(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Tray Type SAC (SAC.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTrayTypeSAC(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Tray Identifier (SAC.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTrayIdentifier(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Position In Tray (SAC.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPositionInTray(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Location (SAC.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLocation(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Container Height (SAC.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerHeight(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Container Diameter (SAC.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerDiameter(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Barrier Delta (SAC.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBarrierDelta(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Bottom Delta (SAC.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getBottomDelta(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Container Size Units (SAC.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerSizeUnits(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Container Volume (SAC.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getContainerVolume(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Available Specimen Volume (SAC.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAvailableSpecimenVolume(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Initial Specimen Volume (SAC.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getInitialSpecimenVolume(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Volume Units (SAC.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getVolumeUnits(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Separator Type (SAC.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSeparatorType(int $position = 25)
{
return $this->getField($position);
}
+ /**
+ * Get Cap Type (SAC.26)
+ *
+ * @param int $position Defaults to 26
+ *
+ * @return array|string|int|null
+ *
+ */
public function getCapType(int $position = 26)
{
return $this->getField($position);
}
+ /**
+ * Get Additive (SAC.27)
+ *
+ * @param int $position Defaults to 27
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAdditive(int $position = 27)
{
return $this->getField($position);
}
+ /**
+ * Get Specimen Component (SAC.28)
+ *
+ * @param int $position Defaults to 28
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecimenComponent(int $position = 28)
{
return $this->getField($position);
}
+ /**
+ * Get Dilution Factor (SAC.29)
+ *
+ * @param int $position Defaults to 29
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDilutionFactor(int $position = 29)
{
return $this->getField($position);
}
+ /**
+ * Get Treatment (SAC.30)
+ *
+ * @param int $position Defaults to 30
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTreatment(int $position = 30)
{
return $this->getField($position);
}
+ /**
+ * Get Temperature (SAC.31)
+ *
+ * @param int $position Defaults to 31
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTemperature(int $position = 31)
{
return $this->getField($position);
}
+ /**
+ * Get Hemolysis Index (SAC.32)
+ *
+ * @param int $position Defaults to 32
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHemolysisIndex(int $position = 32)
{
return $this->getField($position);
}
+ /**
+ * Get Hemolysis Index Units (SAC.33)
+ *
+ * @param int $position Defaults to 33
+ *
+ * @return array|string|int|null
+ *
+ */
public function getHemolysisIndexUnits(int $position = 33)
{
return $this->getField($position);
}
+ /**
+ * Get Lepemia Index (SAC.34)
+ *
+ * @param int $position Defaults to 34
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLepemiaIndex(int $position = 34)
{
return $this->getField($position);
}
+ /**
+ * Get Lepemia Index Units (SAC.35)
+ *
+ * @param int $position Defaults to 35
+ *
+ * @return array|string|int|null
+ *
+ */
public function getLepemiaIndexUnits(int $position = 35)
{
return $this->getField($position);
}
+ /**
+ * Get Icterus Index (SAC.36)
+ *
+ * @param int $position Defaults to 36
+ *
+ * @return array|string|int|null
+ *
+ */
public function getIcterusIndex(int $position = 36)
{
return $this->getField($position);
}
+ /**
+ * Get Icterus Index Units (SAC.37)
+ *
+ * @param int $position Defaults to 37
+ *
+ * @return array|string|int|null
+ *
+ */
public function getIcterusIndexUnits(int $position = 37)
{
return $this->getField($position);
}
+ /**
+ * Get Fibrin Index (SAC.38)
+ *
+ * @param int $position Defaults to 38
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFibrinIndex(int $position = 38)
{
return $this->getField($position);
}
+ /**
+ * Get Fibrin Index Units (SAC.39)
+ *
+ * @param int $position Defaults to 39
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFibrinIndexUnits(int $position = 39)
{
return $this->getField($position);
}
+ /**
+ * Get System Induced Contaminants (SAC.40)
+ *
+ * @param int $position Defaults to 40
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSystemInducedContaminants(int $position = 40)
{
return $this->getField($position);
}
+ /**
+ * Get Drug Interference (SAC.41)
+ *
+ * @param int $position Defaults to 41
+ *
+ * @return array|string|int|null
+ *
+ */
public function getDrugInterference(int $position = 41)
{
return $this->getField($position);
}
+ /**
+ * Get Artificial Blood (SAC.42)
+ *
+ * @param int $position Defaults to 42
+ *
+ * @return array|string|int|null
+ *
+ */
public function getArtificialBlood(int $position = 42)
{
return $this->getField($position);
}
+ /**
+ * Get Special Handling Code (SAC.43)
+ *
+ * @param int $position Defaults to 43
+ *
+ * @return array|string|int|null
+ *
+ */
public function getSpecialHandlingCode(int $position = 43)
{
return $this->getField($position);
}
+ /**
+ * Get Other Environmental Factors (SAC.44)
+ *
+ * @param int $position Defaults to 44
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOtherEnvironmentalFactors(int $position = 44)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/SCH.php b/src/HL7/Segments/SCH.php
index c4e52e1..d6fd007 100644
--- a/src/HL7/Segments/SCH.php
+++ b/src/HL7/Segments/SCH.php
@@ -18,251 +18,676 @@ public function __construct(array $fields = null)
parent::__construct('SCH', $fields);
}
+ /**
+ * Set Placer Appointment ID (SCH.1)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 1
+ *
+ * @return bool
+ *
+ */
public function setPlacerAppointmentID($value, int $position = 1): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Appointment ID (SCH.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setFillerAppointmentID($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Occurrence Number (SCH.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setOccurrenceNumber($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Group Number (SCH.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setPlacerGroupNumber($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Schedule ID (SCH.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setScheduleID($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Event Reason (SCH.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setEventReason($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appointment Reason (SCH.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setAppointmentReason($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appointment Type (SCH.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setAppointmentType($value, int $position = 8): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appointment Duration (SCH.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setAppointmentDuration($value, int $position = 9): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appointment Duration Units (SCH.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setAppointmentDurationUnits($value, int $position = 10): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Appointment Timing Quantity (SCH.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setAppointmentTimingQuantity($value, int $position = 11): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Contact Person (SCH.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setPlacerContactPerson($value, int $position = 12): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Contact Phone Number (SCH.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setPlacerContactPhoneNumber($value, int $position = 13): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Contact Address (SCH.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setPlacerContactAddress($value, int $position = 14): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Placer Contact Location (SCH.15)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 15
+ *
+ * @return bool
+ *
+ */
public function setPlacerContactLocation($value, int $position = 15): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Contact Person (SCH.16)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 16
+ *
+ * @return bool
+ *
+ */
public function setFillerContactPerson($value, int $position = 16): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Contact Phone Number (SCH.17)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 17
+ *
+ * @return bool
+ *
+ */
public function setFillerContactPhoneNumber($value, int $position = 17): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Contact Address (SCH.18)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 18
+ *
+ * @return bool
+ *
+ */
public function setFillerContactAddress($value, int $position = 18): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Contact Location (SCH.19)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 19
+ *
+ * @return bool
+ *
+ */
public function setFillerContactLocation($value, int $position = 19): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Enteredby Person (SCH.20)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 20
+ *
+ * @return bool
+ *
+ */
public function setEnteredbyPerson($value, int $position = 20): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Enteredby Phone Number (SCH.21)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 21
+ *
+ * @return bool
+ *
+ */
public function setEnteredbyPhoneNumber($value, int $position = 21): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Enteredby Location (SCH.22)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 22
+ *
+ * @return bool
+ *
+ */
public function setEnteredbyLocation($value, int $position = 22): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent Placer Appointment ID (SCH.23)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 23
+ *
+ * @return bool
+ *
+ */
public function setParentPlacerAppointmentID($value, int $position = 23): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Parent Filler Appointment ID (SCH.24)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 24
+ *
+ * @return bool
+ *
+ */
public function setParentFillerAppointmentID($value, int $position = 24): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Filler Status Code (SCH.25)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 25
+ *
+ * @return bool
+ *
+ */
public function setFillerStatusCode($value, int $position = 25): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Get Placer Appointment ID (SCH.1)
+ *
+ * @param int $position Defaults to 1
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerAppointmentID(int $position = 1)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Appointment ID (SCH.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerAppointmentID(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Occurrence Number (SCH.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOccurrenceNumber(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Group Number (SCH.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerGroupNumber(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Schedule ID (SCH.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getScheduleID(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Event Reason (SCH.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEventReason(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Appointment Reason (SCH.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppointmentReason(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get Appointment Type (SCH.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppointmentType(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Appointment Duration (SCH.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppointmentDuration(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Appointment Duration Units (SCH.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppointmentDurationUnits(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Appointment Timing Quantity (SCH.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getAppointmentTimingQuantity(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Contact Person (SCH.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerContactPerson(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Contact Phone Number (SCH.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerContactPhoneNumber(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Contact Address (SCH.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerContactAddress(int $position = 14)
{
return $this->getField($position);
}
+ /**
+ * Get Placer Contact Location (SCH.15)
+ *
+ * @param int $position Defaults to 15
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPlacerContactLocation(int $position = 15)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Contact Person (SCH.16)
+ *
+ * @param int $position Defaults to 16
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerContactPerson(int $position = 16)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Contact Phone Number (SCH.17)
+ *
+ * @param int $position Defaults to 17
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerContactPhoneNumber(int $position = 17)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Contact Address (SCH.18)
+ *
+ * @param int $position Defaults to 18
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerContactAddress(int $position = 18)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Contact Location (SCH.19)
+ *
+ * @param int $position Defaults to 19
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerContactLocation(int $position = 19)
{
return $this->getField($position);
}
+ /**
+ * Get Enteredby Person (SCH.20)
+ *
+ * @param int $position Defaults to 20
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteredbyPerson(int $position = 20)
{
return $this->getField($position);
}
+ /**
+ * Get Enteredby Phone Number (SCH.21)
+ *
+ * @param int $position Defaults to 21
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteredbyPhoneNumber(int $position = 21)
{
return $this->getField($position);
}
+ /**
+ * Get Enteredby Location (SCH.22)
+ *
+ * @param int $position Defaults to 22
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEnteredbyLocation(int $position = 22)
{
return $this->getField($position);
}
+ /**
+ * Get Parent Placer Appointment ID (SCH.23)
+ *
+ * @param int $position Defaults to 23
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParentPlacerAppointmentID(int $position = 23)
{
return $this->getField($position);
}
+ /**
+ * Get Parent Filler Appointment ID (SCH.24)
+ *
+ * @param int $position Defaults to 24
+ *
+ * @return array|string|int|null
+ *
+ */
public function getParentFillerAppointmentID(int $position = 24)
{
return $this->getField($position);
}
+ /**
+ * Get Filler Status Code (SCH.25)
+ *
+ * @param int $position Defaults to 25
+ *
+ * @return array|string|int|null
+ *
+ */
public function getFillerStatusCode(int $position = 25)
{
return $this->getField($position);
diff --git a/src/HL7/Segments/TQ1.php b/src/HL7/Segments/TQ1.php
index 567a2cd..3fb3495 100644
--- a/src/HL7/Segments/TQ1.php
+++ b/src/HL7/Segments/TQ1.php
@@ -22,66 +22,183 @@ public function setSetIdTQ1($value, int $position = 1): bool
return $this->setField($position, $value);
}
+ /**
+ * Set Quantity (TQ1.2)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 2
+ *
+ * @return bool
+ *
+ */
public function setQuantity($value, int $position = 2): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Repeat Pattern (TQ1.3)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 3
+ *
+ * @return bool
+ *
+ */
public function setRepeatPattern($value, int $position = 3): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Explicit Time (TQ1.4)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 4
+ *
+ * @return bool
+ *
+ */
public function setExplicitTime($value, int $position = 4): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Relative Time And Units (TQ1.5)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 5
+ *
+ * @return bool
+ *
+ */
public function setRelativeTimeAndUnits($value, int $position = 5): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Service Duration (TQ1.6)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 6
+ *
+ * @return bool
+ *
+ */
public function setServiceDuration($value, int $position = 6): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Start Date Time (TQ1.7)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 7
+ *
+ * @return bool
+ *
+ */
public function setStartDateTime($value, int $position = 7): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set End Date Time (TQ1.8)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 8
+ *
+ * @return bool
+ *
+ */
public function setEndDateTime($value, int $position = 8): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Priority (TQ1.9)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 9
+ *
+ * @return bool
+ *
+ */
public function setPriority($value, int $position = 9): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Condition Text (TQ1.10)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 10
+ *
+ * @return bool
+ *
+ */
public function setConditionText($value, int $position = 10): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Text Instruction (TQ1.11)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 11
+ *
+ * @return bool
+ *
+ */
public function setTextInstruction($value, int $position = 11): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Conjunction (TQ1.12)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 12
+ *
+ * @return bool
+ *
+ */
public function setConjunction($value, int $position = 12): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Occurrence Duration (TQ1.13)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 13
+ *
+ * @return bool
+ *
+ */
public function setOccurrenceDuration($value, int $position = 13): bool
{
return $this->setField($position, $value);
}
+ /**
+ * Set Total Occurrences (TQ1.14)
+ *
+ * @param string|int|array|null $value
+ * @param int $position Defaults to 14
+ *
+ * @return bool
+ *
+ */
public function setTotalOccurrences($value, int $position = 14): bool
{
return $this->setField($position, $value);
@@ -92,66 +209,170 @@ public function getSetIdTQ1(int $position = 1)
return $this->getField($position);
}
+ /**
+ * Get Quantity (TQ1.2)
+ *
+ * @param int $position Defaults to 2
+ *
+ * @return array|string|int|null
+ *
+ */
public function getQuantity(int $position = 2)
{
return $this->getField($position);
}
+ /**
+ * Get Repeat Pattern (TQ1.3)
+ *
+ * @param int $position Defaults to 3
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRepeatPattern(int $position = 3)
{
return $this->getField($position);
}
+ /**
+ * Get Explicit Time (TQ1.4)
+ *
+ * @param int $position Defaults to 4
+ *
+ * @return array|string|int|null
+ *
+ */
public function getExplicitTime(int $position = 4)
{
return $this->getField($position);
}
+ /**
+ * Get Relative Time And Units (TQ1.5)
+ *
+ * @param int $position Defaults to 5
+ *
+ * @return array|string|int|null
+ *
+ */
public function getRelativeTimeAndUnits(int $position = 5)
{
return $this->getField($position);
}
+ /**
+ * Get Service Duration (TQ1.6)
+ *
+ * @param int $position Defaults to 6
+ *
+ * @return array|string|int|null
+ *
+ */
public function getServiceDuration(int $position = 6)
{
return $this->getField($position);
}
+ /**
+ * Get Start Date Time (TQ1.7)
+ *
+ * @param int $position Defaults to 7
+ *
+ * @return array|string|int|null
+ *
+ */
public function getStartDateTime(int $position = 7)
{
return $this->getField($position);
}
+ /**
+ * Get End Date Time (TQ1.8)
+ *
+ * @param int $position Defaults to 8
+ *
+ * @return array|string|int|null
+ *
+ */
public function getEndDateTime(int $position = 8)
{
return $this->getField($position);
}
+ /**
+ * Get Priority (TQ1.9)
+ *
+ * @param int $position Defaults to 9
+ *
+ * @return array|string|int|null
+ *
+ */
public function getPriority(int $position = 9)
{
return $this->getField($position);
}
+ /**
+ * Get Condition Text (TQ1.10)
+ *
+ * @param int $position Defaults to 10
+ *
+ * @return array|string|int|null
+ *
+ */
public function getConditionText(int $position = 10)
{
return $this->getField($position);
}
+ /**
+ * Get Text Instruction (TQ1.11)
+ *
+ * @param int $position Defaults to 11
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTextInstruction(int $position = 11)
{
return $this->getField($position);
}
+ /**
+ * Get Conjunction (TQ1.12)
+ *
+ * @param int $position Defaults to 12
+ *
+ * @return array|string|int|null
+ *
+ */
public function getConjunction(int $position = 12)
{
return $this->getField($position);
}
+ /**
+ * Get Occurrence Duration (TQ1.13)
+ *
+ * @param int $position Defaults to 13
+ *
+ * @return array|string|int|null
+ *
+ */
public function getOccurrenceDuration(int $position = 13)
{
return $this->getField($position);
}
+ /**
+ * Get Total Occurrences (TQ1.14)
+ *
+ * @param int $position Defaults to 14
+ *
+ * @return array|string|int|null
+ *
+ */
public function getTotalOccurrences(int $position = 14)
{
return $this->getField($position);