R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2

12.20 Resource ProcessResponse - Content

Financial Management

Work Group

Maturity Level: 2

Trial Use

Compartments: Practitioner

This resource provides processing status, errors and notes from the processing of a resource.

12.20.1 Scope and Usage

NOTE: This resource is slated to be refactored and reduced in scope as some of its functionality is taken over by the Task resource as part of the FHIR Workflow refactoring. Readers of this resource are encouraged to review the Task resource and consider using it instead and/or to provide feedback if they feel it will be inadequate to satisfy the use-cases associated with this resource and to express opinions about which purposes for they feel ProcessRequest and ProcessResponse should be retained.

The ProcessResponse resource indicates the resource for which the processing status is requested and provides simple acknowledgement and status information of application level errors. It may also be used to convey additional processing requirements in a text form.

This is the formal response to a ProcessRequest and may be used as a application level response to the PaymentNotice resource.

Structure

Name	Flags	Card.	Type	Description & Constraints
ProcessResponse	TU		DomainResource	ProcessResponse resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier		0..*	Identifier	Business Identifier
status	?!Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Financial Resource Status Codes (Required)
created		0..1	dateTime	Creation date
organization		0..1	Reference(Organization)	Authoring Organization
request		0..1	Reference(Any)	Request reference
outcome		0..1	code	Processing outcome Process Outcome Codes (Required)
disposition		0..1	string	Disposition Message
requestProvider		0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Responsible Practitioner
form		0..1	CodeableConcept	Printed Form Identifier Form Codes (Example)
processNote		0..*	BackboneElement	Processing comments or additional requirements
type		0..1	code	display \| print \| printoper NoteType (Required)
text		0..1	string	Comment on the processing
error		0..*	CodeableConcept	Error code Adjudication Error Codes (Example)
communicationRequest		0..*	Reference(CommunicationRequest)	Request for additional information
Documentation for this format

UML Diagram (Legend)

XML Template

<ProcessResponse xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Authoring Organization --></organization>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome value="[code]"/><!-- 0..1 Processing outcome -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible Practitioner --></requestProvider>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <processNote>  <!-- 0..* Processing comments or additional requirements -->
  <type value="[code]"/><!-- 0..1 display | print | printoper -->
  <text value="[string]"/><!-- 0..1 Comment on the processing -->
 </processNote>
 <error><!-- 0..* CodeableConcept Error code --></error>
 <communicationRequest><!-- 0..* Reference(CommunicationRequest) Request for additional information --></communicationRequest>
</ProcessResponse>

JSON Template

{
  "resourceType" : "ProcessResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // active | cancelled | draft | entered-in-error
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Authoring Organization
  "request" : { Reference(Any) }, // Request reference
  "outcome" : "<code>", // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "requestProvider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible Practitioner
  "form" : { CodeableConcept }, // Printed Form Identifier
  "processNote" : [{ // Processing comments or additional requirements
    "type" : "<code>", // display | print | printoper
    "text" : "<string>" // Comment on the processing
  }],
  "error" : [{ CodeableConcept }], // Error code
  "communicationRequest" : [{ Reference(CommunicationRequest) }] // Request for additional information
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ProcessResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ProcessResponse.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:ProcessResponse.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:ProcessResponse.created [ dateTime ]; # 0..1 Creation date
  fhir:ProcessResponse.organization [ Reference(Organization) ]; # 0..1 Authoring Organization
  fhir:ProcessResponse.request [ Reference(Any) ]; # 0..1 Request reference
  fhir:ProcessResponse.outcome [ code ]; # 0..1 Processing outcome
  fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:ProcessResponse.requestProvider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible Practitioner
  fhir:ProcessResponse.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:ProcessResponse.processNote [ # 0..* Processing comments or additional requirements
    fhir:ProcessResponse.processNote.type [ code ]; # 0..1 display | print | printoper
    fhir:ProcessResponse.processNote.text [ string ]; # 0..1 Comment on the processing
  ], ...;
  fhir:ProcessResponse.error [ CodeableConcept ], ... ; # 0..* Error code
  fhir:ProcessResponse.communicationRequest [ Reference(CommunicationRequest) ], ... ; # 0..* Request for additional information
]

Changes since R3

ProcessResponse

ProcessResponse.outcome

Type changed from CodeableConcept to code
Add Binding http://hl7.org/fhir/ValueSet/process-outcome (required)

ProcessResponse.requestProvider

Type changed from Reference(Practitioner) to Reference(Practitioner|PractitionerRole|Organization)

ProcessResponse.processNote.type

Type changed from CodeableConcept to code

ProcessResponse.requestOrganization

deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
ProcessResponse	TU		DomainResource	ProcessResponse resource Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier		0..*	Identifier	Business Identifier
status	?!Σ	0..1	code	active \| cancelled \| draft \| entered-in-error Financial Resource Status Codes (Required)
created		0..1	dateTime	Creation date
organization		0..1	Reference(Organization)	Authoring Organization
request		0..1	Reference(Any)	Request reference
outcome		0..1	code	Processing outcome Process Outcome Codes (Required)
disposition		0..1	string	Disposition Message
requestProvider		0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Responsible Practitioner
form		0..1	CodeableConcept	Printed Form Identifier Form Codes (Example)
processNote		0..*	BackboneElement	Processing comments or additional requirements
type		0..1	code	display \| print \| printoper NoteType (Required)
text		0..1	string	Comment on the processing
error		0..*	CodeableConcept	Error code Adjudication Error Codes (Example)
communicationRequest		0..*	Reference(CommunicationRequest)	Request for additional information
Documentation for this format

UML Diagram (Legend)

XML Template

<ProcessResponse xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Authoring Organization --></organization>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome value="[code]"/><!-- 0..1 Processing outcome -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner|PractitionerRole|Organization) Responsible Practitioner --></requestProvider>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <processNote>  <!-- 0..* Processing comments or additional requirements -->
  <type value="[code]"/><!-- 0..1 display | print | printoper -->
  <text value="[string]"/><!-- 0..1 Comment on the processing -->
 </processNote>
 <error><!-- 0..* CodeableConcept Error code --></error>
 <communicationRequest><!-- 0..* Reference(CommunicationRequest) Request for additional information --></communicationRequest>
</ProcessResponse>

JSON Template

{
  "resourceType" : "ProcessResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // active | cancelled | draft | entered-in-error
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Authoring Organization
  "request" : { Reference(Any) }, // Request reference
  "outcome" : "<code>", // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "requestProvider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible Practitioner
  "form" : { CodeableConcept }, // Printed Form Identifier
  "processNote" : [{ // Processing comments or additional requirements
    "type" : "<code>", // display | print | printoper
    "text" : "<string>" // Comment on the processing
  }],
  "error" : [{ CodeableConcept }], // Error code
  "communicationRequest" : [{ Reference(CommunicationRequest) }] // Request for additional information
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ProcessResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ProcessResponse.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:ProcessResponse.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:ProcessResponse.created [ dateTime ]; # 0..1 Creation date
  fhir:ProcessResponse.organization [ Reference(Organization) ]; # 0..1 Authoring Organization
  fhir:ProcessResponse.request [ Reference(Any) ]; # 0..1 Request reference
  fhir:ProcessResponse.outcome [ code ]; # 0..1 Processing outcome
  fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:ProcessResponse.requestProvider [ Reference(Practitioner|PractitionerRole|Organization) ]; # 0..1 Responsible Practitioner
  fhir:ProcessResponse.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:ProcessResponse.processNote [ # 0..* Processing comments or additional requirements
    fhir:ProcessResponse.processNote.type [ code ]; # 0..1 display | print | printoper
    fhir:ProcessResponse.processNote.text [ string ]; # 0..1 Comment on the processing
  ], ...;
  fhir:ProcessResponse.error [ CodeableConcept ], ... ; # 0..* Error code
  fhir:ProcessResponse.communicationRequest [ Reference(CommunicationRequest) ], ... ; # 0..* Request for additional information
]

Changes since DSTU2

ProcessResponse

ProcessResponse.outcome

Type changed from CodeableConcept to code
Add Binding http://hl7.org/fhir/ValueSet/process-outcome (required)

ProcessResponse.requestProvider

Type changed from Reference(Practitioner) to Reference(Practitioner|PractitionerRole|Organization)

ProcessResponse.processNote.type

Type changed from CodeableConcept to code

ProcessResponse.requestOrganization

deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

12.20.2.1 Terminology Bindings

Path	Definition	Type	Reference
ProcessResponse.status	A code specifying the state of the resource instance.	Required	Financial Resource Status Codes
ProcessResponse.outcome	Local status of outcome codes	Required	Process Outcome Codes
ProcessResponse.form	The forms codes.	Example	Form Codes
ProcessResponse.processNote.type	The presentation types of notes.	Required	NoteType
ProcessResponse.error	The error codes for adjudication processing.	Example	Adjudication Error Codes

Path

Definition

Type

Reference

ProcessResponse.status

A code specifying the state of the resource instance.

Required

Financial Resource Status Codes

ProcessResponse.outcome

Local status of outcome codes

Required

Process Outcome Codes

ProcessResponse.form

The forms codes.

Example

Form Codes

ProcessResponse.processNote.type

The presentation types of notes.

Required

NoteType

ProcessResponse.error

The error codes for adjudication processing.

Example

Adjudication Error Codes

12.20.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
identifier	token	The business identifier of the Explanation of Benefit	ProcessResponse.identifier
organization	reference	The organization who generated this resource	ProcessResponse.organization (Organization)
request	reference	The reference to the claim	ProcessResponse.request (Any)
request-provider	reference	The Provider who is responsible the request transaction	ProcessResponse.requestProvider (Practitioner, Organization, PractitionerRole)
status	token	The status of the process response	ProcessResponse.status