FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagetw.gov.mohw.nhi.base
Resource TypeCapabilityStatement
IdCapabilityStatement-CapabilityStatementTWNHIBASEServer.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/TWNHIFHIR/base/CapabilityStatement-CapabilityStatementTWNHIBASEServer.html
URLhttps://nhicore.nhi.gov.tw/base/CapabilityStatement/CapabilityStatementTWNHIBASEServer
Version0.0.1
Statusactive
Date2025-11-07
NameCapabilityStatementTWNHIBASEServer
Title臺灣健保署基礎-伺服端(TWNHIBASE Server)
Realmtw
Authoritynational
Description臺灣健保署基礎實作指引(TWNHIBASE IG)伺服端(Server)之能力聲明
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
tw.gov.mohw.nhi.base臺灣健保署基礎實作指引
SearchParameter
Claim-patientClaimID
Patient-identifierPatientIdentifier
Patient-namePatientName
StructureDefinition
Claim-twnhibase事前審查-Claim TWNHIBASE
Coverage-twnhibase健保事前審查計畫-Coverage TWNHIBASE
DocumentReference-twnhibase文件參照-DocumentReference TWNHIBASE
Observation-diagnostic-twnhibase基因資訊-Observation Diagnostic TWNHIBASE
Organization-gene-twnhibase基因檢測機構-Organization Gene TWNHIBASE
Organization-twnhibase醫事機構-Organization TWNHIBASE
Patient-twnhibase病人資訊-Patient TWNHIBASE
Specimen-twnhibase基因檢測檢體-Specimen TWNHIBASE
Organization-govt-twcoreTW Core Organization Government

Narrative

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

臺灣健保署基礎-伺服端(TWNHIBASE Server)

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

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

Server的FHIR RESTful功能要求

模式: server

臺灣健保署基礎-伺服端(TWNHIBASE 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是否為TWNHIBASE Profiles Defining URL，並確認實例是否依循Profile製作。
【註：實例是指依據Profile實作，將真實資料以JSON、XML或Turtle格式存放的檔案】

臺灣健保署基礎-伺服端(TWNHIBASE Server)建議應該(SHOULD)：
(1)Server提供的API操作皆支援XML格式

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

Resources或Profiles的RESTful功能

Summary

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

Resource型別ProfileCreateReadVReadDeleteUpdate支援的查詢參數
Claim事前審查-Claim TWNHIBASEyyyypatient
Organization支援的Profiles
   機構-Organization TWNHIBASE
   基因檢測機構-Organization Genetic Testing TWNHIBASE
   TW Core Organization Government		yyyy
Patient病人資訊-Patient TWNHIBASEyyyyname, identifier
Observation基因資訊-Observation Diagnostic TWNHIBASEyyyy
Specimen基因檢測檢體-Specimen TWNHIBASEyyyy
DocumentReference文件參照-DocumentReference TWNHIBASEyyyy
Coverage健保事前審查計畫-Coverage TWNHIBASEyyyy

預期的遵從度： 建議應該（SHOULD）Claim

Profile
事前審查-Claim TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

Search Parameters
遵從度參數類型範例
建議應該（SHOULD）patienttokenGET [base]/Claim?patient={Type/}[id]
 

預期的遵從度： 建議應該（SHOULD）Organization

Core FHIR Resource
Organization
支援的參照政策（Reference policy）
resolves
能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

支援的Profiles

機構-Organization TWNHIBASE
基因檢測機構-Organization Genetic Testing TWNHIBASE
TW Core Organization Government

預期的遵從度： 建議應該（SHOULD）Patient

Profile
病人資訊-Patient TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

Search Parameters
遵從度參數類型範例
建議應該（SHOULD）namestringGET [base]/Patient?name=[string]
建議應該（SHOULD）identifiertokenGET [base]/Patient?identifier=[code]
 

預期的遵從度： 建議應該（SHOULD）Observation

Profile
基因資訊-Observation Diagnostic TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

預期的遵從度： 建議應該（SHOULD）Specimen

Profile
基因檢測檢體-Specimen TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

預期的遵從度： 建議應該（SHOULD）DocumentReference

Profile
文件參照-DocumentReference TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

預期的遵從度： 建議應該（SHOULD）Coverage

Profile
健保事前審查計畫-Coverage TWNHIBASE
支援的參照政策（Reference policy）
resolves

能力摘要
  • 建議應該（SHOULD）支援 create, read, vread, update.

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "CapabilityStatementTWNHIBASEServer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://nhicore.nhi.gov.tw/base/CapabilityStatement/CapabilityStatementTWNHIBASEServer",
  "version": "0.0.1",
  "name": "CapabilityStatementTWNHIBASEServer",
  "title": "臺灣健保署基礎-伺服端(TWNHIBASE Server)",
  "status": "active",
  "experimental": false,
  "date": "2025-11-07",
  "publisher": "衛生福利部中央健康保險署",
  "contact": [
    {
      "name": "衛生福利部中央健康保險署",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nhi.gov.tw"
        }
      ]
    }
  ],
  "description": "臺灣健保署基礎實作指引(TWNHIBASE IG)伺服端(Server)之能力聲明",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "https://nhicore.nhi.gov.tw/base/ImplementationGuide/tw.gov.mohw.nhi.base"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "臺灣健保署基礎-伺服端(TWNHIBASE Server)必須(SHALL)：(1)支援本實作指引中所有profiles (2)根據FHIR規範實作RESTful (3)回傳狀態碼-①(Status 400)：無效參數(invalid parameter)、②(Status 401/4xx)：未經授權的請求(unauthorized request)、③(Status 403)：未充分授權的資料存取範圍(insufficient premission scope)、④(Status 404)：未知的resource(unknown resource) (4)支援JSON格式 (5)可識別每個新增到Server的實例(instance)之meta.profile是否為臺灣健保署基礎Profiles Defining URL，並確認實例是否依循Profile製作。臺灣健保署基礎-伺服端建議應該(SHOULD)：(1)支援XML格式。",
      "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": "Claim",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/Claim-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "patient",
              "definition": "https://nhicore.nhi.gov.tw/base/SearchParameter/Claim-patient",
              "type": "reference"
            }
          ]
        },
        {
          "type": "Organization",
          "supportedProfile": [
            "https://nhicore.nhi.gov.tw/base/StructureDefinition/Organization-twnhibase",
            "https://nhicore.nhi.gov.tw/base/StructureDefinition/Organization-gene-twnhibase",
            "https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Organization-govt-twcore"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "Patient",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/Patient-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "https://nhicore.nhi.gov.tw/base/SearchParameter/Patient-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "https://nhicore.nhi.gov.tw/base/SearchParameter/Patient-identifier",
              "type": "token"
            }
          ]
        },
        {
          "type": "Observation",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/Observation-diagnostic-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "Specimen",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/Specimen-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "DocumentReference",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/DocumentReference-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "type": "Coverage",
          "profile": "https://nhicore.nhi.gov.tw/base/StructureDefinition/Coverage-twnhibase",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "update"
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        }
      ],
      "interaction": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "code": "transaction"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "code": "batch"
        }
      ]
    }
  ]
}