Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse | Version: 0.0.1 | |||
Draft as of 2025-08-31 | Computable Name: SharedCareClaimResponse |
A FHIR resource profile for NZ Telehealth Claim Responses for 24/7 telehealth services.
Note: In 4B item.adjudication, item.detail.adjudication, payment.amount, insurer are compulsory fields, but not utilized in the telehealth implementation. item.adjudication.quantity R5 is item.adjudication.value in R4B.
This profile is used to represent telehealth claim responses in New Zealand for 24/7 telehealth services.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) |
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |
![]() ![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date & time of claim determination |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined |
![]() ![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |
![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Claim-level adjudication | |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category |
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code Binding: Adjudication Error Codes (example): The adjudication error codes. | |
![]() |
Path | Conformance | ValueSet | URI |
ClaimResponse.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 From the FHIR Standard | |
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | |
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | |
ClaimResponse.use | required | Usehttp://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 | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | |
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes From this IG | |
ClaimResponse.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls From the FHIR Standard | |
ClaimResponse.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication From the FHIR Standard | |
ClaimResponse.payment.type | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG | |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |
![]() ![]() ![]() |
1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error | |
![]() ![]() ![]() |
1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |
![]() ![]() ![]() |
1..1 | dateTime | Date & time of claim determination | |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |
![]() ![]() ![]() |
1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined | |
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |
![]() ![]() ![]() |
0..* | Claim-level adjudication | ||
![]() ![]() ![]() |
0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code | |
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code | |
![]() |
Path | Conformance | ValueSet | URI |
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | |
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | |
ClaimResponse.item.adjudication.category | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | |
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes From this IG | |
ClaimResponse.payment.type | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date & time of claim determination | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
![]() ![]() ![]() |
0..1 | string | Disposition Message | |||||
![]() ![]() ![]() |
0..1 | string | Preauthorization reference | |||||
![]() ![]() ![]() |
0..1 | Period | Preauthorization reference effective period | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Party to be paid any benefits payable Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim sub-details | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim sub-detail instance identifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Item sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Claim-level adjudication | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Payment adjustment for non-claim issues | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the adjustment Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |||||
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Business identifier for the payment | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
![]() ![]() ![]() |
0..1 | Attachment | Printed reference or actual form | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Note concerning adjudication | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Note instance identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Note explanatory text | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..* | Reference(CommunicationRequest) | Request for additional information | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ClaimResponse) | Adjudication results | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code Binding: Adjudication Error Codes (example): The adjudication error codes. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
ClaimResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
ClaimResponse.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 From the FHIR Standard | ||||
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | ||||
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | ||||
ClaimResponse.use | required | Usehttp://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 | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | ||||
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes 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 | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG | ||||
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
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) |
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |
![]() ![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date & time of claim determination |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |
![]() ![]() ![]() |
Σ | 1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined |
![]() ![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |
![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Claim-level adjudication | |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category |
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code Binding: Adjudication Error Codes (example): The adjudication error codes. | |
![]() |
Path | Conformance | ValueSet | URI |
ClaimResponse.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 From the FHIR Standard | |
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | |
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | |
ClaimResponse.use | required | Usehttp://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 | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | |
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes From this IG | |
ClaimResponse.addItem.productOrService | example | USCLSCodeshttp://hl7.org/fhir/ValueSet/service-uscls From the FHIR Standard | |
ClaimResponse.total.category | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication From the FHIR Standard | |
ClaimResponse.payment.type | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG | |
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() |
Differential View
This structure is derived from ClaimResponse
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |
![]() ![]() ![]() |
1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error | |
![]() ![]() ![]() |
1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |
![]() ![]() ![]() |
1..1 | dateTime | Date & time of claim determination | |
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |
![]() ![]() ![]() |
1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined | |
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |
![]() ![]() ![]() |
0..* | Claim-level adjudication | ||
![]() ![]() ![]() |
0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code | |
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code | |
![]() |
Path | Conformance | ValueSet | URI |
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | |
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | |
ClaimResponse.item.adjudication.category | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | |
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes From this IG | |
ClaimResponse.payment.type | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ClaimResponse | Response to a claim predetermination or preauthorization | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..* | Identifier | Business identifier(s) for the claim response | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | Status of the Claim Response: active, cancelled, draft, entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | More granular claim type Binding: NZ Claim Types (extensible) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | More granular claim type Binding: NZ Claim Subtypes (extensible) | |||||
![]() ![]() ![]() |
Σ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient) | The recipient of the products and services | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date & time of claim determination | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the Claim | |||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(NZ Telehealth Claim) | Reference to the Claim that was determined | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
![]() ![]() ![]() |
0..1 | string | Disposition Message | |||||
![]() ![]() ![]() |
0..1 | string | Preauthorization reference | |||||
![]() ![]() ![]() |
0..1 | Period | Preauthorization reference effective period | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Party to be paid any benefits payable Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed. | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Claim response items | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Product Or Service URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.sequence | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | BackboneElement | Adjudication (reason, amount, quantity) for each Adjudication Value Code | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Codified representation of adjudication outcome Binding: Adjudication Value Codes (extensible) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Codified reason(s) for the adjudication Binding: Adjudication Reason Codes (extensible) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Money | Monetary value of the adjudication | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Non-monetary value of the adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Any sub-determinations of this itemSequence | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Identifier | Trace Number URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/trace-number | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Review Outcome URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/review-outcome | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Value of the corresponding Claim.item.detail.sequence | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Adjudication for claim sub-details | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Claim sub-detail instance identifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Any line items added by Health NZ to the claim determination that were not in the original claim | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Item sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Detail sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Program the product or service is provided under Binding: ExampleProgramReasonCodes (example): Program specific reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | Date or dates of service or product delivery | ||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
0..1 | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Location) | |||||||
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical location Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Anatomical sub-location Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations. | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items adjudication | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Insurer added line items | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Count of products or services | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Fee, charge or cost per item | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Price scaling factor | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Money | Total item cost | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | positiveInt | Applicable note numbers | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | See adjudication (ClaimResponse) | Added items detail adjudication | |||||
![]() ![]() ![]() |
0..* | See adjudication (ClaimResponse) | Claim-level adjudication | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Financial total of the claim for each Adjudication Value Code | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of adjudication information Binding: AdjudicationValueCodes (example): The adjudication codes. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Money | Financial total for the category | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Summary of the payment being made | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Payment Type Code = complete or partial Binding: Payment Type Codes (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Payment adjustment for non-claim issues | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Explanation for the adjustment Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes. | |||||
![]() ![]() ![]() ![]() |
0..1 | date | Expected date of payment (if known) | |||||
![]() ![]() ![]() ![]() |
1..1 | Money | Payment amount | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Business identifier for the payment | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funds reserved status Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None). | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |||||
![]() ![]() ![]() |
0..1 | Attachment | Printed reference or actual form | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Note concerning adjudication | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Note instance identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | code | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Note explanatory text | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Language of the text Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..* | Reference(CommunicationRequest) | Request for additional information | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Patient insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt | Insurance instance identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Coverage to be used for adjudication | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Coverage) | Insurance information | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Additional provider contract number | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ClaimResponse) | Adjudication results | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Collection of errors produced during claim determination | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to itemSequence to which the error relates | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Refers to detailSequence to which the error relates | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | Subdetail sequence number | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Error code Binding: Adjudication Error Codes (example): The adjudication error codes. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
ClaimResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
ClaimResponse.status | required | FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 From the FHIR Standard | ||||
ClaimResponse.type | extensible | NzClaimTypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-type )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-types From this IG | ||||
ClaimResponse.subType | extensible | NzClaimSubtypes(a valid code from https://standards.digital.health.nz/ns/nz-claim-subtype )https://fhir-ig.digital.health.nz/shared-care/ValueSet/nz-claim-subtypes From this IG | ||||
ClaimResponse.use | required | Usehttp://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 | extensible | AdjudicationValueCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-value-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-value-codes From this IG | ||||
ClaimResponse.item.adjudication.reason | extensible | AdjudicationReasonCodes(a valid code from https://standards.digital.health.nz/ns/adjudication-reason-code )https://fhir-ig.digital.health.nz/shared-care/ValueSet/adjudication-reason-codes 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 | extensible | PaymentTypeCodeshttps://fhir-ig.digital.health.nz/shared-care/ValueSet/payment-type-codes From this IG | ||||
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