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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ProcessRequest	This is a ProcessRequest resource
identifier	array(Identifier)		The ProcessRequest business identifier.
status	string		The status of the resource instance.
action	string	cancel\|poll\|reprocess\|status	The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
target	Reference		The organization which is the target of the request.
created	string		The date when this resource was created.
provider	Reference		The practitioner who is responsible for the action specified in this request.
organization	Reference		The organization which is responsible for the action speccified in this request.
request	Reference		Reference of resource which is the target or subject of this action.
response	Reference		Reference of a prior response to resource which is the target or subject of this action.
nullify	boolean		If true remove all history excluding audit.
reference	string		A reference to supply which authenticates the process.
item	array(ProcessRequest_Item)		List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
include	array()		Names of resource types to include.
exclude	array()		Names of resource types to exclude.
period	Period		A period of time during which the fulfilling resources would have been created.

Response

200 400 401 404

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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ProcessRequest	This is a ProcessRequest resource
identifier	array(Identifier)		The ProcessRequest business identifier.
status	string		The status of the resource instance.
action	string	cancel\|poll\|reprocess\|status	The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
target	Reference		The organization which is the target of the request.
created	string		The date when this resource was created.
provider	Reference		The practitioner who is responsible for the action specified in this request.
organization	Reference		The organization which is responsible for the action speccified in this request.
request	Reference		Reference of resource which is the target or subject of this action.
response	Reference		Reference of a prior response to resource which is the target or subject of this action.
nullify	boolean		If true remove all history excluding audit.
reference	string		A reference to supply which authenticates the process.
item	array(ProcessRequest_Item)		List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
include	array()		Names of resource types to include.
exclude	array()		Names of resource types to exclude.
period	Period		A period of time during which the fulfilling resources would have been created.

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
action	string
identifier	string
organization	string
provider	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
action	string
identifier	string
organization	string
provider	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ProcessRequest	This is a ProcessRequest resource
identifier	array(Identifier)		The ProcessRequest business identifier.
status	string		The status of the resource instance.
action	string	cancel\|poll\|reprocess\|status	The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
target	Reference		The organization which is the target of the request.
created	string		The date when this resource was created.
provider	Reference		The practitioner who is responsible for the action specified in this request.
organization	Reference		The organization which is responsible for the action speccified in this request.
request	Reference		Reference of resource which is the target or subject of this action.
response	Reference		Reference of a prior response to resource which is the target or subject of this action.
nullify	boolean		If true remove all history excluding audit.
reference	string		A reference to supply which authenticates the process.
item	array(ProcessRequest_Item)		List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
include	array()		Names of resource types to include.
exclude	array()		Names of resource types to exclude.
period	Period		A period of time during which the fulfilling resources would have been created.

Response

200 400 401 404

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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ProcessRequest	This is a ProcessRequest resource
identifier	array(Identifier)		The ProcessRequest business identifier.
status	string		The status of the resource instance.
action	string	cancel\|poll\|reprocess\|status	The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
target	Reference		The organization which is the target of the request.
created	string		The date when this resource was created.
provider	Reference		The practitioner who is responsible for the action specified in this request.
organization	Reference		The organization which is responsible for the action speccified in this request.
request	Reference		Reference of resource which is the target or subject of this action.
response	Reference		Reference of a prior response to resource which is the target or subject of this action.
nullify	boolean		If true remove all history excluding audit.
reference	string		A reference to supply which authenticates the process.
item	array(ProcessRequest_Item)		List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
include	array()		Names of resource types to include.
exclude	array()		Names of resource types to exclude.
period	Period		A period of time during which the fulfilling resources would have been created.

Response

200 400 401 404