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
This resource provides processing status, errors and notes from the processing of a resource.
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.
Structure
UML Diagram (Legend)
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>
JSON Template
{doco
"resourceType" : "ProcessResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier
"status" : "<code >", // active | cancelled | draft | entered-in-error
"created" : "<dateTime >", // Creation date
"organization" : { Reference(Organization) }, // Authoring Organization
"request" : { Reference(Any) }, // Request reference
"outcome" : { CodeableConcept }, // Processing outcome
"disposition" : "<string >", // Disposition Message
"requestProvider" : { Reference(Practitioner) }, // Responsible Practitioner
"requestOrganization" : { Reference(Organization) }, // Responsible organization
"form" : { CodeableConcept }, // Printed Form Identifier
"processNote" : [{ // Processing comments or additional requirements
"type" : { CodeableConcept }, // display | print | printoper
"text" : "<string >" // Comment on the processing
}],
"error" : [{ CodeableConcept }], // Error code
"communicationRequest" : [{ Reference(CommunicationRequest) }] // Request for additional information
}
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
See the Full Difference for further information
Structure
UML Diagram (Legend)
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>
JSON Template
{doco
"resourceType" : "ProcessResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier
"status" : "<code >", // active | cancelled | draft | entered-in-error
"created" : "<dateTime >", // Creation date
"organization" : { Reference(Organization) }, // Authoring Organization
"request" : { Reference(Any) }, // Request reference
"outcome" : { CodeableConcept }, // Processing outcome
"disposition" : "<string >", // Disposition Message
"requestProvider" : { Reference(Practitioner) }, // Responsible Practitioner
"requestOrganization" : { Reference(Organization) }, // Responsible organization
"form" : { CodeableConcept }, // Printed Form Identifier
"processNote" : [{ // Processing comments or additional requirements
"type" : { CodeableConcept }, // display | print | printoper
"text" : "<string >" // Comment on the processing
}],
"error" : [{ CodeableConcept }], // Error code
"communicationRequest" : [{ Reference(CommunicationRequest) }] // Request for additional information
}
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
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
| 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. | Example | Form Codes |
| ProcessResponse.processNote.type | The presentation types of notes. | Required | NoteType |
| ProcessResponse.error | The error codes for adjudication processing. | Example | Adjudication Error Codes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.