swagger: '2.0' info: x-ibm-name: ndis-notifications title: NDIS Notifications version: 3.0.0 description: |- Digital Partners can receive notifications for events they have subscribed to, by leveraging Webhooks. What is a Webhook

A webhook (also called a web callback or HTTP push API), is a lightweight API that powers one-way data sharing triggered by events. Unlike typical API's where you would need to poll for data in order to get updates in real-time, a webhook delivers data to your application as the event happens, meaning you get the data immediately.

Note: The most recent subscription to the notification will override the existing one and the webhook destination will be overwritten. The system is designed to prioritize the most recent subscription.

Please note that webhook is linked to the provider number.

Setting up a webhook

To consume a webhook: 1. Set up a publicly accessible endpoint in your application to handle the webhook callbacks. This endpoint should capture POST requests only and Respond with a 200. 2. Extensions/Domains accepted are: https://*.com, https://*.com.au, https://*.org, https://*.org.au, https://*.net, https://*.net.au 3. Sample webhook URL: https://webhookrelay.com Subscribing to an event

In order to subscribe to an event, you will need to provide: 1. The event id you are subscribing to (example: "REMIT_ADV_GENERATED"). 2. Your webhook url (example: https://webhookrelay.com) 3. Frequency of "IMMEDIATE" or "DAILY" 4. A signature and 5. Your preferred algorithm (supported algorithms are: MD5, SHA256 AND SHA512) 6. Basic Authorisation - Base64 encoded string (Example:YWhhbWlsdG9uQGFwaWdlZS5jb206bXlwYXNzdzByZAo) Use the NDIS Reference Data 2.0 get/{attribute_name} operation, replacing attribute_name with “event_id” and “frequency”, to retrieve a list of all available event ids and frequencies, respectively. Validating callbacks (Checksum hashing)

You will likely want to perform some validation of the data to ensure the callbacks are coming from NDIS. Your preferred algorithm (supported algorithms are: ). This is accomplished as below: 1. Let's for instance assume that, as part of your post/subscribe operation, you subscribed to the event "SB_END_DATE_UPDATED", provided a signature "NDIATesting", your chosen algorithm was MD5 and your webhook url is "https://ptsv2.com//t/f1bz8-1586415742/post" (NOTE: these are only sample values) 2. Now, in response to this event being triggered, NDIS' response payload, will include the request body, a checksum value as part of the http header and a eventkey GUID. Example for checksum received in header: FBBFD673DE90C2E12C4B1F222D1E23D6. eventkey received in header: 963421F08D0F1EDBBE9A4B57A78915FE 3. In order to ensure that the callback is coming from NDIS, the above checksum needs to be re-calculated by your system. 4. You can do this by calculating the hash of string using the algorithm you supplied. The hash needs to be applied to the value which equals signature.webhookurl.eventkey 5. Therefore, in our example, you have to re-calculate the checksum using algorithm MD5 on NDIATesting.https://ptsv2.com//t/f1bz8-1586415742/post.963421F08D0F1EDBBE9A4B57A78915FE 6. The re-calculated checksum resulting from the hash of the above is FBBFD673DE90C2E12C4B1F222D1E23D6, which therefore matches the checksum provided by the NDIS in the http header, and the authenticity of the notification can be validated. You can try the hashing calculation by using an online hashing tool such as http://onlinemd5.com/ to validate the above example. Validating callbacks (basic_auth)

Digital Partners can provide an optional Base64 encoded string as the "basic_auth" at the time of event subscription. NDIA will return the exact basic auth initially provided by the Digital Partners when subscribing to the event, as part of the notifications' request header when it is triggered.

In order to utilise this security feature, Digital Partners will be required to update their systems to accept the basic auth in the header. This basic auth can then be decoded by the Digital Partners to validate the authenticity of the callback.

Note: basic_auth is not applicable for PACE notifications.

contact: name: NDIA Support Team email: api.support@ndis.gov.au schemes: - https host: api.ndis.gov.au basePath: /sharedservices/ndis-api/ndis/3.0/notifications consumes: - application/json produces: - application/json security: - clientIdHeader: [] securityDefinitions: clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id description: 'apiKey provided during registration. Max Length(64). example: aa111aa-11a1-1a11-111a-1a1a11aa111a' x-ibm-configuration: testable: true enforced: true cors: enabled: true phase: realized type: rest servers: - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/3.0/notifications description: '' type: - production - development - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/3.0/notifications description: '' type: - production - development paths: /: get: responses: '200': description: 200 OK schema: $ref: '#/definitions/notification_list_response' tags: [] produces: - application/json operationId: notificationList summary: Returns a list of current subscriptions description: Retrieves a list of all the notifications that a provider has subscribed to receive parameters: - $ref: '#/parameters/skip' - $ref: '#/parameters/top' - $ref: '#/parameters/orderby' - $ref: '#/parameters/sortorder' - $ref: '#/parameters/authorization' /maintain/{guid}: patch: responses: '202': description: '' schema: $ref: '#/definitions/notification_patch_response' tags: [] produces: - application/json operationId: notificationPatch parameters: - name: notification_patch_request_data required: true in: body schema: $ref: '#/definitions/notification_patch_request_data' summary: Maintain Notification request description: "Enables the Digital Partners to update the webhook URL or the basic auth of an event they have previously subscribed.

\nNote: \n* basic_auth is not applicable for PACE notifications.

\t" parameters: - name: guid type: string required: true in: path - $ref: '#/parameters/authorization' /subscribe: post: responses: '201': description: '' schema: $ref: '#/definitions/notification_subscribe_response' tags: [] produces: - application/json operationId: notificationSubscribe parameters: - name: notification_subscribe_request_data required: true in: body schema: $ref: '#/definitions/notification_subscribe_request_data' summary: Notification subscribe request description: "This operation can be used to subscribe to receive notifications when the below events occur. Use the NDIS Reference Data API - GET/{attribute_name} operation, replacing the attribute_name with 'event_id' to retrieve the required event id keys.

\nBelow are the list of events currently available for subscription.

\n\nSAP Notifications:
\t\n\n1. New Service Booking created (SB_NEW) - The notification for this event will be triggered when a new service booking is created\n- By a Staff member using the staff portal

\t\n- By a Participant using the myplace participant portal

\n- By a Provider using the myplace provider portal

\n- Via API

\t\nNotification will include service bookings that require provider approval (\\\"status\\\" =\\\"APRO\\\") and staff updated service bookings that have been auto-approved (\\\"status\\\" = \\\"APPR\\\"). Refer to the \\\"status\\\" field to identify if further action is required. If the \\\"status\\\" of the service booking is \\\"APRO\\\", use the PATCH/{update-status} operation to either approve or reject the new service booking.

\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_NEW\\\",\\\"response\\\":{\\\"booking_details\\\":{\\\"participant\\\":430397572,\\\"participant_name\\\":\\\"CM2 SK2\\\",\\\"booking_type\\\":\\\"ZSAG\\\",\\\"service_booking_id\\\":50033064,\\\"start_date\\\":\\\"2021-09-28\\\",\\\"end_date\\\":\\\"2021-09-28\\\",\\\"revised_end_date\\\":\\\"0000-00-00\\\",\\\"inkind_program\\\":\\\"\\\",\\\"status\\\":\\\"APPR\\\",\\\"virtual_status\\\":\\\"Active\\\",\\\"participant_plan_id\\\":1081796,\\\"initiated_by\\\":\\\"Staff\\\",\\\"items\\\":[{\\\"product_category\\\":\\\"ASSISTIVE_TECHNOLOGY\\\",\\\"product_category_item\\\":\\\"05_091203057_0103_1_2\\\",\\\"product_category_item_desc\\\":\\\"Mobile Shower Commode - Potty Child\\\",\\\"quantity\\\":1,\\\"allocated_amount\\\":0.02,\\\"remaining_amount\\\":0.02}]}}

\t\t\n\n2. SB End Date updated (SB_END_DATE_UPDATED) - The notification for this event will be triggered when the end date of a service booking is updated\n- By a Staff member using the staff portal

\t\n- By a Participant using the myplace participant portal

\n- By a Provider using the myplace provider portal

\t\nBy a Digital Partner using Provider API's PATCH /{service_booking_id}/extend-end-date or PATCH/{service_booking_id}/reduce-end-date operation.

\n- Due to a plans' end date being updated as a result of an unscheduled plan review, participant access being revoked or participant access being ceased (due to death).

\nNotification will include service bookings that require provider approval (\\\"status\\\" = \\\"APRC\\\") and staff updated service bookings that have been auto-approved (\\\"status\\\" = \\\"APPR\\\"). Refer to the \\\"status\\\" field to identify if further action is required. If the \\\"status\\\" of the service booking is \\\"APRC\\\", use the PATCH/{update-status} operation to either approve or reject the end date update to the service booking.

\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_END_DATE_UPDATED\\\",\\\"response\\\":{\\\"participant\\\":430397572,\\\"service_booking_id\\\":50030353,\\\"participant_plan_id\\\":1081796,\\\"start_date\\\":\\\"2021-08-25\\\",\\\"end_date\\\":\\\"2021-12-30\\\"}}

\n\n3. Service Booking Budget Updated (SB_BUDGET_UPDATED) - The notification for this event will be triggered when the quantity and/or allocated amount of one or more supports within a service booking is updated\n- By a Staff member using the staff portal

\t\n- By a Participant using the participant portal

\n- By a Provider using the myplace provider portal

\n- Via API

\t\nNotification will include service bookings that require provider approval (\\\"status\\\" = \\\"APRC\\\") and staff updated service bookings that have been auto-approved (\\\"status\\\" = \\\"APPR\\\"). Refer to the \\\"status\\\" field to identify if further action is required. If the \\\"status\\\" of the service booking is \\\"APRC\\\", use the PATCH/{update-status} operation to either approve or reject the allocation update to the service booking.

\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_BUDGET_UPDATED\\\", \\\"response\\\":{\\\"booking_details\\\":{\\\"participant\\\":430397572, \\\"service_booking_id\\\":50026500, \\\"status\\\":\\\"APPR\\\", \\\"virtual_status\\\":\\\"Active\\\", \\\"participant_plan_id\\\":1081796, \\\"items\\\":[{\\\"product_category\\\":\\\"ASSISTIVE_TECHNOLOGY\\\", \\\"product_category_item\\\":\\\"05_091203058_0103_1_2\\\", \\\"product_category_item_desc\\\":\\\"Mobile Shower Commode - Potty Junior\\\", \\\"quantity\\\":1, \\\"allocated_amount\\\":11, \\\"remaining_amount\\\":11}]}}}

\n\n4. Service Booking deleted (SB_DELETED) - The notification for this event will be triggered when a service booking is deleted\n- By a Participant using the myplace participant portal

\t\n- By a Provider using the myplace provider portal

\n- By a Provider using the Provider API's DELETE /{service_booking_id} operation

\t\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_DELETED\\\",\\\"response\\\":{\\\"participant\\\":430397575,\\\"service_booking_id\\\":50033265,\\\"moreinformation\\\":\\\"This service booking has been deleted\\\"}}

\t\t\t\n\n5. SB is Expiring (SB_EXPIRING) - The notification for this event will be triggered for a service booking one day prior to its end date.\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_EXPIRING\\\", \\\"response\\\":{\\\"participant\\\":430397575, \\\"service_booking_id\\\":50032954, \\\"participant_plan_id\\\":1081799, \\\"start_date\\\":\\\"2021-09-27\\\", \\\"end_date\\\":\\\"2021-10-04\\\", \\\"moreinformation\\\":\\\"This service booking will be expiring tomorrow.\\\"}}

\n\n6. Plan End Date is updated (PLAN_END_DT_UPDATED) - The notification of this event will be triggered when the plan end date of a participant's current active plan is updated\n- Due to an unscheduled plan review

\t\n- Due to the auto extension of plan

\n- Due to the participant's access ceasing (due to death for instance)

\t\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"PLAN_END_DT_UPDATED\\\",\\\"response\\\":{\\\"participant\\\":430397572,\\\"participant_plan_id\\\":1081796,\\\"start_date\\\":\\\"2021-06-10\\\",\\\"end_date\\\":\\\"2021-10-03\\\"}}

\n\n7. Remittance Advise is generated (REMIT_ADV_GENERATED) - The notification for this event will be triggered overnight and the JSON payload available in your chosen webhook, when the remittance advice is ready, for payment claims that have been processed and paid, the day before.\nSee sample JSON payload below:

Please note that this notification does not currently work in the Test Vendor environment and therefore cannot be used for testing.

\n- Sample Response Data - {\\\"event_id\\\": \\\"REMIT_ADV_GENERATED\\\", \\\"response\\\": {\\\"remittance_advice\\\": [{\\\"payeebp\\\": 4050004196, \\\"z4no\\\": 4000001213,\\\"finyrs\\\": \\\"2020/2021\\\", \\\"payreqnum\\\": 10582652, \\\"payreqdocdate\\\": \\\"2021-06-28\\\", \\\"provclaimref\\\":\\\"113165160615\\\", \\\"itemid\\\":\\\"01_019_0120_1_1\\\", \\\"itemqty\\\": 1, \\\"unitprice\\\": 35.75, \\\"amountclaimed\\\":35.75, \\\"amountpaid\\\":35.75, \\\"participantbp\\\": 430254976, \\\"participantname\\\": \\\"Mr. Gavin Auer\\\", \\\"supportstartdate\\\": \\\"2021-06-27\\\", \\\"supportenddate\\\": \\\"2021-06-27\\\", \\\"servicebookingnum\\\": 55013749, \\\"bulkclmid\\\": \\\"\\\", \\\"claimtype\\\": \\\"\\\", \\\"cancelrsn\\\": \\\"\\\"}]}}

\n\n8. Participant Report Download (PARTICIPANT_REPORT) - This is an on-demand notification which will provide the Digital Partners a report of all the participants, their organisation has active service bookings with. In order to receive this report, please subscribe to this event first and call the POST/report operation based on your organisations' reporting requirements. \n- Sample Response Data - { \\\"event_id\\\":\\\"PARTICIPANT_REPORT\\\", \\\"response\\\":{ \\\"disclaimer\\\":\\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\", \\\"report_data\\\":[ { \\\"participant_name\\\":\\\"Alessia O'Kon\\\", \\\"ndis_number\\\":430255002, \\\"plan_number\\\":1043859, \\\"plan_start_date\\\":\\\"2021-08-11\\\", \\\"plan_end_date\\\":\\\"2022-08-11\\\", \\\"gender\\\":\\\"MALE\\\", \\\"interpreter_required\\\":\\\"NO\\\" }, { \\\"participant_name\\\":\\\"Alia Schiller\\\", \\\"ndis_number\\\":430255322, \\\"plan_number\\\":1043514, \\\"plan_start_date\\\":\\\"2021-07-23\\\", \\\"plan_end_date\\\":\\\"2022-07-23\\\", \\\"gender\\\":\\\"MALE\\\", \\\"interpreter_required\\\":\\\"NO\\\" }, { \\\"participant_name\\\":\\\"Mike Garry\\\", \\\"ndis_number\\\":430255645, \\\"plan_number\\\":1043845, \\\"plan_start_date\\\":\\\"2021-08-11\\\", \\\"plan_end_date\\\":\\\"2023-08-11\\\", \\\"gender\\\":\\\"MALE\\\", \\\"interpreter_required\\\":\\\"NO\\\" }] } }

\n9. Quotation Response is Required (QUOTATION_RESPO_REQD) - The notification for this event will be triggered when a response to a quotation request is required from the provider organisation. Refer to PATCH/{quotation_id} for further information. \n- Sample Response Data - {\\\"event_id\\\":\\\"QUOTATION_RESPO_REQD\\\", \\\"response\\\":{\\\"quotation_id\\\":5003097, \\\"participant\\\":430397572, \\\"participant_plan_id\\\":1081796}}

\n\n10. Request for Service Response is Required (RFS_ASSIGNED) - The notification for this event will be triggered when a RFS is issued. Please log into your myplace provider portal to view the details of the RFS and to accept or reject it. \n- Sample Response Data - {\\\"event_id\\\":\\\"RFS_ASSIGNED\\\", \\\"response\\\":{\\\"request_id\\\":770180, \\\"moreinformation\\\":\\\"A letter will be available in your organisation's myplace inbox with further details.\\\"}}

\n\n11. Request for SB REPORT (SB_REPORT) - This is an on-demand notification which will provide the Digital Partners a list of service bookings that their organisation has with participants. The report generated is similar to the Download Service Bookings report available via the myplace provider portal and covers a period of 90 days i.e. if the report was generated on 21/10/2021, it will cover a date range of 23/07/2021 to 21/10/2021. This report will include. \n- All service bookings with status of \\\"APPR\\\" and virtual_status of \\\"Active\\\"

\t\n- All service bookings with status of \\\"APPR\\\" and virtual_status of \\\"Inactive\\\", with an end date that falls within the report date range.

\n- Sample Response Data - {\\\"event_id\\\":\\\"SB_REPORT\\\", \\\"response\\\":{\\\"disclaimer\\\":\\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\", \\\"report_data\\\":[{\\\"participant_name\\\":\\\"Ali Test\\\", \\\"participant\\\":430396682, \\\"booking_type\\\":\\\"ZSAG\\\", \\\"service_booking_id\\\":50023825, \\\"initiated_by\\\":\\\"Staff\\\", \\\"start_date\\\":\\\"2021-03-11\\\", \\\"end_date\\\":\\\"2021-09-08\\\", \\\"product_category\\\":\\\"ASSISTIVE_TECHNOLOGY\\\", \\\"product_category_item\\\":\\\"05_091203055_0103_1_2\\\", \\\"quantity\\\":1, \\\"allocated_amount\\\":60600, \\\"remaining_amount\\\":60600, \\\"accrual_amount\\\":0, \\\"status\\\":\\\"APPR\\\", \\\"virtual_status\\\":\\\"Inactive\\\", \\\"last_modified_date\\\":\\\"2021-09-09\\\"}]}}

\n\n12. Report for product category update (PRODUCT_CAT_UPDATED) - The notification for this event will be triggered when there is an update to the price limit for an existing support item. \n

When subscribing for this event frequency must be set to DAILY \n- Sample Response Data - {\\\"event_id\\\":\\\"PRODUCT_CAT_UPDATED\\\", \\\"response\\\":[{\\\"support_item_number\\\": \\\"01_050_0115_1_1\\\", \\\"state_region\\\": \\\"ACT\\\",\\\"state_region_text\\\": \\\"Aust Capital Terr\\\",\\\"price\\\": 1,\\\"currency\\\": \\\"AUD\\\", \\\"start_date\\\": \\\"2022-01-28\\\",\\\"end_date\\\": \\\"9999-12-31\\\"}]}

\n\n13. Report for Price Guide report (PRICE_GUIDE_REPORT) - This is an on-demand notification which will enable the Digital Partners to retrieve the most current pricing information for all valid support items at any given time. \n- Sample Response Data - {\\\"event_id\\\": \\\"PRICE_GUIDE_REPORT\\\",\\\"response\\\": {\\\"disclaimer\\\": \\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\",\\\"report_data\\\": [{\\\"support_item_number\\\": \\\"01_001_0101_1_1\\\",\\\"registration_group\\\": \\\"Accommodation/Tenancy\\\" ,\\\"support_item_name\\\": \\\"Transitional Support\\\",\\\"unit\\\": \\\"Each\\\",\\\"remote\\\": 13502.58,\\\"very_remote\\\": 14467.05,\\\"act\\\": 0,\\\"nsw\\\": 0,\\\"sa\\\": 9645.7,\\\"tas\\\": 9644.7,\\\"vic\\\": 9644.7,\\\"qld\\\": 9644.7,\\\"wa\\\": 9644.7,\\\"nt\\\": 9500},{\\\"support_item_number\\\" : \\\"01_002_0107_1_1\\\",\\\"registration_group\\\": \\\"Assist Personal Activities\\\",\\\"support_item_name\\\": \\\"Assistance With Self-Care Activities - Standard - Weekday Night\\\",\\\"unit\\\": \\\"Hour\\\",\\\"remote\\\": 87.04,\\\"very_remote\\\": 93.26, \\\"act\\\": 62.17,\\\"nsw\\\": 62.17,\\\"sa\\\": 62.17,\\\"tas\\\": 62.17,\\\"vic\\\": 62.17,\\\"qld\\\": 62.17,\\\"wa\\\": 62.17,\\\"nt\\\": 62.17},{\\\"support_item_number\\\": \\\"01_002_0107_1_1_T\\\" ,\\\"registration_group\\\": \\\"Assist Personal Activities\\\",\\\"support_item_name\\\": \\\"Assistance With Self-Care Activities - Standard - Weekday Night - TTP\\\",\\\"unit\\\": \\\"Hour\\\",\\\"remote\\\": 92.26,\\\"very_remote\\\": 98.85,\\\"act\\\": 65.9,\\\"nsw\\\": 65.9,\\\"sa\\\": 65.9,\\\"tas\\\": 65.9,\\\"vic\\\": 65.9,\\\"qld\\\": 65.9,\\\"wa\\\": 65.9,\\\"nt\\\": 65.9},{\\\"support_item_number\\\": \\\"01_003_0107_1_1\\\",\\\"registration_group\\\": \\\"Assist Personal Activities\\\" ,\\\"support_item_name\\\": \\\"Assistance From Live-In Carer\\\",\\\"unit\\\": \\\"Hour\\\",\\\"remote\\\": 71.53,\\\"very_remote\\\" : 76.64,\\\"act\\\": 51.09,\\\"nsw\\\": 51.09,\\\"sa\\\": 51.09,\\\"tas\\\": 51.09,\\\"vic\\\": 51.09,\\\"qld\\\": 51.09,\\\"wa\\\": 51.09,\\\"nt\\\": 51.09}]}}

\n\n14. Report for Bulk Payment Process Finish (BULK_PROCESS_FINISH) - The notification will be triggered immediately when a bulk payment has been submitted by a provider using either\n- the API, or

\t\n- the myplace provider portal

\nand the bulk payment has finished processing.

\n- Sample Response Data - {\\\"event_id\\\":\\\"BULK_PROCESS_FINISH\\\",\\\"disclaimer\\\":\\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\",\\\"batch_reference_name\\\":\\\"BULK_CLM_TEST.CSV\\\",\\\"response\\\":[ {\\\"participant_name\\\":\\\"Erine Marto\\\",\\\"participant\\\":430258008,\\\"claim_number\\\":10819754,\\\"claimed_amount\\\":1,\\\"invoice_number\\\":\\\"300000376754\\\",\\\"claim_status\\\":\\\"4\\\",\\\"start_date\\\":\\\"2022-04-26\\\",\\\"end_date\\\":\\\"2022-04-26\\\",\\\"product_category\\\":\\\"DAILY_ACTIVITIES\\\",\\\"product_category_item\\\":\\\"01_022_0120_1_1\\\",\\\"product_description\\\":\\\"Assistance With The Cost Of Preparation And Delivery Of Meals\\\",\\\"claim_type\\\":\\\"TRAN\\\",\\\"claim_reason\\\":\\\"\\\",\\\"amount\\\":1,\\\"quantity\\\":1,\\\"tax_code\\\":\\\"P1\\\",\\\"plan_id\\\":1046588,\\\"service_agreement\\\":55020359,\\\"inkind_flag\\\":false,\\\"submit_date\\\":\\\"2022-04-26\\\",\\\"reject_reason_code\\\":\\\"\\\",\\\"paid_date\\\":\\\"0000-00-00\\\",\\\"submit_by\\\":\\\"DHS_BATCH\\\",\\\"abn_provider\\\":63786740014,\\\"exemption_reason\\\":\\\"\\\",\\\"ref_doc_no\\\":\\\"ref1_2022-04-26-165130\\\",\\\"clearing_number\\\":0}]}

\n\n15. Report for Bulk Claim Details based on Batch Reference Name(BULK_CLAIM_REPORT) - This is an on-demand notification which will enable the Digital Partners to retrieve claim details of batch file on Daily basis. \n- Sample Response Data - {\\\"event_id\\\":\\\"BULK_CLAIM_REPORT\\\",\\\"disclaimer\\\":\\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\",\\\"batch_reference_name\\\":\\\"BULK_CLM.CSV\\\",\\\"response\\\":[ {\\\"participant_name\\\":\\\"Erine Marto\\\",\\\"participant\\\":430258008,\\\"claim_number\\\":10819715,\\\"claimed_amount\\\":1.5,\\\"invoice_number\\\":\\\"300000376722\\\",\\\"claim_status\\\":\\\"41\\\",\\\"start_date\\\":\\\"2022-04-26\\\",\\\"end_date\\\":\\\"2022-04-26\\\",\\\"product_category\\\":\\\"DAILY_ACTIVITIES\\\",\\\"product_category_item\\\":\\\"01_022_0120_1_1\\\",\\\"product_description\\\":\\\"Assistance With The Cost Of Preparation And Delivery Of Meals\\\",\\\"claim_type\\\":\\\"TRAN\\\",\\\"claim_reason\\\":\\\"\\\",\\\"amount\\\":1.5,\\\"quantity\\\":1,\\\"tax_code\\\":\\\"P1\\\",\\\"plan_id\\\":1046588,\\\"service_agreement\\\":55020359,\\\"inkind_flag\\\":false,\\\"submit_date\\\":\\\"2022-04-26\\\",\\\"reject_reason_code\\\":\\\"\\\",\\\"paid_date\\\":\\\"2022-04-27\\\",\\\"submit_by\\\":\\\"DHS_BATCH\\\",\\\"abn_provider\\\":63786740014,\\\"exemption_reason\\\":\\\"\\\",\\\"ref_doc_no\\\":\\\"ref1_2022-04-26-113005\\\",\\\"clearing_number\\\":7800000829}]}

\n\n16. Report for Participant Claims(PARTICIPANT_CLAIMS) - This is an on-demand notification which will enable Digital Partners to retrieve all payment details for all participants that are associated with the registered provider.

\n- Parameters:

\n- event_id : Must be PARTICIPANT_CLAIMS\n- webhook_url : Provide your webhook url. Refer to \\\"Setting up a webhook\\\" for details.

\t\n- Frequency: must be set to DAILY

\n- signature: To be used as part of checksum

\n- algorithm: Your preferred algorithm (supported algorithms are: MD5, SHA256 AND SHA512)

\n- Sample Request to subscribe to the PARTICIPANT_CLAIMS event:{\\\"event_id\\\": \\\"PARTICIPANT_CLAIMS\\\",\\\"webhook_url\\\": \\\"provide you own webhook url here\\\",\\\"frequency\\\": \\\"DAILY\\\",\\\"signature\\\": \\\"sigtest\\\",\\\"algorithm\\\": \\\"SHA256\\\"}

\n- Sample Response Data - {\\\"event_id\\\":\\\"PARTICIPANT_CLAIMS\\\",\\\"disclaimer\\\":\\\"Disclaimer: This report can only be used in accordance with the NDIS Act 2013 and Privacy Act 1988.\\\",\\\"response\\\":[ {\\\"participant_name\\\":\\\"Erine Marto\\\",\\\"participant\\\":430258008,\\\"claim_number\\\":10793975,\\\"claimed_amount\\\":0.01,\\\"invoice_number\\\":\\\"300000368276\\\",\\\"claim_status\\\":\\\"41\\\",\\\"start_date\\\":\\\"2022-04-22\\\",\\\"end_date\\\":\\\"2022-04-22\\\",\\\"product_category\\\":\\\"CONSUMABLES\\\",\\\"product_category_item\\\":\\\"03_089_0121_1_1\\\",\\\"product_description\\\":\\\"Auslan Or Signed English Training\\\",\\\"claim_type\\\":\\\"TRAN\\\",\\\"claim_reason\\\":\\\"\\\",\\\"amount\\\":0.01,\\\"quantity\\\":1,\\\"tax_code\\\":\\\"P1\\\",\\\"plan_id\\\":1046588,\\\"service_agreement\\\":55020336,\\\"inkind_flag\\\":false,\\\"submit_date\\\":\\\"2022-04-22\\\",\\\"reject_reason_code\\\":\\\"\\\",\\\"paid_date\\\":\\\"2022-04-26\\\",\\\"submit_by\\\":\\\"DHS_BATCH\\\",\\\"abn_provider\\\":63786740014,\\\"exemption_reason\\\":\\\"\\\",\\\"ref_doc_no\\\":\\\"ref1_2022-04-22-120488\\\",\\\"clearing_number\\\":7200000942}]}

\n\n17. Budget Updated (BUDGET_UPDATED) - This notification will allow Plan Managers and Support Coordinators to be notified when SAP participant's budget is changed given that consent is provided.

\nThe trigger is sent:

\nThe notification for this event will be triggered and sent to the Plan Manager or Support Coordinator when a participant's budget is updated, either via APIs or via a Staff Member using the Staff Portal, given that the provider has consent/authority with the related participant.

\nThe notification will be triggered for the following scenarios:\n- A participant plan extension\n- Service Booking creation, update, or deletion.\n- Service booking on quotation approved.\n- Update on Participant's Active Plan Budget.\n - Spent Amount\n - Remaining Amount (claim status is pending payment, or payment cancellation)\n\n- Sample Response Data - {\\\"event_id\\\":\\\"BUDGET_UPDATED\\\",\\\"response\\\":[ {\\\"participant\\\":430111111,\\\"plan_id\\\":1011111}],\\\"response_sb\\\":[ {\\\"participant\\\":430111111,\\\"service_booking\\\":5555556}],\\\"response_claim\\\":[ {\\\"participant\\\":430111111},{\\\"participant\\\":430111111}]}

\nBased on the budget update scenario, the payload response data may change.

\nNote:

\nSubscription Frequency

\n Set subscription frequency \"IMMEDIATE\". If frequency is set to \"DAILY\" for this subscription, it will prompt an error message.

\nNotification Trigger Frequency:

\n Notification will be triggered and sent on Hourly basis. Please note the Notifications that get triggered between (4:00 PM to 9:00 PM) will be delivered after 9:00 PM\n\nPACE Notifications:
\t\n\n1. Budget Updated (BUDGET_UPDATED) - This notification will allow Plan Managers and Support Coordinator to be notified when a PACE participant's budget is updated.

\nThe trigger is sent:

\t\nThe notification for this event will be triggered sent to the Plan Manager or Support Coordinator when a participant's budget is updated via APIs or a Staff Member using the Staff Portal given that provider has consent/authority with the related participant.

\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"BUDGET_UPDATED\\\",\\\"response\\\":{\\\"participant\\\":430111111}}

\nNote: \n* Frequency is \"IMMEDIATE\", and notification can take up to 1 hour to trigger.

\t\n\n2. New Plan Created (PLAN_APPROVED) - This notification will allow Plan Managers or Support Coordinator to be notified when a participant's new plan is created.

\nThe trigger is sent:

\t\nThe notification for this event will be triggered and sent to the Plan Manager or Support Coordinator when there is a new plan approval given that the provider has consent/authority to view plan details with the related participant.

\t\t\n- Sample Response Data - {\\\"event_id\\\":\\\"PLAN_APPROVED\\\",\\\"response\\\":{\\\"participant\\\":430111111}}

\nNote: \n* Frequency is \"IMMEDIATE\", and notification can take up to 1 hour to trigger.

\t\n\n3. Relationship Created (RLTN_CREATED) - For PACE participant the notification for this event will be triggered when:

\n- My Provider Relationship is created between participant and provider in PACE.

\t\n- Plan Manager Relationship is created between participant and provider in PACE.

\n- Recovery Coach Relationship is created between participant and provider in PACE.

\n- Support Coordinator Relationship is created between participant and provider in PACE.

\t\n- Sample Response Data - {\\\"event_id\\\":\\\"RLTN_CREATED\\\", \\\"response\\\":{\\\"participant\\\":430111111, \\\"provider_role\\\":\\\"Plan Manager\\\",\\\"start_date\\\":\\\"2021-12-30\\\",\\\"end_date\\\":\\\"2021-12-30\\\"}}

\nNote: \n* Frequency is \"IMMEDIATE\", and notification can take up to 1 hour to trigger.

\t\n* End Date can be blank if there is no end date recorded in the PACE system \\\"end_date\\\":\\\"\\\"

\t\n\n4. Relationship End Date Update (RLTN_END_DATE_UPDATE) - For PACE participant the notification for this event will be triggered when:

\n- My Provider Relationship end date is updated in PACE.

\t\n- Plan Manager Relationship end date is updated in PACE.

\n- Recovery Coach Relationship end date is updated in PACE.

\n- Support Coordinator Relationship end date is updated in PACE.

\t\n- Sample Response Data - {\\\"event_id\\\":\\\"RLTN_END_DATE_UPDATE\\\", \\\"response\\\":{\\\"participant\\\":430111111, \\\"provider_role\\\":\\\"Plan Manager\\\",\\\"start_date\\\":\\\"2021-12-30\\\",\\\"end_date\\\":\\\"2021-12-30\\\"}}

\nNote: \n* Frequency is \"IMMEDIATE\", and notification can take up to 1 hour to trigger.

\n\n5. Request for Service Response is Required (RFS_ASSIGNED) - The notification for this event will be triggered when a RFS is issued. Please log into relevant portal to view the details of the RFS and to either accept it or reject it.

\n- Sample Response Data - {\\\"event_id\\\":\\\"RFS_ASSIGNED\\\",\\\"response\\\":{\\\"request_id\\\":1234, \\\"moreinformation\\\":\\\"Please log into the myNDIS provider portal to access the RFS request.\\\"}}

\nNote: \n* Frequency is \"IMMEDIATE\", and notification can take up to 1 hour to trigger.

" parameters: - $ref: '#/parameters/authorization' /unsubscribe: post: responses: '200': description: '' schema: $ref: '#/definitions/notification_unsubscribe_response' tags: [] produces: - application/json operationId: notificationUnsubscribe parameters: - name: notification_unsubscribe_request_data required: true in: body schema: $ref: '#/definitions/notification_unsubscribe_request_data' summary: Notification unsubscribe request description: Enables the provider to unsubscribe from a previously subscribed event parameters: - $ref: '#/parameters/authorization' - $ref: '#/parameters/guid' /report: post: responses: '200': description: '' schema: $ref: '#/definitions/notification_report_response' tags: [] produces: - application/json operationId: notificationReport parameters: - name: notification_report_request_data required: true in: body schema: $ref: '#/definitions/notification_report_request_data' summary: Notification report request description: |- Post event subscription via the POST/subscribe operation. Digital Partners can use the POST/report operation to receive reports for the following events. Sample JSON payload for the below events can be found in the description of the POST/subscribe operation. - PARTICIPANT_REPORT

After subscribing to this event, use the following payload to generate the participant report. Sample payload: { "event_id":"PARTICIPANT_REPORT" } - SB_REPORT

After subscribing to this event, use the following payload to generate the service booking report. Sample payload: { "event_id":"SB_REPORT" } - PRICE_GUIDE_REPORT

After subscribing to this event, use the following payload to generate the price guide report. Sample payload: { "event_id":"PRICE_GUIDE_REPORT" } - PARTICIPANT_CLAIMS

After subscribing to this event, use the following payload with valid date range to generate the participant claim report. Parameters:

- event_id must be PARTICIPANT_CLAIMS

- start_date : Must be within last 90 days

- end_date : Must be within 5 days from start date Sample Request to PARTICIPANT_CLAIMS report: { "event_id":"PARTICIPANT_CLAIMS", "start_date":"2022-09-05", "end_date":"2022-09-09" } - BULK_CLAIM_REPORT

After subscribing to this event, use the following payload with valid batch_reference_name to generate the bulk claim report. Sample payload: { "event_id":"BULK_CLAIM_REPORT", "batch_reference_name":"testingref.csv" } - Note: Ensure that you have already subscribed to this event. parameters: - $ref: '#/parameters/authorization' parameters: authorization: name: authorization type: string required: true in: header description: Bearer token x-example: valid Authorizaton Token guid: name: guid type: string required: false in: header description: The Guid x-example: guid skip: name: skip type: integer required: false in: header description: pagination field - No of rows to be skipped format: int32 x-example: 1 top: name: top type: integer required: false in: header description: pagination field - No of rows to be returned format: int32 x-example: 1 orderby: name: orderby type: string required: false in: header description: Pagination - sort by field x-example: orderbyfield sortorder: name: sortorder type: string required: false in: header description: 'Pagination - sort order: valid values - asc/desc' x-example: asc inlinecount: name: inlinecount type: string required: false in: header description: allpages x-example: allpages quotation_id: name: quotation_id type: string required: true in: path description: Quotation ID x-example: 1001111 definitions: notification_report_response: properties: success: type: boolean description: success status of call example: true errors: $ref: '#/definitions/errors' additionalProperties: false notification_unsubscribe_response: properties: success: type: boolean description: success status of call example: true errors: $ref: '#/definitions/errors' additionalProperties: false notification_subscribe_response: properties: success: type: boolean description: success status of call example: true errors: $ref: '#/definitions/errors' additionalProperties: false notification_patch_response: properties: success: type: boolean description: success status of call example: true errors: $ref: '#/definitions/errors' additionalProperties: false notification_list_response: properties: success: type: boolean description: success status of call example: true result: $ref: '#/definitions/notification_list' description: result object additionalProperties: false notification_list: properties: guid: type: string description: Guid. example: 963421F08D0F1EDBBC9A84982F11F574 maxLength: 80 event_id: type: string description: EventId. example: SB_END_DATE_UPDATED maxLength: 50 device_id: type: string description: Device ID. example: TEST1 maxLength: 100 webhook_url: type: string description: Webhook Url. example: https://ptsv2.com//t/flb28-15415742/post maxLength: 1024 additionalProperties: false notification_report_request_data: properties: event_id: type: string description: Event Id example: PARTICIPANT_REPORT maxLength: 20 batch_reference_name: type: string description: Batch Reference Name, 'batch_reference_name' must end with .csv , and must not exceed 20 characters (inclusive of .csv as extension). Only for the BULK_PROCESS_FINISH event example: testingref.csv maxLength: 20 start_date: type: string description: Service Booking Start Date. Only for the PARTICIPANT_CLAIMS event example: '2022-04-13' format: date end_date: type: string description: Service Booking End Date. Only for the PARTICIPANT_CLAIMS event example: '2022-04-13' format: date additionalProperties: true required: - event_id notification_patch_request_data: properties: webhook_url: type: string description: Webhook Url example: https://ptsv2.com//t/flb28-15415742/post maxLength: 1024 basic_auth: type: string description: Basic Auth for the notification maxLength: 512 example: dsfgsdfgsdfgdfg additionalProperties: true notification_subscribe_request_data: properties: event_id: type: string description: Event Id example: PARTICIPANT_CLAIMS maxLength: 20 webhook_url: type: string description: Provide your own webhook url here example: https://ptsv2.com//t/flb28-15415742/post maxLength: 1024 frequency: type: string description: Frequency of the notification maxLength: 10 example: DAILY signature: type: string description: signature string to be used as part of notification checksum maxLength: 512 example: sigtest algorithm: type: string description: algorithm to be used as part of notification checksum maxLength: 50 example: SHA256 basic_auth: type: string description: Basic Auth for the notification maxLength: 512 example: dsfgsdfgsdfgdfg additionalProperties: true required: - event_id - webhook_url - signature - algorithm notification_unsubscribe_request_data: properties: event_id: type: string description: Event Id example: QUOTATION_RESPO_REQD maxLength: 50 additionalProperties: true required: - event_id errors: description: A set of errors type: array items: type: string example: error http_error: description: A single HTTP response properties: http_code: type: string example: 400 description: HTTP status code http_message: type: string example: Bad Request description: HTTP Message more_information: type: string example: One or more required API parameters are missing. description: Additional information additionalProperties: false tags: []