process responses

Create Process Response

post

/organizations/{organizationId}/fhir/3/ProcessResponse

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

Request

Headers


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ProcessResponse	This is a ProcessResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
organization	Reference		The organization who produced this adjudicated response.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete, held.
disposition	string		A description of the status of the adjudication or processing.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
form	CodeableConcept		The form to be used for printing the content.
processNote	array(ProcessResponse_ProcessNote)		Suite of processing notes or additional requirements if the processing has been held.
error	array(CodeableConcept)		Processing errors.
communicationRequest	array(Reference)		Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

201 400 401 404

Patch Process Response

patch

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

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

Request

Headers


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

Params


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

Body


resourceType*	string	ProcessResponse	This is a ProcessResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
organization	Reference		The organization who produced this adjudicated response.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete, held.
disposition	string		A description of the status of the adjudication or processing.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
form	CodeableConcept		The form to be used for printing the content.
processNote	array(ProcessResponse_ProcessNote)		Suite of processing notes or additional requirements if the processing has been held.
error	array(CodeableConcept)		Processing errors.
communicationRequest	array(Reference)		Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

200 201 400 401 404 409

Read Process Response

get

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

Request

Headers


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

Params


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

Response

200 401 404

Read History Process Response

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 401 404

Read Version Process Response

get

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

Request

Headers


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

Params


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

Response

200 400 401 404

Remove Process Response

delete

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

Request

Headers


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

Params


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

Response

200 204 400 401 404 409

Search Get Process Response

get

/organizations/{organizationId}/fhir/3/ProcessResponse

Request

Headers


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

Query params


_id	string
_language	string
identifier	string
organization	string
request	string
request-organization	string
request-provider	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Process Response

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 401 404

Search Post Process Response

post

/organizations/{organizationId}/fhir/3/ProcessResponse/_search

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

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
identifier	string
organization	string
request	string
request-organization	string
request-provider	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ProcessResponse	This is a ProcessResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
organization	Reference		The organization who produced this adjudicated response.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete, held.
disposition	string		A description of the status of the adjudication or processing.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
form	CodeableConcept		The form to be used for printing the content.
processNote	array(ProcessResponse_ProcessNote)		Suite of processing notes or additional requirements if the processing has been held.
error	array(CodeableConcept)		Processing errors.
communicationRequest	array(Reference)		Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

200 401 404

Update Process Response

put

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

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

Request

Headers


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

Params


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

Body


resourceType*	string	ProcessResponse	This is a ProcessResponse resource
identifier	array(Identifier)		The Response business identifier.
status	string		The status of the resource instance.
created	string		The date when the enclosed suite of services were performed or completed.
organization	Reference		The organization who produced this adjudicated response.
request	Reference		Original request resource reference.
outcome	CodeableConcept		Transaction status: error, complete, held.
disposition	string		A description of the status of the adjudication or processing.
requestProvider	Reference		The practitioner who is responsible for the services rendered to the patient.
requestOrganization	Reference		The organization which is responsible for the services rendered to the patient.
form	CodeableConcept		The form to be used for printing the content.
processNote	array(ProcessResponse_ProcessNote)		Suite of processing notes or additional requirements if the processing has been held.
error	array(CodeableConcept)		Processing errors.
communicationRequest	array(Reference)		Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

200 201 400 401 404 409