process requests

post
/organizations/{organizationId}/fhir/3/processrequest

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcessRequestThis is a ProcessRequest resource
identifierarray(Identifier)The ProcessRequest business identifier.
statusstringThe status of the resource instance.
actionstringcancel|poll|reprocess|statusThe type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
targetReferenceThe organization which is the target of the request.
createdstringThe date when this resource was created.
providerReferenceThe practitioner who is responsible for the action specified in this request.
organizationReferenceThe organization which is responsible for the action speccified in this request.
requestReferenceReference of resource which is the target or subject of this action.
responseReferenceReference of a prior response to resource which is the target or subject of this action.
nullifybooleanIf true remove all history excluding audit.
referencestringA reference to supply which authenticates the process.
itemarray(ProcessRequest_Item)List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
includearray()Names of resource types to include.
excludearray()Names of resource types to exclude.
periodPeriodA period of time during which the fulfilling resources would have been created.

Response

patch
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcessRequestThis is a ProcessRequest resource
identifierarray(Identifier)The ProcessRequest business identifier.
statusstringThe status of the resource instance.
actionstringcancel|poll|reprocess|statusThe type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
targetReferenceThe organization which is the target of the request.
createdstringThe date when this resource was created.
providerReferenceThe practitioner who is responsible for the action specified in this request.
organizationReferenceThe organization which is responsible for the action speccified in this request.
requestReferenceReference of resource which is the target or subject of this action.
responseReferenceReference of a prior response to resource which is the target or subject of this action.
nullifybooleanIf true remove all history excluding audit.
referencestringA reference to supply which authenticates the process.
itemarray(ProcessRequest_Item)List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
includearray()Names of resource types to include.
excludearray()Names of resource types to exclude.
periodPeriodA period of time during which the fulfilling resources would have been created.

Response

get
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

delete
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/processrequest

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
identifierstring
organizationstring
providerstring

Params

organizationId*string|stringid|slug

Response

get
/organizations/{organizationId}/fhir/3/processrequest/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

post
/organizations/{organizationId}/fhir/3/processrequest/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
identifierstring
organizationstring
providerstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcessRequestThis is a ProcessRequest resource
identifierarray(Identifier)The ProcessRequest business identifier.
statusstringThe status of the resource instance.
actionstringcancel|poll|reprocess|statusThe type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
targetReferenceThe organization which is the target of the request.
createdstringThe date when this resource was created.
providerReferenceThe practitioner who is responsible for the action specified in this request.
organizationReferenceThe organization which is responsible for the action speccified in this request.
requestReferenceReference of resource which is the target or subject of this action.
responseReferenceReference of a prior response to resource which is the target or subject of this action.
nullifybooleanIf true remove all history excluding audit.
referencestringA reference to supply which authenticates the process.
itemarray(ProcessRequest_Item)List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
includearray()Names of resource types to include.
excludearray()Names of resource types to exclude.
periodPeriodA period of time during which the fulfilling resources would have been created.

Response

put
/organizations/{organizationId}/fhir/3/processrequest/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcessRequestThis is a ProcessRequest resource
identifierarray(Identifier)The ProcessRequest business identifier.
statusstringThe status of the resource instance.
actionstringcancel|poll|reprocess|statusThe type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
targetReferenceThe organization which is the target of the request.
createdstringThe date when this resource was created.
providerReferenceThe practitioner who is responsible for the action specified in this request.
organizationReferenceThe organization which is responsible for the action speccified in this request.
requestReferenceReference of resource which is the target or subject of this action.
responseReferenceReference of a prior response to resource which is the target or subject of this action.
nullifybooleanIf true remove all history excluding audit.
referencestringA reference to supply which authenticates the process.
itemarray(ProcessRequest_Item)List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
includearray()Names of resource types to include.
excludearray()Names of resource types to exclude.
periodPeriodA period of time during which the fulfilling resources would have been created.

Response