ReferenceOrthoOrthoPatientidIdVoid
Void an orthodontic assessment
A practitioner's act: the void columns seal and the assessment becomes immutable; it stays on the record.
Loading the API reference…
A practitioner's act: the void columns seal and the assessment becomes immutable; it stays on the record.
A practice API key or an OAuth access token, both presented as Authorization: Bearer <token>. The token itself names the practice, so no organization header is needed.
In: header
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuid^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/ortho/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08/void" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "patientId": "460a6d87-689c-4661-a526-a52450bbe2d7", "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54", "jurisdiction": "unsupported", "practitionerId": "466df888-f8c2-43ae-868e-866bd0a53556", "credentialRevisionId": "1ee229d3-895b-427e-b89e-2367bca0c57c", "appointmentId": "24c6adb3-18be-4108-aa61-3d58879e05a2", "status": "draft", "revision": -9007199254740991, "completedAt": "2019-08-24T14:15:22Z", "amendedAt": "2019-08-24T14:15:22Z", "amendedById": "string", "referredOn": "2019-08-24", "assessedOn": "2019-08-24", "applianceFittedOn": "2019-08-24", "iotnDhc": -9007199254740991, "iotnDhcCode": "a", "iotnAc": -9007199254740991, "iotnNotApplicable": true, "nhsOutcome": "assess_review", "objectives": [ "align" ], "modelsAvailable": true, "privateTreatment": true, "findings": { "property1": null, "property2": null }, "notes": "string", "voidedAt": "2019-08-24T14:15:22Z", "voidReason": "string", "voidedByPractitionerId": "83f63908-23ec-4764-af59-f731f353cc44", "voidCredentialRevisionId": "5a3cba72-8111-4517-aa92-3d2f5758a149", "voidReauthenticatedAt": "2019-08-24T14:15:22Z", "createdById": "string", "createdByName": "string", "createdBySource": "user", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "revisionCount": -9007199254740991, "commissionerApproval": true, "priorApproval": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "patientId": "460a6d87-689c-4661-a526-a52450bbe2d7", "courseId": "a6aaec24-4fe5-49f2-8b74-509d2f931acc", "orthoAssessmentId": "086dfdc6-5f3f-4252-b502-b7bec06b47f7", "status": "required", "reference": "string", "requestedOn": "2019-08-24", "decidedOn": "2019-08-24", "commissioner": "string", "note": "string", "createdById": "string", "createdByName": "string", "createdBySource": "user", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "events": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "approvalId": "23bbe807-dea1-4601-b208-07fd1aaad2b6", "patientId": "460a6d87-689c-4661-a526-a52450bbe2d7", "fromStatus": "required", "toStatus": "required", "occurredAt": "2019-08-24T14:15:22Z", "actorUserId": "string", "actorSource": "user", "reason": "string", "reference": "string", "requestedOn": "2019-08-24", "decidedOn": "2019-08-24", "commissioner": "string", "note": "string", "createdAt": "2019-08-24T14:15:22Z" } ] }}1 <= length <= 2000