mmlQuery

MML Processing Instruction command mmlQuery

mmlQuery
The mmlQuery requests and extracts MML data.
The Query command requires 2 mandatory fields and 2 option fields.

Type (mandatory)
The exchange data to request can be specified according to the “type” field value.
The “type” must be given in one of the following 3 formats:
type=“patient” ------ Request and response for all Body data (overall document) of patient
type=“list” ---------- Request for list of patient MmlModuleItem contents (docInfo document header information)
type=“statistics” --- Request for and response to statistical information (Only reservation of this is specified in this specification.)

The “type” field is specified as follows:

For type=“patient”

The data is returned according to the in the . If there is no corresponding data (the information for the requested patient is not available), the status in the Result message shows an error.

For type=“list”

Return docInfo (document header) of MmlModuleItem, based on the contents written in in .

l For type=‘statistics’

Enter “anonymous” in the masterId of the request header. In this specification, type=‘statistics’ is reserved only for extraction of statistical information. The interface for extraction of statistical information is not detailed in this specification. The interface will be detailed in a future specification.

reqId (Mandatory)
The format for “reqId” is the same as the aforementioned mmlAppend.
startDate, endDate (Option)
The “startDate” and “endDate” specify the data period to be extracted. The date format described here must be that specified in Part I. If the “startDate” and “endDate” are omitted, the format refers to the entire period. If “startDate” is omitted, the period is up to “endDate.” If “endDate” is omitted, the period is from “startDate” to the current date.

Designation of requested document (module class designation)
With mmlQuery, inquiries (queries) can be performed by designating the module class. In short the type of data to be requested is set up for the “type” attribute of the element, and the element is sent in empty element format.
Designation of requested document (document ID designation)
With mmlQuery, document inquiries (queries) can be performed by designating the document ID. Before transmission, the ID of the data to be requested is set up for the in in the information.

Designation of requested document (group ID designation)
With mmlQuery, inquiries (queries) for a series of documents can be performed by designating the group ID. Before transmission, the ID of the data to be requested is set up for the in in the information.

Example: Request for list of documents containing diagnosis information (request for document headers only)
Note: Essential elements and essential attributes that are not directly related to the comment are omitted.
--------------------------------------------------------
<Mml>
  <?mmlQuery type="list" reqId="0aae5960-667c-11d3-9751-00105a6792e8"?>
  <MmlHeader>
    <masterId>
      <mmlCm:Id
        mmlCm:type="facility"
        mmlCm:checkDigitSchema="M10"
        mmlCm:checkDigit="5"
        mmlCm:tableId="JPN453010100003" >
        12345678
      </mmlCm:Id>
    </masterId>
  </MmlHeader>
  <MmlBody>
    <MmlModuleItem type="registerdDiagnosis"/>
  </MmlBody>
</Mml>
--------------------------------------------------------

Example: Request for documents containing information on diagnoses, lifestyles, and health insurance (complete documents) for the period 2000-01-01 to 2001-12-31
Note: Essential elements and essential attributes that are not directly related to the comment are omitted.
--------------------------------------------------------
<Mml>
  <?mmlQuery type="patient" reqId="0aae5960-667c-11d3-9751-00105a6792e8"
    startDate="2000-01-01" endDate="2001-12-31" ?>
  <MmlHeader>
    <masterId>
      <mmlCm:Id
        mmlCm:type="facility"
        mmlCm:checkDigitSchema="M10"
        mmlCm:checkDigit="5"
        mmlCm:tableId="JPN453010100003" >
        12345678
      </mmlCm:Id>
    </masterId>
  </MmlHeader>
  <MmlBody>
    <MmlModuleItem type="registerdDiagnosis"/>
    <MmlModuleItem type="lifestyle"/>
    <MmlModuleItem type="healthInsurance"/>
  </MmlBody>
</Mml>
--------------------------------------------------------

Example: Document request by document ID (complete document)
Note: Essential elements and essential attributes that are not directly related to the comment are omitted.
--------------------------------------------------------
<Mml>
  <?mmlQuery type="patient" reqId="0aae5960-667c-11d3-9751-00105a6792e8"?>
  <MmlHeader>
    <masterId>
      <mmlCm:Id
        mmlCm:type="facility"
        mmlCm:checkDigitSchema="M10"
        mmlCm:checkDigit="5"
        mmlCm:tableId="JPN453010100003" >
        12345678
      </mmlCm:Id>
    </masterId>
  </MmlHeader>
  <MmlBody>
    <MmlModuleItem>
      <docInfo>
        <docId>
        <uid>0aae5960-667c-11d3-9751-00105a6792e8</uid>
        </docId>
      </docInfo>
    </MmlModuleItem>
</MmlBody>
--------------------------------------------------------

Example: Request for a series of documents by group ID (complete documents), using the uid as an empty element
Note: Essential elements and essential attributes that are not directly related to the comment are omitted.
--------------------------------------------------------
<Mml>
  <?mmlQuery type="patient" reqId="0aae5960-667c-11d3-9751-00105a6792e8"?>
  <MmlHeader>
    <masterId>
      <mmlCm:Id
        mmlCm:type="facility"
        mmlCm:checkDigitSchema="M10"
        mmlCm:checkDigit="5"
        mmlCm:tableId="JPN453010100003" >
        12345678
      </mmlCm:Id>
    </masterId>
  </MmlHeader>
  <MmlBody>
    <MmlModuleItem>
      <docInfo>
        <docId>
        <uid/>
        <groupId >
        0aae5960-667c-11d3-9751-00105a6792e8
        </groupId>
        </docId>
      </docInfo>
    </MmlModuleItem>
</MmlBody>
--------------------------------------------------------