MML basic structure |
Element explanation
1. Mml
[Detail] MML start/end tag
[Attribute]
Attribute name
Data type
Omission
Explanation
version
string
#FIXED
2.3
createDate
dateTime
#REQUIRED
MML creation date. Format: CCYY-MM-DDThh:mm:ss
xmlns
uri
#FIXED
Provide URI of used MML basic structure DTD.
Xmlns:xhtml
uri
#FIXED
Provide URI of used XHTML DTD.
xmlns:mmlCm
uri
#FIXED
Provide URI of used name expression format DTD.
xmlns:mmlNm
uri
#FIXED
Provide URI of used name expression format DTD.
xmlns:mmlFc
uri
#FIXED
Provide URI of used facility information format DTD.
xmlns:mmlDp
uri
#FIXED
Provide URI of used medical department information format DTD
xmlns:mmlAd
uri
#FIXED
Provide URI of used address expression format DTD.
xmlns:mmlPh
uri
#FIXED
Provide URI of used telephone number expression format DTD.
xmlns:mmlPsi
uri
#FIXED
Provide URI of used personal information format DTD.
xmlns:mmlCi
uri
#FIXED
Provide URI of used creator information format DTD.
xmlns:mmlPi
uri
#FIXED
Provide URI of used patient information module DTD.
xmlns:mmlBc
uri
#FIXED
Provide URI of used basic clinical information module DTD.
xmlns:mmlFcl
uri
#FIXED
Provide URI of used initial-consultation-specific information module DTD.
xmlns:mmlHi
uri
#FIXED
Provide URI of used health insurance information module DTD.
xmlns:mmlLs
uri
#FIXED
Provide URI of used life lifestyle information module DTD.
xmlns:mmlPc
uri
#FIXED
Provide URI of used progress course information module DTD.
xmlns:mmlRd
uri
#FIXED
Provide URI of used diagnosis information module DTD.
xmlns:mmlSg
uri
#FIXED
Provide URI of used surgery record information module DTD.
xmlns:mmlSm
uri
#FIXED
Provide URI of used clinical summary information module DTD.
xmlns:mmlLb
uri
#FIXED
Provide URI of used test history information module DTD.
xmlns:mmlRp
uri
#FIXED
Provide URI of used report information module DTD.
xmlns:mmlRe
uri
#FIXED
Provide URI of used report information module DTD.
xmlns:mmlSc
uri
#FIXED
Provide URI of used access right information DTD.
xmlns:claim
uri
#FIXED
Provide URI of used appointment request module DTD.
xmlns:claimA
uri
#FIXED
Provide URI of used point/monetary amount module DTD.
The namespaces declaration that is applied to the overall instance becomes an attribute of the MML root tag (MML basic structure 1. Mml). When a single MML instance includes modules of the same type yet of a different version, the namespaces declaration of the modules will be an attribute of the root tag of each of the modules.
1.1.MmlHeader
[Detail] Header information
1.1.1.mmlCi:CreatorInfo
[Detail] Creator identification information. Refer to the MML common format (creator information format) for the structure.
[Omission] Not allowed
1.1.2.masterId
[Detail] Patient master ID
[Omission] Not allowed
1.1.2.1.mmlCm:Id
[Detail] Refer to the MML common format (Id format) for the structure.
[Omission] Not allowed
1.1.3.toc
[Detail] table of content. Check of “toc” in the header allows the system to recognize what data is contained without reviewing the body.
[Omission] Not allowed
1.1.3.1.tocItem
[Detail] All DTDs used in this MML document are listed.
[Data type] string
[Omission] Not allowed
[Repetition setting] Repeated. The data should be repeated for the number of DTDs used.
1.1.4.scopePeriod
[Detail] Scope period for the entire MML contents
[Omission] Omission allowed
[Attribute]
Attribute name
Data type
Omission
Table used
Explanation
start
date
#IMPLIED
Start date
end
date
#IMPLIED
End date
has0otherInfo
boolean
#IMPLIED
Information beyond the scope period. true: Yes, false: No
isExtract
boolean
#IMPLIED
Extraction of information. true: Yes, false: No
extractPolicy
string
#IMPLIED
MML0004
Policy of extraction
For the scope period of the entire MML indicated by start and end, the value of has0otherInfo should be true if the patient’s medical information beyond the scope period is available. If all patient information at the sending facility within the scope period is given, the value of isExtract is false. If any extraction is carried out, the value is true. Furthermore, the extraction policy should be given in extractPolicy if an extraction is carried out. This is to clarify whether all or partial patient information is received at the receiving side of the MML instance. If it is assumed that all information is received despite the fact that only partial information is received, a serious mistake in medical treatment may occur.
1.1.5.encryptInfo
[Detail] Encryption information for electronic signature. The input method is not specially defined. Refer to “Access right and encryption” in the basic policy.
[Data type] string
[Omission] Omission allowed
1.2.MmlBody
[Detail] Body. Input one or more documents in the text.
[Omission] Not allowed
1.2.1.MmlModuleItem
[Detail] Individual document. Input one document in one MmlModuleItem. In the user local database, it is expected that this data will be controlled as a document record.
[Omission] Not allowed
[Repetition setting] Repeated. The data may be repeated for the number of documents.
[Attribute]This attribute is primarily used for specifying the module when data is being sent/received.
Attribute name
Data type
Omission
Table used
Explanation
type
string
#IMPLIED
MML0005
Document type code
1.2.1.1.docInfo
[Detail] Individual document header information
[Omission] Omission is normally not possible; however, omission is possible if there is no query that specifies the module or no corresponding module in the query response.
[Attribute]The attribute is set up so that the class and version of the module can be understood simply by reference to the document header.
Attribute name
Data type
Omission
Table used
Explanation
contentModuleType
string
#IMPLIED
MML0005
Document type code
moduleVersion
uri
#IMPLIED
Provide URI of used module DTD.
1.2.1.1.1.securityLevel
[Detail] Types of access rights. The MML instance creator should input the access right when created. The actual access control is subject to the application (and its manager) receiving the instance.
[Omission] Not allowed
1.2.1.1.1.1.accessRight
[Detail] Access right
[Omission] Not allowed
[Repetition setting] Repeated. The number of preset access rights is repeated. At a minimum, it is essential that an access right be set up for the person who makes an entry so that that person will not be prevented from making reference. If multiple accessRight elements exist, an OR condition will exist for them. An AND condition will exist if at least two of the following exist directly subordinate to a single accessRight element: facility, medical department, licensed occupation, and individual. If nothing exists that satisfies this AND condition, the access right is not recognized.
[Attribute]
Attribute
Datatypes
Occurrence
Table id
Remarks
permit
boolean
#REQUIRED
Right of reference.
true: Yes,
false: No
To clearly indicate that reference is not approved, “none” is set as a permit attribute. With MML, a specific method of processing documents that can be deleted is not specified for cases in which a deletion request is made. However, one conceivable package is this: If it is important to keep a medical care record correction history, information can be hidden, rather than physically deleted, during a referrer’s normal access.
1.2.1.1.1.1.1.mmlSc:facility
[Detail] Facility. Access rights are set up in facility units.
[Omission] Allowed
1.2.1.1.1.1.1.1.mmlSc:facilityName
[Detail] Facility name
[Data type] string
[Omission] Not allowed
[Repetition setting] Repeated. The number of facilities for which access rights are set up is repeated.
[Attribute]
Values of facility access right definitions have the meanings indicated below.ÅD
Attribute
Datatypes
Occurrence
Table id
Remarks
mmlSc:facilityCode
string
#REQUIRED
MML0035
Facility access right definition
mmlSc:tableId
string
#IMPLIED
Name of table using facility access right definition. Written as MML0035.
mmlSc:facilityId
string
#IMPLIED
Facility code
mmlSc:facilityIdType
string
#IMPLIED
MML0027
Name of facility code master
all
Includes all facilities for which access is sought.
creator
Includes same facility as person making entry.
experience
Includes facilities having medical care histories of persons for whom entries are made (patients).
The method of selecting facilities having medical care histories is left to each application.
individual
Facility IDs are specified and targeted individually. The target facility is provided in mmlSc:facilityId and mmlSc:facilityIdType.
1.2.1.1.1.1.2.mmlSc:department
[Detail] Medical department
[Omission] Allowed
1.2.1.1.1.1.2.1.mmlSc:departmentName
[Detail] Medical department name
[Omission] Not allowed
[Repetition setting] Repeated. The number of departments for which access rights are set up is repeated.
[Attribute]
Attribute
Datatypes
Occurrence
Table id
Remarks
mmlSc:departmentCode
string
#REQUIRED
MML0028
Medical department code
mmlSc:tableId
string
#IMPLIED
Medical department code name. Written as MML0028.
1.2.1.1.1.1.3.mmlSc:licence
[Detail] Licensed occupation
[Omission] Allowed
1.2.1.1.1.1.3.1.mmlSc:licenceName
[Detail] Licensed occupation name
[Omission] Not allowed
[Repetition setting] Repeated. The number of licensed occupations for which access rights are set up is repeated.
[Attribute]
Attribute
Datatypes
Occurrence
Table id
Remarks
mmlSc:licenceCode
string
#REQUIRED
MML0026
Licensed occupation code
mmlSc:tableId
string
#IMPLIED
Licensed occupation code name. Written as MML0026.
1.2.1.1.1.1.4.mmlSc:person
[Detail] Person (individual)
[Omission] Allowed
1.2.1.1.1.1.4.1.mmlSc:personName
[Detail] Personal name
[Data type] string
[Omission] Not allowed
[Repetition setting] Repeated. The number of persons for which access rights are set up is repeated.
[Attribute]
Values of personal access right definitions have the meanings indicated below.
Attribute
Datatypes
Occurrence
Table id
Remarks
mmlSc:personCode
string
#REQUIRED
MML0036
Personal access right definition
mmlSc:tableId
string
#IMPLIED
Name of table using personal access right definition. Written as MML0035.
mmlSc:personId
string
#REQUIRED
Personal ID
mmlSc:personIdType
string
#IMPLIED
Name of personal ID master
all
Includes all persons for which access is sought.
creator
Includes person making entry.
patient
Includes persons for whom entries are made (patients).
individual
Personal IDs are specified and targeted individually. The target person is provided in mmlSc:personId and mmlSc:personIdType.
[Example] 1.2.1.1.1. securityLevel entry (by access right classification)
When reference, correction, and deletion rights are provided to doctors of internal medicine at the Miyazaki Medical College Hospital from October 1, 2001, to December 31, 2001:
-------------------------------------------------------------
<securityLevel>
<accessRight
permit="all"
startDate="2001-10-01"
endDate="2001-12-31"><mmlSc:facility>
<mmlSc:facilityName
mmlSc:facilityCode="individual "
mmlSc:tableId="MML0035"
mmlSc:facilityId="JPN453010100003"
mmlSc:facilityIdType="JMARI">
Miyazaki Medical College Hospital
</mmlSc:facilityName>
</mmlSc:facility><mmlSc:department>
<mmlSc:departmentName
mmlSc:departmentCode="01"
mmlSc:tableId="MML0028"/>
</mmlSc:department><mmlSc:licence>
<mmlSc:licenceName
mmlSc:licenceCode="doctor"
mmlSc:tableId="MML0026"/>
</mmlSc:licence></accessRight>
</securityLevel>-------------------------------------------------------------
When all rights are provided indefinitely to the person making the entry/facility, and when reference rights are provided to a patient (patient John Doe) from October 1, 2001, to December 31, 2001:
-------------------------------------------------------------
<securityLevel>
<accessRight
permit="all"><mmlSc:facility>
<mmlSc:facilityName
mmlSc:facilityCode="creator"
mmlSc:tableId="MML0035">
Person making entry/facility
</mmlSc:facilityName>
</mmlSc:facility>
</accessRight><accessRight
permit="read"
startDate="2001-10-01"
endDate="2001-12-31"><mmlSc:person>
<mmlSc:personName
mmlSc:personCode="patient"
mmlSc:tableId="MML0036"
mmlSc:personId="4500001234"
mmlSc:personIdType="dolphinUserid_2001-10-03">
Patient John Doe
</mmlSc:personName>
</mmlSc:person></accessRight>
</securityLevel>-------------------------------------------------------------
1.2.1.1.2.title
[Detail] Document title
[Data type] string
[Omission] Not allowed
[Attribute]
Attribute name
Data type
Omission
Table used
Explanation
generationPurpose
string
#IMPLIED
MML0007
Type of document detail
1.2.1.1.3.docId
[Detail] Document ID information
[Omission] Not allowed
1.2.1.1.3.1.uid
[Detail] Document unique ID. The format of the unique number should be UUID. (UUID should include hyphens.) It is strongly recommended that the MML processor save the uid locally with some measure when the MML instance is received.
[Data type] string
[Omission] Not allowed
[Example]
<uid>0aae5960-667c-11d3-9751-00105a6792e7</uid>
1.2.1.1.3.2.parentId
[Detail] ID of related parent document. For usage, refer to “Correlation between documents” in Basic policy.
[Data type] string
[Omission] Omission allowed[Repetition setting] Repeated. If multiple parent documents are available, the data should be repeated.
[Attribute]
Attribute name
Data type
Omission
Table used
Explanation
relation
string
#IMPLIED
MML0008
Type of relation
[Example] When the document is corrected (new edition) for the parent document
<parentId relation = "oldEdition">0aae5960-667c-11d3-9751-00105a6792e8</parentId>
1.2.1.1.3.3.groupId
[Detail] Group ID. For utilization method, refer to “Correlation between documents using groupId” in Basic policy.
[Data type] string
[Omission] Omission allowed[Repetition setting] Repeated. Repeated when belonging to multiple groups.
[Attribute]
Attribute name
Data type
Omission
Table used
Explanation
groupClass
string
#IMPLIED
MML0007
Classification of module group
1.2.1.1.4.confirmDate
[Detail] Confirmed date of medical chart electronic storage
[Data type] date Format: CCYY-MM-DD
[Omission] Not allowed
[Attribute] When time series information is one document, input the start date and the end date in the next attribute. ScopePeriod (1.1.4.) represents the coverage period for the entire MML document. In contrast, this represents the period of one MmlModuleItem.
Attribute name
Data type
Omission
Table used
Explanation
start
date
#IMPLIED
Start date for time series information
end
date
#IMPLIED
End date for time series information
1.2.1.1.5.mmlCi:CreatorInfo
[Detail] Creator information of individual document. Refer to the MML common format (creator information format) for the structure.
[Omission] Not allowed
1.2.1.1.6.extRefs
[Detail] List of all external link information described in the content. The list of external reference files can be obtained without analyzing the content.
[Omission] Not allowed
1.2.1.1.6.1.mmlCm:extRef
[Detail] External link information. Refer to the MML common format (external reference format) for the structure.
[Omission] Omission allowed
[Repetition setting] The data should be repeated for the number of external link information described.
1.2.1.2.content
[Detail] Content. Input the module using namespace. Only one type of module can be input in one content.
[Omission] Normally omission is not allowed. Omission is allowed only for response to the list format query.