FHIR IG analytics| Package | tw.gov.mohw.nhi.base |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-CapabilityStatementTWNHIBASEClient.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/TWNHIFHIR/base/CapabilityStatement-CapabilityStatementTWNHIBASEClient.html |
| URL | https://nhicore.nhi.gov.tw/base/CapabilityStatement/CapabilityStatementTWNHIBASEClient |
| Version | 0.0.1 |
| Status | active |
| Date | 2025-11-07 |
| Name | CapabilityStatementTWNHIBASEClient |
| Title | 臺灣健保署基礎-用戶端(TWNHIBASE Client) |
| Realm | tw |
| Authority | national |
| Description | 臺灣健保署基礎實作指引(TWNHIBASE IG)用戶端(Client)之能力聲明 |
| Kind | requirements |
No resources found
| ImplementationGuide | |
| tw.gov.mohw.nhi.base | 臺灣健保署基礎實作指引 |
| SearchParameter | |
| Claim-patient | ClaimID |
| Patient-identifier | PatientIdentifier |
| Patient-name | PatientName |
| 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-twcore | TW Core Organization Government |
Note: links and images are rebased to the (stated) source
jsonclient臺灣健保署基礎-用戶端(TWNHIBASE Client)建議應該(SHOULD):
(1)使用臺灣健保署基礎伺服端(TWNHIBASE Server)能力聲明中的查詢參數,支援讀取和查詢一個或多個臺灣健保署基礎Profile(s)
安全性:
(1)有關要求和建議,請參閱安全性。
共有七類Resources支援查詢,查詢參數如表列:
| Resource型別 | Profile | Create | Read | VRead | Delete | Update | 支援的查詢參數 |
|---|---|---|---|---|---|---|---|
| Claim | 事前審查-Claim TWNHIBASE | y | y | y | y | patient | |
| Organization | 支援的Profiles 機構-Organization TWNHIBASE 基因檢測機構-Organization Genetic Testing TWNHIBASE TW Core Organization Government | y | y | y | y | ||
| Patient | 病人資訊-Patient TWNHIBASE | y | y | y | y | name, identifier | |
| Observation | 基因資訊-Observation Diagnostic TWNHIBASE | y | y | y | y | ||
| Specimen | 基因檢測檢體-Specimen TWNHIBASE | y | y | y | y | ||
| DocumentReference | 文件參照-DocumentReference TWNHIBASE | y | y | y | y | ||
| Coverage | 健保事前審查計畫-Coverage TWNHIBASE | y | y | y | y |
resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 建議應該(SHOULD) | patient | token | GET [base]/Claim?patient={Type/}[id] |
resolvescreate, read, vread, update.resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 建議應該(SHOULD) | name | string | GET [base]/Patient?name=[string] |
| 建議應該(SHOULD) | identifier | token | GET [base]/Patient?identifier=[code] |
resolvescreate, read, vread, update.resolvescreate, read, vread, update.resolvescreate, read, vread, update.resolvescreate, read, vread, update.{
"resourceType": "CapabilityStatement",
"id": "CapabilityStatementTWNHIBASEClient",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://nhicore.nhi.gov.tw/base/CapabilityStatement/CapabilityStatementTWNHIBASEClient",
"version": "0.0.1",
"name": "CapabilityStatementTWNHIBASEClient",
"title": "臺灣健保署基礎-用戶端(TWNHIBASE Client)",
"status": "active",
"experimental": false,
"date": "2025-11-07",
"publisher": "衛生福利部中央健康保險署",
"contact": [
{
"name": "衛生福利部中央健康保險署",
"telecom": [
{
"system": "url",
"value": "https://www.nhi.gov.tw"
}
]
}
],
"description": "臺灣健保署基礎實作指引(TWNHIBASE IG)用戶端(Client)之能力聲明",
"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": "client",
"documentation": "臺灣健保署基礎-用戶端(TWNHIBASE Client)建議應該(SHOULD)使用臺灣健保署基礎伺服端(TWNHIBASE Server)能力聲明中的查詢參數,支援讀取和查詢一個或多個臺灣健保署基礎Profile(s)。",
"security": {
"description": "有關要求和建議,請參閱[安全性](security.html)。"
},
"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"
]
}
]
}
]
}