IMS Plugin/Documentation
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
IMSAddCrewGroup ( correlationID )
Adds a new CrewGroup
correlationID
IMSAddCustomGroup ( customElementID )
Adds a new eCustomConfiguration.CustomGroup
IMSAddDagency01 ( value )
Adds a new dAgency.01
IMSAddDagency02 ( value )
Adds a new dAgency.02
IMSAddDagency04 ( value )
Adds a new dAgency.04
IMSAddDemographicGroup
Adds a new DemographicGroup
IMSAddECrew
Adds a new eCrew
IMSAddECrew01 ( NV ; value )
Adds a new eCrew01
NV
value
IMSAddECrew01 ( NV ; correlationID ; value )
Adds a new eCrew03
NV
correlationID
value
IMSAddECrew02 ( NV ; value )
Adds a new eCrew02
NV
value
IMSAddECustomConfiguration
Adds a new eCustomConfiguration
IMSAddECustomConfiguration01 ( nemsisElement ; value )
Adds a new eCustomConfiguration.01
IMSAddECustomConfiguration02 ( value )
Adds a new eCustomConfiguration.02
IMSAddECustomConfiguration03 ( value )
Adds a new eCustomConfiguration.03
value
IMSAddECustomConfiguration04 ( value )
Adds a new eCustomConfiguration.04
IMSAddECustomConfiguration05 ( value )
Adds a new eCustomConfiguration.05
IMSAddECustomConfiguration06 ( namsisCode ; customValueDescription ; value )
Adds a new eCustomConfiguration.06
IMSAddECustomConfiguration07 ( value )
Adds a new eCustomConfiguration.07
IMSAddECustomConfiguration08 ( value )
Adds a new eCustomConfiguration.08
IMSAddECustomConfiguration09 ( value )
Adds a new eCustomConfiguration.09
IMSAddEDispatch
Adds a new eDispatch
IMSAddEDispatch01 ( value )
Adds a new eDispatch01
value
IMSAddEDispatch02 ( NV ; value )
Adds a new eDispatch02
NV
value
IMSAddEDispatch03 ( value )
Adds a new eDispatch03
value
IMSAddEDispatch04 ( value )
Adds a new eDispatch04
value
IMSAddEDispatch05 ( value )
Adds a new eDispatch05
value
IMSAddEDispatch06 ( value )
Adds a new eDispatch06
value
IMSAddERecord
Adds a new eRecord
IMSAddERecord01 ( value )
Adds a new eRecord.01
IMSAddERecord02 ( value )
Adds a new eRecord.02
value
IMSAddERecord03 ( value )
Adds a new eRecord.03
value
IMSAddERecord04 ( value )
Adds a new eRecord.04
value
IMSAddEResponse
Adds a new eResponse
IMSAddEResponse01 ( value )
Adds a new eResponse01
value
IMSAddEResponse02 ( NV ; value )
Adds a new eResponse02
NV
value
IMSAddEResponse03 ( NV ; value )
Adds a new eResponse03
NV
value
IMSAddEResponse05 ( value )
Adds a new eResponse05
value
IMSAddEResponse05 ( NV ; correlationID ; value )
Adds a new eResponse08
NV
correlationID
value
IMSAddEResponse06 ( value )
Adds a new eResponse06
value
IMSAddEResponse07 ( value )
Adds a new eResponse07
value
IMSAddEResponse09 ( NV ; correlationID ; value )
Adds a new eResponse09
NV
correlationID
value
IMSAddEResponse10 ( NV ; correlationID ; value )
Adds a new eResponse10
NV
correlationID
value
IMSAddEResponse11 ( NV ; correlationID ; value )
Adds a new eResponse11
NV
correlationID
value
IMSAddEResponse12 ( NV ; correlationID ; value )
Adds a new eResponse12
NV
correlationID
value
IMSAddEResponse13 ( value )
Adds a new eResponse13
value
IMSAddEResponse14 ( value )
Adds a new eResponse14
value
IMSAddEResponse15 ( value )
Adds a new eResponse15
value
IMSAddEResponse16 ( value )
Adds a new eResponse16
value
IMSAddEResponse17 ( value )
Adds a new eResponse17
value
IMSAddEResponse18 ( value )
Adds a new eResponse18
value
IMSAddEResponse19 ( value )
Adds a new eResponse19
value
IMSAddEResponse20 ( value )
Adds a new eResponse20
value
IMSAddEResponse21 ( value )
Adds a new eResponse21
value
IMSAddEResponse22 ( value )
Adds a new eResponse22
value
IMSAddEResponse23 ( value )
Adds a new eResponse23
value
IMSAddEResponse24 ( NV ; correlationID ; value )
Adds a new eResponse24
NV
correlationID
value
IMSAddEstate
Adds a new eState
IMSAddEstate01 ( timestamp ; value )
Adds a new eState.01
timestamp
value
IMSAddETimes
Adds a new eTimes
IMSAddETimes01 ( NV ; value )
Adds a new eTimes01
NV
value
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. 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.
fileName
folderPath
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.
""
if there was no error.
IMSLicenseInfo
Returns information about the license used.
IMSNewDataSet
Creates a new EMSDataSet
IMSRegister ( licenseKey ; registeredTo )
Registers the IMS Plugin.
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.
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.
errorCapture
- set to true to suppress the default popups.
IMSVersion
Returns the version of the IMS plugin which is installed.