附件 :
FHIR IG網站內容一致化規定:
實作架構與內容規範
因應數位化發展,確保IG設計原則全國一致化,IG以網站形式呈現,並配合常見工具建立(FSH、Forge等),以利參考者具有一致性的參考架構(例如:twidir)。
IG內應包含以下資訊:應用說明(介紹、背景、範圍、循序圖、閱讀說明、作者與貢獻者)、視覺化邏輯模型、規範文件(能力聲明、查詢參數與操作定義、邏輯模型、FHIR Profiles及Extensions、專門術語)、範例、定義與範例檔下載、安全性及其他必要資料交換規範等。若有版本異動,亦須有版本異動說明頁。
- 應用說明
- 介紹
介紹該標準指引之簡要說明、設計之主要目的,並且明確說明與TW Core IG的繼承關聯,包含版本、範疇。 - 背景
說明指引設計背景、應用情境、實際需求之狀況,讓參考者可以清晰知道應用的情境,並著手進行相應程式、軟體與資料交換架構的開發。 - 範圍
此章節應說明IG適用的背景、操作情境以及實務案例。
- 使用案例
- 將所有利益關係人的應用情境清楚說明,並說明資料交換情境之過程,促進標準化流程推動。
- 循序圖
- 描述IG內的資料交換過程,以及系統要完成實作交換的一連串動作,屬於一種軟體系統運作的動態圖型。
- 閱讀說明
以架構圖呈現網站結構,並針對各章節進行簡易的說明。 - 作者與貢獻者
說明IG之作者、單位以及連絡方式,以利釋疑。
- 視覺化邏輯模型
實作資料內容的資料對照架構,以常見資料對照至對應欄位的參考架構。以邏輯模型為主,對照到該IG內設計之Profiles特定欄位。 - 規範文件
說明該IG內有關標準的一切相關說明。
- 能力聲明
說明伺服端(Server)的預期功能,以便針對IG資料請求者(Requestors)提交的請求作出回應,定義Server支援的FHIR Profiles、RESTful操作(operations)和查詢參數(search parameters)的完整清單。用戶端(Clients)可以根據當地的使用案例和情境需求,使用Server功能以存取資料。 - 查詢參數與操作定義
- 邏輯模型
邏輯性資料模型說明「IG」所包含的資料項目。參考者可藉此資料模型快速瞭解IG的內容,實作者亦可透過此資料模型上方Mappings功能頁籤來瞭解各資料項目應透過哪些IG的 Profiles或Resources的資料項目進行實作,以及可瞭解各模型中的資料項目。 - FHIR Profiles及Extensions
基本 FHIR 規格描述了在許多不同環境中使用的基本資源、框架和 API。Profiles則是針對基本資源進行約束後的相關說明文件。 - 專門術語
說明採用的術語、值集、代碼對應(如果有),如自行定義值集應說明定義架構。
- 範例
提供該IG中所有Profiles及其參照之的Profiles範例,範例中之代碼連結應皆為代碼系統連結。 - 定義與範例檔下載
提供完整IG之網站壓縮檔(zip)、套件壓縮(package.tgz)及規範定義檔與範例壓縮檔。 - 安全性
由指引設計者說明之建議應該(SHOULD)了解與FHIR交易相關的安全考量,特別是此章節說明項目更加相關。 - 版本異動說明(非必要,如為已通過審查之IG、更新之IG應具備該頁面。)
由指引設計者說明版本之間的異動以及改版的相關原因。