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
Official URL: https://twcore.mohw.gov.tw/ig/pas/StructureDefinition/ClaimResponse-self-assessment-twpas | Version: 1.0.1 | |||
Active as of 2024-12-12 | Computable Name: ClaimResponseSelfAssessmentTWPAS |
此自主審查報備-ClaimResponse TWPAS Profile說明本IG如何進一步定義FHIR的ClaimResponse Resource以呈現自主審查報備之內容。
現行開放自主事前審查項目僅有心臟及肝臟移植,若醫院要自主事前審查需向健保署申請,通過後,健保署會於署內系統維護,具有此資格之院所才可填報自主審查報備。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ClaimResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
patient | 1..1 | Reference(病人資訊-Patient TWPAS) | The recipient of the products and services | |
created | S | 1..1 | dateTime | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 |
insurer | 1..1 | Reference(TW Core Organization Government) | Party responsible for reimbursement | |
disposition | S | 0..1 | string | Disposition Message |
item | ||||
adjudication | ||||
reason | S | 1..1 | CodeableConcept | 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意 Binding: NHI-健保事前審查-核定註記值集 (required) |
value | S | 1..1 | decimal | 核定數量,若申請案件類別為3時須填寫。 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
type | Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. ele-1: All FHIR elements must have a @value or children 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 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 | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 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 |
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 | 0..1 | string | Disposition Message 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClaimResponse.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
ClaimResponse.type | extensible | Pattern: institutionalhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
ClaimResponse.use | required | Pattern: preauthorizationhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
ClaimResponse.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | |
ClaimResponse.item.adjudication.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 | ||||
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 | Σ | 0..1 | Reference(Claim) | Id of resource triggering adjudication | ||||
outcome | Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
disposition | S | 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 | 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.
| |||||
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. | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ClaimResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ClaimResponse.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
ClaimResponse.type | extensible | Pattern: institutionalhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | ||||
ClaimResponse.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
ClaimResponse.use | required | Pattern: preauthorizationhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
ClaimResponse.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | ||||
ClaimResponse.payeeType | example | Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype from the FHIR Standard | ||||
ClaimResponse.item.adjudication.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG | ||||
ClaimResponse.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.addItem.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ClaimResponse.addItem.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ClaimResponse.addItem.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ClaimResponse.addItem.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ClaimResponse.addItem.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.addItem.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.payment.type | example | ExamplePaymentTypeCodeshttp://hl7.org/fhir/ValueSet/ex-paymenttype from the FHIR Standard | ||||
ClaimResponse.payment.adjustmentReason | example | PaymentAdjustmentReasonCodeshttp://hl7.org/fhir/ValueSet/payment-adjustment-reason from the FHIR Standard | ||||
ClaimResponse.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ClaimResponse.formCode | example | Form Codeshttp://hl7.org/fhir/ValueSet/forms from the FHIR Standard | ||||
ClaimResponse.processNote.type | required | NoteTypehttp://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard | ||||
ClaimResponse.processNote.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ClaimResponse.error.code | example | Adjudication Error Codeshttp://hl7.org/fhir/ValueSet/adjudication-error from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ClaimResponse
Differential View
This structure is derived from ClaimResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
patient | 1..1 | Reference(病人資訊-Patient TWPAS) | The recipient of the products and services | |
created | S | 1..1 | dateTime | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 |
insurer | 1..1 | Reference(TW Core Organization Government) | Party responsible for reimbursement | |
disposition | S | 0..1 | string | Disposition Message |
item | ||||
adjudication | ||||
reason | S | 1..1 | CodeableConcept | 核定註記。若申請案件類別為3時須填寫。1:同意備查 | 2:不予同意 | 3:部份同意 Binding: NHI-健保事前審查-核定註記值集 (required) |
value | S | 1..1 | decimal | 核定數量,若申請案件類別為3時須填寫。 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
type | Σ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. ele-1: All FHIR elements must have a @value or children 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 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 | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 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 |
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 | 0..1 | string | Disposition Message 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClaimResponse.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
ClaimResponse.type | extensible | Pattern: institutionalhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
ClaimResponse.use | required | Pattern: preauthorizationhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | |
ClaimResponse.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | |
ClaimResponse.item.adjudication.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | |
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
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 | 核定日期。若申請案件類別為3時須填寫。YYYY-MM-DD,西元年月日。 | ||||
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 | Σ | 0..1 | Reference(Claim) | Id of resource triggering adjudication | ||||
outcome | Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
disposition | S | 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 | 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.
| |||||
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. | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ClaimResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ClaimResponse.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
ClaimResponse.type | extensible | Pattern: institutionalhttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | ||||
ClaimResponse.subType | example | ExampleClaimSubTypeCodeshttp://hl7.org/fhir/ValueSet/claim-subtype from the FHIR Standard | ||||
ClaimResponse.use | required | Pattern: preauthorizationhttp://hl7.org/fhir/ValueSet/claim-use|4.0.1 from the FHIR Standard | ||||
ClaimResponse.outcome | required | ClaimProcessingCodeshttp://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard | ||||
ClaimResponse.payeeType | example | Claim Payee Type Codeshttp://hl7.org/fhir/ValueSet/payeetype from the FHIR Standard | ||||
ClaimResponse.item.adjudication.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.item.adjudication.reason | required | NHIApproveComment (a valid code from NHI-健保事前審查-核定註記)https://twcore.mohw.gov.tw/ig/pas/ValueSet/nhi-approve-comment from this IG | ||||
ClaimResponse.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.addItem.programCode | example | ExampleProgramReasonCodeshttp://hl7.org/fhir/ValueSet/ex-program-code from the FHIR Standard | ||||
ClaimResponse.addItem.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place from the FHIR Standard | ||||
ClaimResponse.addItem.bodySite | example | OralSiteCodeshttp://hl7.org/fhir/ValueSet/tooth from the FHIR Standard | ||||
ClaimResponse.addItem.subSite | example | SurfaceCodeshttp://hl7.org/fhir/ValueSet/surface from the FHIR Standard | ||||
ClaimResponse.addItem.detail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.detail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.addItem.detail.subDetail.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls from the FHIR Standard | ||||
ClaimResponse.addItem.detail.subDetail.modifier | example | ModifierTypeCodeshttp://hl7.org/fhir/ValueSet/claim-modifiers from the FHIR Standard | ||||
ClaimResponse.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.payment.type | example | ExamplePaymentTypeCodeshttp://hl7.org/fhir/ValueSet/ex-paymenttype from the FHIR Standard | ||||
ClaimResponse.payment.adjustmentReason | example | PaymentAdjustmentReasonCodeshttp://hl7.org/fhir/ValueSet/payment-adjustment-reason from the FHIR Standard | ||||
ClaimResponse.fundsReserve | example | Funds Reservation Codeshttp://hl7.org/fhir/ValueSet/fundsreserve from the FHIR Standard | ||||
ClaimResponse.formCode | example | Form Codeshttp://hl7.org/fhir/ValueSet/forms from the FHIR Standard | ||||
ClaimResponse.processNote.type | required | NoteTypehttp://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard | ||||
ClaimResponse.processNote.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ClaimResponse.error.code | example | Adjudication Error Codeshttp://hl7.org/fhir/ValueSet/adjudication-error from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from ClaimResponse
Other representations of profile: CSV, Excel, Schematron