feat: allow supplying a comment with confirmRegistration

CHANGELOG.md

@@ -8,7 +8,6 @@
 
 ### New features
 
-- Misc new feature
 - Allow configuring the default search criteria for record search [#6924](https://github.com/opencrvs/opencrvs-core/issues/6924)
 - Add checks to validate client and server are always on the same version. This prevents browsers with a cached or outdated client versions from making potentially invalid requests to the backend [#6695](https://github.com/opencrvs/opencrvs-core/issues/6695)
 - Two new statuses of record are added: `Validated` and `Correction Requested` for advanced search parameters [#6365](https://github.com/opencrvs/opencrvs-core/issues/6365)
@@ -24,6 +23,7 @@
 - **Template Selection Dropdown**: Updated print workflow to include a dropdown menu for template selection when issuing a certificate.
 - Auth now allows exchanging user's token for a new record-specific token [#7728](https://github.com/opencrvs/opencrvs-core/issues/7728)
 - A new GraphQL mutation `upsertRegistrationIdentifier` is added to allow updating the patient identifiers of a registration record such as NID [#8034](https://github.com/opencrvs/opencrvs-core/pull/8034)
+- Updated GraphQL mutation `confirmRegistration` to allow adding a `comment` for record audit [#8197](https://github.com/opencrvs/opencrvs-core/pull/8197)
 - Introduced a new customisable UI component: Banner [#8276](https://github.com/opencrvs/opencrvs-core/issues/8276)
 
 ### Improvements

packages/gateway/src/features/registration/root-resolvers.ts

@@ -612,10 +612,7 @@ export const resolvers: GQLResolver = {
       }
 
       try {
-        const taskEntry = await confirmRegistration(id, authHeader, {
-          registrationNumber: details.registrationNumber,
-          identifiers: details.identifiers
-        })
+        const taskEntry = await confirmRegistration(id, authHeader, details)
 
         return taskEntry.resource.id
       } catch (error) {

packages/gateway/src/features/registration/schema.graphql

@@ -572,6 +572,7 @@ input IdentifierInput {
 input ConfirmRegistrationInput {
   registrationNumber: String!
   identifiers: [IdentifierInput!]
+  comment: String # For record audit
 }
 
 input RejectRegistrationInput {

packages/gateway/src/graphql/schema.d.ts

@@ -582,6 +582,7 @@ export interface GQLReinstated {
 export interface GQLConfirmRegistrationInput {
   registrationNumber: string
   identifiers?: Array<GQLIdentifierInput>
+  comment?: string
 }
 
 export interface GQLRejectRegistrationInput {

packages/gateway/src/graphql/schema.graphql

@@ -707,6 +707,7 @@ type Reinstated {
 input ConfirmRegistrationInput {
   registrationNumber: String!
   identifiers: [IdentifierInput!]
+  comment: String
 }
 
 input RejectRegistrationInput {

packages/gateway/src/workflow/index.ts

@@ -246,6 +246,7 @@ export async function confirmRegistration(
   details: {
     registrationNumber: string
     identifiers?: IdentifierInput[]
+    comment?: string
   }
 ) {
   const res: ReadyForReviewRecord = await createRequest(

packages/workflow/src/features/registration/handler.ts

@@ -25,7 +25,8 @@ import { SupportedPatientIdentifierCode } from '@opencrvs/commons/types'
 export interface EventRegistrationPayload {
   trackingId: string
   registrationNumber: string
-  error: string
+  error?: string
+  comment?: string
   identifiers?: {
     type: SupportedPatientIdentifierCode
     value: string
@@ -38,7 +39,7 @@ export async function markEventAsRegisteredCallbackHandler(
 ) {
   const token = getToken(request)
   const compositionId = request.params.id
-  const { registrationNumber, error, identifiers } =
+  const { registrationNumber, error, comment, identifiers } =
     request.payload as EventRegistrationPayload
 
   if (error) {
@@ -60,6 +61,7 @@ export async function markEventAsRegisteredCallbackHandler(
     savedRecord,
     registrationNumber,
     token,
+    comment,
     identifiers
   )
   const event = getEventType(bundle)

packages/workflow/src/records/fhir.ts

@@ -768,7 +768,10 @@ export function createWaitingForValidationTask(
   }
 }
 
-export function createRegisterTask(previousTask: SavedTask): Task {
+export function createRegisterTask(
+  previousTask: SavedTask,
+  comment?: string
+): Task {
   const timeLoggedMSExtension = previousTask.extension.find(
     (e) => e.url === 'http://opencrvs.org/specs/extension/timeLoggedMS'
   )!
@@ -779,7 +782,7 @@ export function createRegisterTask(previousTask: SavedTask): Task {
     'REGISTERED'
   )
 
-  const comments = previousTask?.note?.[0]?.text
+  const comments = comment ?? previousTask?.note?.[0]?.text
 
   return {
     ...registeredTask,

packages/workflow/src/records/state-transitions.ts

@@ -509,11 +509,14 @@ export async function toRegistered(
   record: WaitingForValidationRecord,
   registrationNumber: EventRegistrationPayload['registrationNumber'],
   token: string,
+  comment?: string,
   identifiers?: EventRegistrationPayload['identifiers']
 ): Promise<RegisteredRecord> {
   const previousTask = getTaskFromSavedBundle(record)
-  const registeredTaskWithoutPractitionerExtensions =
-    createRegisterTask(previousTask)
+  const registeredTaskWithoutPractitionerExtensions = createRegisterTask(
+    previousTask,
+    comment
+  )
 
   const [registeredTask, practitionerResourcesBundle] =
     await withPractitionerDetails(