This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

5.9 Resource ProcessResponse - Content

This resource maintained by the Financial Management Work Group

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

5.9.1 Scope and Usage

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 PaymentNotice and SupportingDocumentation resources.

5.9.2 Resource Content

UML Diagram

ProcessResponse ( DomainResource ) The Response Business Identifier identifier : Identifier 0..* Original request resource reference request : Reference ( Any ) 0..1 Transaction status: error, complete, held outcome : Coding 0..1 « ( Local status of outcome codes ProcessingOutcome ) » A description of the status of the adjudication or processing disposition : string 0..1 The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources ruleset : Coding 0..1 « ( The static and dynamic model to which contents conform, may be business version or standard and version. Ruleset ) » The style (standard) and version of the original material which was converted into this resource originalRuleset : Coding 0..1 « ( The static and dynamic model to which contents conform, may be business version or standard and version. Ruleset ) » The date when the enclosed suite of services were performed or completed created : dateTime 0..1 The organization who produced this adjudicated response organization : Reference ( Organization ) 0..1 The practitioner who is responsible for the services rendered to the patient requestProvider : Reference ( Practitioner ) 0..1 The organization which is responsible for the services rendered to the patient requestOrganization : Reference ( Organization ) 0..1 The form to be used for printing the content form : Coding 0..1 « The forms codes Forms » Processing errors error : Coding 0..* « The error codes for adjudication processing AdjudicationError » Notes The note purpose: Print/Display type : Coding 0..1 « The presentation types of notes NoteType » The note text text : string 0..1 Suite of processing note or additional requirements is the processing has been held notes 0..*

XML Template 

<ProcessResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome><!-- 0..1 Coding Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Authoring Organization --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible Practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <notes>  <!-- 0..* Notes -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </notes>
 <error><!-- 0..* Coding Error code --></error>
</ProcessResponse>

JSON Template 

{doco
  "resourceType" : "ProcessResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(Any) }, // Request reference
  "outcome" : { Coding }, // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Authoring Organization
  "requestProvider" : { Reference(Practitioner) }, // Responsible Practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible organization
  "form" : { Coding }, // Printed Form Identifier
  "notes" : [{ // Notes
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }],
  "error" : [{ Coding }] // Error code
}

UML Diagram

ProcessResponse ( DomainResource ) The Response Business Identifier identifier : Identifier 0..* Original request resource reference request : Reference ( Any ) 0..1 Transaction status: error, complete, held outcome : Coding 0..1 « ( Local status of outcome codes ProcessingOutcome ) » A description of the status of the adjudication or processing disposition : string 0..1 The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources ruleset : Coding 0..1 « ( The static and dynamic model to which contents conform, may be business version or standard and version. Ruleset ) » The style (standard) and version of the original material which was converted into this resource originalRuleset : Coding 0..1 « ( The static and dynamic model to which contents conform, may be business version or standard and version. Ruleset ) » The date when the enclosed suite of services were performed or completed created : dateTime 0..1 The organization who produced this adjudicated response organization : Reference ( Organization ) 0..1 The practitioner who is responsible for the services rendered to the patient requestProvider : Reference ( Practitioner ) 0..1 The organization which is responsible for the services rendered to the patient requestOrganization : Reference ( Organization ) 0..1 The form to be used for printing the content form : Coding 0..1 « The forms codes Forms » Processing errors error : Coding 0..* « The error codes for adjudication processing AdjudicationError » Notes The note purpose: Print/Display type : Coding 0..1 « The presentation types of notes NoteType » The note text text : string 0..1 Suite of processing note or additional requirements is the processing has been held notes 0..*

XML Template 

<ProcessResponse xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <request><!-- 0..1 Reference(Any) Request reference --></request>
 <outcome><!-- 0..1 Coding Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Authoring Organization --></organization>
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible Practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <notes>  <!-- 0..* Notes -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </notes>
 <error><!-- 0..* Coding Error code --></error>
</ProcessResponse>

JSON Template 

{doco
  "resourceType" : "ProcessResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "request" : { Reference(Any) }, // Request reference
  "outcome" : { Coding }, // Processing outcome
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "organization" : { Reference(Organization) }, // Authoring Organization
  "requestProvider" : { Reference(Practitioner) }, // Responsible Practitioner
  "requestOrganization" : { Reference(Organization) }, // Responsible organization
  "form" : { Coding }, // Printed Form Identifier
  "notes" : [{ // Notes
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }],
  "error" : [{ Coding }] // Error code
}

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

5.9.2.1 Terminology Bindings

Path Definition Type Reference
ProcessResponse.outcome Local status of outcome codes Example http://hl7.org/fhir/vs/process-outcome
ProcessResponse.ruleset
ProcessResponse.originalRuleset 		The static and dynamic model to which contents conform, may be business version or standard and version. Example http://hl7.org/fhir/vs/ruleset
ProcessResponse.form The forms codes Required http://hl7.org/fhir/vs/forms
ProcessResponse.notes.type The presentation types of notes Required http://hl7.org/fhir/NT-link
ProcessResponse.error The error codes for adjudication processing Required http://hl7.org/fhir/vs/adjudication-error

5.9.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 Paths
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)
requestorganization reference The Organization who is responsible the request transaction ProcessResponse.requestOrganization
( Organization )
requestprovider reference The Provider who is responsible the request transaction ProcessResponse.requestProvider
( Practitioner )