Professional Documents
Culture Documents
4
Rev.: 01 Rev.date: 2020.01.09 Author: EM Prj: MA1 Code: MO49
Version 1.4
DOCUMENT REVISIONS
REV. Description of improvements with respect to the previous version or to the substituted document.
• Supported by Maestro 1.0.4 – 1.3.0. Support has been dropped in Maestro 1.3.1.
• First officially supported revision of the protocol.
• Known bugs: due to an error in the MaestroReport_v1.1.xsd file, Maestro only saves the
report when the Patient ID field contains a numeric value. Specifying a generic alphanumeric
string causes Maestro to fail during the report generation.
• Notes: Generic alphanumeric values for the Patient ID field were listed as supported in the
rev1.1 technical specification, but an error in the Maestro Report schema file
(MaestroReport_v1.1.xsd) actually caused Maestro to fail when a non-numeric ID had been
specified in the Request file.
MII Availability
The MII protocol is only supported by Maestro when it is being run in Standalone mode.
Interoperability with third party applications is not available when Maestro is installed in NOAH or
Database mode.
MII workflow
Interaction between Maestro and TPAs is accomplished by passing an MII Request file to Maestro
at start-up time. Maestro then processes the file and configures itself to serve the request. When
the operator closes Maestro, an MII Result file is generated for the TPA to consume, detailing the
results of the operator actions in the current session. Both MII Request and Result files are xml files
conforming to the MII specification below.
where filename.mii specifies the full path to the Request file. The directory containing the Request
file must be writable by the current user.
The operator is then expected to perform an examination on the patient, save the medical report
and close Maestro.
SYNCHRONIZATION
When Maestro is launched with the /mii parameter, it immediately creates a lock file in the folder
containing the MII file. The lock file has the same name as the specified MII Request file and ends
with the .lock extension. When Maestro is closed by the operator, it first writes the MII Result file
to disk (along with the reports, if any exams have been performed) and then removes the lock file.
Thus, the calling software should wait on the lock file and only access the Result file after the lock
file has been deleted.
The duty to remove the Result file and the exam report when they are no longer needed is left to
the TPA.
The versionMajor and versionMinor attributes must be populated with the revision number of
the MII specification that the MII file is conforming to. The values needed for versionMajor and
versionMinor to refer to the revision of the specification described in this document are “1” and
“4”, respectively.
Inside the <MII> record, either a <Request> or a <Result> element is allowed, depending on the
MII file type.
Please refer to the following sections for an introduction to the elements allowed inside MII Request
and Result files. For a formal specification of the structure and syntax of MII files please refer to the
MII XSD schema definition attached to this document. Sample Request and Result files are also
available in Appendix A and B.
Inside a <Result> element, only one or more <Report> elements are allowed. Each of them
describes the location of an exam report file on disk, its format and contents.
SISI|SpeechAudiometry|TENTest|ToneDecay|
Tympanometry|VideoOtoscopy|Video]
(See Support Notes for Maestro 1.12)
In case two or more exams have been performed during a single session, the behavior of Maestro
depends on the value specified for the <AggregateReports> element in the Request file. If
<AggregateReports> is set to true, only one <Report> element will be present in the Result file,
and all exams performed will be listed in its <Exam> elements. Accordingly, a single report file will
be written to disk, containing the findings of the whole exam session.
If <AggregateReports> is set to false, and two or more exams have been performed in the current
session, more <Report> elements will be present in the Result file, each containing a single <Exam>
element, and corresponding to a separate report file containing the findings of that single exam.
Maestro 1.12 only supports exporting pure tone and speech audiometries, tympanometries and
acoustic reflexes in XML format. All other exam types are disabled and cannot be performed if an
XML export has been requested via MII.
<Request id="42">
<GUI>
<Layout>
<Left>0</Left>
<Top>0</Top>
<Width>1600</Width>
<Height>1200</Height>
</Layout>
<Logo>D:\logo.png</Logo>
<Language>en</Language>
</GUI>
<Patient>
<Title>Mr.</Title>
<FirstName>John</FirstName>
<MiddleName></MiddleName>
<LastName>Doe</LastName>
<ID>AA0123456789</ID>
<BirthDate>2015-01-01</BirthDate>
<Gender>N</Gender>
</Patient>
<Operator>Dr. Smith</Operator>
<ReportFormat>XML</ReportFormat>
<OutputFolder>C:\Temp</OutputFolder>
<ResultFile>Result.mii</ResultFile>
<AggregateReports>false</AggregateReports>
</Request>
</MII>
Example of a result file corresponding to the request above, where AggregateReport is set to false:
<?xml version="1.0" encoding="ISO-8859-1"?>
<MII versionMajor="1" versionMinor="4">
<Result id="42">
<Report>
<ReportFormat>XML</ReportFormat>
<FileName>C:\Temp\Report001.xml</FileName>
<Exam>PureToneAudiometry</Exam>
</Report>
<Report>
<ReportFormat>XML</ReportFormat>
<FileName>C:\Temp\Report002.xml</FileName>
<Exam>SpeechAudiometry</Exam>
</Report>
<Report>
<ReportFormat>XML</ReportFormat>
<FileName>C:\Temp\Report003.xml</FileName>
<Exam>Tympanometry</Exam>
</Report>
<Report>
<ReportFormat>XML</ReportFormat>
<FileName>C:\Temp\Report004.xml</FileName>
<Exam>Reflex</Exam>
</Report>
</Result>
</MII>
“DD45”: DD45
StimulusSide string Side of the stimulus “NOT_DEFINED”
channel “Left”
“Right”
“Bilateral”
StimulusInput string Input of the “NOT_DEFINED”
stimulus channel “TONE”
“WARBLE”
“NARROWBANDNOISE”
“WHITENOISE”
MaskingOutput string Output of the “NOT_DEFINED”
masking channel “AC”: air conduction
“BC”: bone conduction
“FF”: free field
“INS_MASK”: insert mask
MaskingTransducer string Transducer of the “NOT_DEFINED”
masking channel “TDH39”: TDH-39
“BONE_BC71”: BC – 71
“FREE_FIELD”: free field
“EARTONE_ER3”: ER-3
“EARTONE_ER5”: ER-5
“SENNHEISER_HDA300”: HDA300
“SENNHEISER_HDA200”: HDA200
“SENNHEISER_HDA280”: HDA280
“IME100”: IME100
“DD45”: DD45
MaskingSide string Side of the masking “NOT_DEFINED”
channel “Left”
“Right”
“Bilateral”
MaskingInput string Input of the “NOT_DEFINED”
masking channel “TONE”
“WARBLE”
“NARROWBANDNOISE”
“WHITENOISE”
IsUCL string True if the type of True, false
threshold
examined is UCL,
false if it is HL.
StimulusDBLevel int Intensity level of [-10, 120]
the stimulus
StimulusFrequency int Frequency of the [125, …, 8000, 12500]
Point
stimulus
Masked string True if the point is True, false
masked
Rev 2
The speech audiometry exam is composed of traces. Each trace is described by trace parameters
and is composed of points. The following table specifies the trace parameters and the point
elements:
PressureRateMode is
FIXEDRATE) (daPa/s)
PressureAutoRateMaxValu Unsigned Pressure rate maximum [15, 600]
e short value (different from 0
only if
PressureRateMode is
AUTORATE) (daPa/s)
PressureAutoRateMinValu Unsigned Pressure rate minimum [15, 600]
e short value (different from 0
only if
PressureRateMode is
AUTORATE) (daPa/s)
PressureSweep Enum Pressure sweep “INCREASING”
direction “DECREASING”
DisplayedPressureMaxValu short Pressure scale [-600, + 400]
e maximum displayed
value (daPa)
DisplayedPressureMinValu short Pressure scale [-600, + 400]
e minimum displayed
value (daPa)
DisplayedAdmittanceMode Enum If compensated, the “COMPENSATED”
contribution of the ear “ABSOLUTE”
canal volume is
removed
DisplayedAdmittanceComp string Admittance component “NOT_DEFINED”
onent (Y, B, G) “MODULE”
“SUSCEPTANCE”
“CONDUCTANCE”
“CONDUCTANCEANDSUSCEP
TANCE”
DisplayedAdmittanceMaxV short Admittance scale
alue maximum displayed
value (multiplied by
1000)
DisplayedAdmittanceMinV short Admittance scale
alue minimum displayed
value (multiplied by
1000)
AdmittanceUnitOfMeasure string Unit of measure of “NOT_DEFINED”
admittance “ML”
“CM3”
“MMHO”
AdmittanceConversionFact float Conversion factor
or between mmho and ml
measurement units
[mmho] =
AdmittanceConversion
Factor * [ml]
ECVModule Unsigned Ear Canal Volume (ECV)
short module (multiplied by
1000):
65535 = not valid
ECVPhase short Ear Canal Volume (ECV)
phase (multiplied by
1000):
32767 = not valid
ECVRange Enum ECV value can be inside, “INSIDE”
below or above the “BELOW”
measurement range “ABOVE”
AdmittancePeak Unsigned Admittance value of the
short tympanogram’s peak
(multiplied by 1000):
65534 = not found
65535 = not valid
AdmittancePeakRange Enum Admittance peak value “INSIDE”
can be inside, below or “BELOW”
above the “ABOVE”
measurement range
AdmittancePeakPressure short Pressure value of the
tympanogram’s peak:
4094 = not found
4095 = not valid
DisplayedTympanogramFac Enum Tympanogram factor “NOT_DEFINED”
tor currently displayed on “TYMPANOGRAMWIDTH”
Maestro software “TYMPANOGRAMGRADIENT”
TympanometryGradient Unsigned Tympanogram gradient
short (multiplied by 100):
65535 = not valid
TympanometryWidth Unsigned Tympanogram width
short (daPa):
65535 = not valid
AdmittanceModule Unsigned Module of the
short admittance value
(multiplied by 1000): to
obtain compensated
value subtract the
Point
ECVModule
AdmittancePhase short Phase of the
admittance value
(multiplied by 1000)
Pressure short Pressure value (daPa)