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.6.5 Resource ProcessRequest - Detailed Descriptions

Detailed Descriptions for the elements in the ProcessRequest resource.

ProcessRequest
Definition

This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.

Control1..1
ProcessRequest.identifier
Definition

The ProcessRequest business identifier.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
ProcessRequest.status
Definition

The status of the resource instance.

Control1..1
BindingProcessRequestStatus: A code specifying the state of the resource instance. (Required)
Typecode
Is Modifiertrue
Summarytrue
ProcessRequest.ruleset
Definition

The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

Control0..1
BindingRuleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example)
TypeCoding
ProcessRequest.originalRuleset
Definition

The style (standard) and version of the original material which was converted into this resource.

Control0..1
BindingRuleset Codes: The static and dynamic model to which contents conform, which may be business version or standard/version. (Example)
TypeCoding
Requirements

Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.

ProcessRequest.action
Definition

The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.

Control1..1
BindingActionList: List of allowable action which this resource can request. (Required)
Typecode
ProcessRequest.created
Definition

The date when this resource was created.

Control0..1
TypedateTime
ProcessRequest.target[x]
Definition

The organization which is the target of the request.

Control0..1
TypeIdentifier|Reference(Organization)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ProcessRequest.provider[x]
Definition

The practitioner who is responsible for the action specified in this request.

Control0..1
TypeIdentifier|Reference(Practitioner)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ProcessRequest.organization[x]
Definition

The organization which is responsible for the action speccified in this request.

Control0..1
TypeIdentifier|Reference(Organization)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ProcessRequest.request[x]
Definition

Reference of resource which is the target or subject of this action.

Control0..1
TypeIdentifier|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ProcessRequest.response[x]
Definition

Reference of a prior response to resource which is the target or subject of this action.

Control0..1
TypeIdentifier|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
ProcessRequest.nullify
Definition

If true remove all history excluding audit.

Control0..1
Typeboolean
Requirements

Some resources must not simply be reversed in a processing or accounting sense but rather must have all history removed, such as the accidental submission of sensitive and/or wrong information. If the receiver cannot comply with a Nullify request then they must reject the request.

ProcessRequest.reference
Definition

A reference to supply which authenticates the process.

Control0..1
Typestring
ProcessRequest.item
Definition

List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

Control0..*
ProcessRequest.item.sequenceLinkId
Definition

A service line number.

Control1..1
Typeinteger
ProcessRequest.include
Definition

Names of resource types to include.

Control0..*
Typestring
ProcessRequest.exclude
Definition

Names of resource types to exclude.

Control0..*
Typestring
ProcessRequest.period
Definition

A period of time during which the fulfilling resources would have been created.

Control0..1
TypePeriod