Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HRex Prior authorization

This profile specifies constraints on ClaimResponse resource to reflect the contents of a pro-active prior authorization returned via a card

Usage:

• Examples for this Resource Profile: ClaimResponse/UnsolicitedReferralAuthorizationResponseExample

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ClaimResponse

Name	Flags	Card.	Type	Description & Constraints
ClaimResponse		0..*	ClaimResponse	Prior authorization
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)	The recipient of the products and services
created	S	1..1	dateTime	Response creation date
insurer	S	1..1	Reference(US Core 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 | US Core Organization Profile)	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
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)	The recipient of the products and services
created	SΣ	1..1	dateTime	Response creation date
insurer	SΣ	1..1	Reference(US Core 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 | US Core Organization Profile)	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

Terminology Bindings

Path	Conformance	ValueSet / Code
ClaimResponse.status	required	Fixed Value: active
ClaimResponse.type	extensible	ClaimTypeCodes
ClaimResponse.use	required	Use
ClaimResponse.outcome	required	ClaimProcessingCodes
ClaimResponse.addItem.productOrService	example	USCLSCodes
ClaimResponse.addItem.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.location[x]	example	ExampleServicePlaceCodes

Name	Flags	Card.	Type	Description & Constraints
ClaimResponse		0..*	ClaimResponse	Prior authorization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier for a claim response
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. 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)	The recipient of the products and services
created	SΣ	1..1	dateTime	Response creation date
insurer	SΣ	1..1	Reference(US Core 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 | US Core Organization Profile)	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. Additional Bindings Purpose AllLanguages Max Binding
communicationRequest		0..*	Reference(CommunicationRequest)	Request for additional information
insurance		0..*	BackboneElement	Patient insurance information
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence		1..1	positiveInt	Insurance instance identifier
focal		1..1	boolean	Coverage to be used for adjudication
coverage		1..1	Reference(Coverage)	Insurance information
businessArrangement		0..1	string	Additional provider contract number
claimResponse		0..1	Reference(ClaimResponse)	Adjudication results
error		0..*	BackboneElement	Processing errors
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
itemSequence		0..1	positiveInt	Item sequence number
detailSequence		0..1	positiveInt	Detail sequence number
subDetailSequence		0..1	positiveInt	Subdetail sequence number
code		1..1	CodeableConcept	Error code detailing processing issues Binding: Adjudication Error Codes (example): The adjudication error codes.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ClaimResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ClaimResponse.status	required	Fixed Value: active
ClaimResponse.type	extensible	ClaimTypeCodes
ClaimResponse.subType	example	ExampleClaimSubTypeCodes
ClaimResponse.use	required	Use
ClaimResponse.outcome	required	ClaimProcessingCodes
ClaimResponse.payeeType	example	Claim Payee Type Codes
ClaimResponse.item.adjudication.category	example	AdjudicationValueCodes
ClaimResponse.item.adjudication.reason	example	AdjudicationReasonCodes
ClaimResponse.addItem.productOrService	example	USCLSCodes
ClaimResponse.addItem.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.programCode	example	ExampleProgramReasonCodes
ClaimResponse.addItem.location[x]	example	ExampleServicePlaceCodes
ClaimResponse.addItem.bodySite	example	OralSiteCodes
ClaimResponse.addItem.subSite	example	SurfaceCodes
ClaimResponse.addItem.detail.productOrService	example	USCLSCodes
ClaimResponse.addItem.detail.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.detail.subDetail.productOrService	example	USCLSCodes
ClaimResponse.addItem.detail.subDetail.modifier	example	ModifierTypeCodes
ClaimResponse.total.category	example	AdjudicationValueCodes
ClaimResponse.payment.type	example	ExamplePaymentTypeCodes
ClaimResponse.payment.adjustmentReason	example	PaymentAdjustmentReasonCodes
ClaimResponse.fundsReserve	example	Funds Reservation Codes
ClaimResponse.formCode	example	Form Codes
ClaimResponse.processNote.type	required	NoteType
ClaimResponse.processNote.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ClaimResponse.error.code	example	Adjudication Error Codes

This structure is derived from ClaimResponse

Summary

Mandatory: 1 element
Must-Support: 19 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
• US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider

Maturity: 0

Differential View

This structure is derived from ClaimResponse

Name	Flags	Card.	Type	Description & Constraints
ClaimResponse		0..*	ClaimResponse	Prior authorization
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)	The recipient of the products and services
created	S	1..1	dateTime	Response creation date
insurer	S	1..1	Reference(US Core 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 | US Core Organization Profile)	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
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)	The recipient of the products and services
created	SΣ	1..1	dateTime	Response creation date
insurer	SΣ	1..1	Reference(US Core 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 | US Core Organization Profile)	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

Terminology Bindings

Path	Conformance	ValueSet / Code
ClaimResponse.status	required	Fixed Value: active
ClaimResponse.type	extensible	ClaimTypeCodes
ClaimResponse.use	required	Use
ClaimResponse.outcome	required	ClaimProcessingCodes
ClaimResponse.addItem.productOrService	example	USCLSCodes
ClaimResponse.addItem.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.location[x]	example	ExampleServicePlaceCodes

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ClaimResponse		0..*	ClaimResponse	Prior authorization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier for a claim response
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. 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)	The recipient of the products and services
created	SΣ	1..1	dateTime	Response creation date
insurer	SΣ	1..1	Reference(US Core 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 | US Core Organization Profile)	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. Additional Bindings Purpose AllLanguages Max Binding
communicationRequest		0..*	Reference(CommunicationRequest)	Request for additional information
insurance		0..*	BackboneElement	Patient insurance information
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
sequence		1..1	positiveInt	Insurance instance identifier
focal		1..1	boolean	Coverage to be used for adjudication
coverage		1..1	Reference(Coverage)	Insurance information
businessArrangement		0..1	string	Additional provider contract number
claimResponse		0..1	Reference(ClaimResponse)	Adjudication results
error		0..*	BackboneElement	Processing errors
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
itemSequence		0..1	positiveInt	Item sequence number
detailSequence		0..1	positiveInt	Detail sequence number
subDetailSequence		0..1	positiveInt	Subdetail sequence number
code		1..1	CodeableConcept	Error code detailing processing issues Binding: Adjudication Error Codes (example): The adjudication error codes.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ClaimResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ClaimResponse.status	required	Fixed Value: active
ClaimResponse.type	extensible	ClaimTypeCodes
ClaimResponse.subType	example	ExampleClaimSubTypeCodes
ClaimResponse.use	required	Use
ClaimResponse.outcome	required	ClaimProcessingCodes
ClaimResponse.payeeType	example	Claim Payee Type Codes
ClaimResponse.item.adjudication.category	example	AdjudicationValueCodes
ClaimResponse.item.adjudication.reason	example	AdjudicationReasonCodes
ClaimResponse.addItem.productOrService	example	USCLSCodes
ClaimResponse.addItem.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.programCode	example	ExampleProgramReasonCodes
ClaimResponse.addItem.location[x]	example	ExampleServicePlaceCodes
ClaimResponse.addItem.bodySite	example	OralSiteCodes
ClaimResponse.addItem.subSite	example	SurfaceCodes
ClaimResponse.addItem.detail.productOrService	example	USCLSCodes
ClaimResponse.addItem.detail.modifier	example	ModifierTypeCodes
ClaimResponse.addItem.detail.subDetail.productOrService	example	USCLSCodes
ClaimResponse.addItem.detail.subDetail.modifier	example	ModifierTypeCodes
ClaimResponse.total.category	example	AdjudicationValueCodes
ClaimResponse.payment.type	example	ExamplePaymentTypeCodes
ClaimResponse.payment.adjustmentReason	example	PaymentAdjustmentReasonCodes
ClaimResponse.fundsReserve	example	Funds Reservation Codes
ClaimResponse.formCode	example	Form Codes
ClaimResponse.processNote.type	required	NoteType
ClaimResponse.processNote.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ClaimResponse.error.code	example	Adjudication Error Codes

This structure is derived from ClaimResponse

Summary

Mandatory: 1 element
Must-Support: 19 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
• US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemTraceNumber
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemPreAuthIssueDate
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedDate
• http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/extension-itemAuthorizedProvider

Maturity: 0

Other representations of profile: CSV, Excel, Schematron