DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 R3 R2

5.9 12.21 Resource ProcessResponse - Content

Financial Management Work Group Maturity Level : 0 2   Trial Use Compartments : Practitioner

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

5.9.1 12.21.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 and SupportingDocumentation resources. resource.

5.9.2 12.21.2 Resource Content

Structure

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

doco Documentation for this format

UML Diagram ( Legend )

ProcessResponse ( DomainResource ) The Response business identifier identifier : Identifier [0..*] The status of the resource instance (this element modifies the meaning of other elements) status : code [0..1] A code specifying the state of the resource instance. (Strength=Required) Financial Resource Status ! 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 [0..1] Organization Original request resource reference request : Reference [0..1] « Any » Transaction status: error, complete, held outcome : Coding CodeableConcept [0..1] « Local status of outcome codes (Strength=Example) Process Outcome ?? » 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, which may be business version or standard/version. (Strength=Example) 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, which may be business version or standard/version. (Strength=Example) 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 [0..1] « Organization » The practitioner who is responsible for the services rendered to the patient requestProvider : Reference [0..1] « Practitioner » The organization which is responsible for the services rendered to the patient requestOrganization : Reference [0..1] « Organization » The form to be used for printing the content form : Coding CodeableConcept [0..1] « The forms codes. (Strength=Required) (Strength=Example) Form ! » ?? Processing errors error : Coding CodeableConcept [0..*] « The error codes for adjudication processing. (Strength=Required) (Strength=Example) Adjudication Error ! » ?? Request for additional supporting or authorizing information, such as: documents, images or resources communicationRequest : Reference [0..*] CommunicationRequest Notes ProcessNote The note purpose: Print/Display type : Coding CodeableConcept [0..1] « The presentation types of notes. (Strength=Required) NoteType ! » The note text text : string [0..1] Suite of processing note notes or additional requirements is if the processing has been held notes processNote [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>
 <</request>
 <</outcome>
 <
 <</ruleset>
 <</originalRuleset>
 <
 <</organization>
 <</requestProvider>
 <</requestOrganization>
 <</form>
 <
  <</type>
  <
 </notes>
 <</error>

 <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><!-- 0..1 CodeableConcept Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible Practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <processNote>  <!-- 0..* Processing comments or additional requirements -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <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>

Turtle Template 


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


[ 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 [ CodeableConcept ]; # 0..1 Processing outcome
  fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:ProcessResponse.requestProvider [ Reference(Practitioner) ]; # 0..1 Responsible Practitioner
  fhir:ProcessResponse.requestOrganization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:ProcessResponse.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:ProcessResponse.processNote [ # 0..* Processing comments or additional requirements
    fhir:ProcessResponse.processNote.type [ CodeableConcept ]; # 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.status
  • Added Element
ProcessResponse.outcome
  • Type changed from Coding to CodeableConcept
ProcessResponse.form
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/forms (required)
ProcessResponse.processNote
  • Added Element
ProcessResponse.processNote.type
  • Added Element
ProcessResponse.processNote.text
  • Added Element
ProcessResponse.error
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/adjudication-error (required)
ProcessResponse.communicationRequest
  • Added Element
ProcessResponse.ruleset
  • deleted
ProcessResponse.originalRuleset
  • deleted
ProcessResponse.notes
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

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

doco Documentation for this format

UML Diagram ( Legend )

ProcessResponse ( DomainResource ) The Response business identifier identifier : Identifier [0..*] The status of the resource instance (this element modifies the meaning of other elements) status : code [0..1] A code specifying the state of the resource instance. (Strength=Required) Financial Resource Status ! 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 [0..1] Organization Original request resource reference request : Reference [0..1] « Any » Transaction status: error, complete, held outcome : Coding CodeableConcept [0..1] « Local status of outcome codes (Strength=Example) Process Outcome ?? » 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, which may be business version or standard/version. (Strength=Example) 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, which may be business version or standard/version. (Strength=Example) 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 [0..1] « Organization » The practitioner who is responsible for the services rendered to the patient requestProvider : Reference [0..1] « Practitioner » The organization which is responsible for the services rendered to the patient requestOrganization : Reference [0..1] « Organization » The form to be used for printing the content form : Coding CodeableConcept [0..1] « The forms codes. (Strength=Required) (Strength=Example) Form ! » ?? Processing errors error : Coding CodeableConcept [0..*] « The error codes for adjudication processing. (Strength=Required) (Strength=Example) Adjudication Error ! » ?? Request for additional supporting or authorizing information, such as: documents, images or resources communicationRequest : Reference [0..*] CommunicationRequest Notes ProcessNote The note purpose: Print/Display type : Coding CodeableConcept [0..1] « The presentation types of notes. (Strength=Required) NoteType ! » The note text text : string [0..1] Suite of processing note notes or additional requirements is if the processing has been held notes processNote [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>
 <</request>
 <</outcome>
 <
 <</ruleset>
 <</originalRuleset>
 <
 <</organization>
 <</requestProvider>
 <</requestOrganization>
 <</form>
 <
  <</type>
  <
 </notes>
 <</error>

 <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><!-- 0..1 CodeableConcept Processing outcome --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible Practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <processNote>  <!-- 0..* Processing comments or additional requirements -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <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>

Turtle Template 


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


[ 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 [ CodeableConcept ]; # 0..1 Processing outcome
  fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message
  fhir:ProcessResponse.requestProvider [ Reference(Practitioner) ]; # 0..1 Responsible Practitioner
  fhir:ProcessResponse.requestOrganization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:ProcessResponse.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:ProcessResponse.processNote [ # 0..* Processing comments or additional requirements
    fhir:ProcessResponse.processNote.type [ CodeableConcept ]; # 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.status
  • Added Element
ProcessResponse.outcome
  • Type changed from Coding to CodeableConcept
ProcessResponse.form
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/forms (required)
ProcessResponse.processNote
  • Added Element
ProcessResponse.processNote.type
  • Added Element
ProcessResponse.processNote.text
  • Added Element
ProcessResponse.error
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/adjudication-error (required)
ProcessResponse.communicationRequest
  • Added Element
ProcessResponse.ruleset
  • deleted
ProcessResponse.originalRuleset
  • deleted
ProcessResponse.notes
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

 

Alternate definitions: Schema / Schematron , Resource Profile Master Definition ( XML , JSON ), Questionnaire XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle )

5.9.2.1 12.21.2.1 Terminology Bindings

ProcessResponse.outcome ProcessResponse.ruleset ProcessResponse.originalRuleset ProcessResponse.notes.type
Path Definition Type Reference
ProcessResponse.status Local status A code specifying the state of outcome codes the resource instance. Example Required Process Outcome Financial Resource Status Codes
ProcessResponse.outcome The static and dynamic model to which contents conform, which may be business version or standard/version. Local status of outcome codes Example Ruleset Process Outcome Codes
ProcessResponse.form The forms codes. Required Example Form Codes
ProcessResponse.processNote.type The presentation types of notes. Required NoteType
ProcessResponse.error The error codes for adjudication processing. Required Example Adjudication Error Codes

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