FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/CapabilityStatementTWCIServer

Packagetw.gov.mohw.nhi.ci
TypeCapabilityStatement
IdCapabilityStatementTWCIServer
FHIR VersionR4
Sourcehttps://nhicore.nhi.gov.tw/ci/https://build.fhir.org/ig/TWNHIFHIR/ci/CapabilityStatement-CapabilityStatementTWCIServer.html
URLhttps://nhicore.nhi.gov.tw/ci/CapabilityStatement/CapabilityStatementTWCIServer
Version1.0.0
Statusactive
Date2025-04-30
NameCapabilityStatementTWCIServer
Title臺灣重大傷病-伺服端(TWCI Server)
Realmtw
Authoritynational
Description臺灣健保重大傷病實作指引(TWCI IG)伺服端(Server)之能力聲明
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
tw.gov.mohw.nhi.ci臺灣重大傷病實作指引
SearchParameter
Bundle-idBundleID
Patient-identifierPatientIdentifier
Patient-namePatientName
Task-authored-onTaskAuthoredOn
Task-identifierTaskIdentifier
Task-modifiedTaskModified
Task-patientTaskPatient
Task-periodTaskPeriod
Task-statusTaskStatus
StructureDefinition
Bundle-twci重大傷病申請證明-Bundle TWCI
Condition-twci重大傷病-Condition TWCI
Patient-twci病人資訊-Patient TWCI
Questionnaire-twci重大傷病申請書-Questionnaire TWCI
QuestionnaireResponse-twci重大傷病申請書回覆-QuestionnaireResponse TWCI
Task-twci重大傷病申請-Task TWCI

Narrative

Note: links and images are rebased to the (stated) source

臺灣重大傷病-伺服端(TWCI Server)

  • 實作指引版本：1.0.0
  • FHIR版本：4.0.1
  • 支援格式：json, xml
  • 發佈日：2025-04-30
  • 發佈者：衛生福利部中央健康保險署

必須（SHALL）支援以下實作指引

Server的FHIR RESTful功能要求

模式：server

臺灣重大傷病-伺服端(TWCI Server)必須(SHALL)：
(1)可透過FHIR RESTful API查詢、新增及刪除Resources
(2)根據FHIR規範實作RESTful API
(3)HTTP回傳狀態碼
   ①(Status 2xx)：請求成功
   ②(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是否為TWCI Profiles Defining URL，並確認實例是否依循Profile製作。
【註：實例是指依據Profile實作，將真實資料以JSON、XML或Turtle格式存放的檔案】

臺灣重大傷病-伺服端(TWCI Server)建議應該(SHOULD)：
(1)Server提供的API操作皆支援XML格式

安全性：
(1)Server必須(SHALL)透過回傳 HTTP 401「未授權」， HTTP 403「禁止」，或 HTTP 404 「未找到」，來拒絕任何未經授權的請求。

Resources或Profiles的RESTful功能

Summary

共有六類Resources支援查詢，查詢參數如表列：

Resource型別ProfileCreateReadVReadDeleteUpdate支援的查詢參數
Bundle重大傷病申請證明-Bundle TWCIyyyy_id
Questionnaire重大傷病申請書-Questionnaire TWCIyyyy
QuestionnaireResponse重大傷病申請書回覆-QuestionnaireResponse TWCIyyyy
Task重大傷病申請-Task TWCIyyyyperiod, patient, authored-on, modified, identifier, status
Patient病人資訊-Patient TWCIyyyyname, identifier
Condition重大傷病-Condition TWCIyyyy

預期的遵從度： 必須（SHALL）Bundle

Profile
重大傷病申請證明-Bundle TWCI
支援的參照政策（Reference policy）
resolves

能力摘要
  • SHALL 支援 create, read, vread, update.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Bundle?_id=[id]
GET [base]/Bundle/[id]
 

預期的遵從度： 必須（SHALL） Questionnaire

Profile
重大傷病申請書-Questionnaire TWCI
支援的參照政策（Reference policy）
resolves

能力摘要
  • SHALL 支援 create, read, vread, update.

預期的遵從度： 必須（SHALL） QuestionnaireResponse

Profile
重大傷病申請書回覆-QuestionnaireResponse TWCI
支援的參照政策（Reference policy）
resolves
能力摘要
  • SHALL 支援 create, read, vread, update.

預期的遵從度： 必須（SHALL） Task

Profile
重大傷病申請-Task TWCI
支援的參照政策（Reference policy）
resolves
能力摘要
  • SHALL 支援 create, read, vread, update.

Search Parameters
遵從度參數類型範例
必須（SHALL）patient.identifierreference, tokenGET [base]/Task?patient.identifier=[code]

實作請參考查詢參數

必須（SHALL）patient.namereference, stringGET [base]/Task?patient.name=[string]

實作請參考查詢參數

必須（SHALL）perioddateGET [base]/Task?period={gt|lt|ge|le}[date]{&period={gt|lt|ge|le}[date]}
必須（SHALL）modifieddateGET [base]/Task?modified={gt|lt|ge|le}[date]{&modified={gt|lt|ge|le}[date]}
必須（SHALL）identifiertokenGET [base]/Task?identifier=[code]
必須（SHALL）authored-ondateGET [base]/Task?authored-on={gt|lt|ge|le}[date]{&authored-on={gt|lt|ge|le}[date]}
必須（SHALL）statustokenGET [base]/Task?status=[code]
 

預期的遵從度： 必須（SHALL） Patient

Profile
病人資訊-Patient TWCI
支援的參照政策（Reference policy）
resolves
能力摘要
  • SHALL 支援 create, read, vread, update.

Search Parameters
遵從度參數類型範例
必須（SHALL）identifiertokenGET [base]/Patient?identifier=[code]

實作請參考查詢參數

必須（SHALL）namestringGET [base]/Patient?name=[string]

實作請參考查詢參數

 

預期的遵從度： 必須（SHALL） Condition

Profile
重大傷病-Condition TWCI
支援的參照政策（Reference policy）
resolves
能力摘要
  • SHALL 支援 create, read, vread, update.

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CapabilityStatementTWCIServer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://nhicore.nhi.gov.tw/ci/CapabilityStatement/CapabilityStatementTWCIServer",
  "version": "1.0.0",
  "name": "CapabilityStatementTWCIServer",
  "title": "臺灣重大傷病-伺服端(TWCI Server)",
  "status": "active",
  "experimental": false,
  "date": "2025-04-30",
  "publisher": "衛生福利部中央健康保險署",
  "contact": [
    {
      "name": "衛生福利部中央健康保險署",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nhi.gov.tw"
        }
      ]
    }
  ],
  "description": "臺灣健保重大傷病實作指引(TWCI IG)伺服端(Server)之能力聲明",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "https://nhicore.nhi.gov.tw/ci/ImplementationGuide/tw.gov.mohw.nhi.ci"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "臺灣重大傷病-伺服端(TWCI Server)必須（SHALL）使用臺灣重大傷病伺服端（TWCI Server）能力聲明中的查詢參數，支援讀取和查詢一個或多個臺灣重大傷病Profile(s)。",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ],
        "description": "Server必須(SHALL)透過回傳 HTTP 401「未授權」， HTTP 403「禁止」，或 HTTP 404 「未找到」，來拒絕任何未經授權的請求。"
      },
      "resource": [
        {
          "type": "Bundle",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/Bundle-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Bundle-id",
              "type": "token"
            }
          ]
        },
        {
          "type": "Questionnaire",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/Questionnaire-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "QuestionnaireResponse",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/QuestionnaireResponse-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "Task",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/Task-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "period",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-period",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-patient",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "authored-on",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-authored-on",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "modified",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-modified",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Task-status",
              "type": "token"
            }
          ]
        },
        {
          "type": "Patient",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/Patient-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Patient-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "https://nhicore.nhi.gov.tw/ci/SearchParameter/Patient-identifier",
              "type": "token"
            }
          ]
        },
        {
          "type": "Condition",
          "profile": "https://nhicore.nhi.gov.tw/ci/StructureDefinition/Condition-twci",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        }
      ]
    }
  ]
}