For a full list of available versions, see the Directory of published versions

4.1.2. Submit Assessment IAR

---

4.1.2.1. Formal Definition

URL: Process Message

---

4.1.2.2. Usage

The submit operation involves sending a FHIR R4 Bundle of type message to a designated endpoint. The request is received by the IAR Solution which returns an HTTP response code and an OperationOutcome resource, if applicable.

---

4.1.2.3. Interaction Diagram

Actor: HIC Application

Role: Submit a bundle message containing the Questionnaire and other linked resources.

Actor: IAR CDR

Role: Receives, validates, and stores the bundle message and returns an OperationOutcome response

---

4.1.2.4. Specification

Implementations conformant with this Messaging specification SHALL exchange FHIR Message Bundles as defined in this IG to transfer information between the source (HIC Application) and target (IAR Solution) system.

Implementers SHALL use HTTP-based transfer to send FHIR Message Bundles between endpoints using the FHIR $process-message operation. Alternative transport mechanisms are outside the scope of this IG release. It is recommnended to review the $process-message operation definition prior to implementing the messaging.

This specification is based on the FHIR R4 Create operation. The data is submitted through HTTP POST operation using the endpoint.

4.1.2.4.1. Create Assessment Request

The Create Request will create a new IAR Assessment bundle based upon information available from the source system. The bundle of type message will contain the resources described in the data model.

*Endpoint

POST [base]/xx/$process-message

Note:*The final list of endpoints will be provided during onboarding and is also included in Connectivity Summary

**Sample Request Header

Content-Type: application/fhir+xml; charset=utf-8

Note:**Information about required HTTP headers are provided in Connectivity Summary

Sample Message Body

Example-BundleMessageSubmitPreliminaryScreener

Sample Response

OperationOutcome EHR

---

4.1.2.4.2. Update Assessment Request

The Update Request will update an existing IAR Assessment bundle to match against the respective existing bundle in the repository

Assssment Amendment:

• Set QuestionnaireResponse.status to amended when submitting an update.
• If the repository finds an existing IAR assessment in the repository, the newly submitted assessment will logically replace the existing one in the repository.
• If the assessment is submitted twice with no changes, no amendment occurs and the operation still succeeds.
• Submission-level logs (i.e. Bundle submission) and assessment-level (i.e. QuestionnaireResponse) history are maintained.
• New bundle.identifier will be use for every update submission.
• Same HTTP method (i.e. POST) and endpoint (i.e. $process-message0 will be used for amendment.
• OperationOutcome will be returned on successful amendment.

Assessment Invalidation:

• Set QuestionnaireResponse.status to entered-in-error when submitting an invalidation.
• Uses the same IAR assessment lookup mechanism as amendment.
• If an existing assessment is found in the repository with a matching Assessment ID and the newly submitted status is entered-in-error, the repository marks the assessment as invalid without permanently removing it from the database (i.e. soft delete).
• New bundle identifier will be use for every invalidation submission.
• Same HTTP method (i.e. POST) and endpoint (i.e. $process-message) will be used for invalidation.
• OperationOutcome will be returned on succesful invalidation.

4.1.2.5. Expected Behavior

See Response Handling page for additional response handling behaviour.

Legend
code = OperationOutcome.issue.code
severity = OperationOutcome.issue.severity
details.coding.code=OperationOutcome.issue.details.coding.code
details.coding.display=OperationOutcome.issue.details.coding.display
details.text = OperationOutcome.issue.details.coding.text or OperationOutcome.issue.diagnostics

HTTP Status	Scenario Description	severity	code	details.coding.code	details.coding.display	details.text
200 OK	Successful assessment creation.					The assessment was successfully created. Transaction ID: “txnid”.
400 Bad Request	When there was syntactical error such as a missing or invalid header, a missing or invalid URL parameter (e.g. wrong data type in URL parameter), a request body that can't be parsed or doesn't conform to the basic FHIR JSON/XML syntax rules (e.g. invalid attribute value, incorrect data type, etc.). Returns an OperationOutcome resource indicating an issue. The client must fix the request and try again.	error	invalid			Invalid request - could not find Bundle resource. Transaction ID: “txnid”.
422 Content validation	FHIR validation errors such as invalid terminology code, wrong data type value in payload body (e.g. incorrect date format), the proposed resource violated applicable FHIR profiles (e.g. wrong data element name), or violation of LOB defined business rules.	error	not-supported			Not Supported - The requested resource is not supported. Transaction ID: “txnid”.
401 Unauthorized	Failed authentication.	error	severity			Unauthorized - The source needs to authenticate to get the requested response. Transaction ID: “txnid”.
500 Internal Server Error	Unhandled Exception.	error	exception			Internal Server Error- The server encountered an unexpected condition that prevented it from fulfilling the request. Transaction ID: “txnid”.