HL7 Vietnam VN Core FHIR Implementation Guide

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam
0.3.0 - STU1 Draft Viet Nam cờ

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: VN Core BHYT Gateway Client CapabilityStatement — Yêu cầu tuân thủ tối thiểu cho client gửi hồ sơ thanh toán BHYT

Draft tại thời điểm 2026-03-23

Bản thô xml | Tải xuống


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="vn-core-bhyt-gateway-client"/>
  <language value="vi"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement vn-core-bhyt-gateway-client</b></p><a name="vn-core-bhyt-gateway-client"> </a><a name="hcvn-core-bhyt-gateway-client"> </a><h2 id="title">VN Core BHYT Gateway Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 0.3.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2026-03-23 </li><li>Published by: HL7 Vietnam </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>client</code></h3></div><div class="panel-body"><div><p>Client gửi hồ sơ thanh toán BHYT cần sinh đúng <code>VNCoreBHYTSubmissionBundle</code>, tìm theo <code>MA_LK</code>, và gọi được các operation validate/submit/reverse.</p>
</div><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: no</div><div class="col-lg-6">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>Khuyến nghị tài khoản dịch vụ riêng cho cổng BHYT, token ngắn hạn, audit đầy đủ và tách quyền với các ứng dụng lâm sàng nội bộ.</p>
</div></blockquote><div class="row"><div class="col-12"><span class="lead">Summary of System-wide Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-vn-validate-bhyt-claim.html">$validate-bhyt-claim</a></td><td><div><p>Validate Bundle/Claim trước khi gửi Cổng BHXH</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-vn-submit-bhyt-claim.html">$submit-bhyt-claim</a></td><td><div><p>Gửi hồ sơ thanh toán BHYT theo lớp liên thông hồ sơ BHYT</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-vn-reverse-bhyt-claim.html">$reverse-bhyt-claim</a></td><td><div><p>Thu hồi/đảo hồ sơ BHYT đã gửi</p>
</div></td></tr></tbody></table></div></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Claim1-1">Claim</a></td><td><a href="StructureDefinition-vn-core-claim.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center">y</td><td>identifier, vn-ma-lk</td><td/><td/><td/></tr><tr><td><a href="#Coverage1-2">Coverage</a></td><td><a href="StructureDefinition-vn-core-coverage.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-coverage</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>beneficiary, vn-ma-dkbd</td><td/><td/><td/></tr><tr><td><a href="#Patient1-3">Patient</a></td><td><a href="StructureDefinition-vn-core-patient.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patient</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>vn-cccd, vn-bhxh</td><td/><td/><td/></tr><tr><td><a href="#Organization1-4">Organization</a></td><td><a href="StructureDefinition-vn-core-organization.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-organization</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>vn-cskcb</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Claim1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Claim</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-vn-core-claim.html">Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-claim-ma-lk.html">vn-ma-lk</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Coverage1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Coverage</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-vn-core-coverage.html">Thẻ BHYT VN Core — VN Core Coverage Profile</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>beneficiary</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-coverage-ma-dkbd.html">vn-ma-dkbd</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-3" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Patient</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-vn-core-patient.html">Bệnh nhân VN Core — VN Core Patient Profile</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-patient-cccd.html">vn-cccd</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-patient-bhxh.html">vn-bhxh</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-4" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Organization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-vn-core-organization.html">Cơ sở y tế VN Core — VN Core Organization Profile</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-organization-cskcb.html">vn-cskcb</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="http://fhir.hl7.org.vn/core/CapabilityStatement/vn-core-bhyt-gateway-client"/>
  <version value="0.3.0"/>
  <name value="VNBHYTGatewayClientCapabilityStatement"/>
  <title value="VN Core BHYT Gateway Client CapabilityStatement"/>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2026-03-23"/>
  <publisher value="HL7 Vietnam"/>
  <contact>
    <name value="HL7 Vietnam"/>
    <telecom>
      <system value="url"/>
      <value value="https://hl7.org.vn"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="[email protected]"/>
    </telecom>
  </contact>
  <contact>
    <name value="Omi HealthTech (OmiGroup)"/>
    <telecom>
      <system value="url"/>
      <value value="https://omihealthtech.vn"/>
    </telecom>
    <telecom>
      <system value="url"/>
      <value value="https://omigroup.vn"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="[email protected]"/>
    </telecom>
  </contact>
  <description
               value="Yêu cầu tuân thủ tối thiểu theo từng vai trò triển khai dành cho HIS/EMR hoặc middleware đóng vai trò client trong lớp liên thông hồ sơ BHYT, chịu trách nhiệm gửi hồ sơ thanh toán BHYT. / Minimum conformance requirements for payer submission clients using the VN Core BHYT Submission layer."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="VN"/>
      <display value="Viet Nam"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <format value="xml"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="Client gửi hồ sơ thanh toán BHYT cần sinh đúng `VNCoreBHYTSubmissionBundle`, tìm theo `MA_LK`, và gọi được các operation validate/submit/reverse."/>
    <security>
      <service>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="SMART-on-FHIR"/>
          <display value="SMART-on-FHIR"/>
        </coding>
      </service>
      <description
                   value="Khuyến nghị tài khoản dịch vụ riêng cho cổng BHYT, token ngắn hạn, audit đầy đủ và tách quyền với các ứng dụng lâm sàng nội bộ."/>
    </security>
    <resource>
      <type value="Claim"/>
      <profile
               value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="vn-ma-lk"/>
        <definition
                    value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-claim-ma-lk"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Coverage"/>
      <profile
               value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-coverage"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="beneficiary"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <name value="vn-ma-dkbd"/>
        <definition
                    value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-coverage-ma-dkbd"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Patient"/>
      <profile
               value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patient"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="vn-cccd"/>
        <definition
                    value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-patient-cccd"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="vn-bhxh"/>
        <definition
                    value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-patient-bhxh"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile
               value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-organization"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="vn-cskcb"/>
        <definition
                    value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-organization-cskcb"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <operation>
      <name value="validate-bhyt-claim"/>
      <definition
                  value="http://fhir.hl7.org.vn/core/OperationDefinition/vn-validate-bhyt-claim"/>
      <documentation value="Validate Bundle/Claim trước khi gửi Cổng BHXH"/>
    </operation>
    <operation>
      <name value="submit-bhyt-claim"/>
      <definition
                  value="http://fhir.hl7.org.vn/core/OperationDefinition/vn-submit-bhyt-claim"/>
      <documentation
                     value="Gửi hồ sơ thanh toán BHYT theo lớp liên thông hồ sơ BHYT"/>
    </operation>
    <operation>
      <name value="reverse-bhyt-claim"/>
      <definition
                  value="http://fhir.hl7.org.vn/core/OperationDefinition/vn-reverse-bhyt-claim"/>
      <documentation value="Thu hồi/đảo hồ sơ BHYT đã gửi"/>
    </operation>
  </rest>
</CapabilityStatement>