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

Hồ sơ tài nguyên: Thẻ BHYT VN Core — VN Core Coverage Profile - Mô tả chi tiết

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

Các định nghĩa cho vn-core-coverage hồ sơ tài nguyên

Guidance on how to interpret the contents of this table can be foundhere

0. Coverage
Definition

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

ShortInsurance or medical plan or a payment agreement
Comments

The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
vn-coverage-subscriberid-consistency: Nếu đồng thời dùng subscriberId và identifier[BHYT] thì hai giá trị phải trùng nhau (subscriberId.empty() or identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').empty() or subscriberId = identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').first().value)
2. Coverage.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Coverage.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Coverage.extension:bhytCardType
    Slice NamebhytCardType
    Definition

    Mở rộng ghi nhận loại đối tượng bảo hiểm y tế (DN, HC, HN, TE, BT...). Xác định mức quyền lợi và tỷ lệ đồng chi trả. Tương ứng trường MATHE (2 ký tự đầu) trong QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024). Căn cứ: Luật BHYT 2008 sửa đổi 2014, BHXH Việt Nam.

    ShortLoại đối tượng BHYT (DN, HC, HN, TE...)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Loại đối tượng BHYT — Vietnam BHYT Card Type Extension) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Coverage.extension:primaryCareFacility
    Slice NameprimaryCareFacility
    Definition

    Mở rộng ghi nhận cơ sở KCB ban đầu trên thẻ BHYT. Tương ứng trường MA_DKBD trong QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024). Tham chiếu đến Organization có mã CSKCB (5 chữ số do BHXH VN cấp). Căn cứ: QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024), Luật BHYT 2008 sửa đổi 2014.

    ShortNơi ĐKKCB ban đầu (MA_DKBD)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Nơi đăng ký KCB ban đầu — Vietnam Primary Care Facility Extension) (Extension Type: Reference(Cơ sở y tế VN Core — VN Core Organization Profile))
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Coverage.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Coverage.identifier
    Definition

    A unique identifier assigned to this coverage.

    ShortBusiness Identifier for the coverage
    Comments

    The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows coverages to be distinguished and referenced.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Coverage.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 14. Coverage.identifier:BHYT
      Slice NameBHYT
      Definition

      A unique identifier assigned to this coverage.

      ShortBusiness Identifier for the coverage
      Comments

      The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows coverages to be distinguished and referenced.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Coverage.identifier:BHYT.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Coverage.identifier:BHYT.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Fixed Valuehttp://fhir.hl7.org.vn/core/sid/bhyt
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Coverage.identifier:BHYT.value
      Definition

      Số thẻ BHYT hỗ trợ 3 format: 12 số (CCCD — hỗ trợ từ 15/8/2025 per NĐ 188/2025/NĐ-CP, hiện duy trì song song với các format cũ), 10 số (mã BHXH, từ 01/4/2021), hoặc 15 ký tự (legacy). Bên triển khai cần xác minh chính sách BHXH hiện hành trước khi coi CCCD là mã BHYT duy nhất


      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      ShortSố thẻ BHYTThe value that is unique
      Comments

      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      ExampleGeneral: 123456
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      vn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
      22. Coverage.status
      Definition

      The status of the resource instance.

      ShortTrạng thái thẻ (active, cancelled)active | cancelled | draft | entered-in-error
      Comments

      This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

      Control1..1
      BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

      A code specifying the state of the resource instance.

      Typecode
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Coverage.type
      Definition

      Biểu diễn loại coverage theo ngữ nghĩa chuẩn FHIR. Với hồ sơ thẻ bảo hiểm y tế Việt Nam, dùng mã chuẩn medical từ hệ insurance-coverage-type. Không dùng Coverage.type để mang trường NGUON_CTRA; thông tin nguồn chi trả được mô hình hóa ở lớp Claim, ExplanationOfBenefit và các extension tổng hợp chi phí.


      The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

      ShortLoại coverage theo ngữ nghĩa chuẩn FHIRCoverage category such as medical or accident
      Control10..1
      BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type|4.0.1
      (preferred to http://hl7.org/fhir/ValueSet/coverage-type|4.0.1)

      The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      The order of application of coverages is dependent on the types of coverage.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Coverage.type.coding
      Definition

      A reference to a code defined by a terminology system.

      ShortCode defined by a terminology system
      Comments

      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

      Control10..*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Coverage.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 28. Coverage.type.coding:coverageCategory
        Slice NamecoverageCategory
        Definition

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. Coverage.type.coding:coverageCategory.system
        Definition

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

        Control10..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Valuehttp://terminology.hl7.org/CodeSystem/insurance-coverage-type
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. Coverage.type.coding:coverageCategory.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

        Fixed Valuemedical
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. Coverage.type.text
        Definition

        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

        ShortTên hiển thị tiếng Việt của loại coveragePlain text representation of the concept
        Comments

        Very often the text is the same as a displayName of one of the codings.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Coverage.subscriber
        Definition

        Giữ semantics chuẩn FHIR. Với thẻ BHYT gắn trực tiếp cho người bệnh thì subscriber có thể chính là beneficiary. Với hồ sơ phụ thuộc hoặc đại diện hợp pháp có thể tham chiếu VNCoreRelatedPerson.


        The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

        ShortNgười đứng tên/đối tượng subscriber theo CoverageSubscriber to the policy
        Comments

        May be self or a parent in the case of dependants.

        Control0..1
        TypeReference(Bệnh nhân VN Core — VN Core Patient Profile, Người liên quan/người giám hộ VN Core — VN Core RelatedPerson Profile, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Requirements

        This is the party who is entitled to the benfits under the policy.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Coverage.subscriberId
        Definition

        Trường này giữ lại cho backward-compatible. Hệ thống MỚI nên dùng Coverage.identifier[BHYT]. Nếu cả hai có giá trị, identifier[BHYT].value là authoritative.


        The insurer assigned ID for the Subscriber.

        ShortSố thẻ BHYT (deprecated — dùng identifier[BHYT])ID assigned to the subscriber
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        The insurer requires this identifier on correspondance and claims (digital and otherwise).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        vn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
        40. Coverage.beneficiary
        Definition

        The party who benefits from the insurance coverage; the patient when products and/or services are provided.

        ShortNgười thụ hưởng BHYTPlan beneficiary
        Control1..1
        TypeReference(Bệnh nhân VN Core — VN Core Patient Profile, Patient)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        This is the party who receives treatment for which the costs are reimbursed under the coverage.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Coverage.relationship
        Definition

        Dùng bộ mã subscriber-relationship chuẩn FHIR để tránh tạo custom code system mới.


        The relationship of beneficiary (patient) to the subscriber.

        ShortQuan hệ giữa beneficiary và subscriberBeneficiary relationship to the subscriber
        Comments

        Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

        Control0..1
        BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from SubscriberPolicyholder Relationship Codeshttp://hl7.org/fhir/ValueSet/subscriber-relationship|4.0.1
        (required to http://terminology.hl7.org/ValueSet/subscriber-relationship)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        To determine relationship between the patient and the subscriber to determine coordination of benefits.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Coverage.period
        Definition

        Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

        ShortThời hạn thẻ BHYTCoverage start and end dates
        Control0..1
        TypePeriod
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Some insurers require the submission of the coverage term.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Coverage.period.start
        Definition

        The start of the period. The boundary is inclusive.

        ShortNgày bắt đầu hiệu lựcStarting time with inclusive boundary
        Comments

        If the low element is missing, the meaning is that the low boundary is not known.

        Control0..1
        This element is affected by the following invariants: per-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Coverage.period.end
        Definition

        The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

        ShortNgày hết hiệu lựcEnd time with inclusive boundary, if not ongoing
        Comments

        The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

        Control0..1
        This element is affected by the following invariants: per-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Coverage.payor
        Definition

        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

        ShortCơ quan chi trả (BHXH Việt Nam)Issuer of the policy
        Comments

        May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

        Control1..*
        TypeReference(Organization, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Requirements

        Need to identify the issuer to target for claim processing and for coordination of benefit processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

        Guidance on how to interpret the contents of this table can be foundhere

        0. Coverage
        Invariantsvn-coverage-subscriberid-consistency: Nếu đồng thời dùng subscriberId và identifier[BHYT] thì hai giá trị phải trùng nhau (subscriberId.empty() or identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').empty() or subscriberId = identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').first().value)
        2. Coverage.extension
        SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 4. Coverage.extension:bhytCardType
          Slice NamebhytCardType
          ShortLoại đối tượng BHYT (DN, HC, HN, TE...)
          Control0..1
          TypeExtension(Loại đối tượng BHYT — Vietnam BHYT Card Type Extension) (Extension Type: CodeableConcept)
          Must Supporttrue
          6. Coverage.extension:primaryCareFacility
          Slice NameprimaryCareFacility
          ShortNơi ĐKKCB ban đầu (MA_DKBD)
          Control0..1
          TypeExtension(Nơi đăng ký KCB ban đầu — Vietnam Primary Care Facility Extension) (Extension Type: Reference(Cơ sở y tế VN Core — VN Core Organization Profile))
          Must Supporttrue
          8. Coverage.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Must Supporttrue
          SlicingThis element introduces a set of slices on Coverage.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 10. Coverage.identifier:BHYT
            Slice NameBHYT
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            Must Supporttrue
            12. Coverage.identifier:BHYT.system
            Control1..?
            Fixed Valuehttp://fhir.hl7.org.vn/core/sid/bhyt
            14. Coverage.identifier:BHYT.value
            Definition

            Số thẻ BHYT hỗ trợ 3 format: 12 số (CCCD — hỗ trợ từ 15/8/2025 per NĐ 188/2025/NĐ-CP, hiện duy trì song song với các format cũ), 10 số (mã BHXH, từ 01/4/2021), hoặc 15 ký tự (legacy). Bên triển khai cần xác minh chính sách BHXH hiện hành trước khi coi CCCD là mã BHYT duy nhất

            ShortSố thẻ BHYT
            Control1..?
            Invariantsvn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
            16. Coverage.status
            ShortTrạng thái thẻ (active, cancelled)
            Must Supporttrue
            18. Coverage.type
            Definition

            Biểu diễn loại coverage theo ngữ nghĩa chuẩn FHIR. Với hồ sơ thẻ bảo hiểm y tế Việt Nam, dùng mã chuẩn medical từ hệ insurance-coverage-type. Không dùng Coverage.type để mang trường NGUON_CTRA; thông tin nguồn chi trả được mô hình hóa ở lớp Claim, ExplanationOfBenefit và các extension tổng hợp chi phí.

            ShortLoại coverage theo ngữ nghĩa chuẩn FHIR
            Control1..?
            Must Supporttrue
            20. Coverage.type.coding
            Control1..?
            Must Supporttrue
            SlicingThis element introduces a set of slices on Coverage.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 22. Coverage.type.coding:coverageCategory
              Slice NamecoverageCategory
              Control1..1
              Must Supporttrue
              24. Coverage.type.coding:coverageCategory.system
              Control1..?
              Fixed Valuehttp://terminology.hl7.org/CodeSystem/insurance-coverage-type
              26. Coverage.type.coding:coverageCategory.code
              Control1..?
              Fixed Valuemedical
              28. Coverage.type.text
              ShortTên hiển thị tiếng Việt của loại coverage
              30. Coverage.subscriber
              Definition

              Giữ semantics chuẩn FHIR. Với thẻ BHYT gắn trực tiếp cho người bệnh thì subscriber có thể chính là beneficiary. Với hồ sơ phụ thuộc hoặc đại diện hợp pháp có thể tham chiếu VNCoreRelatedPerson.

              ShortNgười đứng tên/đối tượng subscriber theo Coverage
              TypeReference(Bệnh nhân VN Core — VN Core Patient Profile, Người liên quan/người giám hộ VN Core — VN Core RelatedPerson Profile)
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              32. Coverage.subscriberId
              Definition

              Trường này giữ lại cho backward-compatible. Hệ thống MỚI nên dùng Coverage.identifier[BHYT]. Nếu cả hai có giá trị, identifier[BHYT].value là authoritative.

              ShortSố thẻ BHYT (deprecated — dùng identifier[BHYT])
              Invariantsvn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
              34. Coverage.beneficiary
              ShortNgười thụ hưởng BHYT
              TypeReference(Bệnh nhân VN Core — VN Core Patient Profile)
              Must Supporttrue
              36. Coverage.relationship
              Definition

              Dùng bộ mã subscriber-relationship chuẩn FHIR để tránh tạo custom code system mới.

              ShortQuan hệ giữa beneficiary và subscriber
              BindingThe codes SHALL be taken from SubscriberPolicyholder Relationship Codes
              (required to http://terminology.hl7.org/ValueSet/subscriber-relationship)
              Must Supporttrue
              38. Coverage.period
              ShortThời hạn thẻ BHYT
              Must Supporttrue
              40. Coverage.period.start
              ShortNgày bắt đầu hiệu lực
              Must Supporttrue
              42. Coverage.period.end
              ShortNgày hết hiệu lực
              Must Supporttrue
              44. Coverage.payor
              ShortCơ quan chi trả (BHXH Việt Nam)
              Must Supporttrue

              Guidance on how to interpret the contents of this table can be foundhere

              0. Coverage
              Definition

              Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

              ShortInsurance or medical plan or a payment agreement
              Comments

              The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
              dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              vn-coverage-subscriberid-consistency: Nếu đồng thời dùng subscriberId và identifier[BHYT] thì hai giá trị phải trùng nhau (subscriberId.empty() or identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').empty() or subscriberId = identifier.where(system='http://fhir.hl7.org.vn/core/sid/bhyt').first().value)
              2. Coverage.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Is Modifierfalse
              Summarytrue
              4. Coverage.meta
              Definition

              The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Coverage.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              8. Coverage.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              10. Coverage.text
              Definition

              A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Coverage.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              14. Coverage.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Coverage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Coverage.extension:bhytCardType
                Slice NamebhytCardType
                Definition

                Mở rộng ghi nhận loại đối tượng bảo hiểm y tế (DN, HC, HN, TE, BT...). Xác định mức quyền lợi và tỷ lệ đồng chi trả. Tương ứng trường MATHE (2 ký tự đầu) trong QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024). Căn cứ: Luật BHYT 2008 sửa đổi 2014, BHXH Việt Nam.

                ShortLoại đối tượng BHYT (DN, HC, HN, TE...)
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Loại đối tượng BHYT — Vietnam BHYT Card Type Extension) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. Coverage.extension:primaryCareFacility
                Slice NameprimaryCareFacility
                Definition

                Mở rộng ghi nhận cơ sở KCB ban đầu trên thẻ BHYT. Tương ứng trường MA_DKBD trong QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024). Tham chiếu đến Organization có mã CSKCB (5 chữ số do BHXH VN cấp). Căn cứ: QĐ 130/QĐ-BYT (2023), sửa đổi bởi QĐ 4750/QĐ-BYT (2023) và QĐ 3176/QĐ-BYT (29/10/2024), Luật BHYT 2008 sửa đổi 2014.

                ShortNơi ĐKKCB ban đầu (MA_DKBD)
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Nơi đăng ký KCB ban đầu — Vietnam Primary Care Facility Extension) (Extension Type: Reference(Cơ sở y tế VN Core — VN Core Organization Profile))
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                20. Coverage.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                22. Coverage.identifier
                Definition

                A unique identifier assigned to this coverage.

                ShortBusiness Identifier for the coverage
                Comments

                The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Allows coverages to be distinguished and referenced.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Coverage.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ system
                • 24. Coverage.identifier:BHYT
                  Slice NameBHYT
                  Definition

                  A unique identifier assigned to this coverage.

                  ShortBusiness Identifier for the coverage
                  Comments

                  The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Allows coverages to be distinguished and referenced.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  26. Coverage.identifier:BHYT.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  28. Coverage.identifier:BHYT.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Coverage.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 30. Coverage.identifier:BHYT.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    32. Coverage.identifier:BHYT.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    34. Coverage.identifier:BHYT.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    Fixed Valuehttp://fhir.hl7.org.vn/core/sid/bhyt
                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Coverage.identifier:BHYT.value
                    Definition

                    Số thẻ BHYT hỗ trợ 3 format: 12 số (CCCD — hỗ trợ từ 15/8/2025 per NĐ 188/2025/NĐ-CP, hiện duy trì song song với các format cũ), 10 số (mã BHXH, từ 01/4/2021), hoặc 15 ký tự (legacy). Bên triển khai cần xác minh chính sách BHXH hiện hành trước khi coi CCCD là mã BHYT duy nhất

                    ShortSố thẻ BHYT
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    vn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
                    38. Coverage.identifier:BHYT.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    40. Coverage.identifier:BHYT.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. Coverage.status
                    Definition

                    The status of the resource instance.

                    ShortTrạng thái thẻ (active, cancelled)
                    Comments

                    This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

                    Control1..1
                    BindingThe codes SHALL be taken from FinancialResourceStatusCodes
                    (required to http://hl7.org/fhir/ValueSet/fm-status|4.0.1)

                    A code specifying the state of the resource instance.

                    Typecode
                    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    44. Coverage.type
                    Definition

                    Biểu diễn loại coverage theo ngữ nghĩa chuẩn FHIR. Với hồ sơ thẻ bảo hiểm y tế Việt Nam, dùng mã chuẩn medical từ hệ insurance-coverage-type. Không dùng Coverage.type để mang trường NGUON_CTRA; thông tin nguồn chi trả được mô hình hóa ở lớp Claim, ExplanationOfBenefit và các extension tổng hợp chi phí.

                    ShortLoại coverage theo ngữ nghĩa chuẩn FHIR
                    Control1..1
                    BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes
                    (preferred to http://hl7.org/fhir/ValueSet/coverage-type|4.0.1)

                    The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    The order of application of coverages is dependent on the types of coverage.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. Coverage.type.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    48. Coverage.type.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Coverage.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 50. Coverage.type.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control1..*
                      TypeCoding
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Allows for alternative encodings within a code system, and translations to other code systems.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Coverage.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ system
                      • 52. Coverage.type.coding:coverageCategory
                        Slice NamecoverageCategory
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control1..1
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        54. Coverage.type.coding:coverageCategory.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        56. Coverage.type.coding:coverageCategory.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Coverage.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 58. Coverage.type.coding:coverageCategory.system
                          Definition

                          The identification of the code system that defines the meaning of the symbol in the code.

                          ShortIdentity of the terminology system
                          Comments

                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to be unambiguous about the source of the definition of the symbol.

                          Fixed Valuehttp://terminology.hl7.org/CodeSystem/insurance-coverage-type
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          60. Coverage.type.coding:coverageCategory.version
                          Definition

                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                          ShortVersion of the system - if relevant
                          Comments

                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                          NoteThis is a business version Id, not a resource version Id (see discussion)
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          62. Coverage.type.coding:coverageCategory.code
                          Definition

                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                          ShortSymbol in syntax defined by the system
                          Control1..1
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

                          Fixed Valuemedical
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          64. Coverage.type.coding:coverageCategory.display
                          Definition

                          A representation of the meaning of the code in the system, following the rules of the system.

                          ShortRepresentation defined by the system
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          66. Coverage.type.coding:coverageCategory.userSelected
                          Definition

                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                          ShortIf this coding was chosen directly by the user
                          Comments

                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                          Control0..1
                          Typeboolean
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          68. Coverage.type.text
                          Definition

                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                          ShortTên hiển thị tiếng Việt của loại coverage
                          Comments

                          Very often the text is the same as a displayName of one of the codings.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          70. Coverage.policyHolder
                          Definition

                          The party who 'owns' the insurance policy.

                          ShortOwner of the policy
                          Comments

                          For example: may be an individual, corporation or the subscriber's employer.

                          Control0..1
                          TypeReference(Patient, RelatedPerson, Organization)
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          This provides employer information in the case of Worker's Compensation and other policies.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          72. Coverage.subscriber
                          Definition

                          Giữ semantics chuẩn FHIR. Với thẻ BHYT gắn trực tiếp cho người bệnh thì subscriber có thể chính là beneficiary. Với hồ sơ phụ thuộc hoặc đại diện hợp pháp có thể tham chiếu VNCoreRelatedPerson.

                          ShortNgười đứng tên/đối tượng subscriber theo Coverage
                          Comments

                          May be self or a parent in the case of dependants.

                          Control0..1
                          TypeReference(Bệnh nhân VN Core — VN Core Patient Profile, Người liên quan/người giám hộ VN Core — VN Core RelatedPerson Profile)
                          Is Modifierfalse
                          Must Supporttrue
                          Must Support TypesNo must-support rules about the choice of types/profiles
                          Summarytrue
                          Requirements

                          This is the party who is entitled to the benfits under the policy.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          74. Coverage.subscriberId
                          Definition

                          Trường này giữ lại cho backward-compatible. Hệ thống MỚI nên dùng Coverage.identifier[BHYT]. Nếu cả hai có giá trị, identifier[BHYT].value là authoritative.

                          ShortSố thẻ BHYT (deprecated — dùng identifier[BHYT])
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The insurer requires this identifier on correspondance and claims (digital and otherwise).

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          vn-bhyt-format: Số thẻ BHYT phải theo 1 trong 3 format: (1) 12 chữ số = CCCD (hỗ trợ từ 15/8/2025 per NĐ 188/2025), (2) 10 chữ số = mã BHXH (từ 01/4/2021), (3) 15 ký tự = 2 chữ + 13 số format cũ (trước 2021). Cả 3 format đều được chấp nhận song song ($this.empty() or $this.matches('^[0-9]{12}$') or $this.matches('^[0-9]{10}$') or $this.matches('^[A-Z]{2}[0-9]{13}$'))
                          76. Coverage.beneficiary
                          Definition

                          The party who benefits from the insurance coverage; the patient when products and/or services are provided.

                          ShortNgười thụ hưởng BHYT
                          Control1..1
                          TypeReference(Bệnh nhân VN Core — VN Core Patient Profile)
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          This is the party who receives treatment for which the costs are reimbursed under the coverage.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          78. Coverage.dependent
                          Definition

                          A unique identifier for a dependent under the coverage.

                          ShortDependent number
                          Comments

                          Periodically the member number is constructed from the subscriberId and the dependant number.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          80. Coverage.relationship
                          Definition

                          Dùng bộ mã subscriber-relationship chuẩn FHIR để tránh tạo custom code system mới.

                          ShortQuan hệ giữa beneficiary và subscriber
                          Comments

                          Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

                          Control0..1
                          BindingThe codes SHALL be taken from SubscriberPolicyholder Relationship Codes
                          (required to http://terminology.hl7.org/ValueSet/subscriber-relationship)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summaryfalse
                          Requirements

                          To determine relationship between the patient and the subscriber to determine coordination of benefits.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          82. Coverage.period
                          Definition

                          Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

                          ShortThời hạn thẻ BHYT
                          Control0..1
                          TypePeriod
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Some insurers require the submission of the coverage term.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          84. Coverage.period.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          86. Coverage.period.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Coverage.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 88. Coverage.period.start
                            Definition

                            The start of the period. The boundary is inclusive.

                            ShortNgày bắt đầu hiệu lực
                            Comments

                            If the low element is missing, the meaning is that the low boundary is not known.

                            Control0..1
                            This element is affected by the following invariants: per-1
                            TypedateTime
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            90. Coverage.period.end
                            Definition

                            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                            ShortNgày hết hiệu lực
                            Comments

                            The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                            Control0..1
                            This element is affected by the following invariants: per-1
                            TypedateTime
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            92. Coverage.payor
                            Definition

                            The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

                            ShortCơ quan chi trả (BHXH Việt Nam)
                            Comments

                            May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

                            Control1..*
                            TypeReference(Organization, Patient, RelatedPerson)
                            Is Modifierfalse
                            Must Supporttrue
                            Must Support TypesNo must-support rules about the choice of types/profiles
                            Summarytrue
                            Requirements

                            Need to identify the issuer to target for claim processing and for coordination of benefit processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            94. Coverage.class
                            Definition

                            A suite of underwriter specific classifiers.

                            ShortAdditional coverage classifications
                            Comments

                            For example may be used to identify a class of coverage or employer group, Policy, Plan.

                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            The codes provided on the health card which identify or confirm the specific policy for the insurer.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            96. Coverage.class.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            98. Coverage.class.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            100. Coverage.class.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            102. Coverage.class.type
                            Definition

                            The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

                            ShortType of class such as 'group' or 'plan'
                            Control1..1
                            BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
                            (extensible to http://hl7.org/fhir/ValueSet/coverage-class|4.0.1)

                            The policy classifications, eg. Group, Plan, Class, etc.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            The insurer issued label for a specific health card value.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            104. Coverage.class.value
                            Definition

                            The alphanumeric string value associated with the insurer issued label.

                            ShortValue associated with the type
                            Comments

                            For example, the Group or Plan number.

                            Control1..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            The insurer issued label and value are necessary to identify the specific policy.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            106. Coverage.class.name
                            Definition

                            A short description for the class.

                            ShortHuman readable description of the type and value
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Used to provide a meaningful description in correspondence to the patient.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            108. Coverage.order
                            Definition

                            The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

                            ShortRelative order of the coverage
                            Control0..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Used in managing the coordination of benefits.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            110. Coverage.network
                            Definition

                            The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

                            ShortInsurer network
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Used in referral for treatment and in claims processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            112. Coverage.costToBeneficiary
                            Definition

                            A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

                            ShortPatient payments for services/products
                            Comments

                            For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            Required by providers to manage financial transaction with the patient.

                            Alternate NamesCoPay, Deductible, Exceptions
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            114. Coverage.costToBeneficiary.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            116. Coverage.costToBeneficiary.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            118. Coverage.costToBeneficiary.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            120. Coverage.costToBeneficiary.type
                            Definition

                            The category of patient centric costs associated with treatment.

                            ShortCost category
                            Comments

                            For example visit, specialist visits, emergency, inpatient care, etc.

                            Control0..1
                            BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
                            (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type|4.0.1)

                            The types of services to which patient copayments are specified.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Needed to identify the category associated with the amount for the patient.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            122. Coverage.costToBeneficiary.value[x]
                            Definition

                            The amount due from the patient for the cost category.

                            ShortThe amount or percentage due from the beneficiary
                            Comments

                            Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

                            Control1..1
                            TypeChoice of: Quantity(SimpleQuantity), Money
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Needed to identify the amount for the patient associated with the category.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            124. Coverage.costToBeneficiary.exception
                            Definition

                            A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

                            ShortExceptions for patient payments
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            Required by providers to manage financial transaction with the patient.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            126. Coverage.costToBeneficiary.exception.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            128. Coverage.costToBeneficiary.exception.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            130. Coverage.costToBeneficiary.exception.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            132. Coverage.costToBeneficiary.exception.type
                            Definition

                            The code for the specific exception.

                            ShortException category
                            Control1..1
                            BindingFor example codes, see ExampleCoverageFinancialExceptionCodes
                            (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception|4.0.1)

                            The types of exceptions from the part or full value of financial obligations such as copays.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Needed to identify the exception associated with the amount for the patient.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            134. Coverage.costToBeneficiary.exception.period
                            Definition

                            The timeframe during when the exception is in force.

                            ShortThe effective period of the exception
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            136. Coverage.subrogation
                            Definition

                            When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

                            ShortReimbursement to insurer
                            Comments

                            Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Requirements

                            See definition for when to be used.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            138. Coverage.contract
                            Definition

                            The policy(s) which constitute this insurance coverage.

                            ShortContract details
                            Control0..*
                            TypeReference(Contract)
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            To reference the legally binding contract between the policy holder and the insurer.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))