HL7 Vietnam VN Core FHIR Implementation Guide

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam
0.5.0 - Draft for Community Review

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

## : VN Core BHYT Gateway Server CapabilityStatement — Yêu cầu tuân thủ tối thiểu cho máy chủ cổng 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-server"/>
      <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-server</b></p><a name="vn-core-bhyt-gateway-server"> </a><a name="hcvn-core-bhyt-gateway-server"> </a><h2 id="title">VN Core BHYT Gateway Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 0.5.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: Omi HealthTech / VN Core FHIR Community Initiative </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>server</code></h3></div><div class="panel-body"><div><p>Máy chủ cổng/facade nên công bố rõ khả năng kiểm tra hợp lệ hồ sơ, nhận <code>VNCoreBHYTSubmissionBundle</code>, truy vết theo <code>MA_LK</code> và phản hồi lỗi bằng <code>OperationOutcome</code>.</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ị token máy chủ - máy chủ, danh sách IP cho phép hoặc mTLS theo quy định vận hành, ghi log đầy đủ truy cập và quá trình tiếp nhận hồ sơ BHYT.</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 hồ sơ theo profile và quy tắc của lớp liên thông hồ sơ BHYT</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>Tiếp nhận hồ sơ thanh toán BHYT theo <code>VNCoreBHYTSubmissionBundle</code></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 hoặc hủy hồ sơ đã 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="#Bundle1-1">Bundle</a></td><td><a href="StructureDefinition-vn-core-bhyt-submission-bundle.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-bhyt-submission-bundle</a></td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center">y</td><td>identifier</td><td/><td/><td/></tr><tr><td><a href="#Claim1-2">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-3">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>vn-ma-dkbd</td><td/><td/><td/></tr><tr><td><a href="#ClaimResponse1-4">ClaimResponse</a></td><td><a href="StructureDefinition-vn-core-claim-response.html">http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim-response</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>request, status, vn-xml1-id</td><td/><td/><td/></tr><tr><td><a href="#Patient1-5">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</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Bundle1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Bundle</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-bhyt-submission-bundle.html">Bundle hồ sơ thanh toán BHYT — VN Core BHYT Submission Bundle</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>.</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></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Claim1-2" 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>read</code>, <code>search-type</code>, <code>create</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-3" 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><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="ClaimResponse1-4" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>ClaimResponse</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-response.html">Kết quả giải quyết BHYT VN Core — VN Core ClaimResponse 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>request</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-vn-sp-claim-response-xml1-id.html">vn-xml1-id</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-5" 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></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-server"/>
      <version value="0.5.0"/>
      <name value="VNBHYTGatewayServerCapabilityStatement"/>
      <title value="VN Core BHYT Gateway Server CapabilityStatement"/>
      <status value="draft"/>
      <experimental value="true"/>
      <date value="2026-03-23"/>
      <publisher value="Omi HealthTech / VN Core FHIR Community Initiative"/>
      <contact>
        <name value="Omi HealthTech / VN Core FHIR Community Initiative"/>
        <telecom>
          <system value="url"/>
          <value value="https://hl7.org.vn"/>
        </telecom>
        <telecom>
          <system value="email"/>
          <value value="info@hl7.org.vn"/>
        </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="healthtech@omigroup.vn"/>
        </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 máy chủ/facade tiếp nhận hồ sơ thanh toán BHYT từ HIS/EMR. Tập trung vào lớp liên thông hồ sơ BHYT, `MA_LK`, các operation kiểm tra hợp lệ/gửi/thu hồi và các quy tắc định dạng xuất cổng. / Minimum conformance requirements for payer-facing BHYT submission servers."/>
      <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="server"/>
        <documentation
                       value="Máy chủ cổng/facade nên công bố rõ khả năng kiểm tra hợp lệ hồ sơ, nhận `VNCoreBHYTSubmissionBundle`, truy vết theo `MA_LK` và phản hồi lỗi bằng `OperationOutcome`."/>
        <security>
          <cors value="false"/>
          <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ị token máy chủ - máy chủ, danh sách IP cho phép hoặc mTLS theo quy định vận hành, ghi log đầy đủ truy cập và quá trình tiếp nhận hồ sơ BHYT."/>
        </security>
        <resource>
          <type value="Bundle"/>
          <profile
                   value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-bhyt-submission-bundle"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <searchParam>
            <name value="identifier"/>
            <type value="token"/>
          </searchParam>
        </resource>
        <resource>
          <type value="Claim"/>
          <profile
                   value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="create"/>
          </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="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="ClaimResponse"/>
          <profile
                   value="http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim-response"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <searchParam>
            <name value="request"/>
            <type value="reference"/>
          </searchParam>
          <searchParam>
            <name value="status"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <name value="vn-xml1-id"/>
            <definition
                        value="http://fhir.hl7.org.vn/core/SearchParameter/vn-sp-claim-response-xml1-id"/>
            <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>
        </resource>
        <operation>
          <name value="validate-bhyt-claim"/>
          <definition
                      value="http://fhir.hl7.org.vn/core/OperationDefinition/vn-validate-bhyt-claim"/>
          <documentation
                         value="Validate hồ sơ theo profile và quy tắc của lớp liên thông hồ sơ BHYT"/>
        </operation>
        <operation>
          <name value="submit-bhyt-claim"/>
          <definition
                      value="http://fhir.hl7.org.vn/core/OperationDefinition/vn-submit-bhyt-claim"/>
          <documentation
                         value="Tiếp nhận hồ sơ thanh toán BHYT theo `VNCoreBHYTSubmissionBundle`"/>
        </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 hoặc hủy hồ sơ đã gửi"/>
        </operation>
      </rest>
    </CapabilityStatement>