臺灣健保癌症用藥事前審查實作指引
1.0.1 - release

This page is part of the 臺灣癌症用藥事前審查實作指引(TWPAS IG) (v1.0.1: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: 事前審查回覆-ClaimResponse TWPAS

Official URL: https://twcore.mohw.gov.tw/ig/pas/StructureDefinition/ClaimResponse-twpas Version: 1.0.1
Active as of 2024-12-12 Computable Name: ClaimResponseTWPAS

此事前審查回覆-ClaimResponse TWPAS Profile說明本IG如何進一步定義FHIR的ClaimResponse Resource以呈現癌藥事前審查回覆之內容

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse ClaimResponse
... status 1..1 code active | cancelled | draft | entered-in-error
Required Pattern: active
... type 1..1 CodeableConcept More granular claim type
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://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
... use 1..1 code claim | preauthorization | predetermination
Required Pattern: preauthorization
... created S 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
... insurer 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
... request S 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
... item
.... adjudication
..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


ele-1: All FHIR elements must have a @value or children
Required Pattern: active
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


ele-1: All FHIR elements must have a @value or children
Required Pattern: preauthorization
... patient Σ 1..1 Reference(病人資訊-Patient TWPAS) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
... created SΣ 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
ele-1: All FHIR elements must have a @value or children
... insurer Σ 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
ele-1: All FHIR elements must have a @value or children
... request SΣ 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
ele-1: All FHIR elements must have a @value or children
... outcome Σ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


ele-1: All FHIR elements must have a @value or children
... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
ele-1: All FHIR elements must have a @value or children
... item 0..* BackboneElement Adjudication for claim line items
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... itemSequence 1..1 positiveInt Claim item instance identifier
ele-1: All FHIR elements must have a @value or children
.... adjudication 1..* BackboneElement Adjudication details
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


ele-1: All FHIR elements must have a @value or children
..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
ele-1: All FHIR elements must have a @value or children
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
ClaimResponse.typeextensiblePattern: institutional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ClaimResponse.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier for a claim response
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Required Pattern: active
... type Σ 1..1 CodeableConcept More granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


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://terminology.hl7.org/CodeSystem/claim-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
..... 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
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Required Pattern: preauthorization
... patient Σ 1..1 Reference(病人資訊-Patient TWPAS) The recipient of the products and services
... created SΣ 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
... insurer Σ 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request SΣ 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
... outcome Σ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
... 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 0..* BackboneElement Adjudication for claim 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 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Adjudication 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
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
..... amount 0..1 Money Monetary amount
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。
.... 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 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 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 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 Σ 0..* BackboneElement Adjudication totals
.... 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 Σ 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Payment 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
.... 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 Payable amount after adjustment
.... 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 0..* BackboneElement Processing errors
.... 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..1 positiveInt Item sequence number
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code 1..1 CodeableConcept Error code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
ClaimResponse.typeextensiblePattern: institutional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ClaimResponse.subTypeexampleExampleClaimSubTypeCodes
http://hl7.org/fhir/ValueSet/claim-subtype
from the FHIR Standard
ClaimResponse.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.payeeTypeexampleClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
from the FHIR Standard
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
from the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
from the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
from the FHIR Standard
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.total.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
http://hl7.org/fhir/ValueSet/ex-paymenttype
from the FHIR Standard
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
http://hl7.org/fhir/ValueSet/payment-adjustment-reason
from the FHIR Standard
ClaimResponse.fundsReserveexampleFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
from the FHIR Standard
ClaimResponse.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
from the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
from the FHIR Standard
ClaimResponse.processNote.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.error.codeexampleAdjudication Error Codes
http://hl7.org/fhir/ValueSet/adjudication-error
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse ClaimResponse
... status 1..1 code active | cancelled | draft | entered-in-error
Required Pattern: active
... type 1..1 CodeableConcept More granular claim type
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://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
... use 1..1 code claim | preauthorization | predetermination
Required Pattern: preauthorization
... created S 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
... insurer 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
... request S 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
... item
.... adjudication
..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..* ClaimResponse Response to a claim predetermination or preauthorization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


ele-1: All FHIR elements must have a @value or children
Required Pattern: active
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


ele-1: All FHIR elements must have a @value or children
Required Pattern: preauthorization
... patient Σ 1..1 Reference(病人資訊-Patient TWPAS) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
... created SΣ 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
ele-1: All FHIR elements must have a @value or children
... insurer Σ 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
ele-1: All FHIR elements must have a @value or children
... request SΣ 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
ele-1: All FHIR elements must have a @value or children
... outcome Σ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


ele-1: All FHIR elements must have a @value or children
... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
ele-1: All FHIR elements must have a @value or children
... item 0..* BackboneElement Adjudication for claim line items
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... itemSequence 1..1 positiveInt Claim item instance identifier
ele-1: All FHIR elements must have a @value or children
.... adjudication 1..* BackboneElement Adjudication details
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.


ele-1: All FHIR elements must have a @value or children
..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
ele-1: All FHIR elements must have a @value or children
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
ClaimResponse.typeextensiblePattern: institutional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ClaimResponse.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier for a claim response
... status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Required Pattern: active
... type Σ 1..1 CodeableConcept More granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


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://terminology.hl7.org/CodeSystem/claim-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: institutional
..... 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
... subType 0..1 CodeableConcept More granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

... use Σ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Claim, preauthorization, predetermination.


Required Pattern: preauthorization
... patient Σ 1..1 Reference(病人資訊-Patient TWPAS) The recipient of the products and services
... created SΣ 1..1 dateTime 核定日期或受理日期,即為案件受理狀態(disposition)之異動日期,依據其狀態不同而有不同日期,例如案件受理狀態為已受理,此日期則為受理日期;若為審畢結果則為核定日期。
... insurer Σ 1..1 Reference(TW Core Organization Government) Party responsible for reimbursement
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Party responsible for the claim
... request SΣ 1..1 Reference(事前審查-Claim TWPAS) Id of resource triggering adjudication
... outcome Σ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition S 1..1 string 案件受理狀態。待處理 | 處理中 | 處理中(等待附件檔) | 處理中(檔案檢核中) | 處理中(等待檢查申報資料) | 資料檢核失敗 | 檔案傳送失敗 | 附件檔轉檔失敗 | 影像檔轉檔失敗 | 電子病歷檔轉檔失敗 | 申請檔案檢核失敗 | 申請檔案未備齊 | 已受理 | 審查中 | 審畢結果
Binding: NHI-健保事前審查-案件受理狀態值集 (required)
... 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 0..* BackboneElement Adjudication for claim 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 1..1 positiveInt Claim item instance identifier
.... noteNumber 0..* positiveInt Applicable note numbers
.... adjudication 1..* BackboneElement Adjudication 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
..... category 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason S 1..1 CodeableConcept 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意
Binding: NHI-健保事前審查-核定註記值集 (required)
..... amount 0..1 Money Monetary amount
..... value S 1..1 decimal 核定數量,若申請案件類別為3時須填寫。
.... 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 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 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 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 Σ 0..* BackboneElement Adjudication totals
.... 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 Σ 1..1 CodeableConcept Type of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ 1..1 Money Financial total for the category
... payment 0..1 BackboneElement Payment 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
.... 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 Payable amount after adjustment
.... 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 0..* BackboneElement Processing errors
.... 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..1 positiveInt Item sequence number
.... detailSequence 0..1 positiveInt Detail sequence number
.... subDetailSequence 0..1 positiveInt Subdetail sequence number
.... code 1..1 CodeableConcept Error code detailing processing issues
Binding: Adjudication Error Codes (example): The adjudication error codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClaimResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/fm-status|4.0.1
from the FHIR Standard
ClaimResponse.typeextensiblePattern: institutional
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ClaimResponse.subTypeexampleExampleClaimSubTypeCodes
http://hl7.org/fhir/ValueSet/claim-subtype
from the FHIR Standard
ClaimResponse.userequiredPattern: preauthorization
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ClaimResponse.outcomerequiredClaimProcessingCodes
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ClaimResponse.dispositionrequiredNHIAcceptanceStatus (a valid code from NHI-健保事前審查-案件受理狀態)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-acceptance-status
from this IG
ClaimResponse.payeeTypeexampleClaim Payee Type Codes
http://hl7.org/fhir/ValueSet/payeetype
from the FHIR Standard
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.item.adjudication.reasonrequiredNHIApproveComment (a valid code from NHI-健保事前審查-核定註記)
https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment
from this IG
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
http://hl7.org/fhir/ValueSet/ex-program-code
from the FHIR Standard
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
http://hl7.org/fhir/ValueSet/service-place
from the FHIR Standard
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
http://hl7.org/fhir/ValueSet/tooth
from the FHIR Standard
ClaimResponse.addItem.subSiteexampleSurfaceCodes
http://hl7.org/fhir/ValueSet/surface
from the FHIR Standard
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
http://hl7.org/fhir/ValueSet/claim-modifiers
from the FHIR Standard
ClaimResponse.total.categoryexampleAdjudicationValueCodes
http://hl7.org/fhir/ValueSet/adjudication
from the FHIR Standard
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
http://hl7.org/fhir/ValueSet/ex-paymenttype
from the FHIR Standard
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
http://hl7.org/fhir/ValueSet/payment-adjustment-reason
from the FHIR Standard
ClaimResponse.fundsReserveexampleFunds Reservation Codes
http://hl7.org/fhir/ValueSet/fundsreserve
from the FHIR Standard
ClaimResponse.formCodeexampleForm Codes
http://hl7.org/fhir/ValueSet/forms
from the FHIR Standard
ClaimResponse.processNote.typerequiredNoteType
http://hl7.org/fhir/ValueSet/note-type|4.0.1
from the FHIR Standard
ClaimResponse.processNote.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ClaimResponse.error.codeexampleAdjudication Error Codes
http://hl7.org/fhir/ValueSet/adjudication-error
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorClaimResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClaimResponseIf 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-4errorClaimResponseIf 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-5errorClaimResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClaimResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TWPAS支援的RESTful互動功能的完整清單,請參閱TWPAS Server能力聲明

建議應該支援以下查詢參數:

  1. 必須(SHALL) 支援透過查詢參數 adjudication-reason 查詢所有ClaimResponse:
    (如何透過token查詢)
    GET [base]/ClaimResponse?adjudication-reason=[code]

    例子:
    (1) GET [base]/ClaimResponse?adjudication-reason=1

  2. 必須(SHALL) 支援透過查詢參數 request.patient.name 查詢所有ClaimResponse:
    (如何透過reference查詢)
    (如何透過string查詢)
    GET [base]/ClaimResponse?request.patient.name=[姓名]

    例子:
    (1) GET [base]/ClaimResponse?request.patient.name=王大明

  3. 必須(SHALL) 支援透過查詢參數 request.patient.identifier 查詢所有ClaimResponse:
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/ClaimResponse?request.patient.identifier=[code]

    例子:
    (1) GET [base]/ClaimResponse?request.patient.identifier=A123456789

  4. 必須(SHALL) 支援透過查詢參數 request.identifier 查詢所有ClaimResponse:
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/ClaimResponse?request.identifier=[code]

    例子:
    (1) GET [base]/ClaimResponse?request.identifier=20240831010109051701

  5. 必須(SHALL) 支援透過查詢參數 request.func-type.service-type 查詢所有ClaimResponse:
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/ClaimResponse?request.func-type.service-type={system|}[code]

    例子:
    (1) GET [base]/ClaimResponse?request.func-type.service-type=AJ
    (2) GET [base]/ClaimResponse?request.func-type.service-type=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/medical-consultation-department-nhi-tw|AJ

  6. 必須(SHALL) 支援透過查詢參數 createddisposition查詢所有ClaimResponse:
    (如何透過date查詢)
    (如何透過string查詢)
    GET [base]/ClaimResponse?created={gt|lt|ge|le}[date]{&created={gt|lt|ge|le}[date]}&disposition=[已受理|審畢結果]

    例子:
    (1) GET [base]/ClaimResponse?created=gt2024-08-01&date=lt2024-08-24&disposition=審畢結果