STU 3 Ballot

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 . Page versions: R3 R2

12.7 Resource ProcessResponse - Content

Financial Management Work GroupMaturity Level: 1Compartments: Practitioner

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

12.7.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.7.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcessResponse DomainResourceProcessResponse resource
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
ProcessResponseStatus (Required)
... request[x] 0..1Request reference
.... requestIdentifierIdentifier
.... requestReferenceReference(Any)
... outcome 0..1CodingProcessing outcome
Process Outcome Codes (Example)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset Codes (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset Codes (Example)
... created 0..1dateTimeCreation date
... organization[x] 0..1Authoring Organization
.... organizationIdentifierIdentifier
.... organizationReferenceReference(Organization)
... requestProvider[x] 0..1Responsible Practitioner
.... requestProviderIdentifierIdentifier
.... requestProviderReferenceReference(Practitioner)
... requestOrganization[x] 0..1Responsible organization
.... requestOrganizationIdentifierIdentifier
.... requestOrganizationReferenceReference(Organization)
... form 0..1CodingPrinted Form Identifier
Form Codes (Required)
... notes 0..*BackboneElementNotes
.... type 0..1Codingdisplay | print | printoper
NoteType (Required)
.... text 0..1stringNotes text
... error 0..*CodingError code
Adjudication Error Codes (Required)

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 [1..1] « A code specifying the state of the resource instance. (Strength=Required)ProcessResponseStatus! »Original request resource referencerequest[x] : Type [0..1] « Identifier|Reference(Any) »Transaction status: error, complete, heldoutcome : Coding [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 version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The date when the enclosed suite of services were performed or completedcreated : dateTime [0..1]The organization who produced this adjudicated responseorganization[x] : Type [0..1] « Identifier|Reference(Organization) »The practitioner who is responsible for the services rendered to the patientrequestProvider[x] : Type [0..1] « Identifier|Reference(Practitioner) »The organization which is responsible for the services rendered to the patientrequestOrganization[x] : Type [0..1] « Identifier|Reference( Organization) »The form to be used for printing the contentform : Coding [0..1] « The forms codes. (Strength=Required)Form ! »Processing errorserror : Coding [0..*] « The error codes for adjudication processing. (Strength=Required)Adjudication Error ! »NotesThe note purpose: Print/Displaytype : Coding [0..1] « The presentation types of notes. (Strength=Required)NoteType! »The note texttext : string [0..1]Suite of processing note or additional requirements is the processing has been heldnotes[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]"/><!-- 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><!-- 0..* Coding Error code --></error>
</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>", // 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/> .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 ]; # 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProcessResponse DomainResourceProcessResponse resource
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
ProcessResponseStatus (Required)
... request[x] 0..1Request reference
.... requestIdentifierIdentifier
.... requestReferenceReference(Any)
... outcome 0..1CodingProcessing outcome
Process Outcome Codes (Example)
... disposition 0..1stringDisposition Message
... ruleset 0..1CodingResource version
Ruleset Codes (Example)
... originalRuleset 0..1CodingOriginal version
Ruleset Codes (Example)
... created 0..1dateTimeCreation date
... organization[x] 0..1Authoring Organization
.... organizationIdentifierIdentifier
.... organizationReferenceReference(Organization)
... requestProvider[x] 0..1Responsible Practitioner
.... requestProviderIdentifierIdentifier
.... requestProviderReferenceReference(Practitioner)
... requestOrganization[x] 0..1Responsible organization
.... requestOrganizationIdentifierIdentifier
.... requestOrganizationReferenceReference(Organization)
... form 0..1CodingPrinted Form Identifier
Form Codes (Required)
... notes 0..*BackboneElementNotes
.... type 0..1Codingdisplay | print | printoper
NoteType (Required)
.... text 0..1stringNotes text
... error 0..*CodingError code
Adjudication Error Codes (Required)

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 [1..1] « A code specifying the state of the resource instance. (Strength=Required)ProcessResponseStatus! »Original request resource referencerequest[x] : Type [0..1] « Identifier|Reference(Any) »Transaction status: error, complete, heldoutcome : Coding [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 version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resourcesruleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The style (standard) and version of the original material which was converted into this resourceoriginalRuleset : Coding [0..1] « The static and dynamic model to which contents conform, which may be business version or standard/version. (Strength=Example)Ruleset ?? »The date when the enclosed suite of services were performed or completedcreated : dateTime [0..1]The organization who produced this adjudicated responseorganization[x] : Type [0..1] « Identifier|Reference(Organization) »The practitioner who is responsible for the services rendered to the patientrequestProvider[x] : Type [0..1] « Identifier|Reference(Practitioner) »The organization which is responsible for the services rendered to the patientrequestOrganization[x] : Type [0..1] « Identifier|Reference( Organization) »The form to be used for printing the contentform : Coding [0..1] « The forms codes. (Strength=Required)Form ! »Processing errorserror : Coding [0..*] « The error codes for adjudication processing. (Strength=Required)Adjudication Error ! »NotesThe note purpose: Print/Displaytype : Coding [0..1] « The presentation types of notes. (Strength=Required)NoteType! »The note texttext : string [0..1]Suite of processing note or additional requirements is the processing has been heldnotes[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]"/><!-- 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><!-- 0..* Coding Error code --></error>
</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>", // 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/> .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 ]; # 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 (for ) + JSON Schema, ShEx (for Turtle)

12.7.2.1 Terminology Bindings

PathDefinitionTypeReference
ProcessResponse.status A code specifying the state of the resource instance.RequiredProcessResponseStatus
ProcessResponse.outcome Local status of outcome codesExampleProcess Outcome Codes
ProcessResponse.ruleset
ProcessResponse.originalRuleset 		The static and dynamic model to which contents conform, which may be business version or standard/version.ExampleRuleset Codes
ProcessResponse.form The forms codes.RequiredForm Codes
ProcessResponse.notes.type The presentation types of notes.RequiredNoteType
ProcessResponse.error The error codes for adjudication processing.RequiredAdjudication Error Codes

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

NameTypeDescriptionPaths
identifiertokenThe business identifier of the Explanation of BenefitProcessResponse.identifier
organization-identifiertokenThe organization who generated this resourceProcessResponse.organizationIdentifier
organization-referencereferenceThe organization who generated this resourceProcessResponse.organizationReference
(Organization)
request-identifiertokenThe reference to the claimProcessResponse.requestIdentifier
request-organization-identifiertokenThe Organization who is responsible the request transactionProcessResponse.requestOrganizationIdentifier
request-organization-referencereferenceThe Organization who is responsible the request transactionProcessResponse.requestOrganizationReference
(Organization)
request-provide-ridentifiertokenThe Provider who is responsible the request transactionProcessResponse.requestProviderIdentifier
request-provider-referencereferenceThe Provider who is responsible the request transactionProcessResponse.requestProviderReference
(Practitioner)
request-referencereferenceThe reference to the claimProcessResponse.requestReference
(Any)