HL7 Vietnam VN Core FHIR Implementation Guide

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

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

Hồ sơ tài nguyên: Kết quả giải quyết BHYT VN Core — VN Core ClaimResponse Profile

URL chính thức: http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-claim-response Phiên bản: 0.5.0
Computable Name: VNCoreClaimResponse

Profile ClaimResponse cho Việt Nam. Kết quả xử lý yêu cầu thanh toán BHYT. Bao gồm adjudication chi tiết: tổng đề nghị, đủ điều kiện, cùng chi trả, BHYT thanh toán. Cặp đôi với VNCoreClaim — Claim là yêu cầu, ClaimResponse là kết quả. Mã phản hồi gateway như XML1_ID được biểu diễn bằng identifier slice riêng; không thay thế MA_LK của Claim/Bundle. Căn cứ:

  • QĐ 130/QĐ-BYT → QĐ 4750/QĐ-BYT → QĐ 3176/QĐ-BYT (chuẩn dữ liệu BHXH hiện hành)
  • QĐ 697/QĐ-BYT (19/3/2026) — Mẫu bảng kê chi phí KCB
  • Luật 51/2024/QH15 (27/11/2024) — sửa đổi Luật BHYT, hiệu lực 01/7/2025
  • NĐ 188/2025/NĐ-CP — ban hành 01/7/2025, hiệu lực 15/8/2025 — Hướng dẫn Luật BHYT
  • NĐ 90/2026/NĐ-CP (ban hành 30/03/2026, hiệu lực 15/05/2026 — future-effective) — xử phạt VPHC y tế, tham chiếu khi hồ sơ giám định/thanh toán sai lệch Nguồn thiết kế: OHP Data Processor (ClaimResponse adjudication mapping).

Usages:

You can also check for usages in the FHIR IG Statistics

Các dạng xem hình thức của nội dung hồ sơ

Mô tả profile, differential, snapshot và các biểu diễn liên quan.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value SΣ 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
Example General: 123456
... type SΣ 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.
... use SΣ 1..1 code Mục đích: claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient SΣ 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created SΣ 1..1 dateTime Ngày tạo kết quả
... insurer SΣ 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... request SΣ 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome SΣ 1..1 code Kết quả: queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... amount S 0..1 Money Số tiền (VND)
... total SΣ 0..* BackboneElement Tổng adjudication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category SΣ 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount SΣ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... amount 1..1 Money Số tiền BHXH thanh toán
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClaimResponse.identifier:gatewayResponseId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ClaimResponse.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
ClaimResponse.type Base extensible Claim Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.use Base required Use 📍4.0.1 FHIR Std.
ClaimResponse.outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.payment.​type Base example Example Payment Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ClaimResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ClaimResponse 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 error ClaimResponse 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 error ClaimResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ClaimResponse A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value S 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
... status S 1..1 code Trạng thái kết quả: active | cancelled | draft | entered-in-error
... type S 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
... patient S 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created S 1..1 dateTime Ngày tạo kết quả
... insurer S 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... request S 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome S 1..1 code Kết quả: queued | complete | error | partial
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... amount S 0..1 Money Số tiền (VND)
... total S 0..* BackboneElement Tổng adjudication
.... category S 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount S 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... amount 1..1 Money Số tiền BHXH thanh toán
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value SΣ 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Trạng thái kết quả: active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... type SΣ 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.
... use SΣ 1..1 code Mục đích: claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient SΣ 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created SΣ 1..1 dateTime Ngày tạo kết quả
... insurer SΣ 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request SΣ 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome SΣ 1..1 code Kết quả: queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition 0..1 string Disposition Message
... preAuthRef 0..1 string Preauthorization reference
... preAuthPeriod 0..1 Period Preauthorization reference effective period
... payeeType 0..1 CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... reason 0..1 CodeableConcept Explanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.
..... amount S 0..1 Money Số tiền (VND)
..... value 0..1 decimal Non-monetary value
.... detail 0..* BackboneElement Adjudication for claim details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... detailSequence 1..1 positiveInt Claim detail instance identifier
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Detail level adjudication details
..... subDetail 0..* BackboneElement Adjudication for claim sub-details
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1 positiveInt Claim sub-detail instance identifier
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 0..* See adjudication (ClaimResponse) Subdetail level adjudication details
... addItem 0..* BackboneElement Insurer added line items
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..* positiveInt Item sequence number
.... detailSequence 0..* positiveInt Detail sequence number
.... subdetailSequence 0..* positiveInt Subdetail sequence number
.... provider 0..* Reference(Practitioner | PractitionerRole | Organization) Authorized providers
.... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
.... programCode 0..* CodeableConcept Program the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.
.... serviced[x] 0..1 Date or dates of service or product delivery
..... servicedDate date
..... servicedPeriod Period
.... location[x] 0..1 Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.
..... locationCodeableConcept CodeableConcept
..... locationAddress Address
..... locationReference Reference(Location)
.... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... bodySite 0..1 CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite 0..* CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* See adjudication (ClaimResponse) Added items adjudication
.... detail 0..* BackboneElement Insurer added line details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
..... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Added items detail adjudication
..... subDetail 0..* BackboneElement Insurer added line items
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
...... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 1..* See adjudication (ClaimResponse) Added items detail adjudication
... adjudication 0..* See adjudication (ClaimResponse) Header-level adjudication
... total SΣ 0..* BackboneElement Tổng adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category SΣ 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount SΣ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... adjustment 0..1 Money Payment adjustment for non-claim issues
.... adjustmentReason 0..1 CodeableConcept Explanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.
.... date 0..1 date Expected date of payment
.... amount 1..1 Money Số tiền BHXH thanh toán
.... identifier 0..1 Identifier Business identifier for the payment
... fundsReserve 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... form 0..1 Attachment Printed reference or actual form
... processNote 0..* BackboneElement Note concerning adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 0..1 positiveInt Note instance identifier
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 string Note explanatory text
.... language 0..1 CodeableConcept Language of the text
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
... insurance 0..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 Reference(Coverage) Insurance information
.... businessArrangement 0..1 string Additional provider contract number
.... claimResponse 0..1 Reference(ClaimResponse) Adjudication results
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClaimResponse.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ClaimResponse.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
ClaimResponse.type Base extensible Claim Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.subType Base example Example Claim SubType Codes 📍4.0.1 FHIR Std.
ClaimResponse.use Base required Use 📍4.0.1 FHIR Std.
ClaimResponse.outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
ClaimResponse.payeeType Base example PayeeType 📍4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​reason Base example Adjudication Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​programCode Base example Example Program Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​location[x] Base example Example Service Place Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​bodySite Base example Oral Site Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​subSite Base example Surface Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.subDetail.productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.subDetail.modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.payment.​type Base example Example Payment Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.payment.​adjustmentReason Base example Payment Adjustment Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.fundsReserve Base example FundsReserve 📍4.0.1 FHIR Std.
ClaimResponse.formCode Base example Forms 📍4.0.1 FHIR Std.
ClaimResponse.processNote.​type Base required NoteType 📍4.0.1 FHIR Std.
ClaimResponse.processNote.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ClaimResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ClaimResponse 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 error ClaimResponse 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 error ClaimResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ClaimResponse A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of ClaimResponse.identifier

Dạng xem phần tử chính

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value SΣ 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
Example General: 123456
... type SΣ 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.
... use SΣ 1..1 code Mục đích: claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient SΣ 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created SΣ 1..1 dateTime Ngày tạo kết quả
... insurer SΣ 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... request SΣ 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome SΣ 1..1 code Kết quả: queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... amount S 0..1 Money Số tiền (VND)
... total SΣ 0..* BackboneElement Tổng adjudication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category SΣ 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount SΣ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... amount 1..1 Money Số tiền BHXH thanh toán
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClaimResponse.identifier:gatewayResponseId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ClaimResponse.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
ClaimResponse.type Base extensible Claim Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.use Base required Use 📍4.0.1 FHIR Std.
ClaimResponse.outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.payment.​type Base example Example Payment Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ClaimResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ClaimResponse 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 error ClaimResponse 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 error ClaimResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ClaimResponse A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Dạng xem Differential

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value S 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
... status S 1..1 code Trạng thái kết quả: active | cancelled | draft | entered-in-error
... type S 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
... patient S 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created S 1..1 dateTime Ngày tạo kết quả
... insurer S 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... request S 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome S 1..1 code Kết quả: queued | complete | error | partial
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... amount S 0..1 Money Số tiền (VND)
... total S 0..* BackboneElement Tổng adjudication
.... category S 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount S 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... amount 1..1 Money Số tiền BHXH thanh toán
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG

Dạng xem SnapshotView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 0..* Identifier Định danh kết quả xử lý, bao gồm mã phản hồi gateway nếu có
Slice: Unordered, Open by value:system
.... identifier:gatewayResponseId S 0..1 Identifier Mã phản hồi Cổng tiếp nhận BHYT (XML1_ID)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-identifier-type-cs
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: BHYT_XML1_ID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.hl7.org.vn/core/sid/bhyt-gateway-response-id
..... value SΣ 1..1 string Giá trị XML1_ID hoặc mã phản hồi tương đương
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Trạng thái kết quả: active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
... type SΣ 1..1 CodeableConcept Loại: institutional (nội trú) | professional (ngoại trú)
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.
... use SΣ 1..1 code Mục đích: claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.
... patient SΣ 1..1 Reference(Bệnh nhân VN Core — VN Core Patient Profile) Bệnh nhân
... created SΣ 1..1 dateTime Ngày tạo kết quả
... insurer SΣ 1..1 Reference(Cơ sở y tế VN Core — VN Core Organization Profile) Cơ quan BHXH giải quyết
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request SΣ 0..1 Reference(Yêu cầu thanh toán KCB VN Core — VN Core Claim Profile) Yêu cầu thanh toán gốc (VNCoreClaim)
... outcome SΣ 1..1 code Kết quả: queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.
... disposition 0..1 string Disposition Message
... preAuthRef 0..1 string Preauthorization reference
... preAuthPeriod 0..1 Period Preauthorization reference effective period
... payeeType 0..1 CodeableConcept Party to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.
... item S 0..* BackboneElement Kết quả từng dòng chi phí
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication S 1..* BackboneElement Phân bổ chi phí: đề nghị, đủ ĐK, cùng chi trả, BHYT thanh toán
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... category S 1..1 CodeableConcept Loại: submitted | eligible | copay | benefit
Binding: AdjudicationValueCodes (extensible)
..... reason 0..1 CodeableConcept Explanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.
..... amount S 0..1 Money Số tiền (VND)
..... value 0..1 decimal Non-monetary value
.... detail 0..* BackboneElement Adjudication for claim details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... detailSequence 1..1 positiveInt Claim detail instance identifier
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Detail level adjudication details
..... subDetail 0..* BackboneElement Adjudication for claim sub-details
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1 positiveInt Claim sub-detail instance identifier
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 0..* See adjudication (ClaimResponse) Subdetail level adjudication details
... addItem 0..* BackboneElement Insurer added line items
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence 0..* positiveInt Item sequence number
.... detailSequence 0..* positiveInt Detail sequence number
.... subdetailSequence 0..* positiveInt Subdetail sequence number
.... provider 0..* Reference(Practitioner | PractitionerRole | Organization) Authorized providers
.... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
.... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
.... programCode 0..* CodeableConcept Program the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.
.... serviced[x] 0..1 Date or dates of service or product delivery
..... servicedDate date
..... servicedPeriod Period
.... location[x] 0..1 Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.
..... locationCodeableConcept CodeableConcept
..... locationAddress Address
..... locationReference Reference(Location)
.... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
.... unitPrice 0..1 Money Fee, charge or cost per item
.... factor 0..1 decimal Price scaling factor
.... net 0..1 Money Total item cost
.... bodySite 0..1 CodeableConcept Anatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.
.... subSite 0..* CodeableConcept Anatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* See adjudication (ClaimResponse) Added items adjudication
.... detail 0..* BackboneElement Insurer added line details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
..... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
..... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
..... unitPrice 0..1 Money Fee, charge or cost per item
..... factor 0..1 decimal Price scaling factor
..... net 0..1 Money Total item cost
..... noteNumber 0..* positiveInt Applicable note numbers
..... adjudication 1..* See adjudication (ClaimResponse) Added items detail adjudication
..... subDetail 0..* BackboneElement Insurer added line items
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... productOrService 1..1 CodeableConcept Billing, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.
...... modifier 0..* CodeableConcept Service/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.
...... quantity 0..1 SimpleQuantity(4.0.1) Count of products or services
...... unitPrice 0..1 Money Fee, charge or cost per item
...... factor 0..1 decimal Price scaling factor
...... net 0..1 Money Total item cost
...... noteNumber 0..* positiveInt Applicable note numbers
...... adjudication 1..* See adjudication (ClaimResponse) Added items detail adjudication
... adjudication 0..* See adjudication (ClaimResponse) Header-level adjudication
... total SΣ 0..* BackboneElement Tổng adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category SΣ 1..1 CodeableConcept Loại tổng: submitted | eligible | copay | benefit hoặc category BHYT cục bộ
Binding: Loại adjudication BHYT — BHYT Adjudication Category ValueSet (extensible)
.... amount SΣ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Thông tin thanh toán
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Partial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.
.... adjustment 0..1 Money Payment adjustment for non-claim issues
.... adjustmentReason 0..1 CodeableConcept Explanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.
.... date 0..1 date Expected date of payment
.... amount 1..1 Money Số tiền BHXH thanh toán
.... identifier 0..1 Identifier Business identifier for the payment
... fundsReserve 0..1 CodeableConcept Funds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... form 0..1 Attachment Printed reference or actual form
... processNote 0..* BackboneElement Note concerning adjudication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... number 0..1 positiveInt Note instance identifier
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 1..1 string Note explanatory text
.... language 0..1 CodeableConcept Language of the text
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
... insurance 0..* BackboneElement Patient insurance information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence 1..1 positiveInt Insurance instance identifier
.... focal 1..1 boolean Coverage to be used for adjudication
.... coverage 1..1 Reference(Coverage) Insurance information
.... businessArrangement 0..1 string Additional provider contract number
.... claimResponse 0..1 Reference(ClaimResponse) Adjudication results
... error S 0..* BackboneElement Nhóm issue giám định/từ chối hoặc yêu cầu điều chỉnh
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... itemSequence S 0..1 positiveInt Dòng chi phí liên quan nếu có
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code S 1..1 CodeableConcept Nhóm issue/lý do BHYT
Binding: Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClaimResponse.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ClaimResponse.identifier:gatewayResponseId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ClaimResponse.status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
ClaimResponse.type Base extensible Claim Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.subType Base example Example Claim SubType Codes 📍4.0.1 FHIR Std.
ClaimResponse.use Base required Use 📍4.0.1 FHIR Std.
ClaimResponse.outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
ClaimResponse.payeeType Base example PayeeType 📍4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​category Base extensible Adjudication Value Codes 📦4.0.1 FHIR Std.
ClaimResponse.item.adjudication.​reason Base example Adjudication Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​programCode Base example Example Program Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​location[x] Base example Example Service Place Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​bodySite Base example Oral Site Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​subSite Base example Surface Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.subDetail.productOrService Base example USCLS Codes 📍4.0.1 FHIR Std.
ClaimResponse.addItem.​detail.subDetail.modifier Base example Modifier type Codes 📍4.0.1 FHIR Std.
ClaimResponse.total.​category Base extensible Loại adjudication BHYT — BHYT Adjudication Category ValueSet 📦0.5.0 This IG
ClaimResponse.payment.​type Base example Example Payment Type Codes 📍4.0.1 FHIR Std.
ClaimResponse.payment.​adjustmentReason Base example Payment Adjustment Reason Codes 📍4.0.1 FHIR Std.
ClaimResponse.fundsReserve Base example FundsReserve 📍4.0.1 FHIR Std.
ClaimResponse.formCode Base example Forms 📍4.0.1 FHIR Std.
ClaimResponse.processNote.​type Base required NoteType 📍4.0.1 FHIR Std.
ClaimResponse.processNote.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ClaimResponse.error.​code Base extensible Nhóm issue giám định BHYT cục bộ — VN BHYT Review Issue ValueSet 📦0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ClaimResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ClaimResponse 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 error ClaimResponse 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 error ClaimResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ClaimResponse A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of ClaimResponse.identifier

 

Biểu diễn khác của hồ sơ: CSV, Excel, Schematron