STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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.14 Resource ProcessResponse - Content

Financial Management Work Group Maturity Level : 1 Compartments : Practitioner

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

12.14.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 they feel ProcessRequest and ProcessResponse should be retained for.

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.

12.14.2 Resource Content

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 : 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 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 : CodeableConcept [0..1] « The forms codes. (Strength=Required) Form ! » Processing errors error : CodeableConcept [0..*] « The error codes for adjudication processing. (Strength=Required) Adjudication Error ! » Request for additional supporting or authorizing information, such as: documents, images or resources communicationRequest : Reference [0..*] « CommunicationRequest » Note The note purpose: Print/Display type : CodeableConcept [0..1] « The presentation types of notes. (Strength=Required) NoteType ! » The note text text : string [0..1] Suite of processing note or additional requirements is the processing has been held note [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>
 <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>
 <note>  <!-- 0..* Notes -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </note>
 <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.note [ # 0..* Notes
    fhir:ProcessResponse.note.type [ CodeableConcept ]; # 0..1 display | print | printoper
    fhir:ProcessResponse.note.text [ string ]; # 0..1 Notes text
  ], ...;
  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
ProcessResponse.note added Element
ProcessResponse.note.type added Element
ProcessResponse.note.text added Element
ProcessResponse.error Type changed from Coding to CodeableConcept
ProcessResponse.communicationRequest added Element
ProcessResponse.ruleset deleted
ProcessResponse.originalRuleset deleted
ProcessResponse.notes deleted

See the Full Difference for further information

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 : 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 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 : CodeableConcept [0..1] « The forms codes. (Strength=Required) Form ! » Processing errors error : CodeableConcept [0..*] « The error codes for adjudication processing. (Strength=Required) Adjudication Error ! » Request for additional supporting or authorizing information, such as: documents, images or resources communicationRequest : Reference [0..*] « CommunicationRequest » Note The note purpose: Print/Display type : CodeableConcept [0..1] « The presentation types of notes. (Strength=Required) NoteType ! » The note text text : string [0..1] Suite of processing note or additional requirements is the processing has been held note [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>
 <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>
 <note>  <!-- 0..* Notes -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </note>
 <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.note [ # 0..* Notes
    fhir:ProcessResponse.note.type [ CodeableConcept ]; # 0..1 display | print | printoper
    fhir:ProcessResponse.note.text [ string ]; # 0..1 Notes text
  ], ...;
  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
ProcessResponse.note added Element
ProcessResponse.note.type added Element
ProcessResponse.note.text added Element
ProcessResponse.error Type changed from Coding to CodeableConcept
ProcessResponse.communicationRequest added Element
ProcessResponse.ruleset deleted
ProcessResponse.originalRuleset deleted
ProcessResponse.notes deleted

See the Full Difference for further information

 

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ), JSON-LD (for RDF as JSON-LD ),

12.14.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 Example Process Outcome Codes
ProcessResponse.form The forms codes. Required Form Codes
ProcessResponse.note.type The presentation types of notes. Required NoteType
ProcessResponse.error The error codes for adjudication processing. Required Adjudication Error Codes

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