API - Submit Communication Alert

This API serves three functions:

submit communication alert together with vital readings for alert-code "Threshold".
submit communication alert together with start/end dates for alert-code "Missed Reading".
submit communication alert only for other alert codes (for example "Contact Patient", etc).

Scope

This transaction involves the requestor sending a POST request to the FHIR service to submit a Bundle containing a Communication resource and an optional Observation resource. The request is received by the FHIR Service that extracts and assemble the alert information and vital readings, where applicable, as per the RCM HL7 FHIR Implementation Guide specification and creates the record.

Upon successful creation, the FHIR Service returns an HTTP response code (i.e 2xx) and the same Bundle with the Communication and Observation resources, together with the communication id.

For unsuccessful creation, the FHIR Service returns an HTTP response code (i.e 4xx or 5xx) and an OperationOutcome resource.

Interaction Diagram

Could not find subject. File was not found for images/API-SubmitCommAlert.png

Specification

The

Command 'link' could not render: Object reference not set to an instance of an object.

FHIR specification is based on the HL7 FHIR R5 extended operation. (Ref: https://www.hl7.org/fhir/operations.html)

Submit Communications Alert Request

The Submit Communications Alert Request will create a new communication record, if one does not already exist in the repository. If there is already an existing record, the newly submitted version will replace the existing version in the repository.

The Submit Communications Alert creates a new resource in a server-assigned location. The create interaction is performed by an HTTP POST command as shown:

POST [baseURL]/$submit-communication-alert

Example Submit Communications Alert Message

HTTP Method:

POST

Headers:

Content-Type: application/fhir+json

Address:

[baseURL]/$submit-communication-alert

Message Body:

Alert Code	Example
"Threshold"	Command 'link' could not render: Object reference not set to an instance of an object.
"Missed Reading"	Command 'link' could not render: Object reference not set to an instance of an object.
Others	Command 'link' could not render: Object reference not set to an instance of an object.

Submit Communications Alert Response

HTTP Status Code	Resource	Alert Code	Example
201 Created	Command 'link' could not render: Object reference not set to an instance of an object.	"Threshold"	Command 'link' could not render: Object reference not set to an instance of an object.
201 Created	Command 'link' could not render: Object reference not set to an instance of an object.	"Missed Reading"	Command 'link' could not render: Object reference not set to an instance of an object.
201 Created	Command 'link' could not render: Object reference not set to an instance of an object.	Others	Command 'link' could not render: Object reference not set to an instance of an object.
4xx, 5xx	Command 'link' could not render: Object reference not set to an instance of an object.	-	Command 'link' could not render: Object reference not set to an instance of an object.

Business Level Errors

This section details the business level errors exposed by OperationOutcome resource for this operation. Refer to API Error Handling for framework level errors.

For illustration only

http status code	code	details.coding.code	details.text
400	duplicate	E-10004	An attempt was made to create a duplicate record