FHIR Release 3 (STU) R5 Final QA

This page is part of the FHIR Specification (v3.0.2: STU (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes 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

Content Examples Detailed Descriptions Mappings
Profiles & Extensions

12.21 4.3.2.424 Resource ProcessResponse - Content CodeSystem http://hl7.org/fhir/artifactassessment-disposition

Financial Management Clinical Decision Support icon Work Group   Maturity Level : 2 1   Trial Use Compartments Use Context : Practitioner Country: World
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 Name Flags Card. Type Description & Constraints status ?! Σ 0..1 code disposition 0..1 string
Official URL : http://hl7.org/fhir/artifactassessment-disposition ProcessResponse DomainResource ProcessResponse resource Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension identifier 0..* Identifier Business Identifier Version : 5.0.0-draft-final
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 CodeableConcept as of 2021-01-05 Processing outcome Computable Name : ArtifactAssessmentDisposition Process Outcome Codes ( Example )
Flags : CaseSensitive, Complete. All codes ValueSet: Artifact Assessment Disposition Message requestProvider 0..1 Reference ( Practitioner ) Responsible Practitioner requestOrganization 0..1 Reference ( Organization ) Responsible organization form 0..1 CodeableConcept Printed Form Identifier Form Codes ( Example ) processNote 0..* BackboneElement Processing comments or additional requirements type 0..1 CodeableConcept 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 OID : 2.16.840.1.113883.4.642.4.2024

UML Diagram ( Legend ) This Code system is used in the following value sets:

ProcessResponse ( DomainResource ) The Response business identifier identifier : Identifier
  • ValueSet: Artifact Assessment Disposition [0..*] The status of the resource instance (this element modifies (Possible values for the meaning disposition of other elements) status : code [0..1] A code specifying a comment or change request, typically used for comments and change requests, to indicate the state disposition of the resource instance. (Strength=Required) Financial Resource Status ! The date when responsible party towards the enclosed suite of services were performed changes suggested by the comment or completed created : dateTime [0..1] change request.)
The organization who produced this adjudicated response organization : Reference [0..1] Organization

Original request resource reference request : Reference [0..1] Any 4.3.2.424.1 Definition Transaction status: error, complete, held outcome : CodeableConcept [0..1] Local status of outcome codes (Strength=Example) Process Outcome ?? A description of

Possible values for the status disposition of the adjudication a comment or processing disposition : string [0..1] The practitioner who is responsible change request, typically used for the services rendered comments and change requests, to indicate the patient requestProvider : Reference [0..1] Practitioner The organization which is responsible for disposition of the services rendered to responsible party towards the patient requestOrganization : Reference [0..1] Organization The form to be used for printing changes suggested by the content form : CodeableConcept [0..1] The forms codes. (Strength=Example) Form ?? Processing errors error : CodeableConcept [0..*] The error codes for adjudication processing. (Strength=Example) Adjudication Error ?? Request for additional supporting or authorizing information, such as: documents, images comment or resources communicationRequest : Reference [0..*] CommunicationRequest ProcessNote change request.

The note purpose: Print/Display type : CodeableConcept [0..1] The presentation types of notes. (Strength=Required) NoteType ! The note text text : string [0..1]

4.3.2.424.2 Content Suite of processing notes or additional requirements if the processing has been held processNote [0..*]

XML Template This code system http://hl7.org/fhir/artifactassessment-disposition defines the following codes:

< <!-- from --> <!-- from --> <</identifier> < < <</organization> <</request> <</outcome> < <</requestProvider> <</requestOrganization> <</form> < <</type> < </processNote> <</error> <</communicationRequest> </ProcessResponse> JSON Template { "resourceType" : "", // from // from " " " " " " " " " " " " " }], " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: ] 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 . 0..1 dateTime Creation date organization 0..1 Reference ( Organization ) Authoring Organization request outcome 0..1 CodeableConcept Processing outcome Process Outcome Codes ( Example ) disposition 0..1 string Disposition Message requestProvider requestOrganization 0..1 Reference ( Organization ) Responsible organization form processNote 0..* BackboneElement Processing comments or additional requirements type text 0..1 string Comment on the processing error 0..* communicationRequest 0..* Reference ( CommunicationRequest ) Request for additional information
Changes since DSTU2 Code ProcessResponse ProcessResponse.status Structure Display Name Flags Card. Type Description & Constraints ProcessResponse 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 Definition 0..1 Reference ( Any ) Copy Request reference
unresolved Unresolved The comment is unresolved btn 0..1   btn Reference ( Practitioner ) Responsible Practitioner
not-persuasive Not Persuasive The comment is not persuasive (rejected in full) 0..1 btn CodeableConcept   btn Printed Form Identifier Form Codes ( Example )
persuasive Persuasive The comment is persuasive (accepted in full) 0..1 btn CodeableConcept   btn display | print | printoper NoteType ( Required )
persuasive-with-modification Persuasive with Modification The comment is persuasive with modification (partially accepted) CodeableConcept btn   Error code btn Adjudication Error Codes ( Example )
not-persuasive-with-modification Not Persuasive with Modification The comment is not persuasive with modification (partially rejected) btn   btn 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 : 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=Example) Form ?? Processing errors error : CodeableConcept [0..*] The error codes for adjudication processing. (Strength=Example) Adjudication Error ?? Request for additional supporting or authorizing information, such as: documents, images or resources communicationRequest : Reference [0..*] CommunicationRequest ProcessNote 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 notes or additional requirements if the processing has been held processNote [0..*] XML Template < <!-- from --> <!-- from --> <</identifier> < < <</organization> <</request> <</outcome> < <</requestProvider> <</requestOrganization> <</form> < <</type> < </processNote> <</error> <</communicationRequest> </ProcessResponse>

JSON Template { "resourceType" : "", // from // from " " " " " " " " " " " " " }], " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: ] 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 full registry of code systems for further information This analysis is available defined as XML or JSON .   part of FHIR.

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) 12.21.2.1 Terminology Bindings Path Definition Type Reference ProcessResponse.status A code specifying the state Explanation 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. Example Form Codes columns that may appear on this page:

ProcessResponse.processNote.type The presentation types of notes. ProcessResponse.organization ( Organization )
Required NoteType ProcessResponse.error The error codes for adjudication processing. Level Example Adjudication Error Codes 12.21.3 Search Parameters Search parameters for this resource. The common parameters also apply. A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Searching Code System for more information about searching in REST, messaging, and services. Name Type Description Expression In Common further information.
identifier token Source The business identifier source of the Explanation definition of Benefit ProcessResponse.identifier the code (when the value set draws in codes defined elsewhere)
organization reference Code The organization who generated this code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
request reference Display The reference to display (used in the claim ProcessResponse.request (Any) display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application
request-organization reference Definition The Organization who is responsible An explanation of the request transaction ProcessResponse.requestOrganization ( Organization ) meaning of the concept
request-provider reference Comments The Provider who is responsible Additional notes about how to use the request transaction ProcessResponse.requestProvider ( Practitioner ) code