IMS Plugin/Documentation
From 360Works Product Documentation Wiki
(Difference between revisions)
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
WikiEditTask (Talk | contribs) m (Auto-upload documentation) |
||
| Line 10: | Line 10: | ||
<div id="toc"> | <div id="toc"> | ||
*[[#IMSAddAgencyGroup|IMSAddAgencyGroup]] — Adds a new AgencyGroup | *[[#IMSAddAgencyGroup|IMSAddAgencyGroup]] — Adds a new AgencyGroup | ||
| + | *[[#IMSAddCrewGroup|IMSAddCrewGroup]] ( correlationID ) — Adds a new CrewGroup | ||
*[[#IMSAddCustomGroup|IMSAddCustomGroup]] ( customElementID ) — Adds a new eCustomConfiguration. | *[[#IMSAddCustomGroup|IMSAddCustomGroup]] ( customElementID ) — Adds a new eCustomConfiguration. | ||
*[[#IMSAddDagency01|IMSAddDagency01]] ( value ) — Adds a new dAgency. | *[[#IMSAddDagency01|IMSAddDagency01]] ( value ) — Adds a new dAgency. | ||
| Line 15: | Line 16: | ||
*[[#IMSAddDagency04|IMSAddDagency04]] ( value ) — Adds a new dAgency. | *[[#IMSAddDagency04|IMSAddDagency04]] ( value ) — Adds a new dAgency. | ||
*[[#IMSAddDemographicGroup|IMSAddDemographicGroup]] — Adds a new DemographicGroup | *[[#IMSAddDemographicGroup|IMSAddDemographicGroup]] — Adds a new DemographicGroup | ||
| + | *[[#IMSAddECrew|IMSAddECrew]] — Adds a new eCrew | ||
| + | *[[#IMSAddECrew01|IMSAddECrew01]] ( NV ; value ) — Adds a new eCrew01 | ||
| + | *[[#IMSAddECrew01|IMSAddECrew01]] ( NV ; correlationID ; value ) — Adds a new eCrew03 | ||
| + | *[[#IMSAddECrew02|IMSAddECrew02]] ( NV ; value ) — Adds a new eCrew02 | ||
*[[#IMSAddECustomConfiguration|IMSAddECustomConfiguration]] — Adds a new eCustomConfiguration | *[[#IMSAddECustomConfiguration|IMSAddECustomConfiguration]] — Adds a new eCustomConfiguration | ||
*[[#IMSAddECustomConfiguration01|IMSAddECustomConfiguration01]] ( nemsisElement ; value ) — Adds a new eCustomConfiguration. | *[[#IMSAddECustomConfiguration01|IMSAddECustomConfiguration01]] ( nemsisElement ; value ) — Adds a new eCustomConfiguration. | ||
| Line 25: | Line 30: | ||
*[[#IMSAddECustomConfiguration08|IMSAddECustomConfiguration08]] ( value ) — Adds a new eCustomConfiguration. | *[[#IMSAddECustomConfiguration08|IMSAddECustomConfiguration08]] ( value ) — Adds a new eCustomConfiguration. | ||
*[[#IMSAddECustomConfiguration09|IMSAddECustomConfiguration09]] ( value ) — Adds a new eCustomConfiguration. | *[[#IMSAddECustomConfiguration09|IMSAddECustomConfiguration09]] ( value ) — Adds a new eCustomConfiguration. | ||
| + | *[[#IMSAddEDispatch|IMSAddEDispatch]] — Adds a new eDispatch | ||
| + | *[[#IMSAddEDispatch01|IMSAddEDispatch01]] ( value ) — Adds a new eDispatch01 | ||
| + | *[[#IMSAddEDispatch02|IMSAddEDispatch02]] ( NV ; value ) — Adds a new eDispatch02 | ||
| + | *[[#IMSAddEDispatch03|IMSAddEDispatch03]] ( value ) — Adds a new eDispatch03 | ||
| + | *[[#IMSAddEDispatch04|IMSAddEDispatch04]] ( value ) — Adds a new eDispatch04 | ||
| + | *[[#IMSAddEDispatch05|IMSAddEDispatch05]] ( value ) — Adds a new eDispatch05 | ||
| + | *[[#IMSAddEDispatch06|IMSAddEDispatch06]] ( value ) — Adds a new eDispatch06 | ||
*[[#IMSAddERecord|IMSAddERecord]] — Adds a new eRecord | *[[#IMSAddERecord|IMSAddERecord]] — Adds a new eRecord | ||
*[[#IMSAddERecord01|IMSAddERecord01]] ( value ) — Adds a new eRecord. | *[[#IMSAddERecord01|IMSAddERecord01]] ( value ) — Adds a new eRecord. | ||
| Line 49: | Line 61: | ||
*[[#IMSAddEResponse18|IMSAddEResponse18]] ( value ) — Adds a new eResponse18 | *[[#IMSAddEResponse18|IMSAddEResponse18]] ( value ) — Adds a new eResponse18 | ||
*[[#IMSAddEResponse19|IMSAddEResponse19]] ( value ) — Adds a new eResponse19 | *[[#IMSAddEResponse19|IMSAddEResponse19]] ( value ) — Adds a new eResponse19 | ||
| + | *[[#IMSAddEResponse20|IMSAddEResponse20]] ( value ) — Adds a new eResponse20 | ||
| + | *[[#IMSAddEResponse21|IMSAddEResponse21]] ( value ) — Adds a new eResponse21 | ||
| + | *[[#IMSAddEResponse22|IMSAddEResponse22]] ( value ) — Adds a new eResponse22 | ||
| + | *[[#IMSAddEResponse23|IMSAddEResponse23]] ( value ) — Adds a new eResponse23 | ||
| + | *[[#IMSAddEResponse24|IMSAddEResponse24]] ( NV ; correlationID ; value ) — Adds a new eResponse24 | ||
*[[#IMSAddEstate|IMSAddEstate]] — Adds a new eState | *[[#IMSAddEstate|IMSAddEstate]] — Adds a new eState | ||
*[[#IMSAddEstate01|IMSAddEstate01]] ( timestamp ; value ) — Adds a new eState. | *[[#IMSAddEstate01|IMSAddEstate01]] ( timestamp ; value ) — Adds a new eState. | ||
| + | *[[#IMSAddETimes|IMSAddETimes]] — Adds a new eTimes | ||
| + | *[[#IMSAddETimes01|IMSAddETimes01]] ( NV ; value ) — Adds a new eTimes01 | ||
*[[#IMSAddHeader|IMSAddHeader]] — Adds a new Header | *[[#IMSAddHeader|IMSAddHeader]] — Adds a new Header | ||
*[[#IMSAddPatientCareReport|IMSAddPatientCareReport]] — Adds a new PatientCareReport | *[[#IMSAddPatientCareReport|IMSAddPatientCareReport]] — Adds a new PatientCareReport | ||
| Line 68: | Line 87: | ||
Adds a new AgencyGroup | Adds a new AgencyGroup | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddCrewGroup"></div> | ||
| + | ==IMSAddCrewGroup ( correlationID ) == | ||
| + | Adds a new CrewGroup | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>correlationID</code> <dd> | ||
| + | </dl></div> | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
</div> | </div> | ||
| Line 111: | Line 140: | ||
Adds a new DemographicGroup | Adds a new DemographicGroup | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddECrew"></div> | ||
| + | ==IMSAddECrew== | ||
| + | Adds a new eCrew | ||
| + | |||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddECrew01"></div> | ||
| + | ==IMSAddECrew01 ( NV ; value ) == | ||
| + | Adds a new eCrew01 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddECrew01"></div> | ||
| + | ==IMSAddECrew01 ( NV ; correlationID ; value ) == | ||
| + | Adds a new eCrew03 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>correlationID</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddECrew02"></div> | ||
| + | ==IMSAddECrew02 ( NV ; value ) == | ||
| + | Adds a new eCrew02 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
</div> | </div> | ||
| Line 200: | Line 270: | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
<dl></dl></div> | <dl></dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch"></div> | ||
| + | ==IMSAddEDispatch== | ||
| + | Adds a new eDispatch | ||
| + | |||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch01"></div> | ||
| + | ==IMSAddEDispatch01 ( value ) == | ||
| + | Adds a new eDispatch01 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch02"></div> | ||
| + | ==IMSAddEDispatch02 ( NV ; value ) == | ||
| + | Adds a new eDispatch02 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch03"></div> | ||
| + | ==IMSAddEDispatch03 ( value ) == | ||
| + | Adds a new eDispatch03 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch04"></div> | ||
| + | ==IMSAddEDispatch04 ( value ) == | ||
| + | Adds a new eDispatch04 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch05"></div> | ||
| + | ==IMSAddEDispatch05 ( value ) == | ||
| + | Adds a new eDispatch05 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEDispatch06"></div> | ||
| + | ==IMSAddEDispatch06 ( value ) == | ||
| + | Adds a new eDispatch06 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
</div> | </div> | ||
| Line 444: | Line 582: | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
<dl><dt><code>value</code> <dd> | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEResponse20"></div> | ||
| + | ==IMSAddEResponse20 ( value ) == | ||
| + | Adds a new eResponse20 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEResponse21"></div> | ||
| + | ==IMSAddEResponse21 ( value ) == | ||
| + | Adds a new eResponse21 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEResponse22"></div> | ||
| + | ==IMSAddEResponse22 ( value ) == | ||
| + | Adds a new eResponse22 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEResponse23"></div> | ||
| + | ==IMSAddEResponse23 ( value ) == | ||
| + | Adds a new eResponse23 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddEResponse24"></div> | ||
| + | ==IMSAddEResponse24 ( NV ; correlationID ; value ) == | ||
| + | Adds a new eResponse24 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>correlationID</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
</dl></div> | </dl></div> | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| Line 460: | Line 650: | ||
<div class="parameters"><strong>Parameters:</strong> | <div class="parameters"><strong>Parameters:</strong> | ||
| − | <dl></dl></div> | + | <dl><dt><code>timestamp</code> <dd> |
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddETimes"></div> | ||
| + | ==IMSAddETimes== | ||
| + | Adds a new eTimes | ||
| + | |||
| + | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
| + | </div> | ||
| + | |||
| + | <div id="IMSAddETimes01"></div> | ||
| + | ==IMSAddETimes01 ( NV ; value ) == | ||
| + | Adds a new eTimes01 | ||
| + | |||
| + | <div class="parameters"><strong>Parameters:</strong> | ||
| + | <dl><dt><code>NV</code> <dd> | ||
| + | <dt><code>value</code> <dd> | ||
| + | </dl></div> | ||
<div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | <div class="see"><strong>Returns:</strong> 1 if successful or "ERROR" if an error occurred. | ||
</div> | </div> | ||
Revision as of 19:15, 26 January 2016
IMS Plugin User Guide
Created by IntelliJ IDEA. User: will Date: 1/22/16 Time: 1:29 PM
360Works Plugin Setup Guides
See Plugins_101 for Error reporting, installation, registration, and more.
Function Summary
- IMSAddAgencyGroup — Adds a new AgencyGroup
- IMSAddCrewGroup ( correlationID ) — Adds a new CrewGroup
- IMSAddCustomGroup ( customElementID ) — Adds a new eCustomConfiguration.
- IMSAddDagency01 ( value ) — Adds a new dAgency.
- IMSAddDagency02 ( value ) — Adds a new dAgency.
- IMSAddDagency04 ( value ) — Adds a new dAgency.
- IMSAddDemographicGroup — Adds a new DemographicGroup
- IMSAddECrew — Adds a new eCrew
- IMSAddECrew01 ( NV ; value ) — Adds a new eCrew01
- IMSAddECrew01 ( NV ; correlationID ; value ) — Adds a new eCrew03
- IMSAddECrew02 ( NV ; value ) — Adds a new eCrew02
- IMSAddECustomConfiguration — Adds a new eCustomConfiguration
- IMSAddECustomConfiguration01 ( nemsisElement ; value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration02 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration03 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration04 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration05 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration06 ( namsisCode ; customValueDescription ; value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration07 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration08 ( value ) — Adds a new eCustomConfiguration.
- IMSAddECustomConfiguration09 ( value ) — Adds a new eCustomConfiguration.
- IMSAddEDispatch — Adds a new eDispatch
- IMSAddEDispatch01 ( value ) — Adds a new eDispatch01
- IMSAddEDispatch02 ( NV ; value ) — Adds a new eDispatch02
- IMSAddEDispatch03 ( value ) — Adds a new eDispatch03
- IMSAddEDispatch04 ( value ) — Adds a new eDispatch04
- IMSAddEDispatch05 ( value ) — Adds a new eDispatch05
- IMSAddEDispatch06 ( value ) — Adds a new eDispatch06
- IMSAddERecord — Adds a new eRecord
- IMSAddERecord01 ( value ) — Adds a new eRecord.
- IMSAddERecord02 ( value ) — Adds a new eRecord.
- IMSAddERecord03 ( value ) — Adds a new eRecord.
- IMSAddERecord04 ( value ) — Adds a new eRecord.
- IMSAddEResponse — Adds a new eResponse
- IMSAddEResponse01 ( value ) — Adds a new eResponse01
- IMSAddEResponse02 ( NV ; value ) — Adds a new eResponse02
- IMSAddEResponse03 ( NV ; value ) — Adds a new eResponse03
- IMSAddEResponse05 ( value ) — Adds a new eResponse05
- IMSAddEResponse05 ( NV ; correlationID ; value ) — Adds a new eResponse08
- IMSAddEResponse06 ( value ) — Adds a new eResponse06
- IMSAddEResponse07 ( value ) — Adds a new eResponse07
- IMSAddEResponse09 ( NV ; correlationID ; value ) — Adds a new eResponse09
- IMSAddEResponse10 ( NV ; correlationID ; value ) — Adds a new eResponse10
- IMSAddEResponse11 ( NV ; correlationID ; value ) — Adds a new eResponse11
- IMSAddEResponse12 ( NV ; correlationID ; value ) — Adds a new eResponse12
- IMSAddEResponse13 ( value ) — Adds a new eResponse13
- IMSAddEResponse14 ( value ) — Adds a new eResponse14
- IMSAddEResponse15 ( value ) — Adds a new eResponse15
- IMSAddEResponse16 ( value ) — Adds a new eResponse16
- IMSAddEResponse17 ( value ) — Adds a new eResponse17
- IMSAddEResponse18 ( value ) — Adds a new eResponse18
- IMSAddEResponse19 ( value ) — Adds a new eResponse19
- IMSAddEResponse20 ( value ) — Adds a new eResponse20
- IMSAddEResponse21 ( value ) — Adds a new eResponse21
- IMSAddEResponse22 ( value ) — Adds a new eResponse22
- IMSAddEResponse23 ( value ) — Adds a new eResponse23
- IMSAddEResponse24 ( NV ; correlationID ; value ) — Adds a new eResponse24
- IMSAddEstate — Adds a new eState
- IMSAddEstate01 ( timestamp ; value ) — Adds a new eState.
- IMSAddETimes — Adds a new eTimes
- IMSAddETimes01 ( NV ; value ) — Adds a new eTimes01
- IMSAddHeader — Adds a new Header
- IMSAddPatientCareReport — Adds a new PatientCareReport
- IMSAddServiceGroup — Adds a new ServiceGroup
- IMSAddSoftwareApplicationGroup — Adds a new SoftwareApplicationGroup
- IMSBuildXML ( fileName { ; folderPath} ) — Generates and saves XML.
- IMSLastError — Returns the text of the last error triggered by a plugin function.
- IMSLicenseInfo — Returns information about the license used.
- IMSNewDataSet — Creates a new EMSDataSet
- IMSRegister ( licenseKey ; registeredTo ) — Registers the IMS Plugin.
- IMSSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
- IMSVersion — Returns the version of the IMS plugin which is installed.
Function Detail
IMSAddAgencyGroup
Adds a new AgencyGroup
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddCrewGroup ( correlationID )
Adds a new CrewGroup
Parameters:
correlationID
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddCustomGroup ( customElementID )
Adds a new eCustomConfiguration.CustomGroup
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddDagency01 ( value )
Adds a new dAgency.01
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddDagency02 ( value )
Adds a new dAgency.02
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddDagency04 ( value )
Adds a new dAgency.04
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddDemographicGroup
Adds a new DemographicGroup
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECrew
Adds a new eCrew
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECrew01 ( NV ; value )
Adds a new eCrew01
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECrew01 ( NV ; correlationID ; value )
Adds a new eCrew03
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECrew02 ( NV ; value )
Adds a new eCrew02
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration
Adds a new eCustomConfiguration
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration01 ( nemsisElement ; value )
Adds a new eCustomConfiguration.01
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration02 ( value )
Adds a new eCustomConfiguration.02
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration03 ( value )
Adds a new eCustomConfiguration.03
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration04 ( value )
Adds a new eCustomConfiguration.04
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration05 ( value )
Adds a new eCustomConfiguration.05
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration06 ( namsisCode ; customValueDescription ; value )
Adds a new eCustomConfiguration.06
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration07 ( value )
Adds a new eCustomConfiguration.07
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration08 ( value )
Adds a new eCustomConfiguration.08
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddECustomConfiguration09 ( value )
Adds a new eCustomConfiguration.09
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch
Adds a new eDispatch
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch01 ( value )
Adds a new eDispatch01
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch02 ( NV ; value )
Adds a new eDispatch02
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch03 ( value )
Adds a new eDispatch03
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch04 ( value )
Adds a new eDispatch04
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch05 ( value )
Adds a new eDispatch05
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEDispatch06 ( value )
Adds a new eDispatch06
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddERecord
Adds a new eRecord
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddERecord01 ( value )
Adds a new eRecord.01
Parameters:
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddERecord02 ( value )
Adds a new eRecord.02
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddERecord03 ( value )
Adds a new eRecord.03
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddERecord04 ( value )
Adds a new eRecord.04
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse
Adds a new eResponse
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse01 ( value )
Adds a new eResponse01
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse02 ( NV ; value )
Adds a new eResponse02
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse03 ( NV ; value )
Adds a new eResponse03
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse05 ( value )
Adds a new eResponse05
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse05 ( NV ; correlationID ; value )
Adds a new eResponse08
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse06 ( value )
Adds a new eResponse06
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse07 ( value )
Adds a new eResponse07
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse09 ( NV ; correlationID ; value )
Adds a new eResponse09
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse10 ( NV ; correlationID ; value )
Adds a new eResponse10
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse11 ( NV ; correlationID ; value )
Adds a new eResponse11
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse12 ( NV ; correlationID ; value )
Adds a new eResponse12
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse13 ( value )
Adds a new eResponse13
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse14 ( value )
Adds a new eResponse14
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse15 ( value )
Adds a new eResponse15
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse16 ( value )
Adds a new eResponse16
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse17 ( value )
Adds a new eResponse17
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse18 ( value )
Adds a new eResponse18
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse19 ( value )
Adds a new eResponse19
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse20 ( value )
Adds a new eResponse20
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse21 ( value )
Adds a new eResponse21
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse22 ( value )
Adds a new eResponse22
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse23 ( value )
Adds a new eResponse23
Parameters:
value
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEResponse24 ( NV ; correlationID ; value )
Adds a new eResponse24
Parameters:
NVcorrelationIDvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEstate
Adds a new eState
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddEstate01 ( timestamp ; value )
Adds a new eState.01
Parameters:
timestampvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddETimes
Adds a new eTimes
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddETimes01 ( NV ; value )
Adds a new eTimes01
Parameters:
NVvalue
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddHeader
Adds a new Header
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddPatientCareReport
Adds a new PatientCareReport
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddServiceGroup
Adds a new ServiceGroup
Returns: 1 if successful or "ERROR" if an error occurred.
IMSAddSoftwareApplicationGroup
Adds a new SoftwareApplicationGroup
Returns: 1 if successful or "ERROR" if an error occurred.
IMSBuildXML ( fileName { ; folderPath} )
Generates and saves XML. If you do not supply a folderPath, you may set the result of this plugin funcion to a container field. Otherwise, the file will be saved to the specified folder path.
Parameters:
fileNamefolderPath
Returns: Container data if the save is successful and no folderPath was specified, 1 if saved to disk or "ERROR" if an error occurred.
IMSLastError
Returns the text of the last error triggered by a plugin function. This should be called immediately after a plugin function returns "ERROR" to get a description of the error.
Returns: Error text, or
"" if there was no error.
IMSLicenseInfo
Returns information about the license used.
Returns: The type of license the plugin is registered under.
IMSNewDataSet
Creates a new EMSDataSet
Returns: 1 if successful or "ERROR" if an error occurred.
IMSRegister ( licenseKey ; registeredTo )
Registers the IMS Plugin.
Parameters:
licenseKey- a valid license key string, or the literal string "DEMO" to run in demo mode.
registeredTo- the company name for the license key used.
Returns: 1 on success, or "ERROR" on failure.
IMSSetErrorCapture ( errorCapture )
Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call EmailSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.
Parameters:
errorCapture- set to true to suppress the default popups.
IMSVersion
Returns the version of the IMS plugin which is installed.
Returns: a decimal version number.
