Your appointment is scheduled for tomorrow at 3 PM.
"},"subject":{"type":"string","nullable":true,"description":"Subject line for the email message.","example":"Appointment Reminder"}}}},"components/schemas/send-communication-request":{"id":"components/schemas/send-communication-request","kind":"json-schema","title":"send-communication-request","data":{"description":"Request object for sending a communication to a patient.","discriminator":{"propertyName":"communication_channel","mapping":{"sms":"#/components/schemas/communication-sms-message-content","email":"#/components/schemas/communication-email-message-content"}},"oneOf":[{"$ref":"#/components/schemas/communication-sms-message-content"},{"$ref":"#/components/schemas/communication-email-message-content"}]}},"components/schemas/resource_timestamps":{"id":"components/schemas/resource_timestamps","kind":"json-schema","title":"resource_timestamps","data":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}}}},"components/schemas/communication-channel":{"id":"components/schemas/communication-channel","kind":"json-schema","title":"communication-channel","data":{"type":"string","enum":["sms","email","messaging_app","phone_call","letter"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The different communication channels supported by Dentally."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ONLY \"sms\" and \"email\" can be used for sending communications to patients via the API."},"children":[]}]}]}],"x-enumDescriptions":{"email":"Communication sent via email.","sms":"Communication sent via SMS text message.","messaging_app":"Communication sent via a messaging app (e.g., WhatsApp).","phone_call":"Communication done via a phone call.","letter":"Communication sent via postal mail."}}},"components/schemas/external-communication-sms-content":{"id":"components/schemas/external-communication-sms-content","kind":"json-schema","title":"external-communication-sms-content","data":{"type":"object","description":"Request payload for sending an SMS to a patient.","required":["patient_id","communication_channel","direction","message_type","body"],"additionalProperties":false,"properties":{"patient_id":{"type":"string","format":"uuid","description":"ID of the patient who is the intended recipient of the communication."},"communication_channel":{"type":"string","enum":["sms"]},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the communication. \nInbound indicates that the communication was received from the patient, while \noutbound indicates that the communication was sent to the patient.\n"},"message_type":{"$ref":"#/components/schemas/communication-message-type"},"site_id":{"type":"string","format":"uuid","description":"The ID of the site associated with the communication.","example":"123e4567-e89b-12d3-a456-426614174089"},"body":{"type":"string","maxLength":1600,"description":"The main plain text content of the SMS message.","example":"Your appointment is scheduled for tomorrow at 3 PM."}}}},"components/schemas/external-communication-email-content":{"id":"components/schemas/external-communication-email-content","kind":"json-schema","title":"external-communication-email-content","data":{"type":"object","description":"Request payload for sending an email to a patient.","required":["patient_id","communication_channel","direction","message_type","subject"],"anyOf":[{"required":["body"]},{"required":["html_body"]}],"additionalProperties":false,"properties":{"patient_id":{"type":"string","format":"uuid","description":"ID of the patient who is the intended recipient of the communication."},"communication_channel":{"type":"string","enum":["email"]},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the communication. \nInbound indicates that the communication was received from the patient, while \noutbound indicates that the communication was sent to the patient.\n"},"message_type":{"$ref":"#/components/schemas/communication-message-type"},"site_id":{"type":"string","format":"uuid","description":"The ID of the site associated with the communication.","example":"123e4567-e89b-12d3-a456-426614174089"},"body":{"type":"string","description":"The main plain text content of the email message.","maxLength":50000,"example":"Your appointment is scheduled for tomorrow at 3 PM."},"html_body":{"type":"string","maxLength":100000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The main HTML content of the email message."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content will be used as the HTML content as well."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A maximum of 100,000 characters of text is allowed for this property, including all html tags and their content."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 50,000 character limit will also apply to the text content only, and will not include HTML tags."},"children":[]}]}]}],"example":"Your appointment is scheduled for tomorrow at 3 PM.
"},"subject":{"type":"string","nullable":true,"description":"Subject line for the email message.","example":"Appointment Reminder"}}}},"components/schemas/external-communication-letter-content":{"id":"components/schemas/external-communication-letter-content","kind":"json-schema","title":"external-communication-letter-content","data":{"type":"object","description":"Request payload for logging that a letter was sent to a patient.","required":["patient_id","communication_channel","direction","message_type"],"anyOf":[{"required":["body"]},{"required":["body_link"]}],"additionalProperties":false,"properties":{"patient_id":{"type":"string","format":"uuid","description":"ID of the patient who was the recipient of the communication."},"communication_channel":{"type":"string","enum":["letter"]},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the communication. \nInbound indicates that the communication was received from the patient, while \noutbound indicates that the communication was sent to the patient.\n"},"message_type":{"$ref":"#/components/schemas/communication-message-type"},"site_id":{"type":"string","format":"uuid","description":"The ID of the site associated with the communication.","example":"123e4567-e89b-12d3-a456-426614174089"},"body":{"type":"string","description":"The plain text content of the letter.","maxLength":50000,"example":"Your appointment is scheduled for tomorrow at 3 PM."},"body_link":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the full content of the letter, which may be hosted on an external document storage service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be used for letters that have content that exceeds typical size limits for API requests, or for letters that include rich formatting or attachments that cannot be represented in plain text."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This must be a URL that is accessible to the API service with appropriate authentication (e.g. a pre-signed URL for an object in cloud storage)."},"children":[]}]}]}],"maxLength":1600,"example":"https://example.com/letters/12345/content"}}}},"components/schemas/messaging-channel":{"id":"components/schemas/messaging-channel","kind":"json-schema","title":"messaging-channel","data":{"type":"string","enum":["whatsapp","messenger","signal","telegram","other"],"description":"The messaging channel that is/was used to send messages to patients. This allows for rich media messages and interactive communication."}},"components/schemas/external-communication-messaging-app-content":{"id":"components/schemas/external-communication-messaging-app-content","kind":"json-schema","title":"external-communication-messaging-app-content","data":{"type":"object","description":"Request payload for logging that a was sent to a patient via messaging app.","required":["patient_id","communication_channel","direction","message_type","messaging_channel","body"],"additionalProperties":false,"properties":{"patient_id":{"type":"string","format":"uuid","description":"ID of the patient who was the recipient of the communication."},"communication_channel":{"type":"string","enum":["messaging_app"]},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the communication. \nInbound indicates that the communication was received from the patient, while \noutbound indicates that the communication was sent to the patient.\n"},"message_type":{"$ref":"#/components/schemas/communication-message-type"},"messaging_channel":{"$ref":"#/components/schemas/messaging-channel"},"site_id":{"type":"string","format":"uuid","description":"The ID of the site associated with the communication.","example":"123e4567-e89b-12d3-a456-426614174089"},"body":{"type":"string","description":"The main plain text content of the messaging app message.","maxLength":1600,"example":"Your appointment is scheduled for tomorrow at 3 PM."}}}},"components/schemas/external-communication-phone-call-content":{"id":"components/schemas/external-communication-phone-call-content","kind":"json-schema","title":"external-communication-phone-call-content","data":{"type":"object","description":"Request payload for logging that a phone call was made to a patient.","required":["patient_id","communication_channel","message_type","body"],"additionalProperties":false,"properties":{"patient_id":{"type":"string","format":"uuid","description":"ID of the patient who was the recipient of the communication."},"communication_channel":{"type":"string","enum":["phone_call"]},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the communication. \nInbound indicates that the communication was received from the patient, while \noutbound indicates that the communication was sent to the patient.\n"},"message_type":{"$ref":"#/components/schemas/communication-message-type"},"site_id":{"type":"string","format":"uuid","description":"The ID of the site associated with the communication.","example":"123e4567-e89b-12d3-a456-426614174089"},"body":{"type":"string","description":"A summary of the phone call with the patient, which may include details such as whether the call was answered or went to voicemail, and any key information that was communicated during the call. \n","maxLength":1600,"example":"Left a voicemail reminding the patient of their appointment tomorrow at 3 PM."}}}},"components/schemas/external-communication-request":{"id":"components/schemas/external-communication-request","kind":"json-schema","title":"external-communication-request","data":{"description":"Request object for creating an external communication to a patient.","discriminator":{"propertyName":"communication_channel","mapping":{"sms":"#/components/schemas/external-communication-sms-content","email":"#/components/schemas/external-communication-email-content","letter":"#/components/schemas/external-communication-letter-content","messaging_app":"#/components/schemas/external-communication-messaging-app-content","phone_call":"#/components/schemas/external-communication-phone-call-content"}},"oneOf":[{"$ref":"#/components/schemas/external-communication-sms-content"},{"$ref":"#/components/schemas/external-communication-email-content"},{"$ref":"#/components/schemas/external-communication-letter-content"},{"$ref":"#/components/schemas/external-communication-messaging-app-content"},{"$ref":"#/components/schemas/external-communication-phone-call-content"}]}},"components/schemas/fee-tier":{"id":"components/schemas/fee-tier","kind":"json-schema","title":"fee-tier","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pricing tier for a fee. Quantity "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents five or more units."},"children":[]}]}]}],"required":["quantity","price","duration_minutes"],"properties":{"quantity":{"type":"integer","minimum":1,"maximum":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of units this tier applies to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means five or more."},"children":[]}]}]}],"example":1},"price":{"type":"number","description":"The price for this tier.","example":55},"duration_minutes":{"type":"integer","description":"Appointment duration in minutes for this tier.","example":15}},"additionalProperties":false}},"components/schemas/fee":{"id":"components/schemas/fee","kind":"json-schema","title":"fee","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the price a practice charges for one treatment under one fee schedule, so the same treatment can cost different amounts on Private, a health provider, or a membership plan. Prices and appointment durations are exposed as five ordered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (quantities 1–4 and 5 or more) rather than flat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"required":["id","payment_plan_id","treatment_id","is_multiple_pricing","tiers"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the fee.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"payment_plan_id":{"type":"string","format":"uuid","description":"The payment plan (fee schedule) id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_id":{"type":"string","format":"uuid","description":"The treatment id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"is_multiple_pricing":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, all five quantity-based pricing tiers are returned. When false, only the first tier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 1 / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*_one"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields) is returned."},"children":[]}]}]}],"example":true},"tiers":{"type":"array","minItems":1,"maxItems":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing tiers for quantities 1, 2, 3, 4, and 5 (five or more), in that order. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_multiple_pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, all five tiers are included; when false, only the first tier is included."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/fee-tier"}},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/fee-schedule-funding":{"id":"components/schemas/fee-schedule-funding","kind":"json-schema","title":"fee-schedule-funding","data":{"type":"object","description":"How treatment fees on this fee schedule are split between the patient and any third party, and whether Dentally treats the schedule as a national scheme.","required":["type","scheme","claim_timing"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who is expected to pay fees charted against this fee schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the patient pays the full fee. No third-party claim is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filed through this funding model (NHS dentistry uses a separate claims"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process, even when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheme"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nhs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co_payment_split"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a third party meets part of the fee and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"patient pays the remainder."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance_funded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a third party is expected to meet the full fee."},"children":[]}]}]}]}],"enum":["private","co_payment_split","insurance_funded"],"example":"private"},"scheme":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National care scheme Dentally recognises for this fee schedule, when one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the schedule is practice-defined and is not a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recognised scheme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nhs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - UK NHS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nz_moh_sds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - New Zealand Ministry of Health, Special Dental Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nz_moh_ohsa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - New Zealand Ministry of Health, Oral Health Services Adolescents"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nz_moh_ohsa_hc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - New Zealand Ministry of Health, High Caries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nz_acc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - New Zealand Accident Compensation Corporation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional values may be added in the future, this is an open set."},"children":[]}]}]}],"example":"nhs"},"claim_timing":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a third-party claim is filed for items on this fee schedule. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including NHS plans, because this funding model does"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not file claims through this process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_completion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a claim is filed when the treatment plan is completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a claim is filed each time treatment is charged."},"children":[]}]}]}]}],"enum":["on_completion","on_charge",null],"example":null}},"additionalProperties":false}},"components/schemas/fee-schedule-default-appointment-duration":{"id":"components/schemas/fee-schedule-default-appointment-duration","kind":"json-schema","title":"fee-schedule-default-appointment-duration","data":{"type":"object","description":"Default appointment lengths, in minutes, used when booking common visit types for a patient on this fee schedule (examination, scale and polish, both together, or emergency). These are booking defaults, not per-treatment durations.","required":["exam_minutes","scale_and_polish_minutes","exam_scale_and_polish_minutes","emergency_minutes"],"properties":{"exam_minutes":{"type":"integer","minimum":5,"maximum":120,"description":"Default length in minutes for an examination appointment.","example":10},"scale_and_polish_minutes":{"type":"integer","minimum":5,"maximum":120,"description":"Default length in minutes for a scale and polish appointment.","example":10},"exam_scale_and_polish_minutes":{"type":"integer","minimum":5,"maximum":120,"description":"Default length in minutes for a combined examination and scale and polish appointment.","example":20},"emergency_minutes":{"type":"integer","minimum":5,"maximum":120,"description":"Default length in minutes for an emergency appointment.","example":10}},"additionalProperties":false}},"components/schemas/fee-schedule-patient-default":{"id":"components/schemas/fee-schedule-patient-default","kind":"json-schema","title":"fee-schedule-patient-default","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suggested recall and communication values for a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" patient assigned to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this fee schedule. Dentally's own user interface copies these onto the patient"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form when a receptionist creates a patient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are never applied automatically by the API or by the server. Creating or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updating a patient with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_plan_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" leaves the patient's own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"communication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields unchanged. Integrations that want the same starting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"point as the Dentally UI must copy these values onto the patient record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"themselves. Existing patients keep the values already stored on their record;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changing this fee schedule later does not cascade."},"children":[]}]}]}],"required":["recall","communication"],"properties":{"recall":{"type":"object","description":"Default recall schedule and contact method to copy onto a new patient.","required":["dentist_interval_months","hygienist_interval_months","method"],"properties":{"dentist_interval_months":{"type":"integer","minimum":0,"maximum":24,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default months between dentist recalls. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means no dentist recall interval is suggested."},"children":[]}]}]}],"example":6},"hygienist_interval_months":{"type":"integer","minimum":0,"maximum":24,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default months between hygienist recalls. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means no hygienist recall interval is suggested."},"children":[]}]}]}],"example":6},"method":{"$ref":"#/components/schemas/patient-recall-method"}},"additionalProperties":false},"communication":{"type":"object","description":"Default email and SMS contact flags to copy onto a new patient. These are not the patient's live preferences.","required":["is_email_enabled","is_sms_enabled"],"properties":{"is_email_enabled":{"type":"boolean","description":"Whether a new patient should default to accepting email contact.","example":true},"is_sms_enabled":{"type":"boolean","description":"Whether a new patient should default to accepting SMS contact.","example":true}},"additionalProperties":false}},"additionalProperties":false}},"components/schemas/fee-schedule-membership":{"id":"components/schemas/fee-schedule-membership","kind":"json-schema","title":"fee-schedule-membership","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly membership (subscription) configuration for this fee schedule. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the schedule is not a membership plan. Membership is optional practice configuration; many fee schedules never use it."},"children":[]}]}]}],"required":["monthly_fee","exam_appointments_included","hygiene_appointments_included"],"properties":{"monthly_fee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly membership price. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the plan is not sold as a subscription."},"children":[]}]}]}],"example":0},"exam_appointments_included":{"type":"integer","minimum":0,"description":"Number of examination appointments included per year.","example":0},"hygiene_appointments_included":{"type":"integer","minimum":0,"description":"Number of hygiene appointments included per year.","example":0}},"additionalProperties":false}},"components/schemas/fee-schedule":{"id":"components/schemas/fee-schedule","kind":"json-schema","title":"fee-schedule","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["Fee Schedule"]},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee schedule"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a practice-defined pricing and care category (for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example Private, NHS, or a membership plan), not an instalment schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dentally's user interface in the United Kingdom sometimes calls this a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment plan. Each patient is assigned one fee schedule. The schedule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determines default booking lengths, suggested recall and communication"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values for new patients, how fees are funded, and optional membership"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treatment prices live on a separate fee list and are not included here."},"children":[]}]}]}],"required":["id","name","patient_friendly_name","is_active","site_id","account_code","funding","default_appointment_duration","patient_default","membership"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this fee schedule within the practice.","example":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","readOnly":true},"name":{"type":"string","description":"Staff-facing name of the fee schedule as shown in Dentally.","example":"Private"},"patient_friendly_name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional name for patient-facing documents such as estimates. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when unset; callers that need a patient-facing label may fall back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"is_active":{"type":"boolean","description":"Whether the fee schedule is active. Inactive schedules remain assigned to existing patients but are not offered for new assignments in Dentally.","example":true},"site_id":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site this fee schedule is tied to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the schedule is shared across the practice."},"children":[]}]}]}],"example":"a11df716-ce65-4210-be87-8b8ec448f85c"},"account_code":{"type":"string","description":"Accounting code used for financial reporting.","example":"200"},"funding":{"$ref":"#/components/schemas/fee-schedule-funding"},"default_appointment_duration":{"$ref":"#/components/schemas/fee-schedule-default-appointment-duration"},"patient_default":{"$ref":"#/components/schemas/fee-schedule-patient-default"},"membership":{"$ref":"#/components/schemas/fee-schedule-membership"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/invoice":{"id":"components/schemas/invoice","kind":"json-schema","title":"invoice","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["Invoice"]},{"type":"object","description":"An invoice record representing a billing statement for dental services provided to a patient at a practice.","required":["id","patient_id","site_id","reference","invoice_amount","invoice_amount_outstanding","patient_owed_amount","insurance_owed_amount","insurance_paid_amount","pending_payments_amount","tax_amount","discount_amount","is_paid","is_editable"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the invoice.","example":"123e4567-e89b-12d3-a456-426614174000"},"patient_id":{"type":"string","format":"uuid","description":"Unique identifier for the patient associated with this invoice.","example":"550e8400-e29b-41d4-a716-446655440004"},"site_id":{"type":"string","format":"uuid","description":"Unique identifier for the site associated with this invoice.","example":"7c9e6679-7425-40de-944b-e07fc1f90ae7"},"reference":{"type":"string","description":"Human readable invoice identifier.","example":"00103"},"invoice_amount":{"type":"number","description":"Total invoice amount.","example":150},"invoice_amount_outstanding":{"type":"number","description":"Total amount still owed for this invoice.","example":10},"patient_owed_amount":{"type":"number","description":"Amount the patient owes for this invoice.","example":15},"insurance_owed_amount":{"type":"number","description":"Amount the insurance provider owes for this invoice.","example":20},"insurance_paid_amount":{"type":"number","nullable":true,"description":"Amount the insurance provider has paid for this invoice.","example":30},"pending_payments_amount":{"type":"number","description":"Total pending payments by the insurance provider for this invoice.","example":20},"tax_amount":{"type":"number","description":"Total tax amount for this invoice.","example":20},"discount_amount":{"type":"number","description":"Total discount amount for this invoice.","example":20},"is_paid":{"type":"boolean","description":"Whether the invoice has been paid or not.","example":false},"paid_on":{"type":"string","format":"date","nullable":true,"description":"When the invoice was paid on.","example":"2019-05-14"},"is_editable":{"type":"boolean","description":"Whether the invoice can be edited or not.","example":false},"created_by":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the user who created the invoice, if applicable.","example":"550e8400-e29b-41d4-a716-446655440005"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/invoice-item-pricing":{"id":"components/schemas/invoice-item-pricing","kind":"json-schema","title":"invoice-item-pricing","data":{"type":"object","description":"Pricing amounts for an invoice item line.","required":["item_price","total_price"],"properties":{"discount_amount":{"type":"number","nullable":true,"description":"Discount applied to this line item.","example":10},"insurance_expected":{"type":"number","nullable":true,"description":"Amount expected from insurance for this line item.","example":10},"item_price":{"type":"number","description":"Unit price of the line item before quantity.","example":10},"total_price":{"type":"number","description":"Total price for the line item after quantity and discount.","example":10}},"additionalProperties":false}},"components/schemas/health-provider":{"id":"components/schemas/health-provider","kind":"json-schema","title":"health-provider","data":{"type":"object","description":"Health provider base schema.","required":["provider_name"],"properties":{"provider_name":{"type":"string","description":"The name of the health provider.","enum":["nhs","prsi","private"],"example":"nhs"}}}},"components/schemas/invoice-item-health-provider":{"id":"components/schemas/invoice-item-health-provider","kind":"json-schema","title":"invoice-item-health-provider","data":{"allOf":[{"$ref":"#/components/schemas/health-provider"},{"type":"object","description":"Health-provider details for an invoice item line.","required":["is_provider_charge"],"properties":{"is_provider_charge":{"type":"boolean","description":"Whether this line item is a charge associated with the health provider.","example":false}}}]}},"components/schemas/invoice-item":{"id":"components/schemas/invoice-item","kind":"json-schema","title":"invoice-item","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" line on an invoice. Pricing amounts are nested under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; health-provider charge information under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"health_provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["id","pricing","health_provider","name","quantity","invoice_id"],"properties":{"id":{"type":"string","format":"uuid","description":"The id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"pricing":{"$ref":"#/components/schemas/invoice-item-pricing"},"health_provider":{"$ref":"#/components/schemas/invoice-item-health-provider"},"name":{"type":"string","description":"The name of the resource.","example":"Example name"},"quantity":{"type":"integer","description":"The quantity of the resource.","example":1},"treatment_code":{"type":"string","nullable":true,"description":"The treatment code of the resource.","example":"example"},"invoice_id":{"type":"string","format":"uuid","description":"The invoice id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"practitioner_id":{"type":"string","format":"uuid","nullable":true,"description":"The practitioner id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"sundry_id":{"type":"string","format":"uuid","nullable":true,"description":"The sundry id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_plan_id":{"type":"string","format":"uuid","nullable":true,"description":"The treatment plan id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_plan_item_id":{"type":"string","format":"uuid","nullable":true,"description":"The treatment plan item id of the resource.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"created_by_id":{"type":"string","format":"uuid","nullable":true,"description":"UUID of the user who created the invoice item.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/nhs-contract":{"id":"components/schemas/nhs-contract","kind":"json-schema","title":"nhs-contract","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["NHS Contract"]},{"type":"object","description":"An NHS dental service contract configured for a practice.","required":["id","name","is_active","site_id","nhs_contract_number","nhs_site_id","nhs_location_id","start_date","end_date","is_pds_plus","notes"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the NHS contract.","example":"74299a51-bb9a-47eb-9524-20ec9c3958a8","readOnly":true},"name":{"type":"string","description":"User-assigned name for the NHS contract.","example":"Main Surgery NHS Contract"},"is_active":{"type":"boolean","description":"Whether the NHS contract is active in Dentally.","example":true},"site_id":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the Dentally site associated with the contract. Null indicates a contract shared across the practice.","example":"a11df716-ce65-4210-be87-8b8ec448f85c"},"nhs_contract_number":{"type":"string","nullable":true,"description":"The NHS-assigned contract number, when one is recorded.","example":"1234567890"},"nhs_site_id":{"type":"string","nullable":true,"description":"The NHS-assigned site identifier, when one is recorded.","example":"12345"},"nhs_location_id":{"type":"string","nullable":true,"description":"The NHS-assigned treatment location identifier, when one is recorded.","example":"200006"},"start_date":{"type":"string","format":"date","nullable":true,"description":"Date on which the contract started, when recorded.","example":"2025-04-01"},"end_date":{"type":"string","format":"date","nullable":true,"description":"Date on which the contract ends, when recorded.","example":"2028-03-31"},"is_pds_plus":{"type":"boolean","description":"Whether the contract is marked as PDS Plus.","example":false},"notes":{"type":"string","nullable":true,"description":"User-defined notes about the contract.","example":null},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"id","data":{"type":"string","format":"uuid","description":"Unique identifier of the practitioner.","example":"550e8400-e29b-41d4-a716-446655440003"}},"components/schemas/name":{"id":"components/schemas/name","kind":"json-schema","title":"name","data":{"type":"string","nullable":true,"description":"Full display name of the practitioner.","example":"Dr. John Smith","readOnly":true}},"components/schemas/zone-group-ref":{"id":"components/schemas/zone-group-ref","kind":"json-schema","title":"zone-group-ref","data":{"type":"object","nullable":true,"description":"The zone group the calendar zone belongs to, if any. Zone groups are practice-defined labels that group related calendar zones together.","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the zone group.","example":"0f8fad5b-d9cb-469f-a165-70867728950e"},"name":{"type":"string","description":"Display name of the zone group.","example":"New patient exams","readOnly":true}}}},"components/schemas/calendar-zone":{"id":"components/schemas/calendar-zone","kind":"json-schema","title":"calendar-zone","data":{"type":"object","x-tags":["Calendar Zone"],"description":"A calendar zone: one occurrence of a scheduled, recurring block of diary time reserved for a specific purpose, for a practitioner or a room. Calendar zones do not restrict which appointments can be booked within them.","required":["id","title","start_time","finish_time","practitioner","room_id","zone_group","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the calendar zone.","example":"9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a","readOnly":true},"title":{"type":"string","description":"Title of the calendar zone, as shown in the practice diary.","example":"Emergency slots"},"start_time":{"type":"string","format":"date-time","description":"Start time of the calendar zone in ISO 8601 format in UTC.","example":"2026-01-05T09:00:00Z"},"finish_time":{"type":"string","format":"date-time","description":"Finish time of the calendar zone in ISO 8601 format in UTC.","example":"2026-01-05T12:00:00Z"},"practitioner":{"type":"object","nullable":true,"description":"The practitioner the calendar zone is scheduled for. Null when the calendar zone is scheduled for a room instead. Retrieve the full practitioner record for additional details.","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/id"},"name":{"$ref":"#/components/schemas/name"}}},"room_id":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the room the calendar zone is scheduled for, if applicable.","example":"550e8400-e29b-41d4-a716-446655440004"},"zone_group":{"$ref":"#/components/schemas/zone-group-ref"},"created_at":{"type":"string","format":"date-time","nullable":true,"description":"When the calendar zone was created (UTC, ISO 8601). Null for some older calendar zones.","example":"2025-12-01T10:15:00Z"},"updated_at":{"type":"string","format":"date-time","nullable":true,"description":"When the calendar zone was last updated (UTC, ISO 8601). Null for some older calendar zones.","example":"2025-12-01T10:15:00Z"}},"additionalProperties":false}},"components/schemas/map-identifiers-request":{"id":"components/schemas/map-identifiers-request","kind":"json-schema","title":"map-identifiers-request","data":{"type":"object","description":"Legacy identifiers to map to UUIDs for a NexGen resource. At most 100 ids may be supplied per request.","required":["resource","ids"],"properties":{"resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The NexGen resource type to map identifiers for. Supported values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"practitioner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["patient","practitioner","appointment","invoice"]},"ids":{"type":"array","minItems":1,"maxItems":100,"description":"Legacy integer sequential ids to map. Between 1 and 100 ids must be supplied. Each value must be a numeric sequential id for the requested resource.","items":{"type":"integer"}}},"additionalProperties":false}},"components/schemas/identifier-mapping":{"id":"components/schemas/identifier-mapping","kind":"json-schema","title":"identifier-mapping","data":{"type":"object","description":"A mapping from a legacy integer identifier to its UUID.","required":["id","uuid"],"properties":{"id":{"type":"integer","description":"The legacy integer sequential id for the matched resource.","example":42},"uuid":{"type":"string","format":"uuid","description":"The UUID for the resource within the practice.","example":"4EE0FA3E-12F4-4942-9347-1702EB89EBCC"}},"additionalProperties":false}},"components/schemas/treatment-category":{"id":"components/schemas/treatment-category","kind":"json-schema","title":"treatment-category","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["Treatment Category"]},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"treatment category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a practice-defined folder that groups treatments in the Dentally treatment catalogue, for example Diagnostic Related Services or Restorative. Every treatment belongs to exactly one treatment category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treatment categories are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"practice-wide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". They are not tied to a site, so the list returned for a practice is the complete catalogue, and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned or accepted as a filter."},"children":[]}]}]}],"required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the treatment category within the practice. Use this value when referring to the treatment category in subsequent API calls.","example":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","readOnly":true},"name":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the treatment category as displayed in Dentally. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the category has no name. Names are not unique within a practice. The built-in category named \"System Treatments\" is returned like any other category."},"children":[]}]}]}],"example":"Diagnostic Related Services"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/treatment-plan-nhs-health-provider":{"id":"components/schemas/treatment-plan-nhs-health-provider","kind":"json-schema","title":"treatment-plan-nhs-health-provider","data":{"allOf":[{"$ref":"#/components/schemas/health-provider"},{"type":"object","properties":{"uda_value":{"type":"number","nullable":true,"description":"The NHS UDA value for the treatment plan.","example":10},"completed_uda_value":{"type":"number","nullable":true,"description":"The NHS UDA value for completed work on the treatment plan.","example":10}}}]}},"components/schemas/treatment-plan-private-health-provider":{"id":"components/schemas/treatment-plan-private-health-provider","kind":"json-schema","title":"treatment-plan-private-health-provider","data":{"allOf":[{"$ref":"#/components/schemas/health-provider"},{"type":"object","properties":{"treatment_value":{"type":"number","nullable":true,"description":"The total value of treatment under this health provider.","example":10}}}]}},"components/schemas/treatment-plan-health-provider":{"id":"components/schemas/treatment-plan-health-provider","kind":"json-schema","title":"treatment-plan-health-provider","data":{"type":"object","description":"Health provider details for a treatment plan.","anyOf":[{"$ref":"#/components/schemas/treatment-plan-nhs-health-provider"},{"$ref":"#/components/schemas/treatment-plan-private-health-provider"}],"discriminator":{"propertyName":"provider_name","mapping":{"nhs":"#/components/schemas/treatment-plan-nhs-health-provider","private":"#/components/schemas/treatment-plan-private-health-provider"}}}},"components/schemas/treatment-plan":{"id":"components/schemas/treatment-plan","kind":"json-schema","title":"treatment-plan","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["Treatment Plan"]},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"treatment plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a planned course of dental treatment for a patient at a practice."},"children":[]}]}]}],"required":["id","patient_id","health_provider","start_date","completed_at","is_completed"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the treatment plan.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"patient_id":{"type":"string","format":"uuid","description":"Unique identifier of the patient this treatment plan belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"practitioner_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the practitioner this treatment plan belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"site_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier for the site associated with this treatment plan.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"health_provider":{"type":"array","description":"Health provider details for a treatment plan. A plan may include more than one provider.","items":{"$ref":"#/components/schemas/treatment-plan-health-provider"}},"start_date":{"type":"string","description":"The start date of the treatment plan.","example":"2026-01-01"},"end_date":{"type":"string","nullable":true,"description":"The end date of the treatment plan.","example":"2026-01-01"},"completed_at":{"type":"string","format":"date-time","nullable":true,"description":"When the treatment plan was first marked as completed.","example":"2025-06-01T08:00:00Z"},"is_completed":{"type":"boolean","description":"Whether the treatment plan is completed.","example":false},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/treatment-plan-item-custom-fields":{"id":"components/schemas/treatment-plan-item-custom-fields","kind":"json-schema","title":"treatment-plan-item-custom-fields","data":{"type":"object","description":"A custom field value charted on a treatment plan item.","required":["id","value"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the custom field on the treatment plan item.","example":"2c19fdf0-987c-4e5a-aa71-06ad8a58ee22"},"value":{"description":"The value for this custom field on the treatment plan item.","oneOf":[{"type":"string","nullable":true},{"type":"boolean","nullable":true}],"example":true}},"additionalProperties":false}},"components/schemas/treatment-plan-item-clinical":{"id":"components/schemas/treatment-plan-item-clinical","kind":"json-schema","title":"treatment-plan-item-clinical","data":{"type":"object","description":"Clinical details for a treatment plan item.","required":["region","surfaces","teeth"],"properties":{"region":{"type":"string","description":"The region that the treatment plan item is applied to.","enum":["item","patient","site","surface","tooth","toothCoordinate"],"example":"tooth"},"surfaces":{"type":"array","nullable":true,"description":"The surfaces to be treated. Surfaces are numbered 1-5 for incisors, canines, premolars and deciduous teeth and 1-8 for molar teeth. Surface numbering starts from the top left hand corner of the tooth and is counted clockwise around the edge of the tooth and into the center.","items":{"type":"integer"},"example":[1]},"teeth":{"type":"array","nullable":true,"description":"The teeth to be treated. All teeth are stored using Palmer notation.","items":{"type":"string"},"example":["LR4"]}},"additionalProperties":false}},"components/schemas/treatment-health-provider":{"id":"components/schemas/treatment-health-provider","kind":"json-schema","title":"treatment-health-provider","data":{"allOf":[{"$ref":"#/components/schemas/health-provider"},{"type":"object","description":"Health-provider details for a treatment.","required":["provider_treatment_category"],"properties":{"provider_treatment_category":{"type":"string","nullable":true,"description":"The treatment category or claim code under the health provider.","example":"9317"}}}]}},"components/schemas/treatment-nhs-health-provider":{"id":"components/schemas/treatment-nhs-health-provider","kind":"json-schema","title":"treatment-nhs-health-provider","data":{"allOf":[{"$ref":"#/components/schemas/treatment-health-provider"},{"type":"object","description":"NHS health-provider details for a treatment.","properties":{"uda_band":{"type":"integer","nullable":true,"description":"The NHS UDA band of the treatment.","example":1}}}]}},"components/schemas/treatment-plan-item-health-provider":{"id":"components/schemas/treatment-plan-item-health-provider","kind":"json-schema","title":"treatment-plan-item-health-provider","data":{"type":"object","description":"Health provider details for a treatment plan item.","oneOf":[{"$ref":"#/components/schemas/treatment-nhs-health-provider"}],"discriminator":{"propertyName":"provider_name","mapping":{"nhs":"#/components/schemas/treatment-nhs-health-provider"}}}},"components/schemas/treatment-plan-item":{"id":"components/schemas/treatment-plan-item","kind":"json-schema","title":"treatment-plan-item","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"treatment plan item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a treatment charted on a patient’s treatment plan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item links a treatment to a plan, with pricing, clinical details, completion status, notes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and health provider details where applicable."},"children":[]}]}]}],"required":["id","patient_id","practitioner_id","fee_schedule_id","treatment_plan_id","nomenclature","price","is_charged","is_completed","duration_minutes","custom_fields","clinical","health_provider"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the treatment plan item.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"patient_id":{"type":"string","format":"uuid","description":"Unique identifier of the patient this treatment plan item belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"practitioner_id":{"type":"string","format":"uuid","description":"Unique identifier of the practitioner this treatment plan item belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"fee_schedule_id":{"type":"string","format":"uuid","description":"Unique identifier of the fee schedule this treatment plan item belongs to. Dentally's user interface in the United Kingdom sometimes calls this a payment plan.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"referrer_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the referrer of the treatment plan item.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"invoice_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the invoice the treatment plan item belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_appointment_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the treatment appointment the treatment plan item belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the treatment the treatment plan item belongs to.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"treatment_plan_id":{"type":"string","format":"uuid","description":"Unique identifier of the treatment plan the treatment plan item belongs to."},"nomenclature":{"type":"string","description":"The classification of the treatment plan item.","example":"Acute Mucosal Infection"},"patient_friendly_nomenclature":{"type":"string","nullable":true,"description":"The patient friendly classification of the treatment plan item.","example":"Urgent/Emergency Assessment"},"price":{"type":"number","description":"The price of the treatment plan item.","example":10},"is_charged":{"type":"boolean","description":"Whether the treatment plan item is charged.","example":false},"is_completed":{"type":"boolean","description":"Whether the treatment plan item is completed.","example":false},"completed_at":{"type":"string","format":"date-time","nullable":true,"description":"When the treatment plan item was first marked as completed.","example":"2025-06-01T08:00:00Z"},"duration_minutes":{"type":"integer","description":"The duration in minutes of the treatment plan item.","example":30},"notes":{"type":"string","nullable":true,"description":"The notes relating to the treatment plan item in HTML.","example":"This is a note
"},"custom_fields":{"type":"array","description":"The custom fields for this treatment plan item.","items":{"$ref":"#/components/schemas/treatment-plan-item-custom-fields"}},"clinical":{"$ref":"#/components/schemas/treatment-plan-item-clinical"},"health_provider":{"$ref":"#/components/schemas/treatment-plan-item-health-provider"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/treatment":{"id":"components/schemas/treatment","kind":"json-schema","title":"treatment","data":{"allOf":[{"$ref":"#/components/schemas/entity-timestamps"},{"x-tags":["Treatment"]},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"treatment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a practice-level catalogue entry for a dental procedure that can be assigned to a patient treatment plan. Every treatment belongs to exactly one treatment category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treatments are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"practice-wide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". They are not tied to a site, so the list returned for a practice is the complete catalogue, and no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned or accepted as a filter."},"children":[]}]}]}],"required":["id","is_active","owner","treatment_category_id"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the treatment within the practice. Use this value when referring to the treatment in subsequent API calls.","example":"94525b9c-af18-40a5-905f-f539f1c45f6f","readOnly":true},"code":{"type":"string","nullable":true,"description":"Short procedure code for the treatment within the practice.","example":"100"},"nomenclature":{"type":"string","nullable":true,"description":"Display name of the treatment in Dentally.","example":"Exam"},"description":{"type":"string","nullable":true,"description":"Longer description of the treatment.","example":"An evaluation performed on a patient of record to determine any changes in the patient's dental and medical health status."},"patient_nomenclature":{"type":"string","nullable":true,"description":"Patient-facing name for the treatment.","example":"Examination"},"patient_description":{"type":"string","nullable":true,"description":"Patient-facing description of the treatment.","example":null},"treatment_category_id":{"type":"string","format":"uuid","description":"Identifier of the treatment category this treatment belongs to.","example":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc"},"is_active":{"type":"boolean","description":"Whether the treatment is active in the practice catalogue.","example":true},"is_displayed_on_invoice":{"type":"boolean","nullable":true,"description":"Whether the treatment is displayed on patient invoices.","example":true},"region":{"type":"string","nullable":true,"description":"Chart targeting for how the treatment is applied.","enum":["item","patient","site","surface","tooth","toothCoordinate"],"example":"patient"},"owner":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who manages the treatment. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"practice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for practice-authored entries; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Dentally-managed system treatments."},"children":[]}]}]}],"enum":["practice","system"],"example":"practice"},"health_provider":{"type":"object","nullable":true,"description":"Health-provider details for this treatment.","anyOf":[{"$ref":"#/components/schemas/treatment-health-provider"},{"$ref":"#/components/schemas/treatment-nhs-health-provider"}],"discriminator":{"propertyName":"provider_name","mapping":{"nhs":"#/components/schemas/treatment-nhs-health-provider","prsi":"#/components/schemas/treatment-health-provider"}}},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"}},"additionalProperties":false}]}},"components/schemas/subscription-status":{"id":"components/schemas/subscription-status","kind":"json-schema","title":"subscription-status","data":{"type":"string","enum":["Unknown","Pending","Completed"],"description":"The status of the subscription."}},"components/schemas/subscription":{"id":"components/schemas/subscription","kind":"json-schema","title":"subscription","data":{"type":"object","required":["id","partner_id","product_id","practice_id","status","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The identifier of the subscription, as a uuid."},"partner_id":{"type":"string","format":"uuid","description":"The identifier of the partner which owns the product, as a uuid."},"product_id":{"type":"string","description":"The identifier of the product which is subscribed to, as a uuid."},"practice_id":{"type":"string","format":"uuid","description":"The identifier of the practice which the subscription is for, as a uuid."},"site_id":{"type":"string","format":"uuid","description":"An optional identifier of the site within the practice which the subscription is for, as a uuid. If not specified, the subscription is for all sites within the practice.","nullable":true},"status":{"$ref":"#/components/schemas/subscription-status","description":"The status of the subscription."},"created_at":{"type":"string","format":"date-time","description":"The timestamp of when this subscription was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp of when this subscription was updated.","nullable":true},"deleted_at":{"type":"string","format":"date-time","description":"The timestamp of when this subscription was deleted, or when it will expire if a future date is specified.","nullable":true}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":20},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2026-01-01"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"$ref":"#/components/schemas/appointment-state"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Appointments in the current page.","items":{"$ref":"#/components/schemas/appointment"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON envelope with the newly created appointment as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member."},"children":[]}]}]}],"required":["data"],"properties":{"data":{"description":"Full details for the newly created appointment.","allOf":[{"$ref":"#/components/schemas/appointment"}]}},"additionalProperties":false},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON envelope with the appointment as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member."},"children":[]}]}]}],"required":["data"],"properties":{"data":{"description":"Full details for one appointment.","allOf":[{"$ref":"#/components/schemas/appointment"}]}},"additionalProperties":false},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON envelope with the updated appointment as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member."},"children":[]}]}]}],"required":["data"],"properties":{"data":{"description":"Full details for the updated appointment.","allOf":[{"$ref":"#/components/schemas/appointment"}]}},"additionalProperties":false},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"List of appointment reasons.","items":{"$ref":"#/components/schemas/appointment-reason"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"List of appointment cancellation reasons.","items":{"$ref":"#/components/schemas/appointment-cancellation-reason"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-01-01"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-03-31"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Calendar zones in the current page.","items":{"$ref":"#/components/schemas/calendar-zone"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/calendar-zone"}},"additionalProperties":false},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"List of patients.","items":{"$ref":"#/components/schemas/patient"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","description":"JSON envelope with the newly created patient.","required":["data"],"properties":{"data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created patient record; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas/patient.yml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/patient"}]}}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","format":"email"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"description":"The patient record.","allOf":[{"$ref":"#/components/schemas/patient"}]}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"description":"The updated patient record.","allOf":[{"$ref":"#/components/schemas/patient"}]}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/patient-account"}},"additionalProperties":false},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Practitioners in the current page.","items":{"$ref":"#/components/schemas/practitioner"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"type":"string","format":"uuid"}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Availability slots in the current page.","items":{"$ref":"#/components/schemas/availability-slot"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/practitioner"}},"additionalProperties":false},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Rota schedule history rows in the current page.","items":{"$ref":"#/components/schemas/rota-schedule-history"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Sites in the current page, each including address, contact details, and opening hours for that location.","items":{"$ref":"#/components/schemas/site"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/site"}},"additionalProperties":false},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"object","description":"JSON envelope with the ID of the communication that was sent.","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/resource_timestamps"},{"type":"object","description":"Object containing the ID of the communication that was sent.","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of the communication that was sent.","example":"123e4567-e89b-12d3-a456-426614174005"}}}]}}},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"$ref":"#/components/schemas/communication-channel"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON envelope with the communication details as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member."},"children":[]}]}]}],"required":["data"],"properties":{"data":{"description":"Full details for one response communication.","allOf":[{"type":"object","description":"Object containing the details of the communication.","properties":{"id":{"type":"string","format":"uuid","description":"ID of the requested communication.","example":"123e4567-e89b-12d3-a456-426614174005"},"communication_channel":{"$ref":"#/components/schemas/communication-channel","description":"The channel used to send the communication (e.g., \"sms\", \"email\").","example":"sms"},"body":{"type":"string","description":"The text content of the reply.","example":"I would love to attend my appointment tomorrow at 3 PM."}}},{"$ref":"#/components/schemas/resource_timestamps"}]}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","description":"JSON envelope with the ID of the external communication that was created.","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/resource_timestamps"},{"type":"object","description":"Object containing the ID of the external communication that was created.","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of the external communication that was created.","example":"123e4567-e89b-12d3-a456-426614174005"}}}]}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Fees in the current page.","items":{"$ref":"#/components/schemas/fee"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/fee"}},"additionalProperties":false},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Fee schedules in the current page.","items":{"$ref":"#/components/schemas/fee-schedule"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/fee-schedule"}},"additionalProperties":false},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"List of invoices.","items":{"$ref":"#/components/schemas/invoice"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON envelope with the invoice as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member."},"children":[]}]}]}],"required":["data"],"properties":{"data":{"description":"Full details for one invoice.","allOf":[{"$ref":"#/components/schemas/invoice"}]}},"additionalProperties":false},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"InvoiceItems in the current page.","items":{"$ref":"#/components/schemas/invoice-item"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"NHS contracts in the current page.","items":{"$ref":"#/components/schemas/nhs-contract"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/nhs-contract"}},"additionalProperties":false},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","description":"Mappings for requested ids that matched a record. Ids with no match are omitted.","maxItems":100,"items":{"$ref":"#/components/schemas/identifier-mapping"}}},"additionalProperties":false},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Treatments in the current page.","items":{"$ref":"#/components/schemas/treatment"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/treatment"}},"additionalProperties":false},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Treatment categories in the current page.","items":{"$ref":"#/components/schemas/treatment-category"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/treatment-category"}},"additionalProperties":false},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Treatment Plans in the current page.","items":{"$ref":"#/components/schemas/treatment-plan"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/treatment-plan"}},"additionalProperties":false},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"Treatment Plan Items in the current page.","items":{"$ref":"#/components/schemas/treatment-plan-item"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":"List of active subscriptions.","items":{"$ref":"#/components/schemas/subscription"}},"meta":{"$ref":"#/components/schemas/meta"}},"additionalProperties":false},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/subscription"}},"additionalProperties":false},"id":"schema_54"}},"exampleStore":{"components/examples/response-appointment-list-example":{"id":"components/examples/response-appointment-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","patient":{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","first_name":"John","middle_name":null,"last_name":"Smith"},"start_time":"2025-09-01T11:00:00Z","finish_time":"2025-09-01T11:45:00Z","duration_minutes":45,"notes":"Follow-up appointment.","practitioner":{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"Dr. Johnson"},"site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","state":"Confirmed","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-08-05T10:30:00Z","updated_at":"2025-08-20T16:15:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of appointments","description":"Paginated list with cursor for the next page."},"components/examples/problem-bad-request-example":{"id":"components/examples/problem-bad-request-example","value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field)."},"components/examples/problem-unauthorized-example":{"id":"components/examples/problem-unauthorized-example","value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated."},"components/examples/problem-user-error-example":{"id":"components/examples/problem-user-error-example","value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type)."},"components/examples/problem-server-error-example":{"id":"components/examples/problem-server-error-example","value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure."},"components/examples/response-appointment-single-example":{"id":"components/examples/response-appointment-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"summary":"Single appointment","description":"Wrapper returned by get, create, or update appointment."},"components/examples/problem-unprocessable-entity-example":{"id":"components/examples/problem-unprocessable-entity-example","value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation."},"components/examples/problem-not-found-example":{"id":"components/examples/problem-not-found-example","value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier."},"components/examples/response-appointment-reason-list-example":{"id":"components/examples/response-appointment-reason-list-example","value":{"data":[{"id":"4EE0FA3E-12F4-4942-9347-1702EB89EBCC","name":"Exam + Scale & Polish","is_active":true,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"9A2B3C4D-5E6F-7081-92A3-B4C5D6E7F809","name":"New Patient Consultation","is_active":true,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of appointment reasons","description":"Paginated list with cursor for the next page."},"components/examples/response-appointment-cancellation-reason-list-example":{"id":"components/examples/response-appointment-cancellation-reason-list-example","value":{"data":[{"id":"AE492D60-8970-4AA0-8D5C-84FFAF4A16A3","name":"Patient - Illness","type":"cancelled","is_active":true,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"EFB3701D-649E-407F-860E-D08C31FBF2F4","name":"Practice - Staff Issue","type":"cancelled","is_active":true,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of appointment cancellation reasons","description":"Paginated list with cursor for the next page."},"components/examples/response-patient-single-example":{"id":"components/examples/response-patient-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_active":true,"is_appointment_booking_prevented":false,"preferred_phone_type":"mobile","first_name":"Jane","last_name":"Doe","date_of_birth":"1990-04-12","title":"Ms","ethnicity":"01","payment_plan_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","address":{"address_line_1":"42 High Street","locality":"London","administrative_area":"Greater London","postal_code":"EC1A 1BB"},"email_address":"jane.doe@example.com","biological_sex":"female","phones":[{"phone_type":"mobile","phone_number":"+447911123456","phone_country":"GB","phone_number_normalized":"+447911123456"}],"communication":{"is_marketing_enabled":true,"is_email_enabled":true,"is_sms_enabled":false},"recall":{"dentist":{"date":"2026-03-15","interval_months":6},"hygienist":{"date":"2026-04-01","interval_months":6},"method":"email"},"archived_reason":null,"is_bad_debtor":false,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"summary":"Single patient","description":"Wrapper returned by get, create, or update patient."},"components/examples/response-patient-account-example":{"id":"components/examples/response-patient-account-example","value":{"data":{"owning_patient_id":"550e8400-e29b-41d4-a716-446655440004","balance_amount":-125.5,"patient_balance_amount":-100.5,"pending_payments_amount":-25,"deposit_amount":0,"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"summary":"Patient account balance","description":"Example where the patient owes the practice: monetary amounts in this sample are negative. Accounts in credit have positive amounts."},"components/examples/response-practitioner-list-example":{"id":"components/examples/response-practitioner-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Jane Doe","user_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":"Hygienist","nhs_number":"9998887777","gdc_number":"123456","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"John Smith","user_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":null,"nhs_number":null,"gdc_number":null,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of practitioners","description":"Paginated list with cursor for the next page."},"components/examples/response-practitioner-availability-list-example":{"id":"components/examples/response-practitioner-availability-list-example","value":{"data":[{"start_time":"2031-12-01T09:00:00+00:00","finish_time":"2031-12-01T10:00:00+00:00","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"start_time":"2031-12-01T10:00:00+00:00","finish_time":"2031-12-01T11:00:00+00:00","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of practitioner availability slots","description":"Paginated list of availability slots for the requested practitioners, ordered by start time ascending."},"components/examples/response-practitioner-single-example":{"id":"components/examples/response-practitioner-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Jane Doe","user_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":"Therapist","nhs_number":"NHS-001","gdc_number":"123456","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"summary":"Single practitioner","description":"Wrapper returned by get practitioner."},"components/examples/response-rota-schedule-history-list-example":{"id":"components/examples/response-rota-schedule-history-list-example","value":{"data":[{"practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","date":"2025-01-15","is_available":true,"start_time":"09:00","finish_time":"17:30","breaks":[{"name":"Lunch","start_time":"13:00","finish_time":"14:00"}],"created_at":"2025-01-16T00:05:12Z","updated_at":"2025-01-16T00:05:12Z"},{"practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","date":"2025-01-14","is_available":false,"start_time":null,"finish_time":null,"breaks":[],"created_at":"2025-01-15T00:05:08Z","updated_at":"2025-01-15T00:05:08Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of rota schedule histories","description":"Paginated list of snapshotted rota days for a practitioner, ordered by date descending."},"components/examples/response-site-list-example":{"id":"components/examples/response-site-list-example","value":{"data":[{"id":"8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c","name":"Dentally High Street","address":{"address_line_1":"42 High Street","address_line_2":null,"address_line_3":null,"locality":"Manchester","administrative_area":"Greater Manchester","postal_code":"M1 1AA"},"contact_details":{"email_address":"reception@example.com","phone_number":"+441612345678","website_url":"https://example.com/high-street"},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"09:00","close_at":"17:30"},{"weekday":"Tuesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Wednesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Thursday","open_at":"09:00","close_at":"17:30"},{"weekday":"Friday","open_at":"09:00","close_at":"17:00"},{"weekday":"Saturday","open_at":null,"close_at":null}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"2b3c4d5e-6f70-8192-a3b4-c5d6e7f80901","name":"Dentally Riverside","address":{"address_line_1":"10 River Road","address_line_2":"Unit 2","address_line_3":null,"locality":"Salford","administrative_area":"Greater Manchester","postal_code":"M50 1AB"},"contact_details":{"email_address":"riverside@example.com","phone_number":"+441614445566","website_url":null},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"08:30","close_at":"18:00"},{"weekday":"Tuesday","open_at":"08:30","close_at":"18:00"},{"weekday":"Wednesday","open_at":"08:30","close_at":"18:00"},{"weekday":"Thursday","open_at":"08:30","close_at":"18:00"},{"weekday":"Friday","open_at":"08:30","close_at":"18:00"},{"weekday":"Saturday","open_at":"09:00","close_at":"13:00"}],"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"summary":"First page of sites","description":"Paginated list with cursor for the next page."},"components/examples/response-site-single-example":{"id":"components/examples/response-site-single-example","value":{"data":{"id":"8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c","name":"Dentally High Street","address":{"address_line_1":"42 High Street","address_line_2":null,"address_line_3":null,"locality":"Manchester","administrative_area":"Greater Manchester","postal_code":"M1 1AA"},"contact_details":{"email_address":"reception@example.com","phone_number":"+441612345678","website_url":"https://example.com/high-street"},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"09:00","close_at":"17:30"},{"weekday":"Tuesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Wednesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Thursday","open_at":"09:00","close_at":"17:30"},{"weekday":"Friday","open_at":"09:00","close_at":"17:00"},{"weekday":"Saturday","open_at":null,"close_at":null}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"summary":"Single site","description":"Wrapper returned by get site."},"components/examples/response-fee-list-example":{"id":"components/examples/response-fee-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_multiple_pricing":true,"tiers":[{"quantity":1,"price":55,"duration_minutes":15},{"quantity":2,"price":75,"duration_minutes":20},{"quantity":3,"price":95,"duration_minutes":25},{"quantity":4,"price":110,"duration_minutes":30},{"quantity":5,"price":125,"duration_minutes":35}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"summary":"First page of fees","description":"Paginated list with cursor for the next page."},"components/examples/response-fee-single-example":{"id":"components/examples/response-fee-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_multiple_pricing":true,"tiers":[{"quantity":1,"price":55,"duration_minutes":15},{"quantity":2,"price":75,"duration_minutes":20},{"quantity":3,"price":95,"duration_minutes":25},{"quantity":4,"price":110,"duration_minutes":30},{"quantity":5,"price":125,"duration_minutes":35}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}},"summary":"Single fee","description":"Wrapper returned by get fee."},"components/examples/response-fee-schedule-list-example":{"id":"components/examples/response-fee-schedule-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"NHS","patient_friendly_name":null,"is_active":true,"site_id":null,"account_code":"200","funding":{"type":"private","scheme":"nhs","claim_timing":null},"default_appointment_duration":{"exam_minutes":10,"scale_and_polish_minutes":10,"exam_scale_and_polish_minutes":20,"emergency_minutes":10},"patient_default":{"recall":{"dentist_interval_months":6,"hygienist_interval_months":6,"method":"letter"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-01-15T09:30:00Z","updated_at":"2026-03-02T11:12:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"Private","patient_friendly_name":null,"is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","account_code":"200","funding":{"type":"private","scheme":null,"claim_timing":null},"default_appointment_duration":{"exam_minutes":10,"scale_and_polish_minutes":10,"exam_scale_and_polish_minutes":20,"emergency_minutes":10},"patient_default":{"recall":{"dentist_interval_months":6,"hygienist_interval_months":6,"method":"letter"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-01-15T09:31:00Z","updated_at":"2025-11-04T16:22:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of fee schedules","description":"Paginated list with a cursor for the next page."},"components/examples/response-fee-schedule-single-example":{"id":"components/examples/response-fee-schedule-single-example","value":{"data":{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","name":"OHSA - MoH","patient_friendly_name":"Oral Health Services Adolescents (OHSA)","is_active":true,"site_id":null,"account_code":"200","funding":{"type":"insurance_funded","scheme":"nz_moh_ohsa","claim_timing":"on_completion"},"default_appointment_duration":{"exam_minutes":30,"scale_and_polish_minutes":30,"exam_scale_and_polish_minutes":30,"emergency_minutes":30},"patient_default":{"recall":{"dentist_interval_months":12,"hygienist_interval_months":12,"method":"email"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-04-01T00:00:00Z","updated_at":"2026-01-20T08:45:00Z"}},"summary":"Fee schedule","description":"A fee schedule configured for the practice."},"components/examples/response-invoice-list-example":{"id":"components/examples/response-invoice-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":50,"patient_owed_amount":20,"insurance_owed_amount":10,"insurance_paid_amount":5,"pending_payments_amount":5,"tax_amount":10,"discount_amount":10,"is_paid":false,"paid_on":null,"is_editable":false,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","patient_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":0,"patient_owed_amount":150,"insurance_owed_amount":0,"insurance_paid_amount":0,"pending_payments_amount":0,"tax_amount":0,"discount_amount":0,"is_paid":true,"paid_on":"2026-01-18","is_editable":true,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of invoices","description":"Paginated list with cursor for the next page."},"components/examples/response-invoice-single-example":{"id":"components/examples/response-invoice-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":50,"patient_owed_amount":20,"insurance_owed_amount":10,"insurance_paid_amount":5,"pending_payments_amount":5,"tax_amount":10,"discount_amount":10,"is_paid":false,"paid_on":null,"is_editable":false,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"summary":"Single invoice","description":"Wrapper returned by get, create, or update invoice."},"components/examples/response-invoice-invoice-item-list-example":{"id":"components/examples/response-invoice-invoice-item-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","pricing":{"discount_amount":10,"insurance_expected":10,"item_price":10,"total_price":10},"health_provider":{"is_provider_charge":false,"provider_name":"nhs"},"name":"Example name","quantity":1,"treatment_code":"example","invoice_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","sundry_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_plan_item_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","created_by_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"summary":"First page of invoice items","description":"Paginated list with cursor for the next page."},"components/examples/response-nhs-contract-list-example":{"id":"components/examples/response-nhs-contract-list-example","value":{"data":[{"id":"74299a51-bb9a-47eb-9524-20ec9c3958a8","name":"Main Surgery NHS Contract","is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","nhs_contract_number":"1234567890","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2025-04-01","end_date":null,"is_pds_plus":false,"notes":null,"created_at":"2025-01-10T09:00:00Z","updated_at":"2026-08-20T11:20:00Z"},{"id":"c1d2e3f4-a5b6-7890-cdef-123456789abc","name":"Previous Main Surgery Contract","is_active":false,"site_id":null,"nhs_contract_number":"1234567891","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2024-04-01","end_date":"2026-03-31","is_pds_plus":false,"notes":"Historical contract","created_at":"2024-02-01T08:30:00Z","updated_at":"2026-04-02T10:15:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of NHS contracts","description":"Paginated list with a cursor for the next page."},"components/examples/response-nhs-contract-single-example":{"id":"components/examples/response-nhs-contract-single-example","value":{"data":{"id":"74299a51-bb9a-47eb-9524-20ec9c3958a8","name":"Main Surgery NHS Contract","is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","nhs_contract_number":"1234567890","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2025-04-01","end_date":null,"is_pds_plus":false,"notes":null,"created_at":"2025-01-10T09:00:00Z","updated_at":"2026-08-20T11:20:00Z"}},"summary":"NHS contract","description":"An NHS contract configured for the practice."},"components/examples/response-calendar-zone-list-example":{"id":"components/examples/response-calendar-zone-list-example","value":{"data":[{"id":"9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a","title":"Emergency slots","start_time":"2026-01-05T09:00:00Z","finish_time":"2026-01-05T12:00:00Z","practitioner":{"id":"550e8400-e29b-41d4-a716-446655440003","name":"Dr. John Smith"},"room_id":null,"zone_group":{"id":"0f8fad5b-d9cb-469f-a165-70867728950e","name":"Emergencies"},"created_at":"2025-12-01T10:15:00Z","updated_at":"2025-12-01T10:15:00Z"},{"id":"3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f","title":"Hygiene clinic","start_time":"2026-01-06T13:00:00Z","finish_time":"2026-01-06T17:00:00Z","practitioner":null,"room_id":"550e8400-e29b-41d4-a716-446655440004","zone_group":null,"created_at":null,"updated_at":null}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of calendar zones","description":"Paginated list with a cursor for the next page."},"components/examples/response-calendar-zone-single-example":{"id":"components/examples/response-calendar-zone-single-example","value":{"data":{"id":"9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a","title":"Emergency slots","start_time":"2026-01-05T09:00:00Z","finish_time":"2026-01-05T12:00:00Z","practitioner":{"id":"550e8400-e29b-41d4-a716-446655440003","name":"Dr. John Smith"},"room_id":null,"zone_group":{"id":"0f8fad5b-d9cb-469f-a165-70867728950e","name":"Emergencies"},"created_at":"2025-12-01T10:15:00Z","updated_at":"2025-12-01T10:15:00Z"}},"summary":"Single calendar zone","description":"One calendar zone scheduled for a practitioner."},"components/examples/response-treatment-category-list-example":{"id":"components/examples/response-treatment-category-list-example","value":{"data":[{"id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","name":"Diagnostic Related Services","created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"},{"id":"9a2b3c4d-5e6f-4081-92a3-b4c5d6e7f809","name":"Restorative","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"},{"id":"09b2e37e-8f42-4676-adf3-cb97fc9ee3e6","name":null,"created_at":"2025-05-01T08:00:00Z","updated_at":"2025-05-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQwODowMDowMFoifQ"}},"summary":"First page of treatment categories","description":"Paginated list with cursor for the next page. Categories may have a null name."},"components/examples/response-treatment-category-single-example":{"id":"components/examples/response-treatment-category-single-example","value":{"data":{"id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","name":"Diagnostic Related Services","created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"summary":"Single treatment category","description":"One treatment category in the practice catalogue."},"components/examples/response-treatment-plan-list-example":{"id":"components/examples/response-treatment-plan-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"ea845d0d-d6d7-4dd4-8321-1bd803c897e8","practitioner_id":"c8e79da4-e253-4887-8084-04786bff7e4f","site_id":"2836b794-0d77-4788-b06f-da6927cab30d","health_provider":[{"provider_name":"nhs","uda_value":1.5,"completed_uda_value":3},{"provider_name":"private","treatment_value":50}],"start_date":"2026-06-01","end_date":"2026-10-01","completed_at":"2026-07-01T08:00:00Z","is_completed":true,"created_at":"2026-06-01T08:00:00Z","updated_at":"2026-10-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"summary":"First page of treatment plans","description":"Paginated list with cursor for the next page."},"components/examples/response-treatment-plan-single-example":{"id":"components/examples/response-treatment-plan-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","health_provider":[{"provider_name":"nhs","uda_value":1.5,"completed_uda_value":3}],"start_date":"2026-06-01","end_date":null,"completed_at":null,"is_completed":false,"created_at":"2026-06-01T08:00:00Z","updated_at":"2026-10-01T08:00:00Z"}},"summary":"Single treatment plan","description":"Wrapper returned by get treatment plan."},"components/examples/response-treatment-plan-treatment-plan-item-list-example":{"id":"components/examples/response-treatment-plan-treatment-plan-item-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"9efcb282-8f4f-4ac1-9259-d4e3fe9b6531","practitioner_id":"0930501c-aafd-45e7-90c3-76498ba2d126","fee_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","referrer_id":"e1d854af-15db-4482-8e29-39e74a6c7f75","invoice_id":"10548353-ea10-451f-beac-9b5858a87e01","treatment_appointment_id":"a58310cd-5473-421e-b6ad-ff31f647140d","treatment_id":"68adfa9e-a3c9-47c8-812c-3fe55640b560","treatment_plan_id":"a2f6bdbb-ac9b-4a24-8136-98f1c06fbb89","nomenclature":"Acute Mucosal Infection","patient_friendly_nomenclature":"Urgent/Emergency Assessment","price":10,"is_charged":false,"is_completed":true,"completed_at":"2025-06-01T08:00:00Z","duration_minutes":30,"notes":"This is a note
","custom_fields":[{"id":"e4b5cd1e-4a43-46ce-bdb0-fe75f2e8cd14","value":true}],"clinical":{"region":"tooth","surfaces":[1],"teeth":["LR4"]},"health_provider":{"provider_name":"nhs","provider_treatment_category":"9306","uda_band":2},"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"summary":"First page of treatment plan items","description":"Paginated list with cursor for the next page."},"components/examples/response-treatment-list-example":{"id":"components/examples/response-treatment-list-example","value":{"data":[{"id":"94525b9c-af18-40a5-905f-f539f1c45f6f","code":"100","nomenclature":"Exam","description":"An evaluation performed on a patient of record to determine any changes in the patient's dental and medical health status.","patient_nomenclature":"Examination","patient_description":null,"treatment_category_id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","is_active":true,"is_displayed_on_invoice":true,"region":"patient","owner":"practice","health_provider":{"provider_name":"nhs","provider_treatment_category":"9317","uda_band":1},"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"},{"id":"a1b2c3d4-e5f6-4789-a012-3456789abcde","code":"SYS001","nomenclature":"Unerupted","description":null,"patient_nomenclature":null,"patient_description":null,"treatment_category_id":"09b2e37e-8f42-4676-adf3-cb97fc9ee3e6","is_active":true,"is_displayed_on_invoice":false,"region":"tooth","owner":"system","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQwODowMDowMFoifQ"}},"summary":"First page of treatments","description":"Paginated list with cursor for the next page. Includes a practice-authored treatment and a Dentally-managed system treatment."},"components/examples/response-treatment-single-example":{"id":"components/examples/response-treatment-single-example","value":{"data":{"id":"94525b9c-af18-40a5-905f-f539f1c45f6f","code":"100","nomenclature":"Exam","description":"An evaluation performed on a patient of record to determine any changes in the patient's dental and medical health status.","patient_nomenclature":"Examination","patient_description":null,"treatment_category_id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","is_active":true,"is_displayed_on_invoice":true,"region":"patient","owner":"practice","health_provider":{"provider_name":"nhs","provider_treatment_category":"9317","uda_band":1},"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"summary":"Single treatment","description":"One treatment in the practice catalogue."},"components/examples/response-subscription-list-example":{"id":"components/examples/response-subscription-list-example","value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partner_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","product_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","practice_id":"6657287f-28fc-4ce7-9452-4ea8c27aa7b9","site_id":"0c28be69-430a-422e-a4fc-8b1d512a2fbe","status":"Completed","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z","deleted_at":"2027-04-16T10:00:00Z"},{"id":"07558d56-1225-49b5-90fa-ab8922b6fd30","partner_id":"d05ff51d-e2be-4a78-8592-41baa8cd6cba","product_id":"2dec7d43-a7de-45d1-a46e-7764ffc17bac","practice_id":"686cd614-9c6e-480b-a55b-b499207782b2","site_id":"abc61d6c-0b23-4795-aee4-1c2e12740b59","status":"Pending","created_at":"2025-07-01T08:00:00Z","updated_at":"2026-02-18T12:00:00Z","deleted_at":"2027-05-16T10:00:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"summary":"First page of subscriptions","description":"Paginated list with cursor for the next page."},"components/examples/response-subscription-single-example":{"id":"components/examples/response-subscription-single-example","value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partner_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","product_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","practice_id":"6657287f-28fc-4ce7-9452-4ea8c27aa7b9","site_id":"0c28be69-430a-422e-a4fc-8b1d512a2fbe","status":"Completed","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z","deleted_at":"2027-04-16T10:00:00Z"}},"summary":"Single subscription","description":"Wrapper returned by get subscription."},"paths/~1appointments/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","patient":{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","first_name":"John","middle_name":null,"last_name":"Smith"},"start_time":"2025-09-01T11:00:00Z","finish_time":"2025-09-01T11:45:00Z","duration_minutes":45,"notes":"Follow-up appointment.","practitioner":{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"Dr. Johnson"},"site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","state":"Confirmed","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-08-05T10:30:00Z","updated_at":"2025-08-20T16:15:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of appointments","description":"Paginated list with cursor for the next page.","id":"paths/~1appointments/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1appointments/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointments/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointments/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointments/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointments/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointments/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointments/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointments/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointments/post/responses/201/content/application~1json/examples/appointment":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"appointment","summary":"Single appointment","description":"Wrapper returned by get, create, or update appointment.","id":"paths/~1appointments/post/responses/201/content/application~1json/examples/appointment"},"paths/~1appointments/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointments/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointments/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointments/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointments/post/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1appointments/post/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1appointments/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointments/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointments/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointments/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointments~1{id}/get/responses/200/content/application~1json/examples/appointment":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"appointment","summary":"Single appointment","description":"Wrapper returned by get, create, or update appointment.","id":"paths/~1appointments~1{id}/get/responses/200/content/application~1json/examples/appointment"},"paths/~1appointments~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointments~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointments~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointments~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointments~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1appointments~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1appointments~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointments~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointments~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointments~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointments~1{id}/patch/responses/200/content/application~1json/examples/appointment":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","first_name":"Jane","middle_name":"Marie","last_name":"Doe"},"start_time":"2025-06-01T08:00:00Z","finish_time":"2025-06-01T09:00:00Z","duration_minutes":60,"reason":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Routine dental check-up"},"notes":"Patient requested a morning appointment.","practitioner":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Dr. Smith"},"site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","state":"Pending","cancelled_at":null,"payment_plan_id":null,"room_id":null,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"appointment","summary":"Single appointment","description":"Wrapper returned by get, create, or update appointment.","id":"paths/~1appointments~1{id}/patch/responses/200/content/application~1json/examples/appointment"},"paths/~1appointments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1appointments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1appointments~1{id}/patch/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1appointments~1{id}/patch/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1appointments~1{id}/patch/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointments~1{id}/patch/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointments~1{id}/patch/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointments~1{id}/patch/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointments~1{id}~1cancel/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointments~1{id}~1cancel/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointments~1{id}~1cancel/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointments~1{id}~1cancel/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointments~1{id}~1cancel/post/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1appointments~1{id}~1cancel/post/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1appointments~1{id}~1cancel/post/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1appointments~1{id}~1cancel/post/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1appointments~1{id}~1cancel/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointments~1{id}~1cancel/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointments~1{id}~1cancel/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointments~1{id}~1cancel/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointment_reasons/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"4EE0FA3E-12F4-4942-9347-1702EB89EBCC","name":"Exam + Scale & Polish","is_active":true,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"9A2B3C4D-5E6F-7081-92A3-B4C5D6E7F809","name":"New Patient Consultation","is_active":true,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of appointment reasons","description":"Paginated list with cursor for the next page.","id":"paths/~1appointment_reasons/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1appointment_reasons/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointment_reasons/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointment_reasons/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointment_reasons/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointment_reasons/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointment_reasons/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointment_reasons/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointment_reasons/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1appointment_cancellation_reasons/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"AE492D60-8970-4AA0-8D5C-84FFAF4A16A3","name":"Patient - Illness","type":"cancelled","is_active":true,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"EFB3701D-649E-407F-860E-D08C31FBF2F4","name":"Practice - Staff Issue","type":"cancelled","is_active":true,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of appointment cancellation reasons","description":"Paginated list with cursor for the next page.","id":"paths/~1appointment_cancellation_reasons/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1appointment_cancellation_reasons/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1appointment_cancellation_reasons/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1appointment_cancellation_reasons/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1appointment_cancellation_reasons/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1appointment_cancellation_reasons/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1appointment_cancellation_reasons/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1appointment_cancellation_reasons/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1appointment_cancellation_reasons/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1calendar_zones/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a","title":"Emergency slots","start_time":"2026-01-05T09:00:00Z","finish_time":"2026-01-05T12:00:00Z","practitioner":{"id":"550e8400-e29b-41d4-a716-446655440003","name":"Dr. John Smith"},"room_id":null,"zone_group":{"id":"0f8fad5b-d9cb-469f-a165-70867728950e","name":"Emergencies"},"created_at":"2025-12-01T10:15:00Z","updated_at":"2025-12-01T10:15:00Z"},{"id":"3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f","title":"Hygiene clinic","start_time":"2026-01-06T13:00:00Z","finish_time":"2026-01-06T17:00:00Z","practitioner":null,"room_id":"550e8400-e29b-41d4-a716-446655440004","zone_group":null,"created_at":null,"updated_at":null}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of calendar zones","description":"Paginated list with a cursor for the next page.","id":"paths/~1calendar_zones/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1calendar_zones/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1calendar_zones/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1calendar_zones/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1calendar_zones/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1calendar_zones/get/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1calendar_zones/get/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1calendar_zones/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1calendar_zones/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1calendar_zones/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1calendar_zones/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1calendar_zones~1{id}/get/responses/200/content/application~1json/examples/calendarZone":{"value":{"data":{"id":"9b2f4c1e-3d5a-4e8b-a7c6-1f2e3d4c5b6a","title":"Emergency slots","start_time":"2026-01-05T09:00:00Z","finish_time":"2026-01-05T12:00:00Z","practitioner":{"id":"550e8400-e29b-41d4-a716-446655440003","name":"Dr. John Smith"},"room_id":null,"zone_group":{"id":"0f8fad5b-d9cb-469f-a165-70867728950e","name":"Emergencies"},"created_at":"2025-12-01T10:15:00Z","updated_at":"2025-12-01T10:15:00Z"}},"key":"calendarZone","summary":"Single calendar zone","description":"One calendar zone scheduled for a practitioner.","id":"paths/~1calendar_zones~1{id}/get/responses/200/content/application~1json/examples/calendarZone"},"paths/~1calendar_zones~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1calendar_zones~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1calendar_zones~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1calendar_zones~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1calendar_zones~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1calendar_zones~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1calendar_zones~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1calendar_zones~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1calendar_zones~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1calendar_zones~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients/post/responses/201/content/application~1json/examples/patient":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_active":true,"is_appointment_booking_prevented":false,"preferred_phone_type":"mobile","first_name":"Jane","last_name":"Doe","date_of_birth":"1990-04-12","title":"Ms","ethnicity":"01","payment_plan_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","address":{"address_line_1":"42 High Street","locality":"London","administrative_area":"Greater London","postal_code":"EC1A 1BB"},"email_address":"jane.doe@example.com","biological_sex":"female","phones":[{"phone_type":"mobile","phone_number":"+447911123456","phone_country":"GB","phone_number_normalized":"+447911123456"}],"communication":{"is_marketing_enabled":true,"is_email_enabled":true,"is_sms_enabled":false},"recall":{"dentist":{"date":"2026-03-15","interval_months":6},"hygienist":{"date":"2026-04-01","interval_months":6},"method":"email"},"archived_reason":null,"is_bad_debtor":false,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"patient","summary":"Single patient","description":"Wrapper returned by get, create, or update patient.","id":"paths/~1patients/post/responses/201/content/application~1json/examples/patient"},"paths/~1patients/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients~1search/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients~1search/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients~1search/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients~1search/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients~1search/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients~1search/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients~1search/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients~1search/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients~1{id}/get/responses/200/content/application~1json/examples/patient":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_active":true,"is_appointment_booking_prevented":false,"preferred_phone_type":"mobile","first_name":"Jane","last_name":"Doe","date_of_birth":"1990-04-12","title":"Ms","ethnicity":"01","payment_plan_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","address":{"address_line_1":"42 High Street","locality":"London","administrative_area":"Greater London","postal_code":"EC1A 1BB"},"email_address":"jane.doe@example.com","biological_sex":"female","phones":[{"phone_type":"mobile","phone_number":"+447911123456","phone_country":"GB","phone_number_normalized":"+447911123456"}],"communication":{"is_marketing_enabled":true,"is_email_enabled":true,"is_sms_enabled":false},"recall":{"dentist":{"date":"2026-03-15","interval_months":6},"hygienist":{"date":"2026-04-01","interval_months":6},"method":"email"},"archived_reason":null,"is_bad_debtor":false,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"patient","summary":"Single patient","description":"Wrapper returned by get, create, or update patient.","id":"paths/~1patients~1{id}/get/responses/200/content/application~1json/examples/patient"},"paths/~1patients~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1patients~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1patients~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients~1{id}/patch/responses/200/content/application~1json/examples/patient":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_active":true,"is_appointment_booking_prevented":false,"preferred_phone_type":"mobile","first_name":"Jane","last_name":"Doe","date_of_birth":"1990-04-12","title":"Ms","ethnicity":"01","payment_plan_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","address":{"address_line_1":"42 High Street","locality":"London","administrative_area":"Greater London","postal_code":"EC1A 1BB"},"email_address":"jane.doe@example.com","biological_sex":"female","phones":[{"phone_type":"mobile","phone_number":"+447911123456","phone_country":"GB","phone_number_normalized":"+447911123456"}],"communication":{"is_marketing_enabled":true,"is_email_enabled":true,"is_sms_enabled":false},"recall":{"dentist":{"date":"2026-03-15","interval_months":6},"hygienist":{"date":"2026-04-01","interval_months":6},"method":"email"},"archived_reason":null,"is_bad_debtor":false,"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"patient","summary":"Single patient","description":"Wrapper returned by get, create, or update patient.","id":"paths/~1patients~1{id}/patch/responses/200/content/application~1json/examples/patient"},"paths/~1patients~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1patients~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1patients~1{id}/patch/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients~1{id}/patch/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients~1{id}/patch/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients~1{id}/patch/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1patients~1{id}~1account/get/responses/200/content/application~1json/examples/patientAccount":{"value":{"data":{"owning_patient_id":"550e8400-e29b-41d4-a716-446655440004","balance_amount":-125.5,"patient_balance_amount":-100.5,"pending_payments_amount":-25,"deposit_amount":0,"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"key":"patientAccount","summary":"Patient account balance","description":"Example where the patient owes the practice: monetary amounts in this sample are negative. Accounts in credit have positive amounts.","id":"paths/~1patients~1{id}~1account/get/responses/200/content/application~1json/examples/patientAccount"},"paths/~1patients~1{id}~1account/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1patients~1{id}~1account/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1patients~1{id}~1account/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1patients~1{id}~1account/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1patients~1{id}~1account/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1patients~1{id}~1account/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1patients~1{id}~1account/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1patients~1{id}~1account/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1patients~1{id}~1account/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1patients~1{id}~1account/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1practitioners/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Jane Doe","user_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":"Hygienist","nhs_number":"9998887777","gdc_number":"123456","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"John Smith","user_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":null,"nhs_number":null,"gdc_number":null,"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of practitioners","description":"Paginated list with cursor for the next page.","id":"paths/~1practitioners/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1practitioners/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1practitioners/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1practitioners/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1practitioners/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1practitioners/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1practitioners/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1practitioners/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1practitioners/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1practitioners~1availabilities/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"start_time":"2031-12-01T09:00:00+00:00","finish_time":"2031-12-01T10:00:00+00:00","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"start_time":"2031-12-01T10:00:00+00:00","finish_time":"2031-12-01T11:00:00+00:00","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of practitioner availability slots","description":"Paginated list of availability slots for the requested practitioners, ordered by start time ascending.","id":"paths/~1practitioners~1availabilities/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1practitioners~1availabilities/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1practitioners~1availabilities/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1practitioners~1availabilities/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1practitioners~1availabilities/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1practitioners~1availabilities/get/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1practitioners~1availabilities/get/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1practitioners~1availabilities/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1practitioners~1availabilities/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1practitioners~1availabilities/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1practitioners~1availabilities/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1practitioners~1{id}/get/responses/200/content/application~1json/examples/practitioner":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"Jane Doe","user_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","role":"Therapist","nhs_number":"NHS-001","gdc_number":"123456","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"practitioner","summary":"Single practitioner","description":"Wrapper returned by get practitioner.","id":"paths/~1practitioners~1{id}/get/responses/200/content/application~1json/examples/practitioner"},"paths/~1practitioners~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1practitioners~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1practitioners~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1practitioners~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1practitioners~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1practitioners~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1practitioners~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1practitioners~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1practitioners~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1practitioners~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","date":"2025-01-15","is_available":true,"start_time":"09:00","finish_time":"17:30","breaks":[{"name":"Lunch","start_time":"13:00","finish_time":"14:00"}],"created_at":"2025-01-16T00:05:12Z","updated_at":"2025-01-16T00:05:12Z"},{"practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","date":"2025-01-14","is_available":false,"start_time":null,"finish_time":null,"breaks":[],"created_at":"2025-01-15T00:05:08Z","updated_at":"2025-01-15T00:05:08Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of rota schedule histories","description":"Paginated list of snapshotted rota days for a practitioner, ordered by date descending.","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/422/content/application~1problem+json/examples/unprocessableEntity":{"value":{"type":"https://api.dentally.co/problems/unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"start_time must be before finish_time.","instance":"/v2/appointments"},"key":"unprocessableEntity","summary":"Validation error","description":"RFC 7807 problem details when the request is well-formed but fails business validation.","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/422/content/application~1problem+json/examples/unprocessableEntity"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1practitioners~1{id}~1rota_schedule_histories/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1sites/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c","name":"Dentally High Street","address":{"address_line_1":"42 High Street","address_line_2":null,"address_line_3":null,"locality":"Manchester","administrative_area":"Greater Manchester","postal_code":"M1 1AA"},"contact_details":{"email_address":"reception@example.com","phone_number":"+441612345678","website_url":"https://example.com/high-street"},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"09:00","close_at":"17:30"},{"weekday":"Tuesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Wednesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Thursday","open_at":"09:00","close_at":"17:30"},{"weekday":"Friday","open_at":"09:00","close_at":"17:00"},{"weekday":"Saturday","open_at":null,"close_at":null}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"2b3c4d5e-6f70-8192-a3b4-c5d6e7f80901","name":"Dentally Riverside","address":{"address_line_1":"10 River Road","address_line_2":"Unit 2","address_line_3":null,"locality":"Salford","administrative_area":"Greater Manchester","postal_code":"M50 1AB"},"contact_details":{"email_address":"riverside@example.com","phone_number":"+441614445566","website_url":null},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"08:30","close_at":"18:00"},{"weekday":"Tuesday","open_at":"08:30","close_at":"18:00"},{"weekday":"Wednesday","open_at":"08:30","close_at":"18:00"},{"weekday":"Thursday","open_at":"08:30","close_at":"18:00"},{"weekday":"Friday","open_at":"08:30","close_at":"18:00"},{"weekday":"Saturday","open_at":"09:00","close_at":"13:00"}],"created_at":"2025-08-12T11:00:00Z","updated_at":"2026-01-05T09:45:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"key":"firstPage","summary":"First page of sites","description":"Paginated list with cursor for the next page.","id":"paths/~1sites/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1sites/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1sites/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1sites/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1sites/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1sites/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1sites/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1sites/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1sites/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1sites~1{id}/get/responses/200/content/application~1json/examples/site":{"value":{"data":{"id":"8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c","name":"Dentally High Street","address":{"address_line_1":"42 High Street","address_line_2":null,"address_line_3":null,"locality":"Manchester","administrative_area":"Greater Manchester","postal_code":"M1 1AA"},"contact_details":{"email_address":"reception@example.com","phone_number":"+441612345678","website_url":"https://example.com/high-street"},"opening_hours":[{"weekday":"Sunday","open_at":null,"close_at":null},{"weekday":"Monday","open_at":"09:00","close_at":"17:30"},{"weekday":"Tuesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Wednesday","open_at":"09:00","close_at":"17:30"},{"weekday":"Thursday","open_at":"09:00","close_at":"17:30"},{"weekday":"Friday","open_at":"09:00","close_at":"17:00"},{"weekday":"Saturday","open_at":null,"close_at":null}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"site","summary":"Single site","description":"Wrapper returned by get site.","id":"paths/~1sites~1{id}/get/responses/200/content/application~1json/examples/site"},"paths/~1sites~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1sites~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1sites~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1sites~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1sites~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1sites~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1sites~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1sites~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1sites~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1sites~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1communications/post/requestBody/content/application~1json/examples/send_sms":{"value":{"patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"sms","body":"Your appointment is scheduled for tomorrow at 3 PM.","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"send_sms","summary":"Send an SMS communication","id":"paths/~1communications/post/requestBody/content/application~1json/examples/send_sms"},"paths/~1communications/post/requestBody/content/application~1json/examples/send_email":{"value":{"patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"email","body":"Your appointment is scheduled for tomorrow at 3 PM.","html_body":"Your appointment is scheduled for tomorrow at 3 PM.
","subject":"Appointment Reminder","message_type":"appointment_confirmation","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"send_email","summary":"Send an Email communication","id":"paths/~1communications/post/requestBody/content/application~1json/examples/send_email"},"paths/~1communications/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1communications/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1communications/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1communications/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1communications/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1communications/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1communications/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1communications/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1communications~1{id}~1reply/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1communications~1{id}~1reply/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1communications~1{id}~1reply/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1communications~1{id}~1reply/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1communications~1{id}~1reply/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1communications~1{id}~1reply/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1communications~1{id}~1reply/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1communications~1{id}~1reply/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_sms":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"sms","body":"Your appointment is scheduled for tomorrow at 3 PM.","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_sms","summary":"Create an SMS communication","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_sms"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_sms_reply":{"value":{"direction":"inbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"sms","body":"Thanks, see you tomorrow at 3 PM.","message_type":"patient_reply","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_sms_reply","summary":"Create an SMS reply communication","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_sms_reply"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_email":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"email","body":"Your appointment is scheduled for tomorrow at 3 PM.","html_body":"Your appointment is scheduled for tomorrow at 3 PM.
","subject":"Appointment Reminder","message_type":"appointment_confirmation","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_email","summary":"Create an Email communication","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_email"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_letter_with_text":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"letter","body":"Your appointment is scheduled for tomorrow at 3 PM.","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_letter_with_text","summary":"Create a Letter communication with plain text content","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_letter_with_text"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_letter_with_link":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"letter","body_link":"https://example.com/letters/12345/content","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_letter_with_link","summary":"Create a Letter communication using a link to the content","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_letter_with_link"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_messaging_app":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"messaging_app","messaging_channel":"whatsapp","body":"Your appointment is scheduled for tomorrow at 3 PM.","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001"},"key":"log_messaging_app","summary":"Create a Messaging App communication","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_messaging_app"},"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_phone_call":{"value":{"direction":"outbound","patient_id":"123e4567-e89b-12d3-a456-426614174000","communication_channel":"phone_call","message_type":"appointment_reminder","site_id":"123e4567-e89b-12d3-a456-426614174001","body":"Left a voicemail reminding the patient of their appointment tomorrow at 3 PM."},"key":"log_phone_call","summary":"Create a Phone Call communication","id":"paths/~1external_communications/post/requestBody/content/application~1json/examples/log_phone_call"},"paths/~1external_communications/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1external_communications/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1external_communications/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1external_communications/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1external_communications/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1external_communications/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1external_communications/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1external_communications/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1fees/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_multiple_pricing":true,"tiers":[{"quantity":1,"price":55,"duration_minutes":15},{"quantity":2,"price":75,"duration_minutes":20},{"quantity":3,"price":95,"duration_minutes":25},{"quantity":4,"price":110,"duration_minutes":30},{"quantity":5,"price":125,"duration_minutes":35}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"key":"firstPage","summary":"First page of fees","description":"Paginated list with cursor for the next page.","id":"paths/~1fees/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1fees/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1fees/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1fees/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1fees/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1fees/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1fees/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1fees/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1fees/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/fee":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","is_multiple_pricing":true,"tiers":[{"quantity":1,"price":55,"duration_minutes":15},{"quantity":2,"price":75,"duration_minutes":20},{"quantity":3,"price":95,"duration_minutes":25},{"quantity":4,"price":110,"duration_minutes":30},{"quantity":5,"price":125,"duration_minutes":35}],"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}},"key":"fee","summary":"Single fee","description":"Wrapper returned by get fee.","id":"paths/~1fees~1{id}/get/responses/200/content/application~1json/examples/fee"},"paths/~1fees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1fees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1fees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1fees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1fees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1fees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1fees~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1fees~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1fees~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1fees~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1fee_schedules/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","name":"NHS","patient_friendly_name":null,"is_active":true,"site_id":null,"account_code":"200","funding":{"type":"private","scheme":"nhs","claim_timing":null},"default_appointment_duration":{"exam_minutes":10,"scale_and_polish_minutes":10,"exam_scale_and_polish_minutes":20,"emergency_minutes":10},"patient_default":{"recall":{"dentist_interval_months":6,"hygienist_interval_months":6,"method":"letter"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-01-15T09:30:00Z","updated_at":"2026-03-02T11:12:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","name":"Private","patient_friendly_name":null,"is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","account_code":"200","funding":{"type":"private","scheme":null,"claim_timing":null},"default_appointment_duration":{"exam_minutes":10,"scale_and_polish_minutes":10,"exam_scale_and_polish_minutes":20,"emergency_minutes":10},"patient_default":{"recall":{"dentist_interval_months":6,"hygienist_interval_months":6,"method":"letter"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-01-15T09:31:00Z","updated_at":"2025-11-04T16:22:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of fee schedules","description":"Paginated list with a cursor for the next page.","id":"paths/~1fee_schedules/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1fee_schedules/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1fee_schedules/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1fee_schedules/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1fee_schedules/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1fee_schedules/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1fee_schedules/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1fee_schedules/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1fee_schedules/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1fee_schedules~1{id}/get/responses/200/content/application~1json/examples/feeSchedule":{"value":{"data":{"id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","name":"OHSA - MoH","patient_friendly_name":"Oral Health Services Adolescents (OHSA)","is_active":true,"site_id":null,"account_code":"200","funding":{"type":"insurance_funded","scheme":"nz_moh_ohsa","claim_timing":"on_completion"},"default_appointment_duration":{"exam_minutes":30,"scale_and_polish_minutes":30,"exam_scale_and_polish_minutes":30,"emergency_minutes":30},"patient_default":{"recall":{"dentist_interval_months":12,"hygienist_interval_months":12,"method":"email"},"communication":{"is_email_enabled":true,"is_sms_enabled":true}},"membership":{"monthly_fee":0,"exam_appointments_included":0,"hygiene_appointments_included":0},"created_at":"2024-04-01T00:00:00Z","updated_at":"2026-01-20T08:45:00Z"}},"key":"feeSchedule","summary":"Fee schedule","description":"A fee schedule configured for the practice.","id":"paths/~1fee_schedules~1{id}/get/responses/200/content/application~1json/examples/feeSchedule"},"paths/~1fee_schedules~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1fee_schedules~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1fee_schedules~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1fee_schedules~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1fee_schedules~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1fee_schedules~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1fee_schedules~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1fee_schedules~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1fee_schedules~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1fee_schedules~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1invoices/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":50,"patient_owed_amount":20,"insurance_owed_amount":10,"insurance_paid_amount":5,"pending_payments_amount":5,"tax_amount":10,"discount_amount":10,"is_paid":false,"paid_on":null,"is_editable":false,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"},{"id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","patient_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":0,"patient_owed_amount":150,"insurance_owed_amount":0,"insurance_paid_amount":0,"pending_payments_amount":0,"tax_amount":0,"discount_amount":0,"is_paid":true,"paid_on":"2026-01-18","is_editable":true,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of invoices","description":"Paginated list with cursor for the next page.","id":"paths/~1invoices/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1invoices/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1invoices/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1invoices/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1invoices/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1invoices/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1invoices/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1invoices/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1invoices/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1invoices~1{id}/get/responses/200/content/application~1json/examples/appointment":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","reference":"00103","invoice_amount":150,"invoice_amount_outstanding":50,"patient_owed_amount":20,"insurance_owed_amount":10,"insurance_paid_amount":5,"pending_payments_amount":5,"tax_amount":10,"discount_amount":10,"is_paid":false,"paid_on":null,"is_editable":false,"created_by":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z"}},"key":"appointment","summary":"Single invoice","description":"Wrapper returned by get, create, or update invoice.","id":"paths/~1invoices~1{id}/get/responses/200/content/application~1json/examples/appointment"},"paths/~1invoices~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1invoices~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1invoices~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1invoices~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1invoices~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1invoices~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1invoices~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1invoices~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1invoices~1{id}~1invoice_items/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","pricing":{"discount_amount":10,"insurance_expected":10,"item_price":10,"total_price":10},"health_provider":{"is_provider_charge":false,"provider_name":"nhs"},"name":"Example name","quantity":1,"treatment_code":"example","invoice_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","sundry_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_plan_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","treatment_plan_item_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","created_by_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"key":"firstPage","summary":"First page of invoice items","description":"Paginated list with cursor for the next page.","id":"paths/~1invoices~1{id}~1invoice_items/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1invoices~1{id}~1invoice_items/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1invoices~1{id}~1invoice_items/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1invoices~1{id}~1invoice_items/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1invoices~1{id}~1invoice_items/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1invoices~1{id}~1invoice_items/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1invoices~1{id}~1invoice_items/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1invoices~1{id}~1invoice_items/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1invoices~1{id}~1invoice_items/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1nhs~1contracts/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"74299a51-bb9a-47eb-9524-20ec9c3958a8","name":"Main Surgery NHS Contract","is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","nhs_contract_number":"1234567890","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2025-04-01","end_date":null,"is_pds_plus":false,"notes":null,"created_at":"2025-01-10T09:00:00Z","updated_at":"2026-08-20T11:20:00Z"},{"id":"c1d2e3f4-a5b6-7890-cdef-123456789abc","name":"Previous Main Surgery Contract","is_active":false,"site_id":null,"nhs_contract_number":"1234567891","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2024-04-01","end_date":"2026-03-31","is_pds_plus":false,"notes":"Historical contract","created_at":"2024-02-01T08:30:00Z","updated_at":"2026-04-02T10:15:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of NHS contracts","description":"Paginated list with a cursor for the next page.","id":"paths/~1nhs~1contracts/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1nhs~1contracts/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1nhs~1contracts/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1nhs~1contracts/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1nhs~1contracts/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1nhs~1contracts/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1nhs~1contracts/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1nhs~1contracts/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1nhs~1contracts/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1nhs~1contracts~1{id}/get/responses/200/content/application~1json/examples/contract":{"value":{"data":{"id":"74299a51-bb9a-47eb-9524-20ec9c3958a8","name":"Main Surgery NHS Contract","is_active":true,"site_id":"a11df716-ce65-4210-be87-8b8ec448f85c","nhs_contract_number":"1234567890","nhs_site_id":"12345","nhs_location_id":"200006","start_date":"2025-04-01","end_date":null,"is_pds_plus":false,"notes":null,"created_at":"2025-01-10T09:00:00Z","updated_at":"2026-08-20T11:20:00Z"}},"key":"contract","summary":"NHS contract","description":"An NHS contract configured for the practice.","id":"paths/~1nhs~1contracts~1{id}/get/responses/200/content/application~1json/examples/contract"},"paths/~1nhs~1contracts~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1nhs~1contracts~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1nhs~1contracts~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1nhs~1contracts~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1nhs~1contracts~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1nhs~1contracts~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1nhs~1contracts~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1nhs~1contracts~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1nhs~1contracts~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1nhs~1contracts~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_patient_ids":{"value":{"resource":"patient","ids":[42,43]},"key":"map_patient_ids","summary":"Map patient legacy ids","id":"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_patient_ids"},"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_appointment_ids":{"value":{"resource":"appointment","ids":[1001]},"key":"map_appointment_ids","summary":"Map appointment legacy ids","id":"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_appointment_ids"},"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_invoice_ids":{"value":{"resource":"invoice","ids":[501,502]},"key":"map_invoice_ids","summary":"Map invoice legacy ids","id":"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_invoice_ids"},"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_practitioner_ids":{"value":{"resource":"practitioner","ids":[7]},"key":"map_practitioner_ids","summary":"Map practitioner legacy ids","id":"paths/~1identifier_mappings/post/requestBody/content/application~1json/examples/map_practitioner_ids"},"paths/~1identifier_mappings/post/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1identifier_mappings/post/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1identifier_mappings/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1identifier_mappings/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1identifier_mappings/post/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1identifier_mappings/post/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1identifier_mappings/post/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1identifier_mappings/post/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatments/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"94525b9c-af18-40a5-905f-f539f1c45f6f","code":"100","nomenclature":"Exam","description":"An evaluation performed on a patient of record to determine any changes in the patient's dental and medical health status.","patient_nomenclature":"Examination","patient_description":null,"treatment_category_id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","is_active":true,"is_displayed_on_invoice":true,"region":"patient","owner":"practice","health_provider":{"provider_name":"nhs","provider_treatment_category":"9317","uda_band":1},"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"},{"id":"a1b2c3d4-e5f6-4789-a012-3456789abcde","code":"SYS001","nomenclature":"Unerupted","description":null,"patient_nomenclature":null,"patient_description":null,"treatment_category_id":"09b2e37e-8f42-4676-adf3-cb97fc9ee3e6","is_active":true,"is_displayed_on_invoice":false,"region":"tooth","owner":"system","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQwODowMDowMFoifQ"}},"key":"firstPage","summary":"First page of treatments","description":"Paginated list with cursor for the next page. Includes a practice-authored treatment and a Dentally-managed system treatment.","id":"paths/~1treatments/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1treatments/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatments/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatments/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatments/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatments/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatments/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatments/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatments/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatments~1{id}/get/responses/200/content/application~1json/examples/treatment":{"value":{"data":{"id":"94525b9c-af18-40a5-905f-f539f1c45f6f","code":"100","nomenclature":"Exam","description":"An evaluation performed on a patient of record to determine any changes in the patient's dental and medical health status.","patient_nomenclature":"Examination","patient_description":null,"treatment_category_id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","is_active":true,"is_displayed_on_invoice":true,"region":"patient","owner":"practice","health_provider":{"provider_name":"nhs","provider_treatment_category":"9317","uda_band":1},"created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"key":"treatment","summary":"Single treatment","description":"One treatment in the practice catalogue.","id":"paths/~1treatments~1{id}/get/responses/200/content/application~1json/examples/treatment"},"paths/~1treatments~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatments~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatments~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatments~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatments~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1treatments~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1treatments~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatments~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatments~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatments~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatment_categories/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","name":"Diagnostic Related Services","created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"},{"id":"9a2b3c4d-5e6f-4081-92a3-b4c5d6e7f809","name":"Restorative","created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"},{"id":"09b2e37e-8f42-4676-adf3-cb97fc9ee3e6","name":null,"created_at":"2025-05-01T08:00:00Z","updated_at":"2025-05-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wNi0wMVQwODowMDowMFoifQ"}},"key":"firstPage","summary":"First page of treatment categories","description":"Paginated list with cursor for the next page. Categories may have a null name.","id":"paths/~1treatment_categories/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1treatment_categories/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatment_categories/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatment_categories/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatment_categories/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatment_categories/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatment_categories/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatment_categories/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatment_categories/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatment_categories~1{id}/get/responses/200/content/application~1json/examples/treatmentCategory":{"value":{"data":{"id":"4ee0fa3e-12f4-4942-9347-1702eb89ebcc","name":"Diagnostic Related Services","created_at":"2026-01-05T09:12:44Z","updated_at":"2026-10-02T14:03:10Z"}},"key":"treatmentCategory","summary":"Single treatment category","description":"One treatment category in the practice catalogue.","id":"paths/~1treatment_categories~1{id}/get/responses/200/content/application~1json/examples/treatmentCategory"},"paths/~1treatment_categories~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatment_categories~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatment_categories~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatment_categories~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatment_categories~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1treatment_categories~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1treatment_categories~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatment_categories~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatment_categories~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatment_categories~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatment_plans/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"ea845d0d-d6d7-4dd4-8321-1bd803c897e8","practitioner_id":"c8e79da4-e253-4887-8084-04786bff7e4f","site_id":"2836b794-0d77-4788-b06f-da6927cab30d","health_provider":[{"provider_name":"nhs","uda_value":1.5,"completed_uda_value":3},{"provider_name":"private","treatment_value":50}],"start_date":"2026-06-01","end_date":"2026-10-01","completed_at":"2026-07-01T08:00:00Z","is_completed":true,"created_at":"2026-06-01T08:00:00Z","updated_at":"2026-10-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"key":"firstPage","summary":"First page of treatment plans","description":"Paginated list with cursor for the next page.","id":"paths/~1treatment_plans/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1treatment_plans/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatment_plans/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatment_plans/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatment_plans/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatment_plans/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatment_plans/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatment_plans/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatment_plans/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatment_plans~1{id}/get/responses/200/content/application~1json/examples/treatment_plan":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","practitioner_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","site_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","health_provider":[{"provider_name":"nhs","uda_value":1.5,"completed_uda_value":3}],"start_date":"2026-06-01","end_date":null,"completed_at":null,"is_completed":false,"created_at":"2026-06-01T08:00:00Z","updated_at":"2026-10-01T08:00:00Z"}},"key":"treatment_plan","summary":"Single treatment plan","description":"Wrapper returned by get treatment plan.","id":"paths/~1treatment_plans~1{id}/get/responses/200/content/application~1json/examples/treatment_plan"},"paths/~1treatment_plans~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatment_plans~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatment_plans~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatment_plans~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatment_plans~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1treatment_plans~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1treatment_plans~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatment_plans~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatment_plans~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatment_plans~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","patient_id":"9efcb282-8f4f-4ac1-9259-d4e3fe9b6531","practitioner_id":"0930501c-aafd-45e7-90c3-76498ba2d126","fee_schedule_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","referrer_id":"e1d854af-15db-4482-8e29-39e74a6c7f75","invoice_id":"10548353-ea10-451f-beac-9b5858a87e01","treatment_appointment_id":"a58310cd-5473-421e-b6ad-ff31f647140d","treatment_id":"68adfa9e-a3c9-47c8-812c-3fe55640b560","treatment_plan_id":"a2f6bdbb-ac9b-4a24-8136-98f1c06fbb89","nomenclature":"Acute Mucosal Infection","patient_friendly_nomenclature":"Urgent/Emergency Assessment","price":10,"is_charged":false,"is_completed":true,"completed_at":"2025-06-01T08:00:00Z","duration_minutes":30,"notes":"This is a note
","custom_fields":[{"id":"e4b5cd1e-4a43-46ce-bdb0-fe75f2e8cd14","value":true}],"clinical":{"region":"tooth","surfaces":[1],"teeth":["LR4"]},"health_provider":{"provider_name":"nhs","provider_treatment_category":"9306","uda_band":2},"created_at":"2025-06-01T08:00:00Z","updated_at":"2025-06-01T08:00:00Z"}],"meta":{"cursor":"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"}},"key":"firstPage","summary":"First page of treatment plan items","description":"Paginated list with cursor for the next page.","id":"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1treatment_plans~1{id}~1treatment_plan_items/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1market~1subscriptions/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partner_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","product_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","practice_id":"6657287f-28fc-4ce7-9452-4ea8c27aa7b9","site_id":"0c28be69-430a-422e-a4fc-8b1d512a2fbe","status":"Completed","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z","deleted_at":"2027-04-16T10:00:00Z"},{"id":"07558d56-1225-49b5-90fa-ab8922b6fd30","partner_id":"d05ff51d-e2be-4a78-8592-41baa8cd6cba","product_id":"2dec7d43-a7de-45d1-a46e-7764ffc17bac","practice_id":"686cd614-9c6e-480b-a55b-b499207782b2","site_id":"abc61d6c-0b23-4795-aee4-1c2e12740b59","status":"Pending","created_at":"2025-07-01T08:00:00Z","updated_at":"2026-02-18T12:00:00Z","deleted_at":"2027-05-16T10:00:00Z"}],"meta":{"cursor":"eyJjdXJzb3IiOiJuZXh0In0"}},"key":"firstPage","summary":"First page of subscriptions","description":"Paginated list with cursor for the next page.","id":"paths/~1market~1subscriptions/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1market~1subscriptions/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1market~1subscriptions/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1market~1subscriptions/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1market~1subscriptions/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1market~1subscriptions/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1market~1subscriptions/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1market~1subscriptions/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1market~1subscriptions/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1market~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/subscription":{"value":{"data":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","partner_id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","product_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","practice_id":"6657287f-28fc-4ce7-9452-4ea8c27aa7b9","site_id":"0c28be69-430a-422e-a4fc-8b1d512a2fbe","status":"Completed","created_at":"2025-06-01T08:00:00Z","updated_at":"2026-01-18T12:00:00Z","deleted_at":"2027-04-16T10:00:00Z"}},"key":"subscription","summary":"Single subscription","description":"Wrapper returned by get subscription.","id":"paths/~1market~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/subscription"},"paths/~1market~1subscriptions~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1market~1subscriptions~1{id}/get/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1market~1subscriptions~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1market~1subscriptions~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1market~1subscriptions~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1market~1subscriptions~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1market~1subscriptions~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1market~1subscriptions~1{id}/get/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1market~1subscriptions~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1market~1subscriptions~1{id}/get/responses/5XX/content/application~1problem+json/examples/serverError"},"paths/~1market~1subscriptions~1{id}/delete/responses/400/content/application~1problem+json/examples/badRequest":{"value":{"type":"https://api.dentally.co/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is missing required header 'X-Practice-Id'.","instance":"/v2/sites"},"key":"badRequest","summary":"Malformed or invalid request","description":"RFC 7807 problem details when validation fails (e.g. missing required field).","id":"paths/~1market~1subscriptions~1{id}/delete/responses/400/content/application~1problem+json/examples/badRequest"},"paths/~1market~1subscriptions~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://api.dentally.co/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Valid bearer token required."},"key":"unauthorized","summary":"Missing or invalid credentials","description":"RFC 7807 problem details when the caller is not authenticated.","id":"paths/~1market~1subscriptions~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1market~1subscriptions~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://api.dentally.co/problems/not-found","title":"Not Found","status":404,"detail":"No site found for the given id in this practice.","instance":"/v2/sites/8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c"},"key":"notFound","summary":"Resource not found","description":"RFC 7807 problem details when no resource matches the given identifier.","id":"paths/~1market~1subscriptions~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1market~1subscriptions~1{id}/delete/responses/4XX/content/application~1problem+json/examples/clientError":{"value":{"type":"https://api.dentally.co/problems/client-error","title":"Unprocessable Entity","status":422,"detail":"The request could not be processed with the current state of the resource."},"key":"clientError","summary":"Generic client error response","description":"RFC 7807 problem details for a generic client error (e.g. conflict, unsupported media type).","id":"paths/~1market~1subscriptions~1{id}/delete/responses/4XX/content/application~1problem+json/examples/clientError"},"paths/~1market~1subscriptions~1{id}/delete/responses/5XX/content/application~1problem+json/examples/serverError":{"value":{"type":"https://api.dentally.co/problems/internal-error","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred while processing your request."},"key":"serverError","summary":"Unexpected server error","description":"RFC 7807 problem details for an internal failure.","id":"paths/~1market~1subscriptions~1{id}/delete/responses/5XX/content/application~1problem+json/examples/serverError"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},"oauth2":{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.api.dentally.co/oauth/token","scopes":{"fee:read":"List and retrieve fees.","patient:write":"Create and modify patient records for a practice.","patient:read":"List and retrieve patients.","appointment:read":"List and retrieve appointments.","appointment:write":"Create and modify appointments.","calendar:read":"List and retrieve calendar zones.","communication:write":"Send communications to patients on behalf of a practice.","communication:read":"List and retrieve communications sent to patients on behalf of a practice or replies received from patients.","communication:external:write":"Log externally created communications that were sent to patients on behalf of a practice.","communication:external:sms:write":"Log externally created SMS communications that were sent to the patients on behalf of a practice.","invoice:read":"List and retrieve invoices.","account:read":"Retrieve patient account balances.","fee_schedule:read":"List and retrieve fee schedules.","nhs:contract:read":"List and retrieve NHS contracts.","site:read":"List and retrieve sites.","practitioner:read":"List and retrieve practitioners.","practitioner:rota_schedule:read":"List rota schedule history for a practitioner.","practitioner:availability:read":"List practitioner availability slots for booking.","subscription:read":"List and retrieve subscriptions.","subscription:manage":"Manage subscriptions.","identifier_mapping:read":"List UUID for a resource","treatment:read":"List and retrieve treatment information, including treatments and treatment categories."}}}}},"specVersion":"3.0.0","servers":[{"url":"/_mock/docs/versions/2026-01-01/nexgen","isMockServer":true,"description":"Mock server"},{"url":"https://api.dentally.co","description":"Production - UK"},{"url":"https://api.apac.dentally.com","description":"Production - APAC"}],"specType":"openapi"},"options":{"schemasExpansionLevel":2,"showExtensions":false,"hideDownloadButtons":false,"expandResponses":"200,201","pathInMiddlePanel":true,"mockServer":{"url":"/_mock/docs/versions/2026-01-01/nexgen","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/versions/2026-01-01/nexgen.json?download"},{"url":"/_bundle/docs/versions/2026-01-01/nexgen.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dentally NexGen API","description":"The **Dentally NexGen API** exposes HTTP resources for partner integrations\nwith Dentally. This page is the machine-readable contract; the developer\nportal sidebar carries the rest of the documentation:\n\n- **Getting started** — make your first call.\n- **Authentication** — bearer tokens issued via Auth0.\n- **Versioning** — date-based revisions selected with the\n `Dentally-API-Version` header.\n- **Pagination** — cursor-based paging using `cursor` + `limit`.\n- **Errors** — Problem Details (RFC 7807) for every error response.\n- **Conventions** — naming, types, dates, nullability.\n"}},"baseSlug":"/docs/versions/2026-01-01/nexgen","routesMapping":{}}