國家級人體生物資料庫整合平台共同資料模式實作指引(NBCT Common Data Model IG)
1.0.0 - ci-build
This page is part of the 國家級人體生物資料庫整合平台共同資料模式實作指引(NBCT Common Data Model IG) (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Active as of 2025-03-10 |
{
"resourceType" : "CapabilityStatement",
"id" : "CDMClient",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>實作指引版本：0.1.0</li><li>FHIR版本：4.0.1</li><li>發佈日：2025-03-15</li></ul><h3 id=\"CDMClient\">國家級人體生物資料庫整合平台共同資料模式-用戶端</h3><ul><li>國家級人體生物資料庫整合平台共同資料模式-用戶端（NBCT Common Data Model Client）<strong>建議應該（SHOULD）</strong></li><ol><li>國家級人體生物資料庫整合平台共同資料模式-伺服端（NBCT Common Data Model Server）能力聲明中的查詢參數，支援讀取和查詢一個或多個Profile（s）。</li></ol><li><strong>安全性</strong></li><ol><li>有關要求和建議，請參閱一般安全注意事項部分。</li></ol><li><strong>系統互動能力：</strong></li><ul><li><strong>可能可以（MAY）</strong>支援交易互動（<code>transaction</code> interaction）。</li><li><strong>可能可以（MAY）</strong>支援批次互動（<code>batch</code> interaction）。</li><li><strong>可能可以（MAY）</strong>支援查詢系統互動（<code>search-system</code> interaction）。</li></ul></ul><h3 id=\"resource-details\" class=\"no_toc\">應用說明</h3><ul><li>此「國家級人體生物資料庫整合平台共同資料模式實作指引(NBCT Common Data Model IG)」中使用的 Bundle type為「document」，根據 HL7 FHIR 中規定，Bundle type為「document」時第一個資源須為Composition，並且將整個Bundle視為一個文件或報告來傳遞資料。但在癌症登記檔長表(CRLF)中沒有全部的資料都有相對應的國際編碼，因此CRLF資料先暫定不設計Bundle與Composition內容。</li></ul><h3 id=\"resource-details\" class=\"no_toc\">Resources或Profiles的RESTful功能</h3><ul><li>Profiles</li><ol><li><strong>必須(SHALL)</strong>支援<code>create</code>、<code>update</code></li></ol><li><strong>Resources支援查詢，查詢參數如表列：</strong></li><table class=\"grid\"><thead><tr><th>Resources型別</th><th>Profile</th><th>支援的Profiles</th><th>支援的查詢參數</th></tr></thead><tbody><tr><td><a>Bundle</a></td><td><a href=\"StructureDefinition-BundleTOTFA.html\">門診醫療申報檔(TOTFA) Bundle</a><br/><a href=\"StructureDefinition-BundleTOTFB.html\">住院醫療申報檔案(TOTFB) Bundle</a><br/><a href=\"StructureDefinition-BundleLABD.html\">檢驗檢查資料檔每日格式(LABD) Bundle</a><br/><a href=\"StructureDefinition-BundleLABM.html\">檢驗檢查資料檔每月格式(LABM) Bundle</a><br/><a href=\"StructureDefinition-BundleCASE.html\">癌症個案管理追蹤資料檔(CASE) Bundle</a><br/><a href=\"StructureDefinition-BundleDEATH.html\">死亡資料檔(DEATH) Bundle</a></td><td>-</td><td>_id,identifier</td></tr></tbody></table></ul><h4 id=\"bundle\" class=\"no_toc\">Bundle</h4><ul><li>預期的遵從度：<strong>建議應該（SHOULD）</strong></li><li>Profile：<a href=\"StructureDefinition-BundleTOTFA.html\">門診醫療申報檔(TOTFA) Bundle</a>,<a href=\"StructureDefinition-BundleTOTFB.html\">住院醫療申報檔案(TOTFB) Bundle</a>,<a href=\"StructureDefinition-BundleLABD.html\">檢驗檢查資料檔每日格式(LABD) Bundle</a>,<a href=\"StructureDefinition-BundleLABM.html\">檢驗檢查資料檔每月格式(LABM) Bundle</a>,<a href=\"StructureDefinition-BundleCASE.html\">癌症個案管理追蹤資料檔(CASE) Bundle</a>,<a href=\"StructureDefinition-BundleDEATH.html\">死亡資料檔(DEATH) Bundle</a></li><li><a href=\"https://build.fhir.org/codesystem-reference-handling-policy.html#reference-handling-policy-resolves\">支援的參照政策（Reference policy）</a>：<code>resolves</code>，Server會嘗試將邏輯參照（logical reference）解析為文字參照，意即轉換Reference.identifier為Reference.reference（但如果解析失敗，Server仍然會接收這個resource，請參閱<code>logical</code>）。</li><li>Profile</li><ul><li><strong>建議應該（SHOULD）</strong>支援<code>search-type</code>,<code>read</code>,<code>vread</code></li><li><strong>可能可以（MAY）</strong>支援<code>create</code>,<code>update</code>,<code>patch</code>,<code>delete</code></li></ul><li>查詢參數摘要</li><table class=\"grid\"><thead><tr><th>遵從度</th><th>參數</th><th>類型</th><th>範例</th></tr></thead><tbody><tr><td><strong>建議應該（SHOULD）</strong></td><td><a href=\"SearchParameter-Bundle-id.html\">_id</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?_id=[id]</code>,<br/><code class=\"highlighter-rouge\">GET [base]/Bundle/[id]</code></td></tr><tr><td><strong>建議應該（SHOULD）</strong></td><td><a href=\"SearchParameter-Bundle-identifier.html\">identifier</a></td><td>token</td><td><code class=\"highlighter-rouge\">GET [base]/Bundle?identifier={system|}[code]</code></td></tr></tbody></table></ul></div>"
},
"url" : "https://www.ghd.tw/cdm-fhir/CapabilityStatement/CDMClient",
"version" : "1.0.0",
"name" : "CapabilityStatementCDMClient",
"title" : "國家級人體生物資料庫整合平台共同資料模式-用戶端",
"status" : "active",
"experimental" : false,
"date" : "2025-03-10",
"publisher" : "國家級人體生物資料庫整合平台",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://ghd.tw/"
}
]
}
],
"description" : "國家級人體生物資料庫整合平台共同資料模式-用戶端(Client)之能力聲明",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"patchFormat" : [
"application/json-patch+json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "使用國家級人體生物資料庫整合平台共同資料模式-用戶端能力聲明中的查詢參數，支援讀取和查詢一個或多個Profile(s)。",
"resource" : [
{
"type" : "Bundle",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleCASE"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleDEATH"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleLABD"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleLABM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleTOTFA"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/BundleTOTFB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "CarePlan",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/CarePlan-LFM6"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "ChargeItem",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/ChargeItemCDM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ChargeItemCMDorder"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Composition",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionCASE"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionDEATH"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionLABD"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionLABM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionTOTFA"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/CompositionTOTFB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Condition",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/Condition-Primary"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Condition-Secondary"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ConditionDEATH"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ConditionTOTFAB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "DiagnosticReport",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/DiagnosticReportLABDM"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Encounter",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/EncounterLABD"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/EncounterLABM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/EncounterTOTFA"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/EncounterTOTFB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "MedicationRequest",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/MedicationRequestCDMorder"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Observation",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Clinical-CancerStage"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Clinical-Descriptor"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Clinical-Metastasis"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Clinical-Node"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Clinical-Tumor"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-BodyHeight"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-BodyWeight"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-btchew"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-Drinking"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-LVI"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-NEXAM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-NPOSIT"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-PNI"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-PS"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-CRLF-Smoking"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-GradeClinical"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-GradePathology"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf1"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf2"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf3"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf4"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf5"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf6"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf7"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf8"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf9"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-LF8-ssf10"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Pathology-CancerStage"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Pathology-Descriptor"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Pathology-Metastasis"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Pathology-Node"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Pathology-Tumor"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Observation-Tumor-Size"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationCASERecurrenceStatus"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationCASESurvivalStatus"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationCASETreatmentResponse"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationCDMorder"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationLABDM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ObservationTOTFB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Organization",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/OrganizationCRLF"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/OrganizationLABDM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/OrganizationTOTFAB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Patient",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/PatientCDM"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/PatientCRLF"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/PatientDEATH"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Procedure",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-Diag"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-EBRTTechnique"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM1-DeclarationHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM1-ExternalHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM2-DeclarationHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM2-ExternalHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM3-DeclarationHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM3-ExternalHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM4"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM5-DeclarationHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM5-ExternalHospital"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LFM7"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-LTAndST-Sequence"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-MinimallyInvasiveSurgery"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-ORTTechnique"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-RadioTherapy-Other"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-RadioTherapy"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-RadiotherapyAndSurgery-Sequence"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-Surgical-OtherSite"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-Surgical-PrimarySite"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-Surgical-RegionalLymphNode"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/Procedure-SystemicTherapy"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ProcedureCASE"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ProcedureCDMorder"🔗 ,
"https://www.ghd.tw/cdm-fhir/StructureDefinition/ProcedureTOTFAB"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"type" : "Specimen",
"supportedProfile" : [
🔗 "https://www.ghd.tw/cdm-fhir/StructureDefinition/SpecimenLABDM"
],
"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" : "update"
}
],
"referencePolicy" : [
"resolves"
]
}
]
}
]
}