FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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

12.21 Resource ProcessResponse - Content

Financial Management Work GroupMaturity Level: 2 Trial UseCompartments: Practitioner

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

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 resource.

12.21.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcessResponse DomainResourceProcessResponse resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Authoring Organization
... request 0..1Reference(Any)Request reference
... outcome 0..1CodeableConceptProcessing outcome
Process Outcome Codes (Example)
... disposition 0..1stringDisposition Message
... requestProvider 0..1Reference(Practitioner)Responsible Practitioner
... requestOrganization 0..1Reference(Organization)Responsible organization
... form 0..1CodeableConceptPrinted Form Identifier
Form Codes (Example)
... processNote 0..*BackboneElementProcessing comments or additional requirements
.... type 0..1CodeableConceptdisplay | print | printoper
NoteType (Required)
.... text 0..1stringComment on the processing
... error 0..*CodeableConceptError code
Adjudication Error Codes (Example)
... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information

doco Documentation for this format

UML Diagram (Legend)

ProcessResponse (DomainResource)The Response business identifieridentifier : 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 completedcreated : dateTime [0..1]The organization who produced this adjudicated responseorganization : Reference [0..1] Organization Original request resource referencerequest : Reference [0..1] Any Transaction status: error, complete, heldoutcome : CodeableConcept [0..1] Local status of outcome codes (Strength=Example)Process Outcome ?? A description of the status of the adjudication or processingdisposition : string [0..1]The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference [0..1] Practitioner The organization which is responsible for the services rendered to the patientrequestOrganization : Reference [0..1] Organization The form to be used for printing the contentform : CodeableConcept [0..1] The forms codes. (Strength=Example)Form ?? Processing errorserror : CodeableConcept [0..*] The error codes for adjudication processing. (Strength=Example)Adjudication Error ?? Request for additional supporting or authorizing information, such as: documents, images or resourcescommunicationRequest : Reference [0..*] CommunicationRequest ProcessNoteThe note purpose: Print/Displaytype : CodeableConcept [0..1] The presentation types of notes. (Strength=Required)NoteType! The note texttext : string [0..1]Suite of processing notes or additional requirements if the processing has been heldprocessNote[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>
 <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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcessResponse DomainResourceProcessResponse resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Authoring Organization
... request 0..1Reference(Any)Request reference
... outcome 0..1CodeableConceptProcessing outcome
Process Outcome Codes (Example)
... disposition 0..1stringDisposition Message
... requestProvider 0..1Reference(Practitioner)Responsible Practitioner
... requestOrganization 0..1Reference(Organization)Responsible organization
... form 0..1CodeableConceptPrinted Form Identifier
Form Codes (Example)
... processNote 0..*BackboneElementProcessing comments or additional requirements
.... type 0..1CodeableConceptdisplay | print | printoper
NoteType (Required)
.... text 0..1stringComment on the processing
... error 0..*CodeableConceptError code
Adjudication Error Codes (Example)
... communicationRequest 0..*Reference(CommunicationRequest)Request for additional information

doco Documentation for this format

UML Diagram (Legend)

ProcessResponse (DomainResource)The Response business identifieridentifier : 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 completedcreated : dateTime [0..1]The organization who produced this adjudicated responseorganization : Reference [0..1] Organization Original request resource referencerequest : Reference [0..1] Any Transaction status: error, complete, heldoutcome : CodeableConcept [0..1] Local status of outcome codes (Strength=Example)Process Outcome ?? A description of the status of the adjudication or processingdisposition : string [0..1]The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference [0..1] Practitioner The organization which is responsible for the services rendered to the patientrequestOrganization : Reference [0..1] Organization The form to be used for printing the contentform : CodeableConcept [0..1] The forms codes. (Strength=Example)Form ?? Processing errorserror : CodeableConcept [0..*] The error codes for adjudication processing. (Strength=Example)Adjudication Error ?? Request for additional supporting or authorizing information, such as: documents, images or resourcescommunicationRequest : Reference [0..*] CommunicationRequest ProcessNoteThe note purpose: Print/Displaytype : CodeableConcept [0..1] The presentation types of notes. (Strength=Required)NoteType! The note texttext : string [0..1]Suite of processing notes or additional requirements if the processing has been heldprocessNote[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>
 <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: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

12.21.2.1 Terminology Bindings

PathDefinitionTypeReference
ProcessResponse.status A code specifying the state of the resource instance.RequiredFinancial Resource Status Codes
ProcessResponse.outcome Local status of outcome codesExampleProcess Outcome Codes
ProcessResponse.form The forms codes.ExampleForm Codes
ProcessResponse.processNote.type The presentation types of notes.RequiredNoteType
ProcessResponse.error The error codes for adjudication processing.ExampleAdjudication Error Codes

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.

NameTypeDescriptionExpressionIn Common
identifiertokenThe business identifier of the Explanation of BenefitProcessResponse.identifier
organizationreferenceThe organization who generated this resourceProcessResponse.organization
(Organization)
requestreferenceThe reference to the claimProcessResponse.request
(Any)
request-organizationreferenceThe Organization who is responsible the request transactionProcessResponse.requestOrganization
(Organization)
request-providerreferenceThe Provider who is responsible the request transactionProcessResponse.requestProvider
(Practitioner)