同意書實作指引(Consent Form IG)
0.1.0 - CI Build

This page is part of the 同意書實作指引 (v0.1.0: Releases Ballot 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: 同意書-伺服端

Official URL: http://hitstdio.ntunhs.edu.tw/consentForm/CapabilityStatement/CapabilityStatementConsentServer Version: 0.1.0
Active as of 2022-12-20 Computable Name: CapabilityStatementConsentServer

同意書-伺服端(Server)之能力聲明

Raw OpenAPI-Swagger Definition file | Download

  • 實作指引版本:0.1.0
  • FHIR版本:4.0.1
  • 發佈日:2022-12-20
  • 發佈者:ABC科技股份有限公司

Server的FHIR RESTful功能要求

  • 同意書-伺服端 必須(SHALL)
    1. 可透過FHIR RESTful API查詢的Resources
    2. 根據FHIR規範實作RESTful
    3. HTTP回傳狀態碼
      • (Status 400):無效參數(invalid parameter)
      • (Status 401/4xx):未經授權的請求(unauthorized request)
      • (Status 403):未充分授權的資料存取範圍(insufficient premission scope)
      • (Status 404):未知的resource(unknown resource)
    4. Server提供的API操作皆支援JSON格式
    5. 可識別每個新增到Server的實例(instance)之 meta.profile是否為TW Core Profiles Defining URL,並確認實例是否依循profile製作。【註:實例是指依據profile實作,將真實資料以JSON、XML或Turtle格式存放的檔案】
    6. 支援每個profile的查詢參數
  • 同意書-伺服端 建議應該(SHOULD)
    1. Server提供的API操作皆支援XML格式
  • 安全性
    1. Server必須(SHALL)透過回傳 HTTP 401「未授權」, HTTP 403「禁止」,或 HTTP 404 「未找到」,來拒絕任何未經授權的請求

Resources或Profiles的RESTful功能

Bundle

Composition

  • 預期的符合性(Conformance Expectation): 必須(SHALL)
  • Profiles: 同意書Composition(Composition-CF
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 必須(SHALL)支援 createreadupdatevreadsearch-typepatch
  • 查詢參數摘要
  • 符合性(Conformance)參數類型範例
    必須(SHALL)authorreferenceGET [base]/Composition?author={Type/}[id]
    必須(SHALL)subjectreferenceGET [base]/Composition?subject={Type/}[id]

DocumentReference

  • 預期的符合性(Conformance Expectation): 必須(SHALL)
  • Profiles: 同意書-參照的文件(DocumentReference-CF)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 必須(SHALL)支援 createreadupdatevreadsearch-typepatch