almost 4 years ago

DocumentEntry 各屬性介紹

Optionality,可選性

R:要求, R2:除非不知道, 否則要求, O:可選擇

Attribute Document Source Document Repository
entryUUID R R
availabilityStatus O O
mimeType R R
author R2 R2
legalAuthenticator O O
patientId R R
sourcePatientId O O
sourcePatientInfo O O
homeCommunityId O O
repositoryUniqueId O R
uniqueId R R
languageCode R R
Title O O
comments O O
URI O O
hash R R
Size R R
creationTime R R
serviceStartTime R2 R2
serviceStopTime R2 R2
classCode R R
formatCode R R
healthcareFacilityTypeCode R R
confidentialityCode R R
practiceSettingCode R R
typeCode R R
eventCodeList O O
limitedMetadata
referenceIdList

DocumentEntry.entryUUID

entryUUID 是全域性唯一識別碼, 用於文件 內部管理; 相反地, uniqueId 則用於 外部參考
長度無限制
以下範例 entryUUID 為 urn:uuid:17274e27-288a-4cd1-acee-e9464bb7c32a.

DocumentEntry.entryUUID
<rim:ExtrinsicObject 
  id="urn:uuid:17274e27-288a-4cd1-acee-e9464bb7c32a" 
  mimeType="text/plain" 
  status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" 
  objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1">

DocumentEntry.availabilityStatus

呈現 DocumentEntry 的狀態,分別為以下兩種狀態:
Approved: 該文件提供病人護理用.
Deprecated: 該文件已經過時.
以下範例 availabilityStatus 為 urn:oasis:names:tc:ebxml-regrep:StatusType:Approved

DocumentEntry.availabilityStatus
<rim:ExtrinsicObject 
  id="urn:uuid:17274e27-288a-4cd1-acee-e9464bb7c32a" 
  mimeType="text/plain" 
  status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" 
  objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1">

DocumentEntry.mimeType

文件在 Repository 的 MIME 類型
以下範例 mimeType 為 text/plain

DocumentEntry.mimeType
<rim:ExtrinsicObject 
  id="urn:uuid:17274e27-288a-4cd1-acee-e9464bb7c32a" 
  mimeType="text/plain" 
  status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" 
  objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1">

DocumentEntry.author

代表創作文件的人類和(或)機器
classificationScheme,應為 urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d

DocumentEntry.legalAuthenticator

Represents a participant within the authorInstitution who has legally authenticated or attested the document.
Legal authentication implies that a document has been signed manually or electronically by the legalAuthenticator.
以 XCN 型態表示

<rim:Slot name="legalAuthenticator">
    <rim:ValueList>
        <rim:Value>^Welby^Marcus^^^Dr^MD</rim:Value>
    </rim:ValueList>
</rim:Slot>

DocumentEntry.patientId

唯一識別碼,該文件所屬的病患識別碼
最多一個 patientId
以 CX 型態表示,包含兩個部份:

  • Assigning Authority Domain Id
  • An Id from the above Assigning Authority
DocumentEntry.patientId
<rim:ExternalIdentifier
  identificationScheme="urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427"
  value="6578946^^^&amp;1.3.6.1.4.1.21367.2005.3.7&amp;ISO"
  id="IdExample_051"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:ExternalIdentifier"
  registryObject="DocumentEntry01">
  <rim:Name>
    <rim:LocalizedString value="XDSDocumentEntry.patientId "/>
  </rim:Name>
</rim:ExternalIdentifier>

DocumentEntry.sourcePatientId

代表醫療記錄識別碼 (如病人ID)
根據 HL7 v2.5 CX 資料型態

DocumentEntry.sourcePatientId
<rim:Slot name="sourcePatientId">
  <rim:ValueList>
    <rim:Value>j98789^^^&amp;1.2.3.4.343.1&amp;ISO</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.sourcePatientInfo

包含病患識別碼、姓名、性別、出生日期、住址等

DocumentEntry.sourcePatientInfo
<rim:Slot name="sourcePatientInfo">
  <rim:ValueList> 
    <rim:Value>PID-3|DTP-1^^^&amp;1.3.6.1.4.1.21367.2005.3.7&amp;ISO</rim:Value>
    <rim:Value>PID-5|DICTAPHONE^ONE^^^</rim:Value>
    <rim:Value>PID-7|19650120</rim:Value>
    <rim:Value>PID-8|M</rim:Value>
    <rim:Value>PID-11|100 Main St^^BURLINGTON^MA^01803^USA</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.homeCommunityId

一個社區的全球唯一識別碼,DocumentEntry 和文件可以被存取的社區

<rim:ExtrinsicObject home="urn:oid:1.2.3" ...>
...
</rim:ExtrinsicObject>

DocumentEntry.repositoryUniqueId

唯一識別碼,提供識別文件儲存於哪一個 Repository 之中

DocumentEntry.repositoryUniqueId
<rim:Slot name="repositoryUniqueId">
  <rim:ValueList>
    <rim:Value>1.3.6.1.4.5</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.uniqueId

全域的唯一識別碼,分派至正建立實體的文件,使 DocumentEntry 與 Document 連結
The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute.
(e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.)

DocumentEntry.uniqueId
<rim:ExternalIdentifier
  identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab"
  value="1.2.3.4.5.6.78901.2345.6.7^123456"
  id="IdExample_054"
  objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier"
  registryObject="DocumentEntry01">
  <rim:Name>
    <rim:LocalizedString value="XDSDocumentEntry.uniqueId"/>
  </rim:Name>
</rim:ExternalIdentifier>

DocumentEntry.languageCode

指定符號資料在文件中的人類語言

DocumentEntry.languageCode
<rim:Slot name="languageCode">
    <rim:ValueList>
        <rim:Value>en-CA</rim:Value>
    </rim:ValueList>
</rim:Slot>

DocumentEntry.Title

表示文件的標題

DocumentEntry.Title
<rim:ExtrinsicObject
  id="ExampleDocument"
  objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1"
  mimeType="application/pdf">
  <rim:Name>
    <rim:LocalizedString value="Example Document Title"/>
  </rim:Name>
  ...
</rim:ExtrinsicObject>

DocumentEntry.comments

包含與關聯文件的評論
長度無限制

DocumentEntry.comments
<rim:Description>
    <rim:LocalizedString value = "comment associated with the Document"/>
</rim:Description>

DocumentEntry.URI

文件的URI

DocumentEntry.URI
<rim:Slot name="URI">
  <rim:ValueList>
    <rim:Value>DOC001.XML</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.hash

該文件內容的 hash 值,可以用來驗證文件。
是 ShA1 hash

DocumentEntry.hash
<rim:Slot name="hash">
  <rim:ValueList>
    <rim:Value>da39a3ee5e6b4b0d3255bfef95601890afd80709</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.Size

表示文件的 bytes 大小

DocumentEntry.Size
<rim:Slot name="size">
  <rim:ValueList>
    <rim:Value>3654</rim:Value>
    </rim:ValueList>
</rim:Slot>

DocumentEntry.creationTime

作者創建文件的時間
以 DTM 型態表示

DocumentEntry.creationTime
<rim:Slot name="creationTime">
  <rim:ValueList>
    <rim:Value>20041225212010</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.serviceStartTime

記錄服務開始時間

DocumentEntry.serviceStartTime
<rim:Slot name="serviceStartTime">
  <rim:ValueList>
    <rim:Value>20041225212010</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.serviceStopTime

紀錄服務停止時間

DocumentEntry.serviceStartTime
<rim:Slot name="serviceStopTime">
  <rim:ValueList>
    <rim:Value>20041225232010</rim:Value>
  </rim:ValueList>
</rim:Slot>

DocumentEntry.classCode

指定文件類型,如:處方、出院報告,產生文件時並指定該元件屬性
任何 DocumentEntry 最多一個 ebRIM Classification 包含一個 classCode
classificationScheme 應為 urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a

DocumentEntry.classCode
<rim:Classification
  classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a"
  classifiedObject="ExampleDocument"
  id="IdExample_046"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification"
  nodeRepresentation="10160-0">
  <rim:Name>
    <rim:LocalizedString value="History of Medication Use"/>
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>2.16.840.1.113883.6.1</rim:Value>
    </rim:ValueList>
  </rim:Slot>
</rim:Classification>

DocumentEntry.formatCode

全球唯一的代碼表示該文件的格式。
任何 DocumentEntry 最多一個 ebRIM Classification 包含一個 classCode
classificationScheme應為urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d`

<rim:Classification
  classificationScheme="urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d"
  classifiedObject="ExampleDocument"
  id="IdExample_049"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification"
  nodeRepresentation="ExampleformatCode">
  <rim:Name>
    <rim:LocalizedString value="ExampleformatCodeDisplayName"/>
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>Example Format Code Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
  </rim:Classification>

DocumentEntry.healthcareFacilityTypeCode

代表臨床組織的型態
任何 DocumentEntry 最多一個 ebRIM Classification 包含一個 classCode
classificationScheme 應為 urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1

<rim:Classification
  classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1"
  classifiedObject="ExampleDocument"
  id="IdExample_050"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification"
  nodeRepresentation="ExamplehealthcareFacilityTypeCode">
  <rim:Name>
    <rim:value="healthcareFacilityTypeCodeDisplayName"/>
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>Example Healthcare Facility Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
</rim:Classification>

DocumentEntry.confidentialityCode

這個欄位說明文件的重要性程度(機密性、敏感度等)
一個 ebRIM Classification 包含一個 confidentialityCode,多個 confidentialityCode 指定多個 Classification
classificationScheme 應為 urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f

DocumentEntry.confidentialityCode
<rim:Classification
  classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f"
  classifiedObject="ExampleDocument"
  id="IdExample_046"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification"
  nodeRepresentation="Example confidentialityCode Value"
  <rim:Name>
    <rim:LocalizedString value="ExampleconfidentialityCodeDisplayName"/>
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
    <rim:Value>Example Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
</rim:Classification>

DocumentEntry.practiceSettingCode

臨床專科代碼,如:家庭醫學、實驗室、放射學。
任何 DocumentEntry 最多一個 ebRIM Classification 包含一個 classCode
classificationScheme 應為 urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead

<rim:Classification
  ClassificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead"
  classifiedObject="ExampleDocument" id="IdExample_052"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification"
  nodeRepresentation="ExamplepracticeSettingCode">
  <rim:Name>
        <rim:LocalizedString value="ExamplepracticeSettingCodeDisplayName"/>
    </rim:Name>
    <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>Example Practice Setting Code Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
</rim:Classification>

DocumentEntry.typeCode

代表文件的精確類型,如:超音波報告
任何 DocumentEntry 最多一個 ebRIM Classification 包含一個 classCode
classificationScheme 應為 urn:uuid:f0306f51-975f-434e-a61c-c59651d33983

<rim:Classification
  classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983"
  classifiedObject="ExampleDocument"
  nodeRepresentation="ExampletypeCode"
  id="IdExample_053"
  objectType="urn:oasis:names:tc:ebxmlregrep:ObjectType:RegistryObject:Classification">
  <rim:Name>
    <rim:LocalizedString value="typeCodeDisplayName" />
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>Example Type Code Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
</rim:Classification>

DocumentEntry.eventCodeList

這個代碼主要是臨床行為,如結腸鏡檢查或闌尾切除術
一個 ebRIM Classification 包含一個 confidentialityCode,多個 confidentialityCode 指定多個 Classification
classificationScheme應為urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4`

DocumentEntry.eventCodeList
<rim:Classification
  classificationScheme="urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4"
  classifiedObject="ExampleDocument"id="IdExample_048"
  objectType="urn:oasis:names:tc:ebxmlregrep:
  ObjectType:RegistryObject:Classification"
  nodeRepresentation="ExampleeventCode">
  <rim:Name>
    <rim:LocalizedString value="eventCodeDisplayName"/>
  </rim:Name>
  <rim:Slot name="codingScheme">
    <rim:ValueList>
        <rim:Value>Example Event Code Scheme</rim:Value>
    </rim:ValueList>
  </rim:Slot>
  </rim:Classification>

DocumentEntry.limitedMetadata

Indicates whether the Document Entry was created using the less rigorous requirements of
metadata as defined for the Metadata-Limited Document Source.

DocumentEntry.limitedMetadata
<ExtrinsicObject id="DocEntry">
    <Classification 
        classifiedObject="DocEntry"
        classificationNode="urn:uuid:ab9b591b-83ab-4d03-8f5d-f93b1fb92e85" />
</ExtrinsicObject>

DocumentEntry.referenceIdList

This list contains zero or more Identifiers. These Identifiers may be internal or external
identifiers, e.g., Identifiers may be Accession Numbers, Order Numbers, Referral Request
Identifiers, XDS Workflow Instance Identifiers, etc. The referenceIdList contains Identifiers CXi
encoded, as specified in table 4.2.3.1.7-2.
XDS Document Registry actors supporting the ReferenceId option shall preserve this value.
When the ReferenceId option is not declared, the Document Registry shall handle this extra
metadata according to the historic rules outlined in section 4.2.3.1.6 “Extra Metadata Elements”.

DocumentEntry.referenceIdList
<rim:Slot name="urn:ihe:iti:xds:2013:referenceIdList ">
  <rim:ValueList>
    <rim:Value>2013001^^^&1.2.3.4.5.6&ISO^urn:ihe:iti:xds:2013:accession</rim:Value>
    <rim:Value>1.2.3.12.78.23^^^^urn:ihe:iti:xds:2013:uniqueId^&1.2.3.4&ISO</rim:Value>
  </rim:ValueList>
</rim:Slot>
← IHE - 資訊技術基礎建設技術架構 XDS,Metadata Apache Maven - 如何建置 Apache Maven 專案 →
 
comments powered by Disqus