This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R3
R2
|
|
Compartments
|
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 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.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource | ProcessResponse resource | ||
|
0..* |
|
|
|
|
?! Σ |
|
|
ProcessResponseStatus ( Required ) |
|
0..1 | Request reference | ||
![]() ![]() ![]() |
|
|||
|
Reference ( Any ) | |||
|
0..1 | Coding |
|
|
|
0..1 | string |
|
|
|
0..1 | Coding |
|
|
|
0..1 | Coding |
|
|
|
0..1 | dateTime |
|
|
|
0..1 | Authoring Organization | ||
![]() ![]() ![]() |
|
|||
|
Reference ( Organization ) | |||
|
0..1 | Responsible Practitioner | ||
![]() ![]() ![]() |
| |||
![]() ![]() ![]() |
Reference ( Practitioner ) | |||
|
0..1 | Responsible organization | ||
![]() ![]() ![]() |
|
|||
|
Reference ( Organization ) | |||
|
0..1 | Coding |
|
|
|
0..* | BackboneElement | Notes | |
|
0..1 | Coding |
NoteType |
|
|
0..1 | string |
|
|
|
0..* | Coding |
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<ProcessResponse xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</request> <</outcome> < <</ruleset> <</originalRuleset> < <</organization> <</requestProvider> <</requestOrganization> <</form> < <</type> <<identifier><!-- 0..* Identifier Business Identifier --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <request[x]><!-- 0..1 Identifier|Reference(Any) Request reference --></request[x]> <outcome><!-- 0..1 Coding Processing outcome --></outcome> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Authoring Organization --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible Practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <form><!-- 0..1 Coding Printed Form Identifier --></form> <notes> <!-- 0..* Notes --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Notes text --> </notes><</error><error><!-- 0..* Coding Error code --></error> </ProcessResponse>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "ProcessResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Business Identifier
"status" : "<code>", // R! active | cancelled | draft | entered-in-error
// request[x]: Request reference. One of these 2:
"requestIdentifier" : { Identifier },
"requestReference" : { Reference(Any) },
"outcome" : { Coding }, // Processing outcome
"disposition" : "<string>", // Disposition Message
"ruleset" : { Coding }, // Resource version
"originalRuleset" : { Coding }, // Original version
"created" : "<dateTime>", // Creation date
// organization[x]: Authoring Organization. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
// requestProvider[x]: Responsible Practitioner. One of these 2:
"requestProviderIdentifier" : { Identifier },
"requestProviderReference" : { Reference(Practitioner) },
// requestOrganization[x]: Responsible organization. One of these 2:
"requestOrganizationIdentifier" : { Identifier },
"requestOrganizationReference" : { Reference(Organization) },
"form" : { Coding }, // Printed Form Identifier
"notes" : [{ // Notes
"type" : { Coding }, // display | print | printoper
"text" : "<string>" // Notes text
}],
"
"error" : [{ Coding }] // Error code
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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 ]; # 1..1 active | cancelled | draft | entered-in-error # ProcessResponse.request[x] : 0..1 Request reference. One of these 2 fhir:ProcessResponse.requestIdentifier [ Identifier ] fhir:ProcessResponse.requestReference [ Reference(Any) ] fhir:ProcessResponse.outcome [ Coding ]; # 0..1 Processing outcome fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message fhir:ProcessResponse.ruleset [ Coding ]; # 0..1 Resource version fhir:ProcessResponse.originalRuleset [ Coding ]; # 0..1 Original version fhir:ProcessResponse.created [ dateTime ]; # 0..1 Creation date # ProcessResponse.organization[x] : 0..1 Authoring Organization. One of these 2 fhir:ProcessResponse.organizationIdentifier [ Identifier ] fhir:ProcessResponse.organizationReference [ Reference(Organization) ] # ProcessResponse.requestProvider[x] : 0..1 Responsible Practitioner. One of these 2 fhir:ProcessResponse.requestProviderIdentifier [ Identifier ] fhir:ProcessResponse.requestProviderReference [ Reference(Practitioner) ] # ProcessResponse.requestOrganization[x] : 0..1 Responsible organization. One of these 2 fhir:ProcessResponse.requestOrganizationIdentifier [ Identifier ] fhir:ProcessResponse.requestOrganizationReference [ Reference(Organization) ] fhir:ProcessResponse.form [ Coding ]; # 0..1 Printed Form Identifier fhir:ProcessResponse.notes [ # 0..* Notes fhir:ProcessResponse.notes.type [ Coding ]; # 0..1 display | print | printoper fhir:ProcessResponse.notes.text [ string ]; # 0..1 Notes text ], ...; fhir:ProcessResponse.error [ Coding ], ... ; # 0..* Error code ]
Changes since DSTU2
| ProcessResponse | |
| ProcessResponse.status | added |
| ProcessResponse.request[x] | Renamed from request to request[x] Add Identifier |
| ProcessResponse.organization[x] | Renamed from organization to organization[x] Add Identifier |
| ProcessResponse.requestProvider[x] | Renamed from requestProvider to requestProvider[x] Add Identifier |
| ProcessResponse.requestOrganization[x] | Renamed from requestOrganization to requestOrganization[x] Add Identifier |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
DomainResource | ProcessResponse resource | ||
|
0..* | Identifier |
|
|
|
?! Σ |
|
|
ProcessResponseStatus ( Required ) |
|
0..1 | Request reference | ||
![]() ![]() ![]() |
| |||
![]() ![]() ![]() |
Reference ( Any ) | |||
|
0..1 | Coding |
|
|
|
0..1 | string |
|
|
|
0..1 | Coding |
|
|
|
0..1 | Coding |
|
|
|
0..1 | dateTime |
|
|
|
0..1 | Authoring Organization | ||
![]() ![]() ![]() |
| |||
![]() ![]() ![]() |
Reference ( Organization ) | |||
|
0..1 | Responsible Practitioner | ||
![]() ![]() ![]() |
|
|||
|
Reference ( Practitioner ) | |||
|
0..1 | Responsible organization | ||
![]() ![]() ![]() |
| |||
![]() ![]() ![]() |
Reference ( Organization ) | |||
|
0..1 | Coding |
|
|
|
0..* | BackboneElement | Notes | |
|
0..1 | Coding |
NoteType |
|
|
0..1 | string |
|
|
|
0..* | Coding |
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<ProcessResponse xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</request> <</outcome> < <</ruleset> <</originalRuleset> < <</organization> <</requestProvider> <</requestOrganization> <</form> < <</type> <<identifier><!-- 0..* Identifier Business Identifier --></identifier> <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error --> <request[x]><!-- 0..1 Identifier|Reference(Any) Request reference --></request[x]> <outcome><!-- 0..1 Coding Processing outcome --></outcome> <disposition value="[string]"/><!-- 0..1 Disposition Message --> <ruleset><!-- 0..1 Coding Resource version --></ruleset> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <organization[x]><!-- 0..1 Identifier|Reference(Organization) Authoring Organization --></organization[x]> <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible Practitioner --></requestProvider[x]> <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]> <form><!-- 0..1 Coding Printed Form Identifier --></form> <notes> <!-- 0..* Notes --> <type><!-- 0..1 Coding display | print | printoper --></type> <text value="[string]"/><!-- 0..1 Notes text --> </notes><</error><error><!-- 0..* Coding Error code --></error> </ProcessResponse>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "ProcessResponse",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // Business Identifier
"status" : "<code>", // R! active | cancelled | draft | entered-in-error
// request[x]: Request reference. One of these 2:
"requestIdentifier" : { Identifier },
"requestReference" : { Reference(Any) },
"outcome" : { Coding }, // Processing outcome
"disposition" : "<string>", // Disposition Message
"ruleset" : { Coding }, // Resource version
"originalRuleset" : { Coding }, // Original version
"created" : "<dateTime>", // Creation date
// organization[x]: Authoring Organization. One of these 2:
"organizationIdentifier" : { Identifier },
"organizationReference" : { Reference(Organization) },
// requestProvider[x]: Responsible Practitioner. One of these 2:
"requestProviderIdentifier" : { Identifier },
"requestProviderReference" : { Reference(Practitioner) },
// requestOrganization[x]: Responsible organization. One of these 2:
"requestOrganizationIdentifier" : { Identifier },
"requestOrganizationReference" : { Reference(Organization) },
"form" : { Coding }, // Printed Form Identifier
"notes" : [{ // Notes
"type" : { Coding }, // display | print | printoper
"text" : "<string>" // Notes text
}],
"
"error" : [{ Coding }] // Error code
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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 ]; # 1..1 active | cancelled | draft | entered-in-error # ProcessResponse.request[x] : 0..1 Request reference. One of these 2 fhir:ProcessResponse.requestIdentifier [ Identifier ] fhir:ProcessResponse.requestReference [ Reference(Any) ] fhir:ProcessResponse.outcome [ Coding ]; # 0..1 Processing outcome fhir:ProcessResponse.disposition [ string ]; # 0..1 Disposition Message fhir:ProcessResponse.ruleset [ Coding ]; # 0..1 Resource version fhir:ProcessResponse.originalRuleset [ Coding ]; # 0..1 Original version fhir:ProcessResponse.created [ dateTime ]; # 0..1 Creation date # ProcessResponse.organization[x] : 0..1 Authoring Organization. One of these 2 fhir:ProcessResponse.organizationIdentifier [ Identifier ] fhir:ProcessResponse.organizationReference [ Reference(Organization) ] # ProcessResponse.requestProvider[x] : 0..1 Responsible Practitioner. One of these 2 fhir:ProcessResponse.requestProviderIdentifier [ Identifier ] fhir:ProcessResponse.requestProviderReference [ Reference(Practitioner) ] # ProcessResponse.requestOrganization[x] : 0..1 Responsible organization. One of these 2 fhir:ProcessResponse.requestOrganizationIdentifier [ Identifier ] fhir:ProcessResponse.requestOrganizationReference [ Reference(Organization) ] fhir:ProcessResponse.form [ Coding ]; # 0..1 Printed Form Identifier fhir:ProcessResponse.notes [ # 0..* Notes fhir:ProcessResponse.notes.type [ Coding ]; # 0..1 display | print | printoper fhir:ProcessResponse.notes.text [ string ]; # 0..1 Notes text ], ...; fhir:ProcessResponse.error [ Coding ], ... ; # 0..* Error code ]
Changes since DSTU2
| ProcessResponse | |
| ProcessResponse.status | added |
| ProcessResponse.request[x] | Renamed from request to request[x] Add Identifier |
| ProcessResponse.organization[x] | Renamed from organization to organization[x] Add Identifier |
| ProcessResponse.requestProvider[x] | Renamed from requestProvider to requestProvider[x] Add Identifier |
| ProcessResponse.requestOrganization[x] | Renamed from requestOrganization to requestOrganization[x] Add Identifier |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| ProcessResponse.status | A code specifying the state of the resource instance. |
Required
|
|
| ProcessResponse.outcome | Local status of outcome codes | Example |
|
|
ProcessResponse.ruleset
|
|
Example |
|
| ProcessResponse.form |
|
Required |
|
| ProcessResponse.notes.type |
|
Required | NoteType |
| ProcessResponse.error |
|
Required |
|
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| identifier | token |
|
ProcessResponse.identifier |
|
| token | The organization who generated this resource | ProcessResponse.organizationIdentifier |
| organization-reference | reference |
|
( Organization ) |
|
|
|
|
|
|
| token | The Organization who is responsible the request transaction | ProcessResponse.requestOrganizationIdentifier |
| request-organization-reference | reference |
|
( Organization ) |
|
| token | The Provider who is responsible the request transaction | ProcessResponse.requestProviderIdentifier |
| request-provider-reference | reference |
|
( Practitioner ) |
| request-reference |
reference
|
The reference to the claim |
ProcessResponse.requestReference
(Any) |