MML Processing Instruction command mmlItemResult

mmlItemResult

This is the command used to return the result of MmlModuleItem for Query, Append and Delete in MML data.

This action is set to return the message as a return message for the above 3 commands.

The mmlItemResult command requires 2 additional “status” and “reqId” fields.

The “reqId” format is the same as that of the query previously described.

“status” indicates whether each MmlModuleItem is successful or not. If it is successful, a lower case “success” character string is returned. If not, a lower case “failed” character string is returned. The “errorReason” field can be returned as an option field. In “errorReason,” the reason for error is returned when the “status” has “failed.”

The following is defined for the errorReason value. All values must be upper case character strings as shown below.

 

Error value	Explanation
SYSTEMERROR	A particular system error
HEADERINVALID	information is incorrect.
NOTHINGDATA	Return data is not available.
ACCESSDENIED	Access is denied to the corresponding data for security reasons.
NOTSUPPORTED	Processing of requested electronic document is not supported.

The mmlItemResult command is present before the first child-element of the tag in , and the result of whether the item is correctly processed or not is given.

The following shows 2 examples of return messages. One example is a request of 3 with one message, and the other example is where the return message is correctly recognized but the lifestyle information of MmlModuleItem is returned as successful data acquisition without other 2 pieces of information.

Example: Example of request message

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 type="registeredDiagnosis"/>
    <MmlModuleItem type="lifestyle"/>
    <MmlModuleItem type="healthInsurance"/>
  </MmlBody>
</Mml>

--------------------------------------------------------

 

Example: Example of return message

Note: Essential elements and essential attributes that are not directly related to the comment are omitted.

--------------------------------------------------------

<Mml>
  <?mmlResult status="success" continue="false" partNo="0"
    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">
      <?mmlItemResult status="failed" errorReason="NOTHINGDATA"
        reqid="0aae5960-667c-11d3-9751-00105a6792e8"?>
    </MmlModuleItem>

    <MmlModuleItem type="lifestyle">
      <?mmlItemResult
        status="success"
        reqid="0aae5960-667c-11d3-9751-00105a6792e8"?>
      <docInfo>
        :
      </docInfo>
      <content>
      <mmlLs:LifestyleModule>
        <mmlLs:occupation> forester
        </mmlLs:occupation>
        <mmlLs:tobacco>
        20 cigarettes per day for 30 years
        </mmlLs:tobacco>
        <mmlLs:alcohol>4 dl of sake per day
        </mmlLs:alcohol>
      </mmlLs:LifestyleModule>
      </content>
    </MmlModuleItem>

    <MmlModuleItem type="healthInsurance">
      <?mmlItemResult status="failed" errorRason="NOTHINGDATA"
      reqid="0aae5960-667c-11d3-9751-00105a6792e8"?>
    </MmlModuleItem>

  </MmlBody>

</Mml>

--------------------------------------------------------