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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcessResponseThis is a ProcessResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe organization who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete, held.
dispositionstringA description of the status of the adjudication or processing.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
formCodeableConceptThe form to be used for printing the content.
processNotearray(ProcessResponse_ProcessNote)Suite of processing notes or additional requirements if the processing has been held.
errorarray(CodeableConcept)Processing errors.
communicationRequestarray(Reference)Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcessResponseThis is a ProcessResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe organization who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete, held.
dispositionstringA description of the status of the adjudication or processing.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
formCodeableConceptThe form to be used for printing the content.
processNotearray(ProcessResponse_ProcessNote)Suite of processing notes or additional requirements if the processing has been held.
errorarray(CodeableConcept)Processing errors.
communicationRequestarray(Reference)Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

Read Process Response

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Process Response

get
/organizations/{organizationId}/fhir/3/ProcessResponse/{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

Read Version Process Response

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Process Response

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Process Response

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
organizationstring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Response

Search History Process Response

get
/organizations/{organizationId}/fhir/3/ProcessResponse/_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

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
identifierstring
organizationstring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringProcessResponseThis is a ProcessResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe organization who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete, held.
dispositionstringA description of the status of the adjudication or processing.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
formCodeableConceptThe form to be used for printing the content.
processNotearray(ProcessResponse_ProcessNote)Suite of processing notes or additional requirements if the processing has been held.
errorarray(CodeableConcept)Processing errors.
communicationRequestarray(Reference)Request for additional supporting or authorizing information, such as: documents, images or resources.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringProcessResponseThis is a ProcessResponse resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe organization who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete, held.
dispositionstringA description of the status of the adjudication or processing.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
formCodeableConceptThe form to be used for printing the content.
processNotearray(ProcessResponse_ProcessNote)Suite of processing notes or additional requirements if the processing has been held.
errorarray(CodeableConcept)Processing errors.
communicationRequestarray(Reference)Request for additional supporting or authorizing information, such as: documents, images or resources.

Response