Da Vinci Health Record Exchange (HRex), published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-claimresponse | Version: 1.1.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: HRexClaimResponse | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.19.42.5 |
This profile specifies constraints on ClaimResponse resource to reflect the contents of a pro-active prior authorization returned via a card
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 | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |
status | 1..1 | code | active | cancelled | draft | entered-in-error Fixed Value: active | |
type | S | 1..1 | CodeableConcept | More granular claim type |
use | S | 1..1 | code | claim | preauthorization | predetermination |
patient | S | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services |
created | S | 1..1 | dateTime | Response creation date |
insurer | S | 1..1 | Reference(HRex Organization Profile) | Party responsible for reimbursement |
outcome | S | 1..1 | code | queued | complete | error | partial |
preAuthRef | S | 1..1 | string | PA Number/Identifier |
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date |
addItem | S | 0..* | BackboneElement | Insurer added line items |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber |
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate |
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate |
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code |
modifier | S | 0..* | CodeableConcept | Service/Product billing modifiers |
serviced[x] | S | 0..1 | date, Period | Date or dates of service or product delivery |
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
unitPrice | S | 0..1 | Money | Fee, charge or cost per item |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClaimResponse | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active |
type | SΣ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. |
use | SΣ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
patient | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services |
created | SΣ | 1..1 | dateTime | Response creation date |
insurer | SΣ | 1..1 | Reference(HRex Organization Profile) | Party responsible for reimbursement |
outcome | SΣ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
preAuthRef | S | 1..1 | string | PA Number/Identifier |
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date |
addItem | S | 0..* | BackboneElement | Insurer added line items |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber |
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate |
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate |
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. |
modifier | S | 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. |
serviced[x] | S | 0..1 | Date or dates of service or product delivery | |
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
unitPrice | S | 0..1 | Money | Fee, charge or cost per item |
adjudication | 1..* | See adjudication (ClaimResponse) | Added items adjudication | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClaimResponse.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
ClaimResponse.type | extensible | ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
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.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.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ClaimResponse | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |||||
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. Fixed Value: active | ||||
type | SΣ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
subType | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
use | SΣ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services | ||||
created | SΣ | 1..1 | dateTime | Response creation date | ||||
insurer | SΣ | 1..1 | Reference(HRex Organization Profile) | 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 | SΣ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
disposition | 0..1 | string | Disposition Message | |||||
preAuthRef | S | 1..1 | string | PA Number/Identifier | ||||
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date | ||||
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 | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): The adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monetary value | |||||
detail | 0..* | BackboneElement | Adjudication for claim details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
detailSequence | 1..1 | positiveInt | Claim detail instance identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
subDetail | 0..* | BackboneElement | Adjudication for claim sub-details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
subDetailSequence | 1..1 | positiveInt | Claim sub-detail instance identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
addItem | S | 0..* | BackboneElement | Insurer added line items | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber | ||||
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate | ||||
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate | ||||
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider | ||||
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 | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | ||||
modifier | S | 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] | S | 0..1 | Date or dates of service or product delivery | |||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | S | 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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ClaimResponse.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
ClaimResponse.type | extensible | ClaimTypeCodeshttp://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 | 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 | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.item.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
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 | CommonLanguages
http://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
Summary
Mandatory: 1 element
Must-Support: 19 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 0
Differential View
This structure is derived from ClaimResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClaimResponse | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |
status | 1..1 | code | active | cancelled | draft | entered-in-error Fixed Value: active | |
type | S | 1..1 | CodeableConcept | More granular claim type |
use | S | 1..1 | code | claim | preauthorization | predetermination |
patient | S | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services |
created | S | 1..1 | dateTime | Response creation date |
insurer | S | 1..1 | Reference(HRex Organization Profile) | Party responsible for reimbursement |
outcome | S | 1..1 | code | queued | complete | error | partial |
preAuthRef | S | 1..1 | string | PA Number/Identifier |
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date |
addItem | S | 0..* | BackboneElement | Insurer added line items |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber |
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate |
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate |
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code |
modifier | S | 0..* | CodeableConcept | Service/Product billing modifiers |
serviced[x] | S | 0..1 | date, Period | Date or dates of service or product delivery |
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
unitPrice | S | 0..1 | Money | Fee, charge or cost per item |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClaimResponse | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Fixed Value: active |
type | SΣ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. |
use | SΣ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. |
patient | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services |
created | SΣ | 1..1 | dateTime | Response creation date |
insurer | SΣ | 1..1 | Reference(HRex Organization Profile) | Party responsible for reimbursement |
outcome | SΣ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. |
preAuthRef | S | 1..1 | string | PA Number/Identifier |
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date |
addItem | S | 0..* | BackboneElement | Insurer added line items |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber |
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate |
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate |
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
productOrService | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. |
modifier | S | 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. |
serviced[x] | S | 0..1 | Date or dates of service or product delivery | |
servicedDate | date | |||
servicedPeriod | Period | |||
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. |
quantity | S | 0..1 | SimpleQuantity | Count of products or services |
unitPrice | S | 0..1 | Money | Fee, charge or cost per item |
adjudication | 1..* | See adjudication (ClaimResponse) | Added items adjudication | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClaimResponse.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | |
ClaimResponse.type | extensible | ClaimTypeCodeshttp://hl7.org/fhir/ValueSet/claim-type from the FHIR Standard | |
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.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.location[x] | example | ExampleServicePlaceCodeshttp://hl7.org/fhir/ValueSet/service-place 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ClaimResponse | 0..* | ClaimResponse | Prior authorization This profile also complies with the profile US Core Coverage Profile (6.1.0) | |||||
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. Fixed Value: active | ||||
type | SΣ | 1..1 | CodeableConcept | More granular claim type Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim. | ||||
subType | 0..1 | CodeableConcept | More granular claim type Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode. | |||||
use | SΣ | 1..1 | code | claim | preauthorization | predetermination Binding: Use (required): Claim, preauthorization, predetermination. | ||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | The recipient of the products and services | ||||
created | SΣ | 1..1 | dateTime | Response creation date | ||||
insurer | SΣ | 1..1 | Reference(HRex Organization Profile) | 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 | SΣ | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The result of the claim processing. | ||||
disposition | 0..1 | string | Disposition Message | |||||
preAuthRef | S | 1..1 | string | PA Number/Identifier | ||||
preAuthPeriod | S | 0..1 | Period | Certification Effective Date and Certification End Date | ||||
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 | 0..1 | CodeableConcept | Explanation of adjudication outcome Binding: AdjudicationReasonCodes (example): The adjudication reason codes. | |||||
amount | 0..1 | Money | Monetary amount | |||||
value | 0..1 | decimal | Non-monetary value | |||||
detail | 0..* | BackboneElement | Adjudication for claim details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
detailSequence | 1..1 | positiveInt | Claim detail instance identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 1..* | See adjudication (ClaimResponse) | Detail level adjudication details | |||||
subDetail | 0..* | BackboneElement | Adjudication for claim sub-details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
subDetailSequence | 1..1 | positiveInt | Claim sub-detail instance identifier | |||||
noteNumber | 0..* | positiveInt | Applicable note numbers | |||||
adjudication | 0..* | See adjudication (ClaimResponse) | Subdetail level adjudication details | |||||
addItem | S | 0..* | BackboneElement | Insurer added line items | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemTraceNumber | S | 0..* | Identifier | Item Trace Number URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber | ||||
preAuthIssueDate | S | 0..1 | date | Pre Authorized Issue Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate | ||||
authorizedDate | S | 0..1 | dateTime, Period | Authorized Date URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate | ||||
authorizedProvider | S | 0..1 | Reference(US Core Practitioner Profile(7.0.0) | US Core Organization Profile(7.0.0)) | Authorized Provider URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider | ||||
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 | S | 1..1 | CodeableConcept | Billing, service, product, or drug code Binding: USCLSCodes (example): Allowable service and product codes. | ||||
modifier | S | 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] | S | 0..1 | Date or dates of service or product delivery | |||||
servicedDate | date | |||||||
servicedPeriod | Period | |||||||
location[x] | S | 0..1 | CodeableConcept | Place of service or where product was supplied Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc. | ||||
quantity | S | 0..1 | SimpleQuantity | Count of products or services | ||||
unitPrice | S | 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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ClaimResponse.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard | ||||
ClaimResponse.type | extensible | ClaimTypeCodeshttp://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 | 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 | example | AdjudicationValueCodeshttp://hl7.org/fhir/ValueSet/adjudication from the FHIR Standard | ||||
ClaimResponse.item.adjudication.reason | example | AdjudicationReasonCodeshttp://hl7.org/fhir/ValueSet/adjudication-reason from the FHIR Standard | ||||
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 | CommonLanguages
http://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
Summary
Mandatory: 1 element
Must-Support: 19 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron