Da Vinci Prior Authorization Support (PAS) FHIR IG
1.0.0 - STU 1

This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: PAS Claim Inquiry Response

Defining URL:http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-claiminquiryresponse
Version:1.0.0
Name:PASClaimInquiryResponse
Title:PAS Claim Inquiry Response
Status:Active as of 2020-12-20T19:17:24+00:00
Definition:

PAS constraints on Claim resource mandating support for elements relevant to the response of an inquiry for details of previous authorizations.

Publisher:HL7 International - Financial Management Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-claiminquiryresponse

Formal Views of Profile Content

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

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... identifier S0..*IdentifierBusiness Identifier for a claim response
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... use 1..1codeclaim | preauthorization | predetermination
Fixed Value: preauthorization
... created S1..1dateTimeResponse creation date
... insurer S1..1Reference(PAS Insurer Organization)Party responsible for reimbursement
... requestor S0..1Reference(PAS Requestor Organization)Party responsible for the claim
... request S0..1Reference(PAS Claim)Id of resource triggering adjudication
... outcome S1..1codequeued | complete | error | partial
... preAuthPeriod S0..1PeriodPreauthorization reference effective period
... item S0..*BackboneElementAdjudication for claim line items
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-reviewAction S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reviewAction
.... extension-itemPreAuthIssueDate S0..1dateExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthIssueDate
.... extension-itemPreAuthPeriod S0..1PeriodExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthPeriod
.... extension-authorizationNumber S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-authorizationNumber
.... extension-administrationReferenceNumber S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-administrationReferenceNumber
.... extension-itemAuthorizedDate S0..1dateTime, PeriodExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDate
.... extension-itemAuthorizedDetail S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDetail
.... extension-itemAuthorizedProvider S0..1Reference(PAS Practitioner | US Core Organization Profile)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedProvider
... error S0..*BackboneElementProcessing errors
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-errorFollowupAction S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorFollowupAction
Binding: X12 278 Follow Up Action Value Set (required)
.... extension-errorElement S1..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorElement
.... code S1..1CodeableConceptError code detailing processing issues
Binding: X12 278 Reject Reason Value Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness Identifier for a claim response
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type Σ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... subType 0..1CodeableConceptMore granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

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


Fixed Value: preauthorization
... patient SΣ1..1Reference(PAS Beneficiary Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(PAS Insurer Organization)Party responsible for reimbursement
... requestor S0..1Reference(PAS Requestor Organization)Party responsible for the claim
... request SΣ0..1Reference(PAS Claim)Id of resource triggering adjudication
... outcome SΣ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition 0..1stringDisposition Message
... preAuthRef 0..1stringPreauthorization reference
... preAuthPeriod S0..1PeriodPreauthorization reference effective period
... payeeType 0..1CodeableConceptParty to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

... item S0..*BackboneElementAdjudication for claim line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-reviewAction S0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reviewAction
.... extension-itemPreAuthIssueDate S0..1dateOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthIssueDate
.... extension-itemPreAuthPeriod S0..1PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthPeriod
.... extension-authorizationNumber S0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-authorizationNumber
.... extension-administrationReferenceNumber S0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-administrationReferenceNumber
.... extension-itemAuthorizedDate S0..1dateTime, PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDate
.... extension-itemAuthorizedDetail S0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDetail
.... extension-itemAuthorizedProvider S0..1Reference(PAS Practitioner | US Core Organization Profile)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedProvider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.

..... amount 0..1MoneyMonetary amount
..... value 0..1decimalNon-monetary value
.... detail 0..*BackboneElementAdjudication for claim details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence 1..1positiveIntClaim detail instance identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details
..... subDetail 0..*BackboneElementAdjudication for claim sub-details
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1positiveIntClaim sub-detail instance identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ClaimResponse)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subdetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/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..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*See adjudication (ClaimResponse)Added items adjudication
.... detail 0..*BackboneElementInsurer added line details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/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..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/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..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
... adjudication 0..*See adjudication (ClaimResponse)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 1..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 1..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information
... insurance 0..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInsurance instance identifier
.... focal 1..1booleanCoverage to be used for adjudication
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
.... claimResponse 0..1Reference(ClaimResponse)Adjudication results
... error S0..*BackboneElementProcessing errors
.... id 0..1stringUnique id for inter-element referencing
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-errorFollowupAction S0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorFollowupAction
Binding: X12 278 Follow Up Action Value Set (required)
.... extension-errorElement S1..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorElement
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..1positiveIntItem sequence number
.... detailSequence 0..1positiveIntDetail sequence number
.... subDetailSequence 0..1positiveIntSubdetail sequence number
.... code S1..1CodeableConceptError code detailing processing issues
Binding: X12 278 Reject Reason Value Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... identifier 0..*IdentifierBusiness Identifier for a claim response
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... patient Σ1..1Reference(PAS Beneficiary Patient)The recipient of the products and services
... insurer Σ1..1Reference(PAS Insurer Organization)Party responsible for reimbursement
... requestor 0..1Reference(PAS Requestor Organization)Party responsible for the claim
... request Σ0..1Reference(PAS Claim)Id of resource triggering adjudication
... outcome Σ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... preAuthPeriod 0..1PeriodPreauthorization reference effective period
... item 0..*BackboneElementAdjudication for claim line items
.... extension-reviewAction 0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reviewAction
.... extension-itemPreAuthIssueDate 0..1dateOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthIssueDate
.... extension-itemPreAuthPeriod 0..1PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthPeriod
.... extension-authorizationNumber 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-authorizationNumber
.... extension-administrationReferenceNumber 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-administrationReferenceNumber
.... extension-itemAuthorizedDate 0..1dateTime, PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDate
.... extension-itemAuthorizedDetail 0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDetail
.... extension-itemAuthorizedProvider 0..1Reference(PAS Practitioner | US Core Organization Profile)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedProvider
... error 0..*BackboneElementProcessing errors
.... extension-errorFollowupAction 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorFollowupAction
Binding: X12 278 Follow Up Action Value Set (required)
.... extension-errorElement 1..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorElement
.... code 1..1CodeableConceptError code detailing processing issues
Binding: X12 278 Reject Reason Value Set (required)

doco Documentation for this format

Differential View

This structure is derived from ClaimResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... identifier S0..*IdentifierBusiness Identifier for a claim response
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... use 1..1codeclaim | preauthorization | predetermination
Fixed Value: preauthorization
... created S1..1dateTimeResponse creation date
... insurer S1..1Reference(PAS Insurer Organization)Party responsible for reimbursement
... requestor S0..1Reference(PAS Requestor Organization)Party responsible for the claim
... request S0..1Reference(PAS Claim)Id of resource triggering adjudication
... outcome S1..1codequeued | complete | error | partial
... preAuthPeriod S0..1PeriodPreauthorization reference effective period
... item S0..*BackboneElementAdjudication for claim line items
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-reviewAction S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reviewAction
.... extension-itemPreAuthIssueDate S0..1dateExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthIssueDate
.... extension-itemPreAuthPeriod S0..1PeriodExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthPeriod
.... extension-authorizationNumber S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-authorizationNumber
.... extension-administrationReferenceNumber S0..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-administrationReferenceNumber
.... extension-itemAuthorizedDate S0..1dateTime, PeriodExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDate
.... extension-itemAuthorizedDetail S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDetail
.... extension-itemAuthorizedProvider S0..1Reference(PAS Practitioner | US Core Organization Profile)Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedProvider
... error S0..*BackboneElementProcessing errors
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-errorFollowupAction S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorFollowupAction
Binding: X12 278 Follow Up Action Value Set (required)
.... extension-errorElement S1..1stringExtension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorElement
.... code S1..1CodeableConceptError code detailing processing issues
Binding: X12 278 Reject Reason Value Set (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClaimResponse 0..*ClaimResponseResponse to a claim predetermination or preauthorization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness Identifier for a claim response
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.


Fixed Value: active
... type Σ1..1CodeableConceptMore granular claim type
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.

... subType 0..1CodeableConceptMore granular claim type
Binding: ExampleClaimSubTypeCodes (example): A more granular claim typecode.

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


Fixed Value: preauthorization
... patient SΣ1..1Reference(PAS Beneficiary Patient)The recipient of the products and services
... created SΣ1..1dateTimeResponse creation date
... insurer SΣ1..1Reference(PAS Insurer Organization)Party responsible for reimbursement
... requestor S0..1Reference(PAS Requestor Organization)Party responsible for the claim
... request SΣ0..1Reference(PAS Claim)Id of resource triggering adjudication
... outcome SΣ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.

... disposition 0..1stringDisposition Message
... preAuthRef 0..1stringPreauthorization reference
... preAuthPeriod S0..1PeriodPreauthorization reference effective period
... payeeType 0..1CodeableConceptParty to be paid any benefits payable
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

... item S0..*BackboneElementAdjudication for claim line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-reviewAction S0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reviewAction
.... extension-itemPreAuthIssueDate S0..1dateOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthIssueDate
.... extension-itemPreAuthPeriod S0..1PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemPreAuthPeriod
.... extension-authorizationNumber S0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-authorizationNumber
.... extension-administrationReferenceNumber S0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-administrationReferenceNumber
.... extension-itemAuthorizedDate S0..1dateTime, PeriodOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDate
.... extension-itemAuthorizedDetail S0..1(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedDetail
.... extension-itemAuthorizedProvider S0..1Reference(PAS Practitioner | US Core Organization Profile)Optional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-itemAuthorizedProvider
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 1..1positiveIntClaim item instance identifier
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): The adjudication reason codes.

..... amount 0..1MoneyMonetary amount
..... value 0..1decimalNon-monetary value
.... detail 0..*BackboneElementAdjudication for claim details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... detailSequence 1..1positiveIntClaim detail instance identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Detail level adjudication details
..... subDetail 0..*BackboneElementAdjudication for claim sub-details
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... subDetailSequence 1..1positiveIntClaim sub-detail instance identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ClaimResponse)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subdetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/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..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place of service: pharmacy, school, prison, etc.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 1..*See adjudication (ClaimResponse)Added items adjudication
.... detail 0..*BackboneElementInsurer added line details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/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..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/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..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 1..*See adjudication (ClaimResponse)Added items detail adjudication
... adjudication 0..*See adjudication (ClaimResponse)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the adjustment
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 1..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 1..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information
... insurance 0..*BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInsurance instance identifier
.... focal 1..1booleanCoverage to be used for adjudication
.... coverage 1..1Reference(Coverage)Insurance information
.... businessArrangement 0..1stringAdditional provider contract number
.... claimResponse 0..1Reference(ClaimResponse)Adjudication results
... error S0..*BackboneElementProcessing errors
.... id 0..1stringUnique id for inter-element referencing
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-errorFollowupAction S0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorFollowupAction
Binding: X12 278 Follow Up Action Value Set (required)
.... extension-errorElement S1..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-errorElement
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..1positiveIntItem sequence number
.... detailSequence 0..1positiveIntDetail sequence number
.... subDetailSequence 0..1positiveIntSubdetail sequence number
.... code S1..1CodeableConceptError code detailing processing issues
Binding: X12 278 Reject Reason Value Set (required)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
ClaimResponse.languagepreferredCommonLanguages
Max Binding: AllLanguages
ClaimResponse.statusrequiredFixed Value: active
ClaimResponse.typeextensibleClaimTypeCodes
ClaimResponse.subTypeexampleExampleClaimSubTypeCodes
ClaimResponse.userequiredFixed Value: preauthorization
ClaimResponse.outcomerequiredClaimProcessingCodes
ClaimResponse.payeeTypeexampleClaim Payee Type Codes
ClaimResponse.item.adjudication.categoryexampleAdjudicationValueCodes
ClaimResponse.item.adjudication.reasonexampleAdjudicationReasonCodes
ClaimResponse.addItem.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.modifierexampleModifierTypeCodes
ClaimResponse.addItem.programCodeexampleExampleProgramReasonCodes
ClaimResponse.addItem.location[x]exampleExampleServicePlaceCodes
ClaimResponse.addItem.bodySiteexampleOralSiteCodes
ClaimResponse.addItem.subSiteexampleSurfaceCodes
ClaimResponse.addItem.detail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.modifierexampleModifierTypeCodes
ClaimResponse.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
ClaimResponse.addItem.detail.subDetail.modifierexampleModifierTypeCodes
ClaimResponse.total.categoryexampleAdjudicationValueCodes
ClaimResponse.payment.typeexampleExamplePaymentTypeCodes
ClaimResponse.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
ClaimResponse.fundsReserveexampleFunds Reservation Codes
ClaimResponse.formCodeexampleForm Codes
ClaimResponse.processNote.typerequiredNoteType
ClaimResponse.processNote.languagepreferredCommonLanguages
Max Binding: AllLanguages
ClaimResponse.error.coderequiredX12278RejectReasonCodes