{"items":[{"type":"link","label":"Hero Health Public API","link":"/apis/public-api/openapi","routeSlug":"/apis/public-api/openapi","content":{"contentType":"overview","meta":{"name":"Hero Health Public API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download API docs","url":"https://herohealthsoftware.github.io/herodoctors.co.uk/api/openapi.yaml"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"nodejs","title":"NodeJS","lang":"Node.js"},{"key":"ruby","title":"Ruby","lang":"Ruby"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Hero Health Public API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Hero Health Public API enables healthtech partners to build products that leverage Hero Health's IM1-assured EMIS/TPP integrated functionality."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/openapi"}],"sectionId":"/apis/public-api/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/key-capabilities"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key capabilities"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient messaging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Send SMS, email, and NHS App messages on behalf of a practice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment booking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — List available slots, create reservations, and confirm bookings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Register and look up patients via PDS (Personal Demographics Service)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Subscribe to events such as appointment confirmations and write-to-record outcomes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking & form links"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Generate sharable links for patient self-service flows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Generate access tokens for embedding pre-built Hero UI components"},"children":[]}]}]}]}]}],"sectionId":"/apis/public-api/openapi/section/key-capabilities"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints require an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-practice-group-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. API keys are scoped to specific functionality (messaging, booking, booking links). Contact Hero support to request your key."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits are defined in your Partner agreement. If you exceed your limit you will receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response."},"children":[]}]}]}]}],"sectionId":"/apis/public-api/openapi/section/rate-limits"}]}]}},{"type":"link","label":"Key capabilities","link":"/apis/public-api/openapi/section/key-capabilities","routeSlug":"/apis/public-api/openapi/section/key-capabilities","content":null},{"type":"link","label":"Authentication","link":"/apis/public-api/openapi/section/authentication","routeSlug":"/apis/public-api/openapi/section/authentication","content":null},{"type":"link","label":"Rate limits","link":"/apis/public-api/openapi/section/rate-limits","routeSlug":"/apis/public-api/openapi/section/rate-limits","content":null},{"type":"separator","label":"Appointment Booking","content":null},{"type":"group","label":"Appointments","link":"/apis/public-api/openapi/appointments","routeSlug":"/apis/public-api/openapi/appointments","items":[{"label":"Get an Appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getappointment","routeSlug":"/apis/public-api/openapi/appointments/getappointment","metadata":{"seo":{"title":"Get an Appointment","description":"Retrieves an appointment by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppointment","name":"Get an Appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an appointment by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointments/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/appointments/{id}","href":"appointments/getappointment","openApiOperationId":"getAppointment","summary":"Get an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentGet"}},"schemaId":"components/schemas/AppointmentGet"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentGet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentGet"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}"},{"label":"Get Appointment Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getappointmentstatus","routeSlug":"/apis/public-api/openapi/appointments/getappointmentstatus","metadata":{"seo":{"title":"Get Appointment Status","description":"Retrieves the status of an appointment by its ID, including the derived booking status and EHR partner status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppointmentStatus","name":"Get Appointment Status","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Appointment Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of an appointment by its ID, including the derived booking status and EHR partner status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointments/{id}/status","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/appointments/{id}/status","href":"appointments/getappointmentstatus","openApiOperationId":"getAppointmentStatus","summary":"Get Appointment Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusGet"}},"schemaId":"components/schemas/AppointmentStatusGet"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentStatusGet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusGet"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getappointmentstatus"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}/status"},{"label":"Create an Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/createappointment","routeSlug":"/apis/public-api/openapi/appointments/createappointment","metadata":{"seo":{"title":"Create an Appointment","description":"Create an appointment reservation for a patient. The appointment is held in a reserved state until confirmed via the Book Appointment endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppointment","name":"Create an Appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an appointment reservation for a patient. The appointment is held in a reserved state until confirmed via the Book Appointment endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flow:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" List Slots → Create Appointment (reserve) → Book Appointment (confirm)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the reservation is not confirmed within the hold period, it will be automatically released."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_mechanism"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ehr_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appointments must be managed via the v2 endpoints; v1 supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentReserveBody","exampleIds":["paths/~1v1~1appointments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentReserveBody","exampleIds":["paths/~1v1~1appointments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1appointments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentReserveBody","exampleIds":["paths/~1v1~1appointments/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/appointments","href":"appointments/createappointment","openApiOperationId":"createAppointment","summary":"Create an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentReserveBody","exampleIds":["paths/~1v1~1appointments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentReserveBody","exampleIds":["paths/~1v1~1appointments/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentReserveResponse"}},"schemaId":"components/schemas/AppointmentReserveResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentReserveResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentReserveResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/createappointment"}],"panels":[]}]},"httpPath":"/v1/appointments"},{"label":"List Appointment Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listappointmenttypes","routeSlug":"/apis/public-api/openapi/appointments/listappointmenttypes","metadata":{"seo":{"title":"List Appointment Types","description":"Retrieves a list of all appointment types configured for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppointmentTypes","name":"List Appointment Types","isWebhook":false,"pointer":"/paths/~1v1~1appointment_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Appointment Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all appointment types configured for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"location_ids","in":"query","schemaId":"schema_53"},{"name":"has_availability","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v1~1appointment_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointment_types","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"location_ids","in":"query","required":false,"schemaId":"schema_53"},{"name":"has_availability","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/appointment_types","href":"appointments/listappointmenttypes","openApiOperationId":"listAppointmentTypes","summary":"List Appointment Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentTypeList"}},"schemaId":"components/schemas/AppointmentTypeList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointment_types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentTypeList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentTypeList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/listappointmenttypes"}],"panels":[]}]},"httpPath":"/v1/appointment_types"},{"label":"Get Booking Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getbookinglink","routeSlug":"/apis/public-api/openapi/appointments/getbookinglink","metadata":{"seo":{"title":"Get Booking Link","description":"Get a booking link and its fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBookingLink","name":"Get Booking Link","isWebhook":false,"pointer":"/paths/~1v1~1booking_links~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Booking Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a booking link and its fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1booking_links~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/booking_links/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/booking_links/{id}","href":"appointments/getbookinglink","openApiOperationId":"getBookingLink","summary":"Get Booking Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkFromDb"}},"schemaId":"components/schemas/BookingLinkFromDb"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1booking_links~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingLinkFromDb","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkFromDb"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getbookinglink"}],"panels":[]}]},"httpPath":"/v1/booking_links/{id}"},{"label":"Count Bookable Slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/countslots","routeSlug":"/apis/public-api/openapi/appointments/countslots","metadata":{"seo":{"title":"Count Bookable Slots","description":"Count of all bookable slots for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countSlots","name":"Count Bookable Slots","isWebhook":false,"pointer":"/paths/~1v1~1slots~1count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count Bookable Slots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Count of all bookable slots for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointment_type_id","in":"query","schemaId":"schema_53","required":true},{"name":"location_id","in":"query","schemaId":"schema_53"},{"name":"practitioner_id","in":"query","schemaId":"schema_53"},{"name":"start_date","in":"query","schemaId":"schema_52"},{"name":"end_date","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1slots~1count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/slots/count","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"appointment_type_id","in":"query","required":true,"schemaId":"schema_53"},{"name":"location_id","in":"query","required":false,"schemaId":"schema_53"},{"name":"practitioner_id","in":"query","required":false,"schemaId":"schema_53"},{"name":"start_date","in":"query","required":false,"schemaId":"schema_52"},{"name":"end_date","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/slots/count","href":"appointments/countslots","openApiOperationId":"countSlots","summary":"Count Bookable Slots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponse"}},"schemaId":"components/schemas/EpisodeCountResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1slots~1count/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeCountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/countslots"}],"panels":[]}]},"httpPath":"/v1/slots/count"},{"label":"Get Bookable Slot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getslot","routeSlug":"/apis/public-api/openapi/appointments/getslot","metadata":{"seo":{"title":"Get Bookable Slot","description":"Retrieves a single bookable slot by its ID for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSlot","name":"Get Bookable Slot","isWebhook":false,"pointer":"/paths/~1v1~1slots~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Bookable Slot","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single bookable slot by its ID for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1slots~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/slots/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","429","500"],"pointer":"/v1/slots/{id}","href":"appointments/getslot","openApiOperationId":"getSlot","summary":"Get Bookable Slot"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotGet"}},"schemaId":"components/schemas/SlotGet"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1slots~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SlotGet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotGet"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getslot"}],"panels":[]}]},"httpPath":"/v1/slots/{id}"},{"label":"List Bookable Slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listslots","routeSlug":"/apis/public-api/openapi/appointments/listslots","metadata":{"seo":{"title":"List Bookable Slots","description":"Retrieve available bookable slots for the practice group. Filter by location, practitioner, appointment type, and date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSlots","name":"List Bookable Slots","isWebhook":false,"pointer":"/paths/~1v1~1slots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Bookable Slots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve available bookable slots for the practice group. Filter by location, practitioner, appointment type, and date range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typical flow:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" List Appointment Types → List Slots (filtered) → Create Appointment → Book Appointment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are paginated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters to narrow the date window."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"location_id","in":"query","schemaId":"schema_55","description":"Filter slots by location. Pass a single ID or an array of IDs.","example":"7"},{"name":"practitioner_id","in":"query","schemaId":"schema_55","description":"Filter slots by practitioner. Pass a single ID or an array of IDs.","example":"15"},{"name":"start_date","in":"query","schemaId":"schema_52","description":"Only return slots on or after this date (ISO 8601 format).","example":"2026-03-15"},{"name":"end_date","in":"query","schemaId":"schema_52","description":"Only return slots on or before this date (ISO 8601 format).","example":"2026-03-22"},{"name":"appointment_type_id","in":"query","schemaId":"schema_55","description":"Filter slots by appointment type. Pass a single ID or an array of IDs.","example":"42"}],"pointer":"/paths/~1v1~1slots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/slots","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"location_id","in":"query","required":false,"example":"7","schemaId":"schema_55"},{"name":"practitioner_id","in":"query","required":false,"example":"15","schemaId":"schema_55"},{"name":"start_date","in":"query","required":false,"example":"2026-03-15","schemaId":"schema_52"},{"name":"end_date","in":"query","required":false,"example":"2026-03-22","schemaId":"schema_52"},{"name":"appointment_type_id","in":"query","required":false,"example":"42","schemaId":"schema_55"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/slots","href":"appointments/listslots","openApiOperationId":"listSlots","summary":"List Bookable Slots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotList"}},"schemaId":"components/schemas/SlotList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1slots/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SlotList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/listslots"}],"panels":[]}]},"httpPath":"/v1/slots"},{"label":"Check slot availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/checkslotsavailability","routeSlug":"/apis/public-api/openapi/appointments/checkslotsavailability","metadata":{"seo":{"title":"Check slot availability","description":"Check whether a specific slot is still available for booking. Call this immediately before creating an appointment to avoid reservation conflicts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkSlotsAvailability","name":"Check slot availability","isWebhook":false,"pointer":"/paths/~1v1~1slots~1availability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check slot availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check whether a specific slot is still available for booking. Call this immediately before creating an appointment to avoid reservation conflicts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SlotAvailabilityBody"}},"schemaId":"components/schemas/SlotAvailabilityBody","pointer":"/paths/~1v1~1slots~1availability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/slots/availability","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SlotAvailabilityBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/slots/availability","href":"appointments/checkslotsavailability","openApiOperationId":"checkSlotsAvailability","summary":"Check slot availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/SlotAvailabilityBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SlotAvailabilityBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotAvailability"}},"schemaId":"components/schemas/SlotAvailability"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1slots~1availability/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SlotAvailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SlotAvailability"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/checkslotsavailability"}],"panels":[]}]},"httpPath":"/v1/slots/availability"},{"label":"List Appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listappointments","routeSlug":"/apis/public-api/openapi/appointments/listappointments","metadata":{"seo":{"title":"List Appointments","description":"Retrieves a list of all appointments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppointments","name":"List Appointments","isWebhook":false,"pointer":"/paths/~1v2~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all appointments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_56"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"patient_id","in":"query","schemaId":"schema_52"},{"name":"patient_first_name","in":"query","schemaId":"schema_52"},{"name":"patient_last_name","in":"query","schemaId":"schema_52"},{"name":"patient_full_name","in":"query","schemaId":"schema_52"},{"name":"practitioner_id","in":"query","schemaId":"schema_55"},{"name":"practitioner_first_name","in":"query","schemaId":"schema_52"},{"name":"practitioner_last_name","in":"query","schemaId":"schema_52"},{"name":"practitioner_full_name","in":"query","schemaId":"schema_52"},{"name":"location_id","in":"query","schemaId":"schema_55"},{"name":"appointment_template_name","in":"query","schemaId":"schema_52"},{"name":"location_name","in":"query","schemaId":"schema_52"},{"name":"has_been_cancelled","in":"query","schemaId":"schema_54"},{"name":"appointment_source","in":"query","schemaId":"schema_57"},{"name":"start_time","in":"query","schemaId":"schema_52"},{"name":"end_time","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v2~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/appointments","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_56"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"patient_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_first_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_last_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_full_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"practitioner_id","in":"query","required":false,"schemaId":"schema_55"},{"name":"practitioner_first_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"practitioner_last_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"practitioner_full_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"location_id","in":"query","required":false,"schemaId":"schema_55"},{"name":"appointment_template_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"location_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"has_been_cancelled","in":"query","required":false,"schemaId":"schema_54"},{"name":"appointment_source","in":"query","required":false,"schemaId":"schema_57"},{"name":"start_time","in":"query","required":false,"schemaId":"schema_52"},{"name":"end_time","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/appointments","href":"appointments/listappointments","openApiOperationId":"listAppointments","summary":"List Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsListResponse"}},"schemaId":"components/schemas/AppointmentsListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/listappointments"}],"panels":[]}]},"httpPath":"/v2/appointments"},{"label":"Book an Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/bookappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/bookappointmentv2","metadata":{"seo":{"title":"Book an Appointment","description":"Submits a previously reserved appointment for booking. Returns immediately withstatus \"pending\"; the booking is confirmed asynchronously. Poll Get AppointmentStatus for the outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bookAppointmentV2","name":"Book an Appointment","isWebhook":false,"pointer":"/paths/~1v2~1appointments~1{id}~1book/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Book an Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a previously reserved appointment for booking. Returns immediately with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status \"pending\"; the booking is confirmed asynchronously. Poll Get Appointment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status for the outcome."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only appointments reserved with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_mechanism: ehr_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be booked here; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appointments must be booked via the v1 endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1appointments~1{id}~1book/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody"}},"schemaId":"components/schemas/AppointmentBookBody","pointer":"/paths/~1v2~1appointments~1{id}~1book/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/appointments/{id}/book","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v2/appointments/{id}/book","href":"appointments/bookappointmentv2","openApiOperationId":"bookAppointmentV2","summary":"Book an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentBookBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}},"schemaId":"components/schemas/AppointmentV2BookResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment is not bookable — already booked, reservation expired, a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"booking is already in progress, or reserved with a different mechanism."},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1appointments~1{id}~1book/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentV2BookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/bookappointmentv2"}],"panels":[]}]},"httpPath":"/v2/appointments/{id}/book"},{"label":"Cancel an Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/cancelappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/cancelappointmentv2","metadata":{"seo":{"title":"Cancel an Appointment","description":"Cancels a confirmed appointment. Returns immediately with status \"cancelling\"; the cancellation is confirmed asynchronously. Poll Get Appointment Status for the outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelAppointmentV2","name":"Cancel an Appointment","isWebhook":false,"pointer":"/paths/~1v2~1appointments~1{id}~1cancel/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a confirmed appointment. Returns immediately with status \"cancelling\";\nthe cancellation is confirmed asynchronously. Poll Get Appointment Status for\nthe outcome.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1appointments~1{id}~1cancel/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"schemaId":"components/schemas/AppointmentCancelBody","pointer":"/paths/~1v2~1appointments~1{id}~1cancel/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/appointments/{id}/cancel","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"responseCodes":["200","400","401","404","409","422","429","500"],"pointer":"/v2/appointments/{id}/cancel","href":"appointments/cancelappointmentv2","openApiOperationId":"cancelAppointmentV2","summary":"Cancel an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentCancelBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}},"schemaId":"components/schemas/AppointmentV2BookResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"409","description":"A cancellation is already in progress for this appointment"},{"code":"422","description":"Appointment is not in a cancellable state"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1appointments~1{id}~1cancel/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentV2BookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/cancelappointmentv2"}],"panels":[]}]},"httpPath":"/v2/appointments/{id}/cancel"},{"label":"Reschedule Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/rescheduleappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/rescheduleappointmentv2","metadata":{"seo":{"title":"Reschedule Appointment","description":"Asynchronously reschedules an EHR-confirmed appointment to a new slot (book-new then cancel-old). Returns immediately with a rescheduling status; poll the status endpoint for the outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rescheduleAppointmentV2","name":"Reschedule Appointment","isWebhook":false,"pointer":"/paths/~1v2~1appointments~1{id}~1reschedule/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reschedule Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Asynchronously reschedules an EHR-confirmed appointment to a new slot (book-new then cancel-old). Returns immediately with a rescheduling status; poll the status endpoint for the outcome."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1appointments~1{id}~1reschedule/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentV2RescheduleBody"}},"schemaId":"components/schemas/AppointmentV2RescheduleBody","pointer":"/paths/~1v2~1appointments~1{id}~1reschedule/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/appointments/{id}/reschedule","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentV2RescheduleBody"}},"responseCodes":["200","400","401","404","409","422","429","500"],"pointer":"/v2/appointments/{id}/reschedule","href":"appointments/rescheduleappointmentv2","openApiOperationId":"rescheduleAppointmentV2","summary":"Reschedule Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentV2RescheduleBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentV2RescheduleBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}},"schemaId":"components/schemas/AppointmentV2BookResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"409","description":"A reschedule is already in progress for this appointment"},{"code":"422","description":"Appointment is not in a reschedulable state, or is inside the reschedule policy window"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1appointments~1{id}~1reschedule/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentV2BookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentV2BookResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/rescheduleappointmentv2"}],"panels":[]}]},"httpPath":"/v2/appointments/{id}/reschedule"},{"label":"Edit an Appointment reservation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/editappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/editappointmentv2","metadata":{"seo":{"title":"Edit an Appointment reservation","description":"Updates an unconfirmed reservation in place - slot, practitioner, reason,patient proxy - and re-stamps the reservation hold, returning the freshreserved_until. Only appointments in the reserved state can be edited;use Reschedule for confirmed appointments. Works for both bookingmechanisms - a reservation has not touched the EHR yet. The locationand appointment type cannot change - release the reservation andre-reserve to move site or change type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editAppointmentV2","name":"Edit an Appointment reservation","isWebhook":false,"pointer":"/paths/~1v2~1appointments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit an Appointment reservation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an unconfirmed reservation in place - slot, practitioner, reason,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"patient proxy - and re-stamps the reservation hold, returning the fresh"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reserved_until. Only appointments in the reserved state can be edited;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use Reschedule for confirmed appointments. Works for both booking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mechanisms - a reservation has not touched the EHR yet. The location"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and appointment type cannot change - release the reservation and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"re-reserve to move site or change type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1appointments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentV2EditBody"}},"schemaId":"components/schemas/AppointmentV2EditBody","pointer":"/paths/~1v2~1appointments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/appointments/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentV2EditBody"}},"responseCodes":["200","400","401","404","409","422","429","500"],"pointer":"/v2/appointments/{id}","href":"appointments/editappointmentv2","openApiOperationId":"editAppointmentV2","summary":"Edit an Appointment reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentV2EditBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentV2EditBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentReserveResponse"}},"schemaId":"components/schemas/AppointmentReserveResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"409","description":"A booking is already in progress for this appointment"},{"code":"422","description":"Appointment is not an active reservation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1appointments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentReserveResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentReserveResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"409"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/editappointmentv2"}],"panels":[]}]},"httpPath":"/v2/appointments/{id}"},{"label":"List Automated messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listautomatedmessages","routeSlug":"/apis/public-api/openapi/appointments/listautomatedmessages","metadata":{"seo":{"title":"List Automated messages","description":"Retrieves a list of automated appointment messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAutomatedMessages","name":"List Automated messages","isWebhook":false,"pointer":"/paths/~1v2~1automated_messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Automated messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of automated appointment messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"orderBy","in":"query","schemaId":"schema_58"},{"name":"order_descending","in":"query","schemaId":"schema_59"},{"name":"recipient_id","in":"query","schemaId":"schema_52"},{"name":"status","in":"query","schemaId":"schema_60"},{"name":"notification_type","in":"query","schemaId":"schema_55"}],"pointer":"/paths/~1v2~1automated_messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/automated_messages","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_58"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_59"},{"name":"recipient_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"status","in":"query","required":false,"schemaId":"schema_60"},{"name":"notification_type","in":"query","required":false,"schemaId":"schema_55"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/automated_messages","href":"appointments/listautomatedmessages","openApiOperationId":"listAutomatedMessages","summary":"List Automated messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomatedMessagesListResponse"}},"schemaId":"components/schemas/AutomatedMessagesListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1automated_messages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutomatedMessagesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomatedMessagesListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/listautomatedmessages"}],"panels":[]}]},"httpPath":"/v2/automated_messages"},{"label":"List Booking links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listbookinglinks","routeSlug":"/apis/public-api/openapi/appointments/listbookinglinks","metadata":{"seo":{"title":"List Booking links","description":"Retrieves a list of shortlinks filtered by 'booking' link type and version 2."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBookingLinks","name":"List Booking links","isWebhook":false,"pointer":"/paths/~1v2~1bookinglinks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Booking links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of shortlinks filtered by 'booking' link type and version 2."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_61"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"status","in":"query","schemaId":"schema_62"},{"name":"exclude_patient_specific_links","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v2~1bookinglinks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/bookinglinks","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_61"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"status","in":"query","required":false,"schemaId":"schema_62"},{"name":"exclude_patient_specific_links","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/bookinglinks","href":"appointments/listbookinglinks","openApiOperationId":"listBookingLinks","summary":"List Booking links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinksListResponse"}},"schemaId":"components/schemas/BookingLinksListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1bookinglinks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingLinksListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinksListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/listbookinglinks"}],"panels":[]}]},"httpPath":"/v2/bookinglinks"},{"label":"Edit an Appointment","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/editappointment","routeSlug":"/apis/public-api/openapi/appointments/editappointment","metadata":{"seo":{"title":"Edit an Appointment","description":"Deprecated: new integrations should use PUT /v2/appointments/{id} (editAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editAppointment","name":"Edit an Appointment","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit an Appointment","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: new integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v2/appointments/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editAppointmentV2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead. This endpoint remains available for existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit a non-confirmed appointment"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1appointments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/appointments/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/appointments/{id}","href":"appointments/editappointment","openApiOperationId":"editAppointment","summary":"Edit an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/editappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}"},{"label":"Book an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/bookappointment","routeSlug":"/apis/public-api/openapi/appointments/bookappointment","metadata":{"seo":{"title":"Book an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/book (bookAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bookAppointment","name":"Book an Appointment","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}~1book/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Book an Appointment","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: new integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/appointments/{id}/book"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookAppointmentV2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead. This endpoint remains available for existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm a previously reserved appointment. This transitions the appointment from reserved to booked status and triggers any configured notifications (e.g. patient confirmation SMS)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The appointment must have been created via the Create Appointment endpoint first. Appointments reserved with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"booking_mechanism: ehr_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be booked via the v2 endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}~1book/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody","exampleIds":["paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentBookBody","exampleIds":["paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1appointments~1{id}~1book/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/appointments/{id}/book","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody","exampleIds":["paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/appointments/{id}/book","href":"appointments/bookappointment","openApiOperationId":"bookAppointment","summary":"Book an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentBookBody","exampleIds":["paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentBookBody","exampleIds":["paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment is not bookable — already booked, reservation expired, the slot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is no longer available, or it was reserved with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ehr_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (book via v2)."},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}~1book/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/bookappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}/book"},{"label":"Cancel an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/cancelappointment","routeSlug":"/apis/public-api/openapi/appointments/cancelappointment","metadata":{"seo":{"title":"Cancel an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/cancel (cancelAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelAppointment","name":"Cancel an Appointment","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}~1cancel/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an Appointment","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: new integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/appointments/{id}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelAppointmentV2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead. This endpoint remains available for existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a booked or reserved appointment. The slot will be released and made available for other bookings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}~1cancel/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"schemaId":"components/schemas/AppointmentCancelBody","pointer":"/paths/~1v1~1appointments~1{id}~1cancel/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/appointments/{id}/cancel","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/appointments/{id}/cancel","href":"appointments/cancelappointment","openApiOperationId":"cancelAppointment","summary":"Cancel an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentCancelBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}~1cancel/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/cancelappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}/cancel"},{"label":"Reschedule an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/rescheduleappointment","routeSlug":"/apis/public-api/openapi/appointments/rescheduleappointment","metadata":{"seo":{"title":"Reschedule an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/reschedule (rescheduleAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rescheduleAppointment","name":"Reschedule an Appointment","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{id}~1reschedule/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reschedule an Appointment","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: new integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/appointments/{id}/reschedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rescheduleAppointmentV2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") instead. This endpoint remains available for existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reschedule a confirmed appointment"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1appointments~1{id}~1reschedule/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/appointments/{id}/reschedule","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/appointments/{id}/reschedule","href":"appointments/rescheduleappointment","openApiOperationId":"rescheduleAppointment","summary":"Reschedule an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentRescheduleBody","exampleIds":["paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1appointments~1{id}~1reschedule/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/rescheduleappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{id}/reschedule"}],"content":{"contentType":"group","meta":{"name":"Appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Create appointment reservations, confirm bookings, cancel, and reschedule. Query available slots and appointment types filtered by location, practitioner, and appointment type."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/appointments/{id}","summary":"Get an Appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getappointment","deprecated":false},{"title":"/v1/appointments/{id}/status","summary":"Get Appointment Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getappointmentstatus","deprecated":false},{"title":"/v1/appointments","summary":"Create an Appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/createappointment","deprecated":false},{"title":"/v1/appointment_types","summary":"List Appointment Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/listappointmenttypes","deprecated":false},{"title":"/v1/booking_links/{id}","summary":"Get Booking Link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getbookinglink","deprecated":false},{"title":"/v1/slots/count","summary":"Count Bookable Slots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/countslots","deprecated":false},{"title":"/v1/slots/{id}","summary":"Get Bookable Slot","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getslot","deprecated":false},{"title":"/v1/slots","summary":"List Bookable Slots","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/listslots","deprecated":false},{"title":"/v1/slots/availability","summary":"Check slot availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/checkslotsavailability","deprecated":false},{"title":"/v2/appointments","summary":"List Appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/listappointments","deprecated":false},{"title":"/v2/appointments/{id}/book","summary":"Book an Appointment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appointments/bookappointmentv2","deprecated":false},{"title":"/v2/appointments/{id}/cancel","summary":"Cancel an Appointment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appointments/cancelappointmentv2","deprecated":false},{"title":"/v2/appointments/{id}/reschedule","summary":"Reschedule Appointment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appointments/rescheduleappointmentv2","deprecated":false},{"title":"/v2/appointments/{id}","summary":"Edit an Appointment reservation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/editappointmentv2","deprecated":false},{"title":"/v2/automated_messages","summary":"List Automated messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/listautomatedmessages","deprecated":false},{"title":"/v2/bookinglinks","summary":"List Booking links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/listbookinglinks","deprecated":false},{"title":"/v1/appointments/{id}","summary":"Edit an Appointment","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/appointments/editappointment","deprecated":true},{"title":"/v1/appointments/{id}/book","summary":"Book an Appointment","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/appointments/bookappointment","deprecated":true},{"title":"/v1/appointments/{id}/cancel","summary":"Cancel an Appointment","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/appointments/cancelappointment","deprecated":true},{"title":"/v1/appointments/{id}/reschedule","summary":"Reschedule an Appointment","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/appointments/rescheduleappointment","deprecated":true}]}]}]}]}},{"type":"group","label":"Practitioners","link":"/apis/public-api/openapi/practitioners","routeSlug":"/apis/public-api/openapi/practitioners","items":[{"label":"List Practitioners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/listpractitioners","routeSlug":"/apis/public-api/openapi/practitioners/listpractitioners","metadata":{"seo":{"title":"List Practitioners","description":"Retrieves a list of practitioners configured for online booking on Hero Health."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPractitioners","name":"List Practitioners","isWebhook":false,"pointer":"/paths/~1v1~1practitioners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Practitioners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of practitioners configured for online booking on Hero Health."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"location_ids","in":"query","schemaId":"schema_53"},{"name":"appointment_type_ids","in":"query","schemaId":"schema_53"},{"name":"has_availability","in":"query","schemaId":"schema_54"},{"name":"search","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive partial match on the practitioner's first name, last name, the two together, or their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ehr_partner_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so a practitioner can be found either by the name patients see or by the session holder name they carry in the EHR."},"children":[]}]}]}]},{"name":"include[]","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts additional sets of practitioners into the response. Repeatable and combinable. By default only active practitioners are returned; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adds archived practitioners, identifiable by a non-null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"include[]=archived"},{"name":"order_by","in":"query","schemaId":"components/schemas/LocationOrderBy","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort by. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts by last name then first name, ignoring case; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts by the number of available slots. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order_descending","in":"query","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. To list the practitioners with the most availability first, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_by=slot_count&order_descending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1practitioners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/practitioners","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"location_ids","in":"query","required":false,"schemaId":"schema_53"},{"name":"appointment_type_ids","in":"query","required":false,"schemaId":"schema_53"},{"name":"has_availability","in":"query","required":false,"schemaId":"schema_54"},{"name":"search","in":"query","required":false,"schemaId":"schema_52"},{"name":"include[]","in":"query","required":false,"example":"include[]=archived","schemaId":"schema_63","style":"form","explode":true},{"name":"order_by","in":"query","required":false,"schemaId":"components/schemas/LocationOrderBy"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/practitioners","href":"practitioners/listpractitioners","openApiOperationId":"listPractitioners","summary":"List Practitioners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerList"}},"schemaId":"components/schemas/PractitionerList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1practitioners/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PractitionerList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practitioners/listpractitioners"}],"panels":[]}]},"httpPath":"/v1/practitioners"},{"label":"Get a Practitioner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/getpractitioner","routeSlug":"/apis/public-api/openapi/practitioners/getpractitioner","metadata":{"seo":{"title":"Get a Practitioner","description":"Retrieves a single practitioner by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPractitioner","name":"Get a Practitioner","isWebhook":false,"pointer":"/paths/~1v1~1practitioners~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Practitioner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single practitioner by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1practitioners~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include[]","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts additional sets of practitioners into the lookup. By default an archived practitioner is not found; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieves it, identifiable by a non-null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"include[]=archived"}],"pointer":"/paths/~1v1~1practitioners~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/practitioners/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[{"name":"include[]","in":"query","required":false,"example":"include[]=archived","schemaId":"schema_63","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/practitioners/{id}","href":"practitioners/getpractitioner","openApiOperationId":"getPractitioner","summary":"Get a Practitioner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerResponse"}},"schemaId":"components/schemas/PractitionerResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found. Archived practitioners are not found unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1practitioners~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PractitionerResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practitioners/getpractitioner"}],"panels":[]}]},"httpPath":"/v1/practitioners/{id}"},{"label":"Update a Practitioner","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/updatepractitioner","routeSlug":"/apis/public-api/openapi/practitioners/updatepractitioner","metadata":{"seo":{"title":"Update a Practitioner","description":"Updates a practitioner's identity, contact and notification fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePractitioner","name":"Update a Practitioner","isWebhook":false,"pointer":"/paths/~1v1~1practitioners~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Practitioner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a practitioner's identity, contact and notification fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deep-merged: any key absent at any level is left untouched. Sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"notifications\":{\"appointment_cancelled\":{\"sms\":true}}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets that one channel and leaves "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_cancelled.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the other events exactly as they were."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notifications.video_appointment.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" differs from the appointment flags: rather than firing on an event, it controls whether the practitioner is offered as a recipient when a video consultation invitation is sent."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1practitioners~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PractitionerUpdateBody"}},"schemaId":"components/schemas/PractitionerUpdateBody","pointer":"/paths/~1v1~1practitioners~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/practitioners/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PractitionerUpdateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/practitioners/{id}","href":"practitioners/updatepractitioner","openApiOperationId":"updatePractitioner","summary":"Update a Practitioner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PractitionerUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PractitionerUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerResponse"}},"schemaId":"components/schemas/PractitionerResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1practitioners~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PractitionerResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practitioners/updatepractitioner"}],"panels":[]}]},"httpPath":"/v1/practitioners/{id}"},{"label":"Archive a Practitioner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/archivepractitioner","routeSlug":"/apis/public-api/openapi/practitioners/archivepractitioner","metadata":{"seo":{"title":"Archive a Practitioner","description":"Archives a practitioner so they are no longer active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archivePractitioner","name":"Archive a Practitioner","isWebhook":false,"pointer":"/paths/~1v1~1practitioners~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a Practitioner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archives a practitioner so they are no longer active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1practitioners~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/practitioners/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","429","500"],"pointer":"/v1/practitioners/{id}","href":"practitioners/archivepractitioner","openApiOperationId":"archivePractitioner","summary":"Archive a Practitioner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerDeleteResponse"}},"schemaId":"components/schemas/PractitionerDeleteResponse"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1practitioners~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PractitionerDeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PractitionerDeleteResponse"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practitioners/archivepractitioner"}],"panels":[]}]},"httpPath":"/v1/practitioners/{id}"}],"content":{"contentType":"group","meta":{"name":"Practitioners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Practitioners","showPageActions":true},{"nodeType":"markdoc","content":"List, retrieve, update, and archive practitioners within a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/practitioners","summary":"List Practitioners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practitioners/listpractitioners","deprecated":false},{"title":"/v1/practitioners/{id}","summary":"Get a Practitioner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practitioners/getpractitioner","deprecated":false},{"title":"/v1/practitioners/{id}","summary":"Update a Practitioner","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/practitioners/updatepractitioner","deprecated":false},{"title":"/v1/practitioners/{id}","summary":"Archive a Practitioner","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/practitioners/archivepractitioner","deprecated":false}]}]}]}]}},{"type":"group","label":"Locations","link":"/apis/public-api/openapi/locations","routeSlug":"/apis/public-api/openapi/locations","items":[{"label":"List Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/listlocations","routeSlug":"/apis/public-api/openapi/locations/listlocations","metadata":{"seo":{"title":"List Locations","description":"Retrieves a list of the locations configured for a practice group on Hero Health."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLocations","name":"List Locations","isWebhook":false,"pointer":"/paths/~1v1~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of the locations configured for a practice group on Hero Health."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointment_type_ids","in":"query","schemaId":"schema_53"},{"name":"has_availability","in":"query","schemaId":"schema_54"},{"name":"search","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive partial match on the location's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_site_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so a location can be found by either the name patients see or the site name it carries in the partner system."},"children":[]}]}]}]},{"name":"include[]","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts additional sets of locations into the response. Repeatable and combinable. By default only active locations are returned; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adds archived locations, identifiable by a non-null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"include[]=archived"},{"name":"order_by","in":"query","schemaId":"components/schemas/LocationOrderBy","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort by. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts alphabetically, ignoring case; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts by the number of available slots. Defaults to the practice group's configured location order."},"children":[]}]}]}]},{"name":"order_descending","in":"query","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. To list the locations with the most availability first, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_by=slot_count&order_descending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"appointment_type_ids","in":"query","required":false,"schemaId":"schema_53"},{"name":"has_availability","in":"query","required":false,"schemaId":"schema_54"},{"name":"search","in":"query","required":false,"schemaId":"schema_52"},{"name":"include[]","in":"query","required":false,"example":"include[]=archived","schemaId":"schema_63","style":"form","explode":true},{"name":"order_by","in":"query","required":false,"schemaId":"components/schemas/LocationOrderBy"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/locations","href":"locations/listlocations","openApiOperationId":"listLocations","summary":"List Locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationList"}},"schemaId":"components/schemas/LocationList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/listlocations"}],"panels":[]}]},"httpPath":"/v1/locations"},{"label":"Get a Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/getlocationbyid","routeSlug":"/apis/public-api/openapi/locations/getlocationbyid","metadata":{"seo":{"title":"Get a Location","description":"Retrieve a single location by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationById","name":"Get a Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single location by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1locations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include[]","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts additional sets of locations into the lookup. By default an archived location is not found; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieves it, identifiable by a non-null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"include[]=archived"}],"pointer":"/paths/~1v1~1locations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/locations/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[{"name":"include[]","in":"query","required":false,"example":"include[]=archived","schemaId":"schema_63","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/locations/{id}","href":"locations/getlocationbyid","openApiOperationId":"getLocationById","summary":"Get a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationListItem"}},"schemaId":"components/schemas/LocationListItem"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found. Archived locations are not found unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed."},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1locations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationListItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationListItem"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/getlocationbyid"}],"panels":[]}]},"httpPath":"/v1/locations/{id}"},{"label":"Update a Location","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/updatelocation","routeSlug":"/apis/public-api/openapi/locations/updatelocation","metadata":{"seo":{"title":"Update a Location","description":"Update an existing location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLocation","name":"Update a Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1locations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationUpdateBody"}},"schemaId":"components/schemas/LocationUpdateBody","pointer":"/paths/~1v1~1locations~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/locations/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationUpdateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/locations/{id}","href":"locations/updatelocation","openApiOperationId":"updateLocation","summary":"Update a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/LocationUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDto"}},"schemaId":"components/schemas/LocationDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1locations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/updatelocation"}],"panels":[]}]},"httpPath":"/v1/locations/{id}"},{"label":"Archive a Location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/archivelocation","routeSlug":"/apis/public-api/openapi/locations/archivelocation","metadata":{"seo":{"title":"Archive a Location","description":"Archive a location. Archived locations are no longer visible to patients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveLocation","name":"Archive a Location","isWebhook":false,"pointer":"/paths/~1v1~1locations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a location. Archived locations are no longer visible to patients."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1locations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/locations/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/locations/{id}","href":"locations/archivelocation","openApiOperationId":"archiveLocation","summary":"Archive a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1locations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/archivelocation"}],"panels":[]}]},"httpPath":"/v1/locations/{id}"}],"content":{"contentType":"group","meta":{"name":"Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations","showPageActions":true},{"nodeType":"markdoc","content":"List, retrieve, create, update, and archive locations for a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/locations","summary":"List Locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/listlocations","deprecated":false},{"title":"/v1/locations/{id}","summary":"Get a Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/getlocationbyid","deprecated":false},{"title":"/v1/locations/{id}","summary":"Update a Location","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/locations/updatelocation","deprecated":false},{"title":"/v1/locations/{id}","summary":"Archive a Location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locations/archivelocation","deprecated":false}]}]}]}]}},{"type":"separator","label":"Administration","content":null},{"type":"group","label":"Admin","link":"/apis/public-api/openapi/admin","routeSlug":"/apis/public-api/openapi/admin","items":[{"label":"List Admins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/listadmins","routeSlug":"/apis/public-api/openapi/admin/listadmins","metadata":{"seo":{"title":"List Admins","description":"Retrieves a list of all admins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAdmins","name":"List Admins","isWebhook":false,"pointer":"/paths/~1v1~1admins/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Admins","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all admins."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_65"},{"name":"order_descending","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v1~1admins/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/admins","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_65"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/admins","href":"admin/listadmins","openApiOperationId":"listAdmins","summary":"List Admins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminListResponse"}},"schemaId":"components/schemas/AdminListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admins/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/listadmins"}],"panels":[]}]},"httpPath":"/v1/admins"},{"label":"Update an Admin","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/updateadmin","routeSlug":"/apis/public-api/openapi/admin/updateadmin","metadata":{"seo":{"title":"Update an Admin","description":"Updates an admin using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAdmin","name":"Update an Admin","isWebhook":false,"pointer":"/paths/~1v1~1admins~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Admin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an admin using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1admins~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpdateBody"}},"schemaId":"components/schemas/AdminUpdateBody","pointer":"/paths/~1v1~1admins~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/admins/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AdminUpdateBody"}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/admins/{id}","href":"admin/updateadmin","openApiOperationId":"updateAdmin","summary":"Update an Admin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AdminUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminUpdateResponse"}},"schemaId":"components/schemas/AdminUpdateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Admin inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admins~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminUpdateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/updateadmin"}],"panels":[]}]},"httpPath":"/v1/admins/{id}"},{"label":"Upsert Admin In-Context Signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/upsertadminsignature","routeSlug":"/apis/public-api/openapi/admin/upsertadminsignature","metadata":{"seo":{"title":"Upsert Admin In-Context Signature","description":"Insert or update a signature for Admin in context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertAdminSignature","name":"Upsert Admin In-Context Signature","isWebhook":false,"pointer":"/paths/~1v1~1admin~1signature/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Admin In-Context Signature","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Insert or update a signature for Admin in context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpsertSignatureBody"}},"schemaId":"components/schemas/AdminUpsertSignatureBody","pointer":"/paths/~1v1~1admin~1signature/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/admin/signature","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AdminUpsertSignatureBody"}},"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/admin/signature","href":"admin/upsertadminsignature","openApiOperationId":"upsertAdminSignature","summary":"Upsert Admin In-Context Signature"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AdminUpsertSignatureBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpsertSignatureBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"No Admin on context"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admin~1signature/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/upsertadminsignature"}],"panels":[]}]},"httpPath":"/v1/admin/signature"},{"label":"Upsert Admin In-Context Preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/upsertadminpreferences","routeSlug":"/apis/public-api/openapi/admin/upsertadminpreferences","metadata":{"seo":{"title":"Upsert Admin In-Context Preferences","description":"Insert or update preferences for the given Admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertAdminPreferences","name":"Upsert Admin In-Context Preferences","isWebhook":false,"pointer":"/paths/~1v1~1admin~1preferences/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Admin In-Context Preferences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Insert or update preferences for the given Admin."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpsertPreferencesBody"}},"schemaId":"components/schemas/AdminUpsertPreferencesBody","pointer":"/paths/~1v1~1admin~1preferences/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/admin/preferences","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AdminUpsertPreferencesBody"}},"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/admin/preferences","href":"admin/upsertadminpreferences","openApiOperationId":"upsertAdminPreferences","summary":"Upsert Admin In-Context Preferences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AdminUpsertPreferencesBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminUpsertPreferencesBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"No Admin on context"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admin~1preferences/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/upsertadminpreferences"}],"panels":[]}]},"httpPath":"/v1/admin/preferences"},{"label":"Get prescriber details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/getprescriber","routeSlug":"/apis/public-api/openapi/admin/getprescriber","metadata":{"seo":{"title":"Get prescriber details","description":"Retrieves prescriber details for the admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrescriber","name":"Get prescriber details","isWebhook":false,"pointer":"/paths/~1v1~1admins~1{id}~1prescriber/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get prescriber details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves prescriber details for the admin."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1admins~1{id}~1prescriber/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/admins/{id}/prescriber","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/admins/{id}/prescriber","href":"admin/getprescriber","openApiOperationId":"getPrescriber","summary":"Get prescriber details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberResponse"}},"schemaId":"components/schemas/AdminPrescriberResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admins~1{id}~1prescriber/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminPrescriberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/getprescriber"}],"panels":[]}]},"httpPath":"/v1/admins/{id}/prescriber"},{"label":"List Admin Teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/listadminteams","routeSlug":"/apis/public-api/openapi/admin/listadminteams","metadata":{"seo":{"title":"List Admin Teams","description":"Retrieves a list of all admin teams."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAdminTeams","name":"List Admin Teams","isWebhook":false,"pointer":"/paths/~1v1~1admin_teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Admin Teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all admin teams."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_66"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"admin_id","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1admin_teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/admin_teams","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_66"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"admin_id","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/admin_teams","href":"admin/listadminteams","openApiOperationId":"listAdminTeams","summary":"List Admin Teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminTeamListResponse"}},"schemaId":"components/schemas/AdminTeamListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admin_teams/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminTeamListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminTeamListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/listadminteams"}],"panels":[]}]},"httpPath":"/v1/admin_teams"},{"label":"Create an Admin Team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/createadminteam","routeSlug":"/apis/public-api/openapi/admin/createadminteam","metadata":{"seo":{"title":"Create an Admin Team","description":"Creates a new admin team with the specified name and admin members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAdminTeam","name":"Create an Admin Team","isWebhook":false,"pointer":"/paths/~1v1~1admin_teams/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Admin Team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new admin team with the specified name and admin members."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminTeamCreateBody"}},"schemaId":"components/schemas/AdminTeamCreateBody","pointer":"/paths/~1v1~1admin_teams/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/admin_teams","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AdminTeamCreateBody"}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/v1/admin_teams","href":"admin/createadminteam","openApiOperationId":"createAdminTeam","summary":"Create an Admin Team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AdminTeamCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AdminTeamCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Admin team created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminTeamCreateResponse"}},"schemaId":"components/schemas/AdminTeamCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"403","description":"Forbidden"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1admin_teams/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminTeamCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminTeamCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/admin/createadminteam"}],"panels":[]}]},"httpPath":"/v1/admin_teams"}],"content":{"contentType":"group","meta":{"name":"Admin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admin","showPageActions":true},{"nodeType":"markdoc","content":"Manage admin users, signatures, and preferences within a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/admins","summary":"List Admins","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin/listadmins","deprecated":false},{"title":"/v1/admins/{id}","summary":"Update an Admin","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/admin/updateadmin","deprecated":false},{"title":"/v1/admin/signature","summary":"Upsert Admin In-Context Signature","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin/upsertadminsignature","deprecated":false},{"title":"/v1/admin/preferences","summary":"Upsert Admin In-Context Preferences","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/admin/upsertadminpreferences","deprecated":false},{"title":"/v1/admins/{id}/prescriber","summary":"Get prescriber details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin/getprescriber","deprecated":false},{"title":"/v1/admin_teams","summary":"List Admin Teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/admin/listadminteams","deprecated":false},{"title":"/v1/admin_teams","summary":"Create an Admin Team","prefix":{"name":"post","color":"post"},"badges":[],"link":"/admin/createadminteam","deprecated":false}]}]}]}]}},{"type":"group","label":"Practice Group","link":"/apis/public-api/openapi/practice-group","routeSlug":"/apis/public-api/openapi/practice-group","items":[{"label":"Create an Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/createaccesstoken","routeSlug":"/apis/public-api/openapi/practice-group/createaccesstoken","metadata":{"seo":{"title":"Create an Access Token","description":"Generate a short-lived Access Token (JWT) to authenticate Hero Health Elements (SDKs)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccessToken","name":"Create an Access Token","isWebhook":false,"pointer":"/paths/~1v1~1access_token/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Access Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a short-lived Access Token (JWT) to authenticate Hero Health Elements (SDKs)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint must only be called from your server — never from client-side code. The returned token expires after 30 minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jwt-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute when rendering a Hero Element (React component or Web Component)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin attribution on the newly created token is resolved from:"},"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":"x-admin-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on token generation (header)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the default-admin behaviour: falls back to the practice group's configured default admin when the header is not supplied."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/access_token","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/v1/access_token","href":"practice-group/createaccesstoken","openApiOperationId":"createAccessToken","summary":"Create an Access Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenResponse"}},"schemaId":"components/schemas/AccessTokenResponse"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorised — invalid or missing API key"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — API key does not have the required scope"},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1access_token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccessTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccessTokenResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/createaccesstoken"}],"panels":[]}]},"httpPath":"/v1/access_token"},{"label":"List Content Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/listcontenttemplates","routeSlug":"/apis/public-api/openapi/practice-group/listcontenttemplates","metadata":{"seo":{"title":"List Content Templates","description":"Retrieves a list of content templates available to the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContentTemplates","name":"List Content Templates","isWebhook":false,"pointer":"/paths/~1v1~1content-templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Content Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of content templates available to the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_67"},{"name":"page_size","in":"query","schemaId":"schema_68"}],"pointer":"/paths/~1v1~1content-templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/content-templates","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"example":"0","schemaId":"schema_67"},{"name":"page_size","in":"query","required":false,"example":"20","schemaId":"schema_68"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/content-templates","href":"practice-group/listcontenttemplates","openApiOperationId":"listContentTemplates","summary":"List Content Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTemplateList"}},"schemaId":"components/schemas/ContentTemplateList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1content-templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentTemplateList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentTemplateList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/listcontenttemplates"}],"panels":[]}]},"httpPath":"/v1/content-templates"},{"label":"Get Practice Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getpracticegroupbyid","routeSlug":"/apis/public-api/openapi/practice-group/getpracticegroupbyid","metadata":{"seo":{"title":"Get Practice Group","description":"Retrieves information regarding the authenticated Practice Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPracticeGroupById","name":"Get Practice Group","isWebhook":false,"pointer":"/paths/~1v1~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Practice Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information regarding the authenticated Practice Group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/me","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/me","href":"practice-group/getpracticegroupbyid","openApiOperationId":"getPracticeGroupById","summary":"Get Practice Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeDto"}},"schemaId":"components/schemas/MeDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1me/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MeDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/getpracticegroupbyid"}],"panels":[]}]},"httpPath":"/v1/me"},{"label":"Get Practice Group Capabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getcapabilities","routeSlug":"/apis/public-api/openapi/practice-group/getcapabilities","metadata":{"seo":{"title":"Get Practice Group Capabilities","description":"Retrieves capabilities of the authenticated Practice Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCapabilities","name":"Get Practice Group Capabilities","isWebhook":false,"pointer":"/paths/~1v1~1me~1capabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Practice Group Capabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves capabilities of the authenticated Practice Group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/me/capabilities","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/me/capabilities","href":"practice-group/getcapabilities","openApiOperationId":"getCapabilities","summary":"Get Practice Group Capabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PracticeGroupCapabilitiesResponse"}},"schemaId":"components/schemas/PracticeGroupCapabilitiesResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1me~1capabilities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PracticeGroupCapabilitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PracticeGroupCapabilitiesResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/getcapabilities"}],"panels":[]}]},"httpPath":"/v1/me/capabilities"},{"label":"List Network Practices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/listnetworkpractices","routeSlug":"/apis/public-api/openapi/practice-group/listnetworkpractices","metadata":{"seo":{"title":"List Network Practices","description":"List practice groups from the same network as the authenticated Practice Group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkPractices","name":"List Network Practices","isWebhook":false,"pointer":"/paths/~1v1~1network/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Network Practices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List practice groups from the same network as the authenticated Practice Group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/network","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/network","href":"practice-group/listnetworkpractices","openApiOperationId":"listNetworkPractices","summary":"List Network Practices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListNetworkPracticeGroupDto"}},"schemaId":"components/schemas/ListNetworkPracticeGroupDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1network/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListNetworkPracticeGroupDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListNetworkPracticeGroupDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/listnetworkpractices"}],"panels":[]}]},"httpPath":"/v1/network"},{"label":"Get Practice Group SMS credit count","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getsmscreditcount","routeSlug":"/apis/public-api/openapi/practice-group/getsmscreditcount","metadata":{"seo":{"title":"Get Practice Group SMS credit count","description":"Retrieves the authenticated Practice Group's SMS credit count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSmsCreditCount","name":"Get Practice Group SMS credit count","isWebhook":false,"pointer":"/paths/~1v1~1me~1sms-credits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Practice Group SMS credit count","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the authenticated Practice Group's SMS credit count."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/me/sms-credits","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/me/sms-credits","href":"practice-group/getsmscreditcount","openApiOperationId":"getSmsCreditCount","summary":"Get Practice Group SMS credit count"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PracticeGroupSmsCountResponse"}},"schemaId":"components/schemas/PracticeGroupSmsCountResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1me~1sms-credits/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PracticeGroupSmsCountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PracticeGroupSmsCountResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/practice-group/getsmscreditcount"}],"panels":[]}]},"httpPath":"/v1/me/sms-credits"}],"content":{"contentType":"group","meta":{"name":"Practice Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Practice Group","showPageActions":true},{"nodeType":"markdoc","content":"Manage practice group settings, access tokens, and configuration. Use the access token endpoint to generate short-lived JWTs for Hero Elements."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/access_token","summary":"Create an Access Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/practice-group/createaccesstoken","deprecated":false},{"title":"/v1/content-templates","summary":"List Content Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practice-group/listcontenttemplates","deprecated":false},{"title":"/v1/me","summary":"Get Practice Group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practice-group/getpracticegroupbyid","deprecated":false},{"title":"/v1/me/capabilities","summary":"Get Practice Group Capabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practice-group/getcapabilities","deprecated":false},{"title":"/v1/network","summary":"List Network Practices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practice-group/listnetworkpractices","deprecated":false},{"title":"/v1/me/sms-credits","summary":"Get Practice Group SMS credit count","prefix":{"name":"get","color":"get"},"badges":[],"link":"/practice-group/getsmscreditcount","deprecated":false}]}]}]}]}},{"type":"group","label":"Patients","link":"/apis/public-api/openapi/patients","routeSlug":"/apis/public-api/openapi/patients","items":[{"label":"Sync Hero patient with EHR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/connectpatientehr","routeSlug":"/apis/public-api/openapi/patients/connectpatientehr","metadata":{"seo":{"title":"Sync Hero patient with EHR","description":"Sync a Hero patient with an EHR patient"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connectPatientEhr","name":"Sync Hero patient with EHR","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}~1ehr~1connect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync Hero patient with EHR","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sync a Hero patient with an EHR patient"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}~1ehr~1connect/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientConnectEhrBody"}},"schemaId":"components/schemas/PatientConnectEhrBody","pointer":"/paths/~1v1~1patients~1{id}~1ehr~1connect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{id}/ehr/connect","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatientConnectEhrBody"}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/patients/{id}/ehr/connect","href":"patients/connectpatientehr","openApiOperationId":"connectPatientEhr","summary":"Sync Hero patient with EHR"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PatientConnectEhrBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientConnectEhrBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}~1ehr~1connect/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/connectpatientehr"}],"panels":[]}]},"httpPath":"/v1/patients/{id}/ehr/connect"},{"label":"Preview Patient Merging","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/previewpatientmerge","routeSlug":"/apis/public-api/openapi/patients/previewpatientmerge","metadata":{"seo":{"title":"Preview Patient Merging","description":"Return a preview of a merge between two patients hand provide a merge token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewPatientMerge","name":"Preview Patient Merging","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}~1merge~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview Patient Merging","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return a preview of a merge between two patients hand provide a merge token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}~1merge~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"}},"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody","pointer":"/paths/~1v1~1patients~1{id}~1merge~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{id}/merge/preview","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients/{id}/merge/preview","href":"patients/previewpatientmerge","openApiOperationId":"previewPatientMerge","summary":"Preview Patient Merging"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientMergePreviewResponse"}},"schemaId":"components/schemas/PatientMergePreviewResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}~1merge~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientMergePreviewResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientMergePreviewResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/previewpatientmerge"}],"panels":[]}]},"httpPath":"/v1/patients/{id}/merge/preview"},{"label":"Merge Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/mergepatient","routeSlug":"/apis/public-api/openapi/patients/mergepatient","metadata":{"seo":{"title":"Merge Patients","description":"Merge one patient with another"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mergePatient","name":"Merge Patients","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merge one patient with another"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientMergeBody"}},"schemaId":"components/schemas/PatientMergeBody","pointer":"/paths/~1v1~1patients~1{id}~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{id}/merge","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatientMergeBody"}},"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/patients/{id}/merge","href":"patients/mergepatient","openApiOperationId":"mergePatient","summary":"Merge Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PatientMergeBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientMergeBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/mergepatient"}],"panels":[]}]},"httpPath":"/v1/patients/{id}/merge"},{"label":"Get a Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/getpatientbyid","routeSlug":"/apis/public-api/openapi/patients/getpatientbyid","metadata":{"seo":{"title":"Get a Patient","description":"Retrieve patient information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPatientById","name":"Get a Patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve patient information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/patients/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients/{id}","href":"patients/getpatientbyid","openApiOperationId":"getPatientById","summary":"Get a Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientDto"}},"schemaId":"components/schemas/PatientDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/getpatientbyid"}],"panels":[]}]},"httpPath":"/v1/patients/{id}"},{"label":"List Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatients","routeSlug":"/apis/public-api/openapi/patients/listpatients","metadata":{"seo":{"title":"List Patients","description":"Retrieve a list of patients for the practice group. Filter by EMIS ID, NHS number, or date of birth using the field and search query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPatients","name":"List Patients","isWebhook":false,"pointer":"/paths/~1v1~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of patients for the practice group. Filter by EMIS ID, NHS number, or date of birth using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"field","in":"query","schemaId":"schema_69"},{"name":"search","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/patients","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"field","in":"query","required":false,"schemaId":"schema_69"},{"name":"search","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients","href":"patients/listpatients","openApiOperationId":"listPatients","summary":"List Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListResponse"}},"schemaId":"components/schemas/PatientListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/listpatients"}],"panels":[]}]},"httpPath":"/v1/patients"},{"label":"Register a Patient using PDS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/registerpatientpds","routeSlug":"/apis/public-api/openapi/patients/registerpatientpds","metadata":{"seo":{"title":"Register a Patient using PDS","description":"Register a patient by tracing them against the NHS Spine via PDS (Personal Demographics Service). Provide an NHS number and date of birth, or alternatively a combination of forename, surname, DOB, and postcode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerPatientPds","name":"Register a Patient using PDS","isWebhook":false,"pointer":"/paths/~1v1~1patients~1register_pds/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a Patient using PDS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a patient by tracing them against the NHS Spine via PDS (Personal Demographics Service). Provide an NHS number and date of birth, or alternatively a combination of forename, surname, DOB, and postcode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the patient already exists in Hero for this practice group, their existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned. If not found, Hero will create a new patient record using the demographics retrieved from PDS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common use case:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Call this endpoint before sending a message or creating a booking to obtain the Hero "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientRegisterPdsBodyObject"}},"schemaId":"components/schemas/PatientRegisterPdsBodyObject","pointer":"/paths/~1v1~1patients~1register_pds/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/register_pds","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatientRegisterPdsBodyObject"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients/register_pds","href":"patients/registerpatientpds","openApiOperationId":"registerPatientPds","summary":"Register a Patient using PDS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PatientRegisterPdsBodyObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientRegisterPdsBodyObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientRegisterPdsResponse"}},"schemaId":"components/schemas/PatientRegisterPdsResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"No patient found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1register_pds/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientRegisterPdsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientRegisterPdsResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/registerpatientpds"}],"panels":[]}]},"httpPath":"/v1/patients/register_pds"},{"label":"Register a Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/registerpatient","routeSlug":"/apis/public-api/openapi/patients/registerpatient","metadata":{"seo":{"title":"Register a Patient","description":"Create or update a patient based on the data sent. If a patient with matching NHS number and DOB exists for the practice group, it will be updated. Otherwise, a new patient record is created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerPatient","name":"Register a Patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or update a patient based on the data sent. If a patient with matching NHS number and DOB exists for the practice group, it will be updated. Otherwise, a new patient record is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike Register Patient via PDS, this endpoint does not perform a Spine lookup — you provide the full patient demographics directly. Use this when you already hold the patient's details and do not need PDS tracing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientRegisterBody"}},"schemaId":"components/schemas/PatientRegisterBody","pointer":"/paths/~1v1~1patients~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/register","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatientRegisterBody"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/patients/register","href":"patients/registerpatient","openApiOperationId":"registerPatient","summary":"Register a Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PatientRegisterBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatientRegisterBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"}},"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1register/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClinicalDocumentAssignPatientBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClinicalDocumentAssignPatientBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/registerpatient"}],"panels":[]}]},"httpPath":"/v1/patients/register"},{"label":"Get Patient Billing Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/patientbillinginfo","routeSlug":"/apis/public-api/openapi/patients/patientbillinginfo","metadata":{"seo":{"title":"Get Patient Billing Info","description":"Retrieves billing information for the patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patientBillingInfo","name":"Get Patient Billing Info","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}~1billing_info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient Billing Info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves billing information for the patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}~1billing_info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/patients/{id}/billing_info","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients/{id}/billing_info","href":"patients/patientbillinginfo","openApiOperationId":"patientBillingInfo","summary":"Get Patient Billing Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingDetailsFromDb"}},"schemaId":"components/schemas/BillingDetailsFromDb"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}~1billing_info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingDetailsFromDb","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingDetailsFromDb"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/patientbillinginfo"}],"panels":[]}]},"httpPath":"/v1/patients/{id}/billing_info"},{"label":"List Patient Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientpaymentmethods","routeSlug":"/apis/public-api/openapi/patients/listpatientpaymentmethods","metadata":{"seo":{"title":"List Patient Payment Methods","description":"Retrieves payment methods for default stripe customer of patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPatientPaymentMethods","name":"List Patient Payment Methods","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{id}~1payment_methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Patient Payment Methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves payment methods for default stripe customer of patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1patients~1{id}~1payment_methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/patients/{id}/payment_methods","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/patients/{id}/payment_methods","href":"patients/listpatientpaymentmethods","openApiOperationId":"listPatientPaymentMethods","summary":"List Patient Payment Methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientPaymentMethodsResponse"}},"schemaId":"components/schemas/PatientPaymentMethodsResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1patients~1{id}~1payment_methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientPaymentMethodsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientPaymentMethodsResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/listpatientpaymentmethods"}],"panels":[]}]},"httpPath":"/v1/patients/{id}/payment_methods"},{"label":"Get a Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/getpatientbyidv2","routeSlug":"/apis/public-api/openapi/patients/getpatientbyidv2","metadata":{"seo":{"title":"Get a Patient","description":"Retrieve patient information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPatientByIdV2","name":"Get a Patient","isWebhook":false,"pointer":"/paths/~1v2~1patients~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve patient information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1patients~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/patients/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/patients/{id}","href":"patients/getpatientbyidv2","openApiOperationId":"getPatientByIdV2","summary":"Get a Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientDtoV2"}},"schemaId":"components/schemas/PatientDtoV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1patients~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientDtoV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientDtoV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/getpatientbyidv2"}],"panels":[]}]},"httpPath":"/v2/patients/{id}"},{"label":"List Patients (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientsv2","routeSlug":"/apis/public-api/openapi/patients/listpatientsv2","metadata":{"seo":{"title":"List Patients (v2)","description":"Retrieves a list of all patients, from either the EHR or HERO. The verified_email and verified_phone fields search against verified portal credentials (Hero DB only)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPatientsV2","name":"List Patients (v2)","isWebhook":false,"pointer":"/paths/~1v2~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Patients (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of all patients, from either the EHR or HERO. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified_phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields search against verified portal credentials (Hero DB only)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"field","in":"query","schemaId":"schema_70"},{"name":"search","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v2~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/patients","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"field","in":"query","required":false,"schemaId":"schema_70"},{"name":"search","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/patients","href":"patients/listpatientsv2","openApiOperationId":"listPatientsV2","summary":"List Patients (v2)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListEhrCandidatesResponse"}},"schemaId":"components/schemas/PatientListEhrCandidatesResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientListEhrCandidatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListEhrCandidatesResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/listpatientsv2"}],"panels":[]}]},"httpPath":"/v2/patients"},{"label":"List Patients (v3)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientsv3","routeSlug":"/apis/public-api/openapi/patients/listpatientsv3","metadata":{"seo":{"title":"List Patients (v3)","description":"Retrieve a list of patients for the practice group using explicit patient filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPatientsV3","name":"List Patients (v3)","isWebhook":false,"pointer":"/paths/~1v3~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Patients (v3)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of patients for the practice group using explicit patient filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is intended for structured patient search flows where partners can provide named filters such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nhs_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ehr_partner_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compared with the v2 patients endpoint, v3 supports multi-field search in a single request instead of the older "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one filter must be supplied."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52","description":"Zero-based page index for paginated results."},{"name":"page_size","in":"query","schemaId":"schema_52","description":"Number of results to return per page."},{"name":"first_name","in":"query","schemaId":"schema_52","description":"Filter by patient first name."},{"name":"last_name","in":"query","schemaId":"schema_52","description":"Filter by patient last name."},{"name":"dob","in":"query","schemaId":"schema_71","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by exact date of birth in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},{"name":"nhs_number","in":"query","schemaId":"schema_52","description":"Filter by NHS number."},{"name":"ehr_partner_id","in":"query","schemaId":"schema_52","description":"Filter by the patient identifier used by the connected EHR."}],"pointer":"/paths/~1v3~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/patients","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"first_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"last_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"dob","in":"query","required":false,"example":"1990-12-31","schemaId":"schema_71"},{"name":"nhs_number","in":"query","required":false,"schemaId":"schema_52"},{"name":"ehr_partner_id","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v3/patients","href":"patients/listpatientsv3","openApiOperationId":"listPatientsV3","summary":"List Patients (v3)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListEhrCandidatesResponse"}},"schemaId":"components/schemas/PatientListEhrCandidatesResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Unprocessable entity"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v3~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientListEhrCandidatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientListEhrCandidatesResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/listpatientsv3"}],"panels":[]}]},"httpPath":"/v3/patients"}],"content":{"contentType":"group","meta":{"name":"Patients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patients","showPageActions":true},{"nodeType":"markdoc","content":"Register, search, and manage patient records. Supports PDS (Personal Demographics Service) lookups to trace patients against the NHS Spine."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/patients/{id}/ehr/connect","summary":"Sync Hero patient with EHR","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patients/connectpatientehr","deprecated":false},{"title":"/v1/patients/{id}/merge/preview","summary":"Preview Patient Merging","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patients/previewpatientmerge","deprecated":false},{"title":"/v1/patients/{id}/merge","summary":"Merge Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patients/mergepatient","deprecated":false},{"title":"/v1/patients/{id}","summary":"Get a Patient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/getpatientbyid","deprecated":false},{"title":"/v1/patients","summary":"List Patients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/listpatients","deprecated":false},{"title":"/v1/patients/register_pds","summary":"Register a Patient using PDS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patients/registerpatientpds","deprecated":false},{"title":"/v1/patients/register","summary":"Register a Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/patients/registerpatient","deprecated":false},{"title":"/v1/patients/{id}/billing_info","summary":"Get Patient Billing Info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/patientbillinginfo","deprecated":false},{"title":"/v1/patients/{id}/payment_methods","summary":"List Patient Payment Methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/listpatientpaymentmethods","deprecated":false},{"title":"/v2/patients/{id}","summary":"Get a Patient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/getpatientbyidv2","deprecated":false},{"title":"/v2/patients","summary":"List Patients (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/listpatientsv2","deprecated":false},{"title":"/v3/patients","summary":"List Patients (v3)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/listpatientsv3","deprecated":false}]}]}]}]}},{"type":"separator","label":"Triage","content":null},{"type":"group","label":"Episode","link":"/apis/public-api/openapi/episode","routeSlug":"/apis/public-api/openapi/episode","items":[{"label":"Count Episodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/countepisodes","routeSlug":"/apis/public-api/openapi/episode/countepisodes","metadata":{"seo":{"title":"Count Episodes","description":"Retrieves a count of all episodes for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countEpisodes","name":"Count Episodes","isWebhook":false,"pointer":"/paths/~1v1~1episodes~1count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count Episodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a count of all episodes for a practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_id[]","in":"query","schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","schemaId":"schema_72"},{"name":"status[]","in":"query","schemaId":"schema_73"},{"name":"priority[]","in":"query","schemaId":"schema_74"}],"pointer":"/paths/~1v1~1episodes~1count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/episodes/count","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"assignee_id[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","required":false,"schemaId":"schema_72"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_73"},{"name":"priority[]","in":"query","required":false,"schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/episodes/count","href":"episode/countepisodes","openApiOperationId":"countEpisodes","summary":"Count Episodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponse"}},"schemaId":"components/schemas/EpisodeCountResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1episodes~1count/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeCountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/countepisodes"}],"panels":[]}]},"httpPath":"/v1/episodes/count"},{"label":"List Episodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/listepisodes","routeSlug":"/apis/public-api/openapi/episode/listepisodes","metadata":{"seo":{"title":"List Episodes","description":"Retrieves a list of all episodes for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEpisodes","name":"List Episodes","isWebhook":false,"pointer":"/paths/~1v1~1episodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Episodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all episodes for a practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","schemaId":"schema_72"},{"name":"status[]","in":"query","schemaId":"schema_73"},{"name":"priority[]","in":"query","schemaId":"schema_74"},{"name":"order_by[]","in":"query","schemaId":"schema_76"},{"name":"order_descending[]","in":"query","schemaId":"schema_53"}],"pointer":"/paths/~1v1~1episodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/episodes","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","required":false,"schemaId":"schema_72"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_73"},{"name":"priority[]","in":"query","required":false,"schemaId":"schema_74"},{"name":"order_by[]","in":"query","required":false,"schemaId":"schema_76"},{"name":"order_descending[]","in":"query","required":false,"schemaId":"schema_53"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/episodes","href":"episode/listepisodes","openApiOperationId":"listEpisodes","summary":"List Episodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeListResponse"}},"schemaId":"components/schemas/EpisodeListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1episodes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/listepisodes"}],"panels":[]}]},"httpPath":"/v1/episodes"},{"label":"Get Episode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/getepisode","routeSlug":"/apis/public-api/openapi/episode/getepisode","metadata":{"seo":{"title":"Get Episode","description":"Retrieve episode information for the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEpisode","name":"Get Episode","isWebhook":false,"pointer":"/paths/~1v1~1episodes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Episode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve episode information for the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1episodes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/episodes/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/episodes/{id}","href":"episode/getepisode","openApiOperationId":"getEpisode","summary":"Get Episode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeDto"}},"schemaId":"components/schemas/EpisodeDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1episodes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/getepisode"}],"panels":[]}]},"httpPath":"/v1/episodes/{id}"},{"label":"Update an episode","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/updateepisode","routeSlug":"/apis/public-api/openapi/episode/updateepisode","metadata":{"seo":{"title":"Update an episode","description":"Updates an episode using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEpisode","name":"Update an episode","isWebhook":false,"pointer":"/paths/~1v1~1episodes~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an episode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an episode using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1episodes~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EpisodeUpdateBody"}},"schemaId":"components/schemas/EpisodeUpdateBody","pointer":"/paths/~1v1~1episodes~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/episodes/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EpisodeUpdateBody"}},"responseCodes":["200","403","429","500"],"pointer":"/v1/episodes/{id}","href":"episode/updateepisode","openApiOperationId":"updateEpisode","summary":"Update an episode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/EpisodeUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EpisodeUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyGetParam"}},"schemaId":"components/schemas/ApiKeyGetParam"},{"code":"403","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1episodes~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiKeyGetParam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyGetParam"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/updateepisode"}],"panels":[]}]},"httpPath":"/v1/episodes/{id}"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/createepisodenote","routeSlug":"/apis/public-api/openapi/episode/createepisodenote","metadata":{"seo":{"title":"Create a note","description":"Create a note for an episode in inbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEpisodeNote","name":"Create a note","isWebhook":false,"pointer":"/paths/~1v1~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a note for an episode in inbox."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteCreateBody"}},"schemaId":"components/schemas/NoteCreateBody","pointer":"/paths/~1v1~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/notes","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NoteCreateBody"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/notes","href":"episode/createepisodenote","openApiOperationId":"createEpisodeNote","summary":"Create a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/NoteCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NoteCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Note created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteDto"}},"schemaId":"components/schemas/NoteDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NoteDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoteDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/createepisodenote"}],"panels":[]}]},"httpPath":"/v1/notes"},{"label":"Count Episodes (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/countepisodesv2","routeSlug":"/apis/public-api/openapi/episode/countepisodesv2","metadata":{"seo":{"title":"Count Episodes (v2)","description":"Counts the episodes for a practice group, with the same filters as the list, without loading any of them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countEpisodesV2","name":"Count Episodes (v2)","isWebhook":false,"pointer":"/paths/~1v2~1episodes~1count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count Episodes (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Counts the episodes for a practice group, with the same filters as the list, without loading any of them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_id[]","in":"query","schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","schemaId":"schema_72"},{"name":"status[]","in":"query","schemaId":"schema_73"},{"name":"priority[]","in":"query","schemaId":"schema_74"},{"name":"count_limit","in":"query","schemaId":"schema_77","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stop counting past this many episodes. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is then at most "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true when more episodes match. Without it, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exact and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false. Useful for performance when you only display a badge, e.g. 99+."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1episodes~1count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/episodes/count","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"assignee_id[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","required":false,"schemaId":"schema_72"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_73"},{"name":"priority[]","in":"query","required":false,"schemaId":"schema_74"},{"name":"count_limit","in":"query","required":false,"schemaId":"schema_77"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v2/episodes/count","href":"episode/countepisodesv2","openApiOperationId":"countEpisodesV2","summary":"Count Episodes (v2)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponseV2"}},"schemaId":"components/schemas/EpisodeCountResponseV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1episodes~1count/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeCountResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeCountResponseV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/countepisodesv2"}],"panels":[]}]},"httpPath":"/v2/episodes/count"},{"label":"List Episodes (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/listepisodesv2","routeSlug":"/apis/public-api/openapi/episode/listepisodesv2","metadata":{"seo":{"title":"List Episodes (v2)","description":"Retrieves a list of all episodes for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEpisodesV2","name":"List Episodes (v2)","isWebhook":false,"pointer":"/paths/~1v2~1episodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Episodes (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all episodes for a practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","schemaId":"schema_72"},{"name":"status[]","in":"query","schemaId":"schema_73"},{"name":"priority[]","in":"query","schemaId":"schema_74"},{"name":"order_by[]","in":"query","schemaId":"schema_76"},{"name":"order_descending[]","in":"query","schemaId":"schema_53"}],"pointer":"/paths/~1v2~1episodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/episodes","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","required":false,"schemaId":"schema_72"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_73"},{"name":"priority[]","in":"query","required":false,"schemaId":"schema_74"},{"name":"order_by[]","in":"query","required":false,"schemaId":"schema_76"},{"name":"order_descending[]","in":"query","required":false,"schemaId":"schema_53"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/episodes","href":"episode/listepisodesv2","openApiOperationId":"listEpisodesV2","summary":"List Episodes (v2)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeListResponseV2"}},"schemaId":"components/schemas/EpisodeListResponseV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1episodes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeListResponseV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/listepisodesv2"}],"panels":[]}]},"httpPath":"/v2/episodes"},{"label":"Get Episode (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/getepisodev2","routeSlug":"/apis/public-api/openapi/episode/getepisodev2","metadata":{"seo":{"title":"Get Episode (v2)","description":"Retrieves the episode payload using the multi-task view for the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEpisodeV2","name":"Get Episode (v2)","isWebhook":false,"pointer":"/paths/~1v2~1episodes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Episode (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the episode payload using the multi-task view for the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1episodes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/episodes/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/episodes/{id}","href":"episode/getepisodev2","openApiOperationId":"getEpisodeV2","summary":"Get Episode (v2)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeDtoV2"}},"schemaId":"components/schemas/EpisodeDtoV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1episodes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EpisodeDtoV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EpisodeDtoV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/episode/getepisodev2"}],"panels":[]}]},"httpPath":"/v2/episodes/{id}"}],"content":{"contentType":"group","meta":{"name":"Episode"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Episode","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage clinical episodes — containers for related patient interactions and messages."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/episodes/count","summary":"Count Episodes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/countepisodes","deprecated":false},{"title":"/v1/episodes","summary":"List Episodes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/listepisodes","deprecated":false},{"title":"/v1/episodes/{id}","summary":"Get Episode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/getepisode","deprecated":false},{"title":"/v1/episodes/{id}","summary":"Update an episode","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/episode/updateepisode","deprecated":false},{"title":"/v1/notes","summary":"Create a note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/episode/createepisodenote","deprecated":false},{"title":"/v2/episodes/count","summary":"Count Episodes (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/countepisodesv2","deprecated":false},{"title":"/v2/episodes","summary":"List Episodes (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/listepisodesv2","deprecated":false},{"title":"/v2/episodes/{id}","summary":"Get Episode (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/episode/getepisodev2","deprecated":false}]}]}]}]}},{"type":"group","label":"Care Navigation","link":"/apis/public-api/openapi/care-navigation","routeSlug":"/apis/public-api/openapi/care-navigation","items":[{"label":"List Pathways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listpathways","routeSlug":"/apis/public-api/openapi/care-navigation/listpathways","metadata":{"seo":{"title":"List Pathways","description":"Retrieves a list of pathways for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPathways","name":"List Pathways","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1pathways/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pathways","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of pathways for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"has_forms","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v1~1care-nav~1pathways/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/pathways","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"has_forms","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/pathways","href":"care-navigation/listpathways","openApiOperationId":"listPathways","summary":"List Pathways"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayList"}},"schemaId":"components/schemas/PathwayList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1pathways/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PathwayList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/listpathways"}],"panels":[]}]},"httpPath":"/v1/care-nav/pathways"},{"label":"Create Pathway","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createpathway","routeSlug":"/apis/public-api/openapi/care-navigation/createpathway","metadata":{"seo":{"title":"Create Pathway","description":"Creates a pathway and its initial submission types for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPathway","name":"Create Pathway","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1pathways/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pathway","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a pathway and its initial submission types for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PathwayCreateBody"}},"schemaId":"components/schemas/PathwayCreateBody","pointer":"/paths/~1v1~1care-nav~1pathways/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/care-nav/pathways","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PathwayCreateBody"}},"responseCodes":["201","400","401","422","429","500"],"pointer":"/v1/care-nav/pathways","href":"care-navigation/createpathway","openApiOperationId":"createPathway","summary":"Create Pathway"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PathwayCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PathwayCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}},"schemaId":"components/schemas/PathwayDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1pathways/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PathwayDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/createpathway"}],"panels":[]}]},"httpPath":"/v1/care-nav/pathways"},{"label":"Get Pathway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getpathway","routeSlug":"/apis/public-api/openapi/care-navigation/getpathway","metadata":{"seo":{"title":"Get Pathway","description":"Retrieves a pathway."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPathway","name":"Get Pathway","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pathway","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a pathway."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/pathways/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/pathways/{id}","href":"care-navigation/getpathway","openApiOperationId":"getPathway","summary":"Get Pathway"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}},"schemaId":"components/schemas/PathwayDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PathwayDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/getpathway"}],"panels":[]}]},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Update Pathway","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatepathway","routeSlug":"/apis/public-api/openapi/care-navigation/updatepathway","metadata":{"seo":{"title":"Update Pathway","description":"Updates a pathway for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePathway","name":"Update Pathway","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pathway","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a pathway for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PathwayUpdateBody"}},"schemaId":"components/schemas/PathwayUpdateBody","pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/care-nav/pathways/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PathwayUpdateBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v1/care-nav/pathways/{id}","href":"care-navigation/updatepathway","openApiOperationId":"updatePathway","summary":"Update Pathway"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/PathwayUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PathwayUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}},"schemaId":"components/schemas/PathwayDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PathwayDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PathwayDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/updatepathway"}],"panels":[]}]},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Delete Pathway","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/deletepathway","routeSlug":"/apis/public-api/openapi/care-navigation/deletepathway","metadata":{"seo":{"title":"Delete Pathway","description":"Soft deletes a pathway for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePathway","name":"Delete Pathway","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Pathway","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Soft deletes a pathway for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/care-nav/pathways/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/care-nav/pathways/{id}","href":"care-navigation/deletepathway","openApiOperationId":"deletePathway","summary":"Delete Pathway"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1pathways~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/deletepathway"}],"panels":[]}]},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Get Care Navigation Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getcarenavigationsettings","routeSlug":"/apis/public-api/openapi/care-navigation/getcarenavigationsettings","metadata":{"seo":{"title":"Get Care Navigation Settings","description":"Retrieves the care navigation settings for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCareNavigationSettings","name":"Get Care Navigation Settings","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Care Navigation Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the care navigation settings for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/settings","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","429","500"],"pointer":"/v1/care-nav/settings","href":"care-navigation/getcarenavigationsettings","openApiOperationId":"getCareNavigationSettings","summary":"Get Care Navigation Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSettingsDto"}},"schemaId":"components/schemas/CareNavSettingsDto"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavSettingsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSettingsDto"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/getcarenavigationsettings"}],"panels":[]}]},"httpPath":"/v1/care-nav/settings"},{"label":"Update Care Navigation Settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatecarenavigationsettings","routeSlug":"/apis/public-api/openapi/care-navigation/updatecarenavigationsettings","metadata":{"seo":{"title":"Update Care Navigation Settings","description":"Updates the care navigation settings for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCareNavigationSettings","name":"Update Care Navigation Settings","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Care Navigation Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the care navigation settings for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavSettingsUpdateBody"}},"schemaId":"components/schemas/CareNavSettingsUpdateBody","pointer":"/paths/~1v1~1care-nav~1settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/care-nav/settings","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CareNavSettingsUpdateBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v1/care-nav/settings","href":"care-navigation/updatecarenavigationsettings","openApiOperationId":"updateCareNavigationSettings","summary":"Update Care Navigation Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CareNavSettingsUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavSettingsUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSettingsDto"}},"schemaId":"components/schemas/CareNavSettingsDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1settings/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavSettingsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSettingsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/updatecarenavigationsettings"}],"panels":[]}]},"httpPath":"/v1/care-nav/settings"},{"label":"List Care Navigation Opening Hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listcarenavigationopeninghours","routeSlug":"/apis/public-api/openapi/care-navigation/listcarenavigationopeninghours","metadata":{"seo":{"title":"List Care Navigation Opening Hours","description":"Lists care navigation opening hours for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCareNavigationOpeningHours","name":"List Care Navigation Opening Hours","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1opening-hours/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Care Navigation Opening Hours","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists care navigation opening hours for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/opening-hours","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","429","500"],"pointer":"/v1/care-nav/opening-hours","href":"care-navigation/listcarenavigationopeninghours","openApiOperationId":"listCareNavigationOpeningHours","summary":"List Care Navigation Opening Hours"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourListResponse"}},"schemaId":"components/schemas/CareNavOpeningHourListResponse"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1opening-hours/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavOpeningHourListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourListResponse"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/listcarenavigationopeninghours"}],"panels":[]}]},"httpPath":"/v1/care-nav/opening-hours"},{"label":"Create Care Navigation Opening Hour","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createcarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/createcarenavigationopeninghour","metadata":{"seo":{"title":"Create Care Navigation Opening Hour","description":"Creates a care navigation opening hour for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCareNavigationOpeningHour","name":"Create Care Navigation Opening Hour","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1opening-hours/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Care Navigation Opening Hour","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a care navigation opening hour for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourCreateBody"}},"schemaId":"components/schemas/CareNavOpeningHourCreateBody","pointer":"/paths/~1v1~1care-nav~1opening-hours/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/care-nav/opening-hours","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourCreateBody"}},"responseCodes":["201","400","401","404","422","429","500"],"pointer":"/v1/care-nav/opening-hours","href":"care-navigation/createcarenavigationopeninghour","openApiOperationId":"createCareNavigationOpeningHour","summary":"Create Care Navigation Opening Hour"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CareNavOpeningHourCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourDto"}},"schemaId":"components/schemas/CareNavOpeningHourDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1opening-hours/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CareNavOpeningHourDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/createcarenavigationopeninghour"}],"panels":[]}]},"httpPath":"/v1/care-nav/opening-hours"},{"label":"Update Care Navigation Opening Hour","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatecarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/updatecarenavigationopeninghour","metadata":{"seo":{"title":"Update Care Navigation Opening Hour","description":"Updates a single care navigation opening hour for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCareNavigationOpeningHour","name":"Update Care Navigation Opening Hour","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Care Navigation Opening Hour","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a single care navigation opening hour for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourUpdateBody"}},"schemaId":"components/schemas/CareNavOpeningHourUpdateBody","pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/care-nav/opening-hours/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourUpdateBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v1/care-nav/opening-hours/{id}","href":"care-navigation/updatecarenavigationopeninghour","openApiOperationId":"updateCareNavigationOpeningHour","summary":"Update Care Navigation Opening Hour"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CareNavOpeningHourUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourDto"}},"schemaId":"components/schemas/CareNavOpeningHourDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavOpeningHourDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavOpeningHourDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/updatecarenavigationopeninghour"}],"panels":[]}]},"httpPath":"/v1/care-nav/opening-hours/{id}"},{"label":"Delete Care Navigation Opening Hour","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/deletecarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/deletecarenavigationopeninghour","metadata":{"seo":{"title":"Delete Care Navigation Opening Hour","description":"Deletes a single care navigation opening hour for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCareNavigationOpeningHour","name":"Delete Care Navigation Opening Hour","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Care Navigation Opening Hour","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a single care navigation opening hour for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/care-nav/opening-hours/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/care-nav/opening-hours/{id}","href":"care-navigation/deletecarenavigationopeninghour","openApiOperationId":"deleteCareNavigationOpeningHour","summary":"Delete Care Navigation Opening Hour"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1opening-hours~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/deletecarenavigationopeninghour"}],"panels":[]}]},"httpPath":"/v1/care-nav/opening-hours/{id}"},{"label":"Get Care Navigation Submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getcarenavsubmission","routeSlug":"/apis/public-api/openapi/care-navigation/getcarenavsubmission","metadata":{"seo":{"title":"Get Care Navigation Submission","description":"Get a care navigation submission and its fields. An acting admin without the required policies still receives the submission, with the attachment link and file name removed from any attachment answer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCareNavSubmission","name":"Get Care Navigation Submission","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submissions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Care Navigation Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a care navigation submission and its fields. An acting admin without the required policies still receives the submission, with the attachment link and file name removed from any attachment answer.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1submissions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/submissions/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/submissions/{id}","href":"care-navigation/getcarenavsubmission","openApiOperationId":"getCareNavSubmission","summary":"Get Care Navigation Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionGetDto"}},"schemaId":"components/schemas/CareNavSubmissionGetDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submissions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavSubmissionGetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionGetDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/getcarenavsubmission"}],"panels":[]}]},"httpPath":"/v1/care-nav/submissions/{id}"},{"label":"List Care Navigation Submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listcarenavsubmissions","routeSlug":"/apis/public-api/openapi/care-navigation/listcarenavsubmissions","metadata":{"seo":{"title":"List Care Navigation Submissions","description":"Retrieves a list of all care navigation submissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCareNavSubmissions","name":"List Care Navigation Submissions","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Care Navigation Submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all care navigation submissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_78"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"patient_id","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1care-nav~1submissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/submissions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_78"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"patient_id","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/submissions","href":"care-navigation/listcarenavsubmissions","openApiOperationId":"listCareNavSubmissions","summary":"List Care Navigation Submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionListResponse"}},"schemaId":"components/schemas/CareNavSubmissionListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submissions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavSubmissionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/listcarenavsubmissions"}],"panels":[]}]},"httpPath":"/v1/care-nav/submissions"},{"label":"Create Care Nav Submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createsubmission","routeSlug":"/apis/public-api/openapi/care-navigation/createsubmission","metadata":{"seo":{"title":"Create Care Nav Submission","description":"Create a Care Nav Submission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubmission","name":"Create Care Nav Submission","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Care Nav Submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Care Nav Submission."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionCreateBody"}},"schemaId":"components/schemas/CareNavSubmissionCreateBody","pointer":"/paths/~1v1~1care-nav~1submission/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/care-nav/submission","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionCreateBody"}},"responseCodes":["200","403","429","500"],"pointer":"/v1/care-nav/submission","href":"care-navigation/createsubmission","openApiOperationId":"createSubmission","summary":"Create Care Nav Submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CareNavSubmissionCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionCreateResult"}},"schemaId":"components/schemas/CareNavSubmissionCreateResult"},{"code":"403","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CareNavSubmissionCreateResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CareNavSubmissionCreateResult"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/createsubmission"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission"},{"label":"List Submission Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/listsubmissiontype","metadata":{"seo":{"title":"List Submission Types","description":"Retrieves a list of submission types for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubmissionType","name":"List Submission Types","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Submission Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of submission types for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pathway_id","in":"query","schemaId":"schema_52"},{"name":"type","in":"query","schemaId":"components/schemas/SubmissionTypeEnum"}],"pointer":"/paths/~1v1~1care-nav~1submission-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/submission-types","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"pathway_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"type","in":"query","required":false,"schemaId":"components/schemas/SubmissionTypeEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/submission-types","href":"care-navigation/listsubmissiontype","openApiOperationId":"listSubmissionType","summary":"List Submission Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeList"}},"schemaId":"components/schemas/SubmissionTypeList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmissionTypeList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/listsubmissiontype"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission-types"},{"label":"Create Submission Type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/createsubmissiontype","metadata":{"seo":{"title":"Create Submission Type","description":"Creates a submission type for an existing pathway in the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubmissionType","name":"Create Submission Type","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Submission Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a submission type for an existing pathway in the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmissionTypeCreateBody"}},"schemaId":"components/schemas/SubmissionTypeCreateBody","pointer":"/paths/~1v1~1care-nav~1submission-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/care-nav/submission-types","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmissionTypeCreateBody"}},"responseCodes":["201","400","401","422","429","500"],"pointer":"/v1/care-nav/submission-types","href":"care-navigation/createsubmissiontype","openApiOperationId":"createSubmissionType","summary":"Create Submission Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/SubmissionTypeCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmissionTypeCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}},"schemaId":"components/schemas/SubmissionTypeDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubmissionTypeDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/createsubmissiontype"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission-types"},{"label":"Get Submission Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/getsubmissiontype","metadata":{"seo":{"title":"Get Submission Type","description":"Retrieves a submission type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubmissionType","name":"Get Submission Type","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Submission Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a submission type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/care-nav/submission-types/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/care-nav/submission-types/{id}","href":"care-navigation/getsubmissiontype","openApiOperationId":"getSubmissionType","summary":"Get Submission Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}},"schemaId":"components/schemas/SubmissionTypeDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmissionTypeDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/getsubmissiontype"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission-types/{id}"},{"label":"Update Submission Type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatesubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/updatesubmissiontype","metadata":{"seo":{"title":"Update Submission Type","description":"Updates a submission type for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubmissionType","name":"Update Submission Type","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Submission Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a submission type for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmissionTypeUpdateBody"}},"schemaId":"components/schemas/SubmissionTypeUpdateBody","pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/care-nav/submission-types/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubmissionTypeUpdateBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v1/care-nav/submission-types/{id}","href":"care-navigation/updatesubmissiontype","openApiOperationId":"updateSubmissionType","summary":"Update Submission Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/SubmissionTypeUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubmissionTypeUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}},"schemaId":"components/schemas/SubmissionTypeDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubmissionTypeDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmissionTypeDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/updatesubmissiontype"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission-types/{id}"},{"label":"Archive Submission Type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/archivesubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/archivesubmissiontype","metadata":{"seo":{"title":"Archive Submission Type","description":"Archives a submission type for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveSubmissionType","name":"Archive Submission Type","isWebhook":false,"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Submission Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archives a submission type for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/care-nav/submission-types/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","422","429","500"],"pointer":"/v1/care-nav/submission-types/{id}","href":"care-navigation/archivesubmissiontype","openApiOperationId":"archiveSubmissionType","summary":"Archive Submission Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"422","description":"Business rule violation"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1care-nav~1submission-types~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/care-navigation/archivesubmissiontype"}],"panels":[]}]},"httpPath":"/v1/care-nav/submission-types/{id}"}],"content":{"contentType":"group","meta":{"name":"Care Navigation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Care Navigation","showPageActions":true},{"nodeType":"markdoc","content":"Manage care navigation pathways and patient submissions for triage workflows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/care-nav/pathways","summary":"List Pathways","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/listpathways","deprecated":false},{"title":"/v1/care-nav/pathways","summary":"Create Pathway","prefix":{"name":"post","color":"post"},"badges":[],"link":"/care-navigation/createpathway","deprecated":false},{"title":"/v1/care-nav/pathways/{id}","summary":"Get Pathway","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/getpathway","deprecated":false},{"title":"/v1/care-nav/pathways/{id}","summary":"Update Pathway","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/care-navigation/updatepathway","deprecated":false},{"title":"/v1/care-nav/pathways/{id}","summary":"Delete Pathway","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/care-navigation/deletepathway","deprecated":false},{"title":"/v1/care-nav/settings","summary":"Get Care Navigation Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/getcarenavigationsettings","deprecated":false},{"title":"/v1/care-nav/settings","summary":"Update Care Navigation Settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/care-navigation/updatecarenavigationsettings","deprecated":false},{"title":"/v1/care-nav/opening-hours","summary":"List Care Navigation Opening Hours","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/listcarenavigationopeninghours","deprecated":false},{"title":"/v1/care-nav/opening-hours","summary":"Create Care Navigation Opening Hour","prefix":{"name":"post","color":"post"},"badges":[],"link":"/care-navigation/createcarenavigationopeninghour","deprecated":false},{"title":"/v1/care-nav/opening-hours/{id}","summary":"Update Care Navigation Opening Hour","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/care-navigation/updatecarenavigationopeninghour","deprecated":false},{"title":"/v1/care-nav/opening-hours/{id}","summary":"Delete Care Navigation Opening Hour","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/care-navigation/deletecarenavigationopeninghour","deprecated":false},{"title":"/v1/care-nav/submissions/{id}","summary":"Get Care Navigation Submission","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/getcarenavsubmission","deprecated":false},{"title":"/v1/care-nav/submissions","summary":"List Care Navigation Submissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/listcarenavsubmissions","deprecated":false},{"title":"/v1/care-nav/submission","summary":"Create Care Nav Submission","prefix":{"name":"post","color":"post"},"badges":[],"link":"/care-navigation/createsubmission","deprecated":false},{"title":"/v1/care-nav/submission-types","summary":"List Submission Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/listsubmissiontype","deprecated":false},{"title":"/v1/care-nav/submission-types","summary":"Create Submission Type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/care-navigation/createsubmissiontype","deprecated":false},{"title":"/v1/care-nav/submission-types/{id}","summary":"Get Submission Type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/care-navigation/getsubmissiontype","deprecated":false},{"title":"/v1/care-nav/submission-types/{id}","summary":"Update Submission Type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/care-navigation/updatesubmissiontype","deprecated":false},{"title":"/v1/care-nav/submission-types/{id}","summary":"Archive Submission Type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/care-navigation/archivesubmissiontype","deprecated":false}]}]}]}]}},{"type":"group","label":"WriteToRecord","link":"/apis/public-api/openapi/writetorecord","routeSlug":"/apis/public-api/openapi/writetorecord","items":[{"label":"Get Write to Record status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/writetorecord/getwritetorecordstatus","routeSlug":"/apis/public-api/openapi/writetorecord/getwritetorecordstatus","metadata":{"seo":{"title":"Get Write to Record status","description":"Get the latest Write to Record status for a resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWriteToRecordStatus","name":"Get Write to Record status","isWebhook":false,"pointer":"/paths/~1v1~1write-to-record~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Write to Record status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the latest Write to Record status for a resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"resource_type","in":"query","schemaId":"schema_79","description":"The resource type to check.","required":true,"example":"consultation"},{"name":"resource_id","in":"query","schemaId":"schema_52","description":"The resource ID to check.","required":true,"example":"12345"}],"pointer":"/paths/~1v1~1write-to-record~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/write-to-record/status","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"resource_type","in":"query","required":true,"example":"consultation","schemaId":"components/schemas/ResourceType"},{"name":"resource_id","in":"query","required":true,"example":"12345","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/write-to-record/status","href":"writetorecord/getwritetorecordstatus","openApiOperationId":"getWriteToRecordStatus","summary":"Get Write to Record status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteToRecordStatusResponse"}},"schemaId":"components/schemas/WriteToRecordStatusResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1write-to-record~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteToRecordStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteToRecordStatusResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/writetorecord/getwritetorecordstatus"}],"panels":[]}]},"httpPath":"/v1/write-to-record/status"}],"content":{"contentType":"group","meta":{"name":"WriteToRecord"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WriteToRecord","showPageActions":true},{"nodeType":"markdoc","content":"Check the status of write-to-record operations for messages sent to the EHR."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/write-to-record/status","summary":"Get Write to Record status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/writetorecord/getwritetorecordstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Task","link":"/apis/public-api/openapi/task","routeSlug":"/apis/public-api/openapi/task","items":[{"label":"Update a task","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/updatetask","routeSlug":"/apis/public-api/openapi/task/updatetask","metadata":{"seo":{"title":"Update a task","description":"Updates a task using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTask","name":"Update a task","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1tasks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a task","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a task using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1tasks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateBody"}},"schemaId":"components/schemas/TaskUpdateBody","pointer":"/paths/~1v1~1tasks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/tasks/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskUpdateBody"}},"responseCodes":["200","403","429","500"],"pointer":"/v1/tasks/{id}","href":"task/updatetask","openApiOperationId":"updateTask","summary":"Update a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/TaskUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdateResponse"}},"schemaId":"components/schemas/TaskUpdateResponse"},{"code":"403","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1tasks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskUpdateResponse"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/updatetask"}],"panels":[]}]},"httpPath":"/v1/tasks/{id}"},{"label":"Get Task","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/gettask","routeSlug":"/apis/public-api/openapi/task/gettask","metadata":{"seo":{"title":"Get Task","description":"Retrieve task information for the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTask","name":"Get Task","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1tasks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Task","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve task information for the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1tasks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tasks/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/tasks/{id}","href":"task/gettask","openApiOperationId":"getTask","summary":"Get Task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDto"}},"schemaId":"components/schemas/TaskDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1tasks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/gettask"}],"panels":[]}]},"httpPath":"/v2/tasks/{id}"},{"label":"List Tasks","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/listtasks","routeSlug":"/apis/public-api/openapi/task/listtasks","metadata":{"seo":{"title":"List Tasks","description":"Retrieves a list of all tasks for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTasks","name":"List Tasks","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v2~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tasks","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all tasks for a practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","schemaId":"schema_72"},{"name":"status[]","in":"query","schemaId":"schema_73"},{"name":"priority[]","in":"query","schemaId":"schema_74"},{"name":"order_by[]","in":"query","schemaId":"schema_76"},{"name":"order_descending[]","in":"query","schemaId":"schema_53"}],"pointer":"/paths/~1v2~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tasks","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"assignee_id[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"assignee_type[]","in":"query","required":false,"schemaId":"schema_72"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_73"},{"name":"priority[]","in":"query","required":false,"schemaId":"schema_74"},{"name":"order_by[]","in":"query","required":false,"schemaId":"schema_76"},{"name":"order_descending[]","in":"query","required":false,"schemaId":"schema_53"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/tasks","href":"task/listtasks","openApiOperationId":"listTasks","summary":"List Tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskListResponse"}},"schemaId":"components/schemas/TaskListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task/listtasks"}],"panels":[]}]},"httpPath":"/v2/tasks"}],"content":{"contentType":"group","meta":{"name":"Task"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task","showPageActions":true},{"nodeType":"markdoc","content":"Manage tasks assigned to admin users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/tasks/{id}","summary":"Update a task","prefix":{"name":"patch","color":"http-deprecated"},"badges":[],"link":"/task/updatetask","deprecated":true},{"title":"/v2/tasks/{id}","summary":"Get Task","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/task/gettask","deprecated":true},{"title":"/v2/tasks","summary":"List Tasks","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/task/listtasks","deprecated":true}]}]}]}]}},{"type":"separator","label":"Messaging","content":null},{"type":"group","label":"Individual messages","link":"/apis/public-api/openapi/individual-messages","routeSlug":"/apis/public-api/openapi/individual-messages","items":[{"label":"Get Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getmessage","routeSlug":"/apis/public-api/openapi/individual-messages/getmessage","metadata":{"seo":{"title":"Get Message","description":"Retrieves a message by its ID. An acting admin without the required policy still receives the message, with the link removed from every attachment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMessage","name":"Get Message","isWebhook":false,"pointer":"/paths/~1v1~1messages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a message by its ID. An acting admin without the required policy still receives the message, with the link removed from every attachment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1messages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/messages/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/messages/{id}","href":"individual-messages/getmessage","openApiOperationId":"getMessage","summary":"Get Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageGetResponse"}},"schemaId":"components/schemas/MessageGetResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1messages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessageGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageGetResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/getmessage"}],"panels":[]}]},"httpPath":"/v1/messages/{id}"},{"label":"Send a Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/sendmessage","routeSlug":"/apis/public-api/openapi/individual-messages/sendmessage","metadata":{"seo":{"title":"Send a Message","description":"Send a message to a patient via SMS, email, NHS App, or as a Hero-only audit record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendMessage","name":"Send a Message","isWebhook":false,"pointer":"/paths/~1v1~1messages~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a message to a patient via SMS, email, NHS App, or as a Hero-only audit record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message types:"},"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":"sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Sent via the practice's configured SMS provider (e.g. Firetext)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Sent via Hero's email service (AWS SES)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nhs_app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Delivered through the NHS App"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Not delivered to the patient; used as an audit log for messages sent externally"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write_to_record: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to persist the message in the patient's EHR (EMIS/TPP) after clinician approval."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MessageSendBody","exampleIds":["paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/MessageSendBody","exampleIds":["paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1messages~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/messages/send","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MessageSendBody","exampleIds":["paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","422","429","500"],"pointer":"/v1/messages/send","href":"individual-messages/sendmessage","openApiOperationId":"sendMessage","summary":"Send a Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/MessageSendBody","exampleIds":["paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MessageSendBody","exampleIds":["paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageSendResult"}},"schemaId":"components/schemas/MessageSendResult"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — missing or invalid fields"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"403","description":"Forbidden - missing policy or scope"},{"code":"404","description":"Patient not found"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable — patient does not have the required contact detail for the chosen message type"},"children":[]}]}]}]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1messages~1send/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessageSendResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageSendResult"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/sendmessage"}],"panels":[]}]},"httpPath":"/v1/messages/send"},{"label":"Get Message Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getstatus","routeSlug":"/apis/public-api/openapi/individual-messages/getstatus","metadata":{"seo":{"title":"Get Message Status","description":"Retrieve message write to record and send status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatus","name":"Get Message Status","isWebhook":false,"pointer":"/paths/~1v1~1messages~1{id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Message Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve message write to record and send status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1messages~1{id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/messages/{id}/status","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","403","429","500"],"pointer":"/v1/messages/{id}/status","href":"individual-messages/getstatus","openApiOperationId":"getStatus","summary":"Get Message Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageStatus"}},"schemaId":"components/schemas/MessageStatus"},{"code":"403","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1messages~1{id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessageStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageStatus"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/getstatus"}],"panels":[]}]},"httpPath":"/v1/messages/{id}/status"},{"label":"List Assignee Collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/assigneecollections","routeSlug":"/apis/public-api/openapi/individual-messages/assigneecollections","metadata":{"seo":{"title":"List Assignee Collection","description":"Retrieve a list of all assignees including Admin or AdminTeam for the requesting practice group and admin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assigneeCollections","name":"List Assignee Collection","isWebhook":false,"pointer":"/paths/~1v1~1messages~1assignee~1collection/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Assignee Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all assignees including Admin or AdminTeam for the requesting practice group and admin"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/messages/assignee/collection","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","403","429","500"],"pointer":"/v1/messages/assignee/collection","href":"individual-messages/assigneecollections","openApiOperationId":"assigneeCollections","summary":"List Assignee Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssigneesCollectionResult"}},"schemaId":"components/schemas/AssigneesCollectionResult"},{"code":"403","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1messages~1assignee~1collection/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssigneesCollectionResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssigneesCollectionResult"}}},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/assigneecollections"}],"panels":[]}]},"httpPath":"/v1/messages/assignee/collection"},{"label":"Search SNOMED concepts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/searchsnomed","routeSlug":"/apis/public-api/openapi/individual-messages/searchsnomed","metadata":{"seo":{"title":"Search SNOMED concepts","description":"Searches by code when query is numeric (a single code or a comma-separated list of codes), otherwise searches by free-text term."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchSnomed","name":"Search SNOMED concepts","isWebhook":false,"pointer":"/paths/~1v1~1snomed/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search SNOMED concepts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches by code when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is numeric (a single code or a comma-separated list of codes), otherwise searches by free-text term."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_52","description":"A free-text term, or a single SNOMED code / comma-separated list of codes.","required":true}],"pointer":"/paths/~1v1~1snomed/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/snomed","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"query","in":"query","required":true,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/snomed","href":"individual-messages/searchsnomed","openApiOperationId":"searchSnomed","summary":"Search SNOMED concepts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SnomedSearchResult"}},"schemaId":"components/schemas/SnomedSearchResult"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1snomed/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SnomedSearchResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SnomedSearchResult"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/searchsnomed"}],"panels":[]}]},"httpPath":"/v1/snomed"},{"label":"List Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/listtemplates","routeSlug":"/apis/public-api/openapi/individual-messages/listtemplates","metadata":{"seo":{"title":"List Templates","description":"Retrieves a list of message templates for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplates","name":"List Templates","isWebhook":false,"pointer":"/paths/~1v1~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of message templates for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"has_follow_up","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v1~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/templates","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"has_follow_up","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/templates","href":"individual-messages/listtemplates","openApiOperationId":"listTemplates","summary":"List Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateList"}},"schemaId":"components/schemas/TemplateList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/listtemplates"}],"panels":[]}]},"httpPath":"/v1/templates"},{"label":"Get Automated Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getautomatedmessage","routeSlug":"/apis/public-api/openapi/individual-messages/getautomatedmessage","metadata":{"seo":{"title":"Get Automated Message","description":"Retrieve automated message for the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAutomatedMessage","name":"Get Automated Message","isWebhook":false,"pointer":"/paths/~1v2~1automated_messages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Automated Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve automated message for the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1automated_messages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/automated_messages/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/automated_messages/{id}","href":"individual-messages/getautomatedmessage","openApiOperationId":"getAutomatedMessage","summary":"Get Automated Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomatedMessageGetDto"}},"schemaId":"components/schemas/AutomatedMessageGetDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1automated_messages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AutomatedMessageGetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AutomatedMessageGetDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/getautomatedmessage"}],"panels":[]}]},"httpPath":"/v2/automated_messages/{id}"},{"label":"List Sent Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/listsentmessages","routeSlug":"/apis/public-api/openapi/individual-messages/listsentmessages","metadata":{"seo":{"title":"List Sent Messages","description":"Retrieves a list of all sent messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSentMessages","name":"List Sent Messages","isWebhook":false,"pointer":"/paths/~1v2~1sent_messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Sent Messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all sent messages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_80"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"patient_first_name","in":"query","schemaId":"schema_52"},{"name":"patient_last_name","in":"query","schemaId":"schema_52"},{"name":"patient_full_name","in":"query","schemaId":"schema_52"},{"name":"patient_id","in":"query","schemaId":"schema_52"},{"name":"recipient_contact_detail","in":"query","schemaId":"schema_52"},{"name":"write_to_record_status","in":"query","schemaId":"components/schemas/ConsultationWtrStatus"},{"name":"message_type","in":"query","schemaId":"schema_81"},{"name":"short_link_id","in":"query","schemaId":"schema_52"},{"name":"short_link_type","in":"query","schemaId":"schema_52"},{"name":"campaign_id","in":"query","schemaId":"schema_52"},{"name":"status","in":"query","schemaId":"schema_82"},{"name":"scheduled","in":"query","schemaId":"schema_54"},{"name":"sent_by","in":"query","schemaId":"schema_52"},{"name":"sent_at[]","in":"query","schemaId":"schema_53"},{"name":"scheduled_at[]","in":"query","schemaId":"schema_53"}],"pointer":"/paths/~1v2~1sent_messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/sent_messages","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_80"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"patient_first_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_last_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_full_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"recipient_contact_detail","in":"query","required":false,"schemaId":"schema_52"},{"name":"write_to_record_status","in":"query","required":false,"schemaId":"components/schemas/ConsultationWtrStatus"},{"name":"message_type","in":"query","required":false,"schemaId":"schema_81"},{"name":"short_link_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"short_link_type","in":"query","required":false,"schemaId":"schema_52"},{"name":"campaign_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"status","in":"query","required":false,"schemaId":"schema_82"},{"name":"scheduled","in":"query","required":false,"schemaId":"schema_54"},{"name":"sent_by","in":"query","required":false,"schemaId":"schema_52"},{"name":"sent_at[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"scheduled_at[]","in":"query","required":false,"schemaId":"schema_53"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/sent_messages","href":"individual-messages/listsentmessages","openApiOperationId":"listSentMessages","summary":"List Sent Messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessagesListResponseV2"}},"schemaId":"components/schemas/MessagesListResponseV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1sent_messages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessagesListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessagesListResponseV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/listsentmessages"}],"panels":[]}]},"httpPath":"/v2/sent_messages"},{"label":"Validate a SNOMED Code","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/validatesnomed","routeSlug":"/apis/public-api/openapi/individual-messages/validatesnomed","metadata":{"seo":{"title":"Validate a SNOMED Code","description":"Deprecated. Use GET /v1/snomed with the code as the query parameter to validate a SNOMED code instead — a non-empty result confirms the code is valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateSnomed","name":"Validate a SNOMED Code","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1snomed~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a SNOMED Code","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/snomed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the code as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to validate a SNOMED code instead — a non-empty result confirms the code is valid."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SnomedValidateBody"}},"schemaId":"components/schemas/SnomedValidateBody","pointer":"/paths/~1v1~1snomed~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/snomed/validate","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SnomedValidateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/snomed/validate","href":"individual-messages/validatesnomed","openApiOperationId":"validateSnomed","summary":"Validate a SNOMED Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/SnomedValidateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SnomedValidateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SnomedValidateResult"}},"schemaId":"components/schemas/SnomedValidateResult"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1snomed~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SnomedValidateResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SnomedValidateResult"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-messages/validatesnomed"}],"panels":[]}]},"httpPath":"/v1/snomed/validate"}],"content":{"contentType":"group","meta":{"name":"Individual messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Individual messages","showPageActions":true},{"nodeType":"markdoc","content":"Send SMS, email, NHS App, and Hero-only messages to patients. Supports write-to-record to persist messages in the patient's EHR."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/messages/{id}","summary":"Get Message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/getmessage","deprecated":false},{"title":"/v1/messages/send","summary":"Send a Message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-messages/sendmessage","deprecated":false},{"title":"/v1/messages/{id}/status","summary":"Get Message Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/getstatus","deprecated":false},{"title":"/v1/messages/assignee/collection","summary":"List Assignee Collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/assigneecollections","deprecated":false},{"title":"/v1/snomed","summary":"Search SNOMED concepts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/searchsnomed","deprecated":false},{"title":"/v1/templates","summary":"List Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/listtemplates","deprecated":false},{"title":"/v2/automated_messages/{id}","summary":"Get Automated Message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/getautomatedmessage","deprecated":false},{"title":"/v2/sent_messages","summary":"List Sent Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-messages/listsentmessages","deprecated":false},{"title":"/v1/snomed/validate","summary":"Validate a SNOMED Code","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/individual-messages/validatesnomed","deprecated":true}]}]}]}]}},{"type":"group","label":"Batch messages","link":"/apis/public-api/openapi/batch-messages","routeSlug":"/apis/public-api/openapi/batch-messages","items":[{"label":"Create a Batch Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/createbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/createbatchmessage","metadata":{"seo":{"title":"Create a Batch Message","description":"Create a Batch Message"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBatchMessage","name":"Create a Batch Message","isWebhook":false,"pointer":"/paths/~1v1~1batch_message/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Batch Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Batch Message"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchMessageCreateBody"}},"schemaId":"components/schemas/BatchMessageCreateBody","pointer":"/paths/~1v1~1batch_message/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/batch_message","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchMessageCreateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/batch_message","href":"batch-messages/createbatchmessage","openApiOperationId":"createBatchMessage","summary":"Create a Batch Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/BatchMessageCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchMessageCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}},"schemaId":"components/schemas/BatchMessage"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/createbatchmessage"}],"panels":[]}]},"httpPath":"/v1/batch_message"},{"label":"List Batch Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listbatchmessages","routeSlug":"/apis/public-api/openapi/batch-messages/listbatchmessages","metadata":{"seo":{"title":"List Batch Messages","description":"List Batch Messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchMessages","name":"List Batch Messages","isWebhook":false,"pointer":"/paths/~1v1~1batch_message/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Batch Messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Batch Messages"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"status","in":"query","schemaId":"schema_83"}],"pointer":"/paths/~1v1~1batch_message/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch_message","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"status","in":"query","required":false,"schemaId":"schema_83"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/batch_message","href":"batch-messages/listbatchmessages","openApiOperationId":"listBatchMessages","summary":"List Batch Messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}},"schemaId":"components/schemas/BatchMessage"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/listbatchmessages"}],"panels":[]}]},"httpPath":"/v1/batch_message"},{"label":"Send a Batch Message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/sendbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/sendbatchmessage","metadata":{"seo":{"title":"Send a Batch Message","description":"Send a Batch Message"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendBatchMessage","name":"Send a Batch Message","isWebhook":false,"pointer":"/paths/~1v1~1batch_message~1{id}~1send/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a Batch Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a Batch Message"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1batch_message~1{id}~1send/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/batch_message/{id}/send","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/batch_message/{id}/send","href":"batch-messages/sendbatchmessage","openApiOperationId":"sendBatchMessage","summary":"Send a Batch Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Ok"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message~1{id}~1send/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/sendbatchmessage"}],"panels":[]}]},"httpPath":"/v1/batch_message/{id}/send"},{"label":"Get a Batch Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/getbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/getbatchmessage","metadata":{"seo":{"title":"Get a Batch Message","description":"Get a Batch Message"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBatchMessage","name":"Get a Batch Message","isWebhook":false,"pointer":"/paths/~1v1~1batch_message~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Batch Message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Batch Message"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1batch_message~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch_message/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/batch_message/{id}","href":"batch-messages/getbatchmessage","openApiOperationId":"getBatchMessage","summary":"Get a Batch Message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}},"schemaId":"components/schemas/BatchMessage"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchMessage"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/getbatchmessage"}],"panels":[]}]},"httpPath":"/v1/batch_message/{id}"},{"label":"List Batch Message Recipients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listrecipients","routeSlug":"/apis/public-api/openapi/batch-messages/listrecipients","metadata":{"seo":{"title":"List Batch Message Recipients","description":"List Batch Message Recipients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecipients","name":"List Batch Message Recipients","isWebhook":false,"pointer":"/paths/~1v1~1batch_message~1{id}~1recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Batch Message Recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Batch Message Recipients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1batch_message~1{id}~1recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"status","in":"query","schemaId":"schema_83"}],"pointer":"/paths/~1v1~1batch_message~1{id}~1recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch_message/{id}/recipients","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"status","in":"query","required":false,"schemaId":"schema_83"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/batch_message/{id}/recipients","href":"batch-messages/listrecipients","openApiOperationId":"listRecipients","summary":"List Batch Message Recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecipientList"}},"schemaId":"components/schemas/RecipientList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message~1{id}~1recipients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecipientList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecipientList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/listrecipients"}],"panels":[]}]},"httpPath":"/v1/batch_message/{id}/recipients"},{"label":"List Batch Message Sends","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listbatchmessagesends","routeSlug":"/apis/public-api/openapi/batch-messages/listbatchmessagesends","metadata":{"seo":{"title":"List Batch Message Sends","description":"List Batch Message Sends"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchMessageSends","name":"List Batch Message Sends","isWebhook":false,"pointer":"/paths/~1v1~1batch_message~1{id}~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Batch Message Sends","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Batch Message Sends"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1batch_message~1{id}~1messages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"status","in":"query","schemaId":"schema_84"}],"pointer":"/paths/~1v1~1batch_message~1{id}~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/batch_message/{id}/messages","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"status","in":"query","required":false,"schemaId":"schema_84"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/batch_message/{id}/messages","href":"batch-messages/listbatchmessagesends","openApiOperationId":"listBatchMessageSends","summary":"List Batch Message Sends"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageList"}},"schemaId":"components/schemas/MessageList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1batch_message~1{id}~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessageList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MessageList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-messages/listbatchmessagesends"}],"panels":[]}]},"httpPath":"/v1/batch_message/{id}/messages"}],"content":{"contentType":"group","meta":{"name":"Batch messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch messages","showPageActions":true},{"nodeType":"markdoc","content":"Create, send, and track batch messages and their recipients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/batch_message","summary":"Create a Batch Message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-messages/createbatchmessage","deprecated":false},{"title":"/v1/batch_message","summary":"List Batch Messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-messages/listbatchmessages","deprecated":false},{"title":"/v1/batch_message/{id}/send","summary":"Send a Batch Message","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/batch-messages/sendbatchmessage","deprecated":false},{"title":"/v1/batch_message/{id}","summary":"Get a Batch Message","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-messages/getbatchmessage","deprecated":false},{"title":"/v1/batch_message/{id}/recipients","summary":"List Batch Message Recipients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-messages/listrecipients","deprecated":false},{"title":"/v1/batch_message/{id}/messages","summary":"List Batch Message Sends","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-messages/listbatchmessagesends","deprecated":false}]}]}]}]}},{"type":"group","label":"Links","link":"/apis/public-api/openapi/links","routeSlug":"/apis/public-api/openapi/links","items":[{"label":"Create an Attachment Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createattachmentlink","routeSlug":"/apis/public-api/openapi/links/createattachmentlink","metadata":{"seo":{"title":"Create an Attachment Link","description":"Creates a attachment link using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAttachmentLink","name":"Create an Attachment Link","isWebhook":false,"pointer":"/paths/~1v1~1attachment_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Attachment Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a attachment link using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachmentLinkCreateObject"}},"schemaId":"components/schemas/AttachmentLinkCreateObject","pointer":"/paths/~1v1~1attachment_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/attachment_links","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AttachmentLinkCreateObject"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v1/attachment_links","href":"links/createattachmentlink","openApiOperationId":"createAttachmentLink","summary":"Create an Attachment Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/AttachmentLinkCreateObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AttachmentLinkCreateObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentLinkCreateResponse"}},"schemaId":"components/schemas/AttachmentLinkCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"403","description":"Forbidden - missing policy or scope"},{"code":"422","description":"Patient inexistent and/or Appointment Type inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1attachment_links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttachmentLinkCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentLinkCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"403"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/createattachmentlink"}],"panels":[]}]},"httpPath":"/v1/attachment_links"},{"label":"Create a Booking Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createbookinglink","routeSlug":"/apis/public-api/openapi/links/createbookinglink","metadata":{"seo":{"title":"Create a Booking Link","description":"Create a booking link that can be shared with a patient. The link allows the patient to self-book into an available appointment slot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBookingLink","name":"Create a Booking Link","isWebhook":false,"pointer":"/paths/~1v1~1booking_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Booking Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a booking link that can be shared with a patient. The link allows the patient to self-book into an available appointment slot.\n\nBooking links are tied to a specific patient and appointment type. The generated URL can be sent via SMS or email using the Send Message endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateBody"}},"schemaId":"components/schemas/BookingLinkCreateBody","pointer":"/paths/~1v1~1booking_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/booking_links","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateBody"}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/booking_links","href":"links/createbookinglink","openApiOperationId":"createBookingLink","summary":"Create a Booking Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/BookingLinkCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateResponse"}},"schemaId":"components/schemas/BookingLinkCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Patient inexistent and/or Appointment Type inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1booking_links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingLinkCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/createbookinglink"}],"panels":[]}]},"httpPath":"/v1/booking_links"},{"label":"Update a Booking Link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/updatebookinglink","routeSlug":"/apis/public-api/openapi/links/updatebookinglink","metadata":{"seo":{"title":"Update a Booking Link","description":"Updates a booking link using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBookingLink","name":"Update a Booking Link","isWebhook":false,"pointer":"/paths/~1v1~1booking_links~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Booking Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a booking link using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1booking_links~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingLinkUpdateBody"}},"schemaId":"components/schemas/BookingLinkUpdateBody","pointer":"/paths/~1v1~1booking_links~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/booking_links/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BookingLinkUpdateBody"}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/booking_links/{id}","href":"links/updatebookinglink","openApiOperationId":"updateBookingLink","summary":"Update a Booking Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/BookingLinkUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookingLinkUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateResponse"}},"schemaId":"components/schemas/BookingLinkCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Patient inexistent and/or Appointment Type inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1booking_links~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BookingLinkCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BookingLinkCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/updatebookinglink"}],"panels":[]}]},"httpPath":"/v1/booking_links/{id}"},{"label":"Create a Form Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createformlink","routeSlug":"/apis/public-api/openapi/links/createformlink","metadata":{"seo":{"title":"Create a Form Link","description":"Creates a form link using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFormLink","name":"Create a Form Link","isWebhook":false,"pointer":"/paths/~1v1~1form_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Form Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a form link using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormLinkCreateBody"}},"schemaId":"components/schemas/FormLinkCreateBody","pointer":"/paths/~1v1~1form_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/form_links","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormLinkCreateBody"}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/form_links","href":"links/createformlink","openApiOperationId":"createFormLink","summary":"Create a Form Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/FormLinkCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormLinkCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormLinkCreateResponse"}},"schemaId":"components/schemas/FormLinkCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Patient and/or Form inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1form_links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormLinkCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormLinkCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/createformlink"}],"panels":[]}]},"httpPath":"/v1/form_links"},{"label":"Get Link Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/getlinkstatus","routeSlug":"/apis/public-api/openapi/links/getlinkstatus","metadata":{"seo":{"title":"Get Link Status","description":"Get the status of a given link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLinkStatus","name":"Get Link Status","isWebhook":false,"pointer":"/paths/~1v1~1links~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Link Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the status of a given link."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"url","in":"query","schemaId":"schema_52","description":"The URL of the link. Provide either 'url' or 'id'.","example":"https://bookings.herohealth.net/s/abc123"},{"name":"id","in":"query","schemaId":"schema_52","description":"The ID of the short link. Provide either 'url' or 'id'.","example":"12345"}],"pointer":"/paths/~1v1~1links~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/links/status","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"url","in":"query","required":false,"example":"https://bookings.herohealth.net/s/abc123","schemaId":"schema_52"},{"name":"id","in":"query","required":false,"example":"12345","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/links/status","href":"links/getlinkstatus","openApiOperationId":"getLinkStatus","summary":"Get Link Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkStatusResponse"}},"schemaId":"components/schemas/LinkStatusResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Link inexistent or invalid"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1links~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LinkStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LinkStatusResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/getlinkstatus"}],"panels":[]}]},"httpPath":"/v1/links/status"},{"label":"List Short links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/listshortlinks","routeSlug":"/apis/public-api/openapi/links/listshortlinks","metadata":{"seo":{"title":"List Short links","description":"Retrieves a list of shortlinks filtered by given parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShortLinks","name":"List Short links","isWebhook":false,"pointer":"/paths/~1v1~1short_links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Short links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of shortlinks filtered by given parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_61"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"type","in":"query","schemaId":"schema_85"},{"name":"status","in":"query","schemaId":"schema_62"},{"name":"exclude_patient_specific_links","in":"query","schemaId":"schema_54"}],"pointer":"/paths/~1v1~1short_links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/short_links","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_61"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"type","in":"query","required":false,"schemaId":"schema_85"},{"name":"status","in":"query","required":false,"schemaId":"schema_62"},{"name":"exclude_patient_specific_links","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/short_links","href":"links/listshortlinks","openApiOperationId":"listShortLinks","summary":"List Short links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShortLinksListResponse"}},"schemaId":"components/schemas/ShortLinksListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1short_links/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShortLinksListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShortLinksListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/listshortlinks"}],"panels":[]}]},"httpPath":"/v1/short_links"},{"label":"Create a Video Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createvideolink","routeSlug":"/apis/public-api/openapi/links/createvideolink","metadata":{"seo":{"title":"Create a Video Link","description":"Creates a video link using the provided parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVideoLink","name":"Create a Video Link","isWebhook":false,"pointer":"/paths/~1v1~1video_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Video Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a video link using the provided parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VideoLinkCreateBody"}},"schemaId":"components/schemas/VideoLinkCreateBody","pointer":"/paths/~1v1~1video_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/video_links","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VideoLinkCreateBody"}},"responseCodes":["200","400","401","422","429","500"],"pointer":"/v1/video_links","href":"links/createvideolink","openApiOperationId":"createVideoLink","summary":"Create a Video Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/VideoLinkCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VideoLinkCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoLinkCreateResponse"}},"schemaId":"components/schemas/VideoLinkCreateResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Patient inexistent"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1video_links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoLinkCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoLinkCreateResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/links/createvideolink"}],"panels":[]}]},"httpPath":"/v1/video_links"}],"content":{"contentType":"group","meta":{"name":"Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Links","showPageActions":true},{"nodeType":"markdoc","content":"Generate and manage booking links, form links, and short links for patient self-service flows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/attachment_links","summary":"Create an Attachment Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/links/createattachmentlink","deprecated":false},{"title":"/v1/booking_links","summary":"Create a Booking Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/links/createbookinglink","deprecated":false},{"title":"/v1/booking_links/{id}","summary":"Update a Booking Link","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/links/updatebookinglink","deprecated":false},{"title":"/v1/form_links","summary":"Create a Form Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/links/createformlink","deprecated":false},{"title":"/v1/links/status","summary":"Get Link Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/links/getlinkstatus","deprecated":false},{"title":"/v1/short_links","summary":"List Short links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/links/listshortlinks","deprecated":false},{"title":"/v1/video_links","summary":"Create a Video Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/links/createvideolink","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Webhooks","link":"/apis/public-api/openapi/webhooks","routeSlug":"/apis/public-api/openapi/webhooks","items":[{"label":"Create a Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/createwebhook","routeSlug":"/apis/public-api/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a Webhook","description":"Create a webhook subscription for the authenticated practice group. Hero will send an HTTP POST request to the specified URL whenever the subscribed event occurs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a webhook subscription for the authenticated practice group. Hero will send an HTTP POST request to the specified URL whenever the subscribed event occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available events:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment.confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment.cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment.rescheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prescription.issued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient.added-to-sequence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write-to-record.succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write-to-record.failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signing_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable HMAC-SHA256 signature verification on incoming webhook requests. See the webhook security documentation for verification examples."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookCreateBody","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookCreateBody","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhooks","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookCreateBody","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/WebhookCreateBody","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookCreateBody","exampleIds":["paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookDto"}},"schemaId":"components/schemas/WebhookDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"List Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/listwebhooks","routeSlug":"/apis/public-api/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List Webhooks","description":"Retrieve all webhook subscriptions for the authenticated practice group. Use this to audit active subscriptions or check event types you are subscribed to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List Webhooks","isWebhook":false,"pointer":"/paths/~1v1~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all webhook subscriptions for the authenticated practice group. Use this to audit active subscriptions or check event types you are subscribed to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"event_type","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhooks","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"event_type","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List Webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}},"schemaId":"components/schemas/WebhookListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/v1/webhooks"},{"label":"Delete a Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/deletewebhook","routeSlug":"/apis/public-api/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a Webhook","description":"Delete a webhook subscription. Hero will immediately stop sending events to the webhook URL. This action cannot be undone — you will need to create a new webhook to resubscribe."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a Webhook","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a webhook subscription. Hero will immediately stop sending events to the webhook URL. This action cannot be undone — you will need to create a new webhook to resubscribe."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhooks/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","429","500"],"pointer":"/v1/webhooks/{id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/v1/webhooks/{id}"},{"label":"List Webhook Executions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/listwebhookexecutions","routeSlug":"/apis/public-api/openapi/webhooks/listwebhookexecutions","metadata":{"seo":{"title":"List Webhook Executions","description":"Retrieves a list of executions for a specific webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhookExecutions","name":"List Webhook Executions","isWebhook":false,"pointer":"/paths/~1v1~1webhooks~1{id}~1executions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhook Executions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of executions for a specific webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1webhooks~1{id}~1executions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhooks/{id}/executions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/webhooks/{id}/executions","href":"webhooks/listwebhookexecutions","openApiOperationId":"listWebhookExecutions","summary":"List Webhook Executions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListExecutionResponse"}},"schemaId":"components/schemas/WebhookListExecutionResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1webhooks~1{id}~1executions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookListExecutionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListExecutionResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhookexecutions"}],"panels":[]}]},"httpPath":"/v1/webhooks/{id}/executions"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Subscribe to Hero events (e.g. appointment confirmations, write-to-record outcomes) and receive real-time notifications via HTTP callbacks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhooks","summary":"Create a Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/v1/webhooks","summary":"List Webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/v1/webhooks/{id}","summary":"Delete a Webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/v1/webhooks/{id}/executions","summary":"List Webhook Executions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhookexecutions","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payments & Billing","content":null},{"type":"group","label":"Invoicing","link":"/apis/public-api/openapi/invoicing","routeSlug":"/apis/public-api/openapi/invoicing","items":[{"label":"List Coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/listcoupons","routeSlug":"/apis/public-api/openapi/invoicing/listcoupons","metadata":{"seo":{"title":"List Coupons","description":"Retrieves a list of Stripe coupons for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCoupons","name":"List Coupons","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1coupons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Coupons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of Stripe coupons for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1invoicing~1coupons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoicing/coupons","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"query","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/coupons","href":"invoicing/listcoupons","openApiOperationId":"listCoupons","summary":"List Coupons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponList"}},"schemaId":"components/schemas/CouponList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1coupons/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoicing/listcoupons"}],"panels":[]}]},"httpPath":"/v1/invoicing/coupons"},{"label":"Create Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/createinvoice","routeSlug":"/apis/public-api/openapi/invoicing/createinvoice","metadata":{"seo":{"title":"Create Invoice","description":"Creates a new invoice for a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoice","name":"Create Invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1invoices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new invoice for a patient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is required and must be the Admin ID of the person issuing the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the patient will be derived from the appointment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the List Products endpoint to retrieve available invoice items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceCreateBody"}},"schemaId":"components/schemas/InvoiceCreateBody","pointer":"/paths/~1v1~1invoicing~1invoices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoicing/invoices","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceCreateBody"}},"responseCodes":["201","400","401","422","429","500"],"pointer":"/v1/invoicing/invoices","href":"invoicing/createinvoice","openApiOperationId":"createInvoice","summary":"Create Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/InvoiceCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invoice created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1invoices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoicing/createinvoice"}],"panels":[]}]},"httpPath":"/v1/invoicing/invoices"},{"label":"Update Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/updateinvoice","routeSlug":"/apis/public-api/openapi/invoicing/updateinvoice","metadata":{"seo":{"title":"Update Invoice","description":"Updates an existing invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoice","name":"Update Invoice","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1invoices~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is required and must be the Admin ID of the person updating the invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For draft invoices, all fields can be updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For finalized invoices, only metadata fields (memo, footer, coupons) can be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"The invoice ID","required":true}],"pointer":"/paths/~1v1~1invoicing~1invoices~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceUpdateBody"}},"schemaId":"components/schemas/InvoiceUpdateBody","pointer":"/paths/~1v1~1invoicing~1invoices~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/invoicing/invoices/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceUpdateBody"}},"responseCodes":["200","400","401","404","422","429","500"],"pointer":"/v1/invoicing/invoices/{id}","href":"invoicing/updateinvoice","openApiOperationId":"updateInvoice","summary":"Update Invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/InvoiceUpdateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceUpdateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Invoice not found"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1invoices~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoicing/updateinvoice"}],"panels":[]}]},"httpPath":"/v1/invoicing/invoices/{id}"},{"label":"Link Invoice to Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/linkinvoice","routeSlug":"/apis/public-api/openapi/invoicing/linkinvoice","metadata":{"seo":{"title":"Link Invoice to Appointment","description":"Links an external Stripe invoice to an appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkInvoice","name":"Link Invoice to Appointment","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1invoices~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link Invoice to Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Links an external Stripe invoice to an appointment.\n\nThis endpoint finds or creates a Hero invoice record from a Stripe invoice ID,\nthen links it to the specified appointment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceLinkBody"}},"schemaId":"components/schemas/InvoiceLinkBody","pointer":"/paths/~1v1~1invoicing~1invoices~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoicing/invoices/link","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceLinkBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/invoices/link","href":"invoicing/linkinvoice","openApiOperationId":"linkInvoice","summary":"Link Invoice to Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/InvoiceLinkBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceLinkBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invoice linked successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Stripe invoice or appointment not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1invoices~1link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoicing/linkinvoice"}],"panels":[]}]},"httpPath":"/v1/invoicing/invoices/link"},{"label":"List Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/listproducts","routeSlug":"/apis/public-api/openapi/invoicing/listproducts","metadata":{"seo":{"title":"List Products","description":"Retrieves a list of Stripe products for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"List Products","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of Stripe products for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_52","required":true},{"name":"active","in":"query","schemaId":"schema_54"},{"name":"type","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v1~1invoicing~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoicing/products","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"query","in":"query","required":true,"schemaId":"schema_52"},{"name":"active","in":"query","required":false,"schemaId":"schema_54"},{"name":"type","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/products","href":"invoicing/listproducts","openApiOperationId":"listProducts","summary":"List Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductList"}},"schemaId":"components/schemas/ProductList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoicing/listproducts"}],"panels":[]}]},"httpPath":"/v1/invoicing/products"}],"content":{"contentType":"group","meta":{"name":"Invoicing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoicing","showPageActions":true},{"nodeType":"markdoc","content":"Manage invoices, coupons, and products for a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/invoicing/coupons","summary":"List Coupons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoicing/listcoupons","deprecated":false},{"title":"/v1/invoicing/invoices","summary":"Create Invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoicing/createinvoice","deprecated":false},{"title":"/v1/invoicing/invoices/{id}","summary":"Update Invoice","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoicing/updateinvoice","deprecated":false},{"title":"/v1/invoicing/invoices/link","summary":"Link Invoice to Appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoicing/linkinvoice","deprecated":false},{"title":"/v1/invoicing/products","summary":"List Products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoicing/listproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Memberships","link":"/apis/public-api/openapi/memberships","routeSlug":"/apis/public-api/openapi/memberships","items":[{"label":"Create Membership Policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/createmembershippolicy","routeSlug":"/apis/public-api/openapi/memberships/createmembershippolicy","metadata":{"seo":{"title":"Create Membership Policy","description":"Creates a new membership policy for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMembershipPolicy","name":"Create Membership Policy","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1membership-policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Membership Policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new membership policy for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MembershipPolicyCreateBody"}},"schemaId":"components/schemas/MembershipPolicyCreateBody","pointer":"/paths/~1v1~1invoicing~1membership-policies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoicing/membership-policies","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MembershipPolicyCreateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/membership-policies","href":"memberships/createmembershippolicy","openApiOperationId":"createMembershipPolicy","summary":"Create Membership Policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/MembershipPolicyCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MembershipPolicyCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MembershipPolicy"}},"schemaId":"components/schemas/MembershipPolicy"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1membership-policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MembershipPolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MembershipPolicy"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/createmembershippolicy"}],"panels":[]}]},"httpPath":"/v1/invoicing/membership-policies"},{"label":"List Membership Schemes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listmembershipschemes","routeSlug":"/apis/public-api/openapi/memberships/listmembershipschemes","metadata":{"seo":{"title":"List Membership Schemes","description":"Retrieves a list of membership schemes for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMembershipSchemes","name":"List Membership Schemes","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1membership-schemes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Membership Schemes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of membership schemes for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoicing/membership-schemes","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/membership-schemes","href":"memberships/listmembershipschemes","openApiOperationId":"listMembershipSchemes","summary":"List Membership Schemes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MembershipSchemeList"}},"schemaId":"components/schemas/MembershipSchemeList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1membership-schemes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MembershipSchemeList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MembershipSchemeList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listmembershipschemes"}],"panels":[]}]},"httpPath":"/v1/invoicing/membership-schemes"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listsubscriptions","routeSlug":"/apis/public-api/openapi/memberships/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Retrieves a list of subscriptions for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptions","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1v1~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of subscriptions for a practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"patient_id","in":"query","schemaId":"schema_52","required":true},{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"order_by[]","in":"query","schemaId":"schema_86"},{"name":"order_descending[]","in":"query","schemaId":"schema_53"},{"name":"scheme_id","in":"query","schemaId":"schema_52"},{"name":"scheme_name","in":"query","schemaId":"schema_52"},{"name":"status","in":"query","schemaId":"components/schemas/StatusEnum"}],"pointer":"/paths/~1v1~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscriptions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"patient_id","in":"query","required":true,"schemaId":"schema_52"},{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"order_by[]","in":"query","required":false,"schemaId":"schema_86"},{"name":"order_descending[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"scheme_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"scheme_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/StatusEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/subscriptions","href":"memberships/listsubscriptions","openApiOperationId":"listSubscriptions","summary":"List Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}},"schemaId":"components/schemas/SubscriptionListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listsubscriptions"}],"panels":[]}]},"httpPath":"/v1/subscriptions"},{"label":"List Subscribers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listsubscribers","routeSlug":"/apis/public-api/openapi/memberships/listsubscribers","metadata":{"seo":{"title":"List Subscribers","description":"Retrieves a list of subscribers for a practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscribers","name":"List Subscribers","isWebhook":false,"pointer":"/paths/~1v1~1subscribers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscribers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of subscribers for a practice group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list every subscriber on one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" narrows the result to that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"patient, so omit it to see a subscription's other members."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"patient_id","in":"query","schemaId":"schema_52"},{"name":"page_index","in":"query","schemaId":"schema_75"},{"name":"page_size","in":"query","schemaId":"schema_75"},{"name":"order_by[]","in":"query","schemaId":"schema_87"},{"name":"order_descending[]","in":"query","schemaId":"schema_53"},{"name":"scheme_id","in":"query","schemaId":"schema_52"},{"name":"scheme_name","in":"query","schemaId":"schema_52"},{"name":"subscription_id","in":"query","schemaId":"schema_88","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by List Subscriptions, with or without its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M100027"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100027"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are equivalent)."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"components/schemas/StatusEnum"}],"pointer":"/paths/~1v1~1subscribers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/subscribers","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"patient_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_index","in":"query","required":false,"schemaId":"schema_75"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_75"},{"name":"order_by[]","in":"query","required":false,"schemaId":"schema_87"},{"name":"order_descending[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"scheme_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"scheme_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"subscription_id","in":"query","required":false,"example":"M100027","schemaId":"schema_88"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/StatusEnum"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/subscribers","href":"memberships/listsubscribers","openApiOperationId":"listSubscribers","summary":"List Subscribers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriberListResponse"}},"schemaId":"components/schemas/SubscriberListResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1subscribers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriberListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriberListResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listsubscribers"}],"panels":[]}]},"httpPath":"/v1/subscribers"}],"content":{"contentType":"group","meta":{"name":"Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Memberships","showPageActions":true},{"nodeType":"markdoc","content":"Manage notification subscriptions, subscribers, membership policies, and membership schemes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/invoicing/membership-policies","summary":"Create Membership Policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/createmembershippolicy","deprecated":false},{"title":"/v1/invoicing/membership-schemes","summary":"List Membership Schemes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listmembershipschemes","deprecated":false},{"title":"/v1/subscriptions","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listsubscriptions","deprecated":false},{"title":"/v1/subscribers","summary":"List Subscribers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listsubscribers","deprecated":false}]}]}]}]}},{"type":"group","label":"Prescriptions","link":"/apis/public-api/openapi/prescriptions","routeSlug":"/apis/public-api/openapi/prescriptions","items":[{"label":"Get Prescriber's Pharmacies List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/listprescriberpharmacies","routeSlug":"/apis/public-api/openapi/prescriptions/listprescriberpharmacies","metadata":{"seo":{"title":"Get Prescriber's Pharmacies List","description":"Retrieve a list of pharmacies for the prescriber."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPrescriberPharmacies","name":"Get Prescriber's Pharmacies List","isWebhook":false,"pointer":"/paths/~1v1~1prescriber~1{id}~1pharmacies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Prescriber's Pharmacies List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of pharmacies for the prescriber."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1prescriber~1{id}~1pharmacies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/prescriber/{id}/pharmacies","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/prescriber/{id}/pharmacies","href":"prescriptions/listprescriberpharmacies","openApiOperationId":"listPrescriberPharmacies","summary":"Get Prescriber's Pharmacies List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PharmaciesListResponseBody"}},"schemaId":"components/schemas/PharmaciesListResponseBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1prescriber~1{id}~1pharmacies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PharmaciesListResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PharmaciesListResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/listprescriberpharmacies"}],"panels":[]}]},"httpPath":"/v1/prescriber/{id}/pharmacies"},{"label":"Create Pharmacy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createpharmacy","routeSlug":"/apis/public-api/openapi/prescriptions/createpharmacy","metadata":{"seo":{"title":"Create Pharmacy","description":"Create a new Pharmacy for the prescriber."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPharmacy","name":"Create Pharmacy","isWebhook":false,"pointer":"/paths/~1v1~1pharmacies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pharmacy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Pharmacy for the prescriber."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePharmacyBody"}},"schemaId":"components/schemas/CreatePharmacyBody","pointer":"/paths/~1v1~1pharmacies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pharmacies","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePharmacyBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/pharmacies","href":"prescriptions/createpharmacy","openApiOperationId":"createPharmacy","summary":"Create Pharmacy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CreatePharmacyBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePharmacyBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PharmacyBaseSchema"}},"schemaId":"components/schemas/PharmacyBaseSchema"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1pharmacies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PharmacyBaseSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PharmacyBaseSchema"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/createpharmacy"}],"panels":[]}]},"httpPath":"/v1/pharmacies"},{"label":"Create a Prescription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createprescription","routeSlug":"/apis/public-api/openapi/prescriptions/createprescription","metadata":{"seo":{"title":"Create a Prescription","description":"Create a new prescription for a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPrescription","name":"Create a Prescription","isWebhook":false,"pointer":"/paths/~1v1~1prescriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Prescription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new prescription for a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"schemaId":"components/schemas/CreatePrescriptionBody","pointer":"/paths/~1v1~1prescriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/prescriptions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/prescriptions","href":"prescriptions/createprescription","openApiOperationId":"createPrescription","summary":"Create a Prescription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CreatePrescriptionBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionResponseBody"}},"schemaId":"components/schemas/CreatePrescriptionResponseBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1prescriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePrescriptionResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/createprescription"}],"panels":[]}]},"httpPath":"/v1/prescriptions"},{"label":"Get a Prescription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/getprescriptionbyid","routeSlug":"/apis/public-api/openapi/prescriptions/getprescriptionbyid","metadata":{"seo":{"title":"Get a Prescription","description":"Retrieve details of a specific prescription by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrescriptionById","name":"Get a Prescription","isWebhook":false,"pointer":"/paths/~1v1~1prescriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Prescription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific prescription by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"The ID of the prescription to retrieve.","required":true}],"pointer":"/paths/~1v1~1prescriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/prescriptions/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/prescriptions/{id}","href":"prescriptions/getprescriptionbyid","openApiOperationId":"getPrescriptionById","summary":"Get a Prescription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPrescriptionResponseBody"}},"schemaId":"components/schemas/GetPrescriptionResponseBody"},{"code":"400","description":"Validation error (e.g., invalid ID format)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Prescription not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1prescriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPrescriptionResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPrescriptionResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/getprescriptionbyid"}],"panels":[]}]},"httpPath":"/v1/prescriptions/{id}"},{"label":"List Prescriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/listprescriptions","routeSlug":"/apis/public-api/openapi/prescriptions/listprescriptions","metadata":{"seo":{"title":"List Prescriptions","description":"Retrieves a list of all prescriptions for a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPrescriptions","name":"List Prescriptions","isWebhook":false,"pointer":"/paths/~1v2~1prescriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Prescriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all prescriptions for a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_78"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"patient_id","in":"query","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v2~1prescriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/prescriptions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_78"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"patient_id","in":"query","required":true,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/prescriptions","href":"prescriptions/listprescriptions","openApiOperationId":"listPrescriptions","summary":"List Prescriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrescriptionsListResponseV2"}},"schemaId":"components/schemas/PrescriptionsListResponseV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1prescriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrescriptionsListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrescriptionsListResponseV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/listprescriptions"}],"panels":[]}]},"httpPath":"/v2/prescriptions"},{"label":"Create Prescription with Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createprescriptionwithpatient","routeSlug":"/apis/public-api/openapi/prescriptions/createprescriptionwithpatient","metadata":{"seo":{"title":"Create Prescription with Patient","description":"Creates a new prescription and associates it with a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPrescriptionWithPatient","name":"Create Prescription with Patient","isWebhook":false,"pointer":"/paths/~1v2~1prescriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Prescription with Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new prescription and associates it with a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"schemaId":"components/schemas/CreatePrescriptionBody","pointer":"/paths/~1v2~1prescriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/prescriptions","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/prescriptions","href":"prescriptions/createprescriptionwithpatient","openApiOperationId":"createPrescriptionWithPatient","summary":"Create Prescription with Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CreatePrescriptionBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionResponseBody"}},"schemaId":"components/schemas/CreatePrescriptionResponseBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1prescriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePrescriptionResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePrescriptionResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/createprescriptionwithpatient"}],"panels":[]}]},"httpPath":"/v2/prescriptions"},{"label":"Get Prescriber","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/getprescriber","routeSlug":"/apis/public-api/openapi/prescriptions/getprescriber","metadata":{"seo":{"title":"Get Prescriber","description":"Retrieves a prescriber by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrescriber","name":"Get Prescriber","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1prescriber~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Prescriber","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a prescriber by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1prescriber~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/prescriber/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/prescriber/{id}","href":"prescriptions/getprescriber","openApiOperationId":"getPrescriber","summary":"Get Prescriber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrescriberGetResponse"}},"schemaId":"components/schemas/PrescriberGetResponse"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1prescriber~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrescriberGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrescriberGetResponse"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/getprescriber"}],"panels":[]}]},"httpPath":"/v1/prescriber/{id}"}],"content":{"contentType":"group","meta":{"name":"Prescriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prescriptions","showPageActions":true},{"nodeType":"markdoc","content":"Create, list, and manage prescriptions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/prescriber/{id}/pharmacies","summary":"Get Prescriber's Pharmacies List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prescriptions/listprescriberpharmacies","deprecated":false},{"title":"/v1/pharmacies","summary":"Create Pharmacy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prescriptions/createpharmacy","deprecated":false},{"title":"/v1/prescriptions","summary":"Create a Prescription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prescriptions/createprescription","deprecated":false},{"title":"/v1/prescriptions/{id}","summary":"Get a Prescription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prescriptions/getprescriptionbyid","deprecated":false},{"title":"/v2/prescriptions","summary":"List Prescriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prescriptions/listprescriptions","deprecated":false},{"title":"/v2/prescriptions","summary":"Create Prescription with Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prescriptions/createprescriptionwithpatient","deprecated":false},{"title":"/v1/prescriber/{id}","summary":"Get Prescriber","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/prescriptions/getprescriber","deprecated":true}]}]}]}]}},{"type":"group","label":"Customers","link":"/apis/public-api/openapi/customers","routeSlug":"/apis/public-api/openapi/customers","items":[{"label":"List Customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/listcustomers","routeSlug":"/apis/public-api/openapi/customers/listcustomers","metadata":{"seo":{"title":"List Customers","description":"Retrieves a list of Stripe customers for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomers","name":"List Customers","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of Stripe customers for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"query","in":"query","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1invoicing~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoicing/customers","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"query","in":"query","required":true,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/customers","href":"customers/listcustomers","openApiOperationId":"listCustomers","summary":"List Customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerList"}},"schemaId":"components/schemas/CustomerList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomers"}],"panels":[]}]},"httpPath":"/v1/invoicing/customers"},{"label":"Create Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/createcustomer","routeSlug":"/apis/public-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Create Customer","description":"Creates a new Stripe customer for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomer","name":"Create Customer","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Stripe customer for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCreateBody"}},"schemaId":"components/schemas/CustomerCreateBody","pointer":"/paths/~1v1~1invoicing~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/invoicing/customers","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerCreateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/customers","href":"customers/createcustomer","openApiOperationId":"createCustomer","summary":"Create Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/CustomerCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomer"}],"panels":[]}]},"httpPath":"/v1/invoicing/customers"},{"label":"Get Default Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/getdefaultcustomer","routeSlug":"/apis/public-api/openapi/customers/getdefaultcustomer","metadata":{"seo":{"title":"Get Default Customer","description":"Retrieves the default Stripe customer for a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultCustomer","name":"Get Default Customer","isWebhook":false,"pointer":"/paths/~1v1~1invoicing~1customers~1default/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Default Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the default Stripe customer for a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"patient_id","in":"query","schemaId":"schema_52","description":"The unique identifier of the patient","required":true}],"pointer":"/paths/~1v1~1invoicing~1customers~1default/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/invoicing/customers/default","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"patient_id","in":"query","required":true,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/invoicing/customers/default","href":"customers/getdefaultcustomer","openApiOperationId":"getDefaultCustomer","summary":"Get Default Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}},"schemaId":"components/schemas/Customer"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"No default customer found for patient"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1invoicing~1customers~1default/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getdefaultcustomer"}],"panels":[]}]},"httpPath":"/v1/invoicing/customers/default"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Create, list, and retrieve invoicing customers for a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/invoicing/customers","summary":"List Customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/listcustomers","deprecated":false},{"title":"/v1/invoicing/customers","summary":"Create Customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomer","deprecated":false},{"title":"/v1/invoicing/customers/default","summary":"Get Default Customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getdefaultcustomer","deprecated":false}]}]}]}]}},{"type":"separator","label":"Forms & Templates","content":null},{"type":"group","label":"Form","link":"/apis/public-api/openapi/form","routeSlug":"/apis/public-api/openapi/form","items":[{"label":"List Forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/listforms","routeSlug":"/apis/public-api/openapi/form/listforms","metadata":{"seo":{"title":"List Forms","description":"Retrieves a list of all forms configured for the requesting practice group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listForms","name":"List Forms","isWebhook":false,"pointer":"/paths/~1v1~1forms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all forms configured for the requesting practice group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_52"},{"name":"reply_form","in":"query","schemaId":"schema_54"},{"name":"form_type","in":"query","schemaId":"schema_89"}],"pointer":"/paths/~1v1~1forms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/forms","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_52"},{"name":"reply_form","in":"query","required":false,"schemaId":"schema_54"},{"name":"form_type","in":"query","required":false,"schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/forms","href":"form/listforms","openApiOperationId":"listForms","summary":"List Forms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormList"}},"schemaId":"components/schemas/FormList"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormList"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/listforms"}],"panels":[]}]},"httpPath":"/v1/forms"},{"label":"Create Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/createform","routeSlug":"/apis/public-api/openapi/form/createform","metadata":{"seo":{"title":"Create Form","description":"Create a new form template with fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createForm","name":"Create Form","isWebhook":false,"pointer":"/paths/~1v1~1forms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new form template with fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"schemaId":"components/schemas/FormCreateBody","pointer":"/paths/~1v1~1forms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/forms","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"responseCodes":["201","400","401","429","500"],"pointer":"/v1/forms","href":"form/createform","openApiOperationId":"createForm","summary":"Create Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/FormCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberQuery"}},"schemaId":"components/schemas/AdminPrescriberQuery"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/AdminPrescriberQuery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberQuery"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/createform"}],"panels":[]}]},"httpPath":"/v1/forms"},{"label":"Update Form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/updateform","routeSlug":"/apis/public-api/openapi/form/updateform","metadata":{"seo":{"title":"Update Form","description":"Update an existing form template, replacing all fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateForm","name":"Update Form","isWebhook":false,"pointer":"/paths/~1v1~1forms~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing form template, replacing all fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1forms~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"schemaId":"components/schemas/FormCreateBody","pointer":"/paths/~1v1~1forms~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/forms/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/forms/{id}","href":"form/updateform","openApiOperationId":"updateForm","summary":"Update Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/FormCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberQuery"}},"schemaId":"components/schemas/AdminPrescriberQuery"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdminPrescriberQuery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdminPrescriberQuery"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/updateform"}],"panels":[]}]},"httpPath":"/v1/forms/{id}"},{"label":"Get Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/getform","routeSlug":"/apis/public-api/openapi/form/getform","metadata":{"seo":{"title":"Get Form","description":"Get a form and its fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getForm","name":"Get Form","isWebhook":false,"pointer":"/paths/~1v1~1forms~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a form and its fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1forms~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/forms/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/forms/{id}","href":"form/getform","openApiOperationId":"getForm","summary":"Get Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormDto"}},"schemaId":"components/schemas/FormDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/getform"}],"panels":[]}]},"httpPath":"/v1/forms/{id}"},{"label":"Create Form Response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/createresponse","routeSlug":"/apis/public-api/openapi/form/createresponse","metadata":{"seo":{"title":"Create Form Response","description":"Create a response for a given Form ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createResponse","name":"Create Form Response","isWebhook":false,"pointer":"/paths/~1v1~1forms~1{id}~1response/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Form Response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a response for a given Form ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1forms~1{id}~1response/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormResponseCreateBody"}},"schemaId":"components/schemas/FormResponseCreateBody","pointer":"/paths/~1v1~1forms~1{id}~1response/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/forms/{id}/response","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormResponseCreateBody"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/forms/{id}/response","href":"form/createresponse","openApiOperationId":"createResponse","summary":"Create Form Response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/FormResponseCreateBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormResponseCreateBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseBody"}},"schemaId":"components/schemas/FormResponseBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"403","description":"Forbidden - missing policy or scope"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms~1{id}~1response/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/createresponse"}],"panels":[]}]},"httpPath":"/v1/forms/{id}/response"},{"label":"Update Form Response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/updateformresponse","routeSlug":"/apis/public-api/openapi/form/updateformresponse","metadata":{"seo":{"title":"Update Form Response","description":"Update form response for a given form response ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFormResponse","name":"Update Form Response","isWebhook":false,"pointer":"/paths/~1v1~1forms~1response~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Form Response","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update form response for a given form response ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1forms~1response~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormResponseSaveToRecordBody"}},"schemaId":"components/schemas/FormResponseSaveToRecordBody","pointer":"/paths/~1v1~1forms~1response~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/forms/response/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormResponseSaveToRecordBody"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v1/forms/response/{id}","href":"form/updateformresponse","openApiOperationId":"updateFormResponse","summary":"Update Form Response"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"schemaId":"components/schemas/FormResponseSaveToRecordBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormResponseSaveToRecordBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseBody"}},"schemaId":"components/schemas/FormResponseBody"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"403","description":"Forbidden - missing policy or scope"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1forms~1response~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseBody"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/updateformresponse"}],"panels":[]}]},"httpPath":"/v1/forms/response/{id}"}],"content":{"contentType":"group","meta":{"name":"Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Form","showPageActions":true},{"nodeType":"markdoc","content":"List and retrieve forms (questionnaires) configured for a practice group."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/forms","summary":"List Forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/listforms","deprecated":false},{"title":"/v1/forms","summary":"Create Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/form/createform","deprecated":false},{"title":"/v1/forms/{id}","summary":"Update Form","prefix":{"name":"put","color":"put"},"badges":[],"link":"/form/updateform","deprecated":false},{"title":"/v1/forms/{id}","summary":"Get Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/getform","deprecated":false},{"title":"/v1/forms/{id}/response","summary":"Create Form Response","prefix":{"name":"post","color":"post"},"badges":[],"link":"/form/createresponse","deprecated":false},{"title":"/v1/forms/response/{id}","summary":"Update Form Response","prefix":{"name":"post","color":"post"},"badges":[],"link":"/form/updateformresponse","deprecated":false}]}]}]}]}},{"type":"group","label":"Form Response","link":"/apis/public-api/openapi/form-response","routeSlug":"/apis/public-api/openapi/form-response","items":[{"label":"Get FormResponse","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/getformresponse","routeSlug":"/apis/public-api/openapi/form-response/getformresponse","metadata":{"seo":{"title":"Get FormResponse","description":"Get a form response and its fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFormResponse","name":"Get FormResponse","isWebhook":false,"pointer":"/paths/~1v1~1form_response~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FormResponse","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a form response and its fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1form_response~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/form_response/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/form_response/{id}","href":"form-response/getformresponse","openApiOperationId":"getFormResponse","summary":"Get FormResponse"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseDto"}},"schemaId":"components/schemas/FormResponseDto"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1form_response~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponseDto"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form-response/getformresponse"}],"panels":[]}]},"httpPath":"/v1/form_response/{id}"},{"label":"Get FormSubmissionResponse","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/getformsubmissionresponsedata","routeSlug":"/apis/public-api/openapi/form-response/getformsubmissionresponsedata","metadata":{"seo":{"title":"Get FormSubmissionResponse","description":"Get a form submission response and its fields. An acting admin without the required policies still receives the response, with the attachment link and file name removed from any attachment answer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFormSubmissionResponseData","name":"Get FormSubmissionResponse","isWebhook":false,"pointer":"/paths/~1v1~1form_submission_response~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FormSubmissionResponse","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a form submission response and its fields. An acting admin without the required policies still receives the response, with the attachment link and file name removed from any attachment answer.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","required":true}],"pointer":"/paths/~1v1~1form_submission_response~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/form_submission_response/{id}","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/form_submission_response/{id}","href":"form-response/getformsubmissionresponsedata","openApiOperationId":"getFormSubmissionResponseData","summary":"Get FormSubmissionResponse"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormSubmissionResponseDTO"}},"schemaId":"components/schemas/FormSubmissionResponseDTO"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v1~1form_submission_response~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormSubmissionResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormSubmissionResponseDTO"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form-response/getformsubmissionresponsedata"}],"panels":[]}]},"httpPath":"/v1/form_submission_response/{id}"},{"label":"List Form Responses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/listformresponses","routeSlug":"/apis/public-api/openapi/form-response/listformresponses","metadata":{"seo":{"title":"List Form Responses","description":"Retrieves a list of all form responses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFormResponses","name":"List Form Responses","isWebhook":false,"pointer":"/paths/~1v2~1form_responses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Form Responses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all form responses."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links)."},{"name":"practiceGroupId","scopes":[],"type":"apiKey","in":"header","paramName":"x-practice-group-id","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_index","in":"query","schemaId":"schema_52"},{"name":"page_size","in":"query","schemaId":"schema_52"},{"name":"order_by","in":"query","schemaId":"schema_90"},{"name":"status","in":"query","schemaId":"components/schemas/ConsultationWtrStatus"},{"name":"order_descending","in":"query","schemaId":"schema_54"},{"name":"patient_first_name","in":"query","schemaId":"schema_52"},{"name":"patient_last_name","in":"query","schemaId":"schema_52"},{"name":"patient_full_name","in":"query","schemaId":"schema_52"},{"name":"form_title","in":"query","schemaId":"schema_52"},{"name":"form_type","in":"query","schemaId":"schema_52"},{"name":"patient_id","in":"query","schemaId":"schema_52"},{"name":"created_at[]","in":"query","schemaId":"schema_53"},{"name":"service","in":"query","schemaId":"schema_52"}],"pointer":"/paths/~1v2~1form_responses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/form_responses","servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page_index","in":"query","required":false,"schemaId":"schema_52"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_52"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_90"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/ConsultationWtrStatus"},{"name":"order_descending","in":"query","required":false,"schemaId":"schema_54"},{"name":"patient_first_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_last_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_full_name","in":"query","required":false,"schemaId":"schema_52"},{"name":"form_title","in":"query","required":false,"schemaId":"schema_52"},{"name":"form_type","in":"query","required":false,"schemaId":"schema_52"},{"name":"patient_id","in":"query","required":false,"schemaId":"schema_52"},{"name":"created_at[]","in":"query","required":false,"schemaId":"schema_53"},{"name":"service","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"x-api-key","in":"header"},{"id":"practiceGroupId","type":"apiKey","name":"x-practice-group-id","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v2/form_responses","href":"form-response/listformresponses","openApiOperationId":"listFormResponses","summary":"List Form Responses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/public-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponsesListResponseV2"}},"schemaId":"components/schemas/FormResponsesListResponseV2"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}},"schemaId":"components/schemas/ValidationError"},{"code":"401","description":"Unauthorised"},{"code":"404","description":"Not found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Unknown error"}],"pointer":"/paths/~1v2~1form_responses/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormResponsesListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormResponsesListResponseV2"}}},{"code":"400","schemaId":"components/schemas/ValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationError"}}},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form-response/listformresponses"}],"panels":[]}]},"httpPath":"/v2/form_responses"}],"content":{"contentType":"group","meta":{"name":"Form Response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Form Response","showPageActions":true},{"nodeType":"markdoc","content":"Create, retrieve, and update form responses submitted by patients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/form_response/{id}","summary":"Get FormResponse","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form-response/getformresponse","deprecated":false},{"title":"/v1/form_submission_response/{id}","summary":"Get FormSubmissionResponse","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form-response/getformsubmissionresponsedata","deprecated":false},{"title":"/v2/form_responses","summary":"List Form Responses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form-response/listformresponses","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AddressDto":{"id":"components/schemas/AddressDto","kind":"json-schema","title":"AddressDto","data":{"properties":{"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["line_1","line_2","line_3","town","county","postcode"]}},"components/schemas/AddressBody":{"id":"components/schemas/AddressBody","kind":"json-schema","title":"AddressBody","data":{"properties":{"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"}},"type":"object"}},"components/schemas/paginateSchema":{"id":"components/schemas/paginateSchema","kind":"json-schema","title":"paginateSchema","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true}},"type":"object"}},"components/schemas/Sex":{"id":"components/schemas/Sex","kind":"json-schema","title":"Sex","data":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]}},"components/schemas/Title":{"id":"components/schemas/Title","kind":"json-schema","title":"Title","data":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]}},"components/schemas/PatientIdentifier":{"id":"components/schemas/PatientIdentifier","kind":"json-schema","title":"PatientIdentifier","data":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"components/schemas/AdminTeamFromDb":{"id":"components/schemas/AdminTeamFromDb","kind":"json-schema","title":"AdminTeamFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"components/schemas/AdminTeamListResponse":{"id":"components/schemas/AdminTeamListResponse","kind":"json-schema","title":"AdminTeamListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AdminTeamListQuery":{"id":"components/schemas/AdminTeamListQuery","kind":"json-schema","title":"AdminTeamListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["admin_team_name"]},"order_descending":{"type":"string"},"admin_team_name":{"type":"string"},"admin_id":{"type":"string","pattern":"^\\d+$"}},"type":"object"}},"components/schemas/AdminTeamCreateBody":{"id":"components/schemas/AdminTeamCreateBody","kind":"json-schema","title":"AdminTeamCreateBody","data":{"properties":{"name":{"type":"string","minLength":1,"description":"The name of the admin team.","example":"Triage Team"},"admin_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"minItems":1,"description":"An array of admin user IDs to assign as members of the team.","example":"[\"1\", \"2\"]"}},"type":"object","required":["name","admin_ids"]}},"components/schemas/AdminTeamCreateResponse":{"id":"components/schemas/AdminTeamCreateResponse","kind":"json-schema","title":"AdminTeamCreateResponse","data":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"practice_group_id":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","name","practice_group_id","created_at","updated_at"]}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"type":"string","enum":["form_response","communication","consultation","prescription"]}},"components/schemas/WriteToRecordBody":{"id":"components/schemas/WriteToRecordBody","kind":"json-schema","title":"WriteToRecordBody","data":{"properties":{"resource_id":{"type":"string","pattern":"^\\d+$"},"resource_type":{"type":"string","enum":["form_response","communication","consultation","prescription"]}},"type":"object","required":["resource_id","resource_type"]}},"components/schemas/WriteToRecordResult":{"id":"components/schemas/WriteToRecordResult","kind":"json-schema","title":"WriteToRecordResult","data":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"success":{"type":"boolean"},"auth_token":{"type":"string","nullable":true},"confirm_write_to_record_url":{"type":"string","nullable":true}},"type":"object","required":["type","success"]}},"components/schemas/WriteToRecordStatusResponse":{"id":"components/schemas/WriteToRecordStatusResponse","kind":"json-schema","title":"WriteToRecordStatusResponse","data":{"properties":{"resource_type":{"type":"string","enum":["form_response","communication","consultation","prescription"]},"resource_id":{"type":"string"},"status":{"type":"string","enum":["pending","success","failed","permanent_failure","in_progress"]},"details":{"type":"string","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"write_to_record_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["resource_type","resource_id","status","updated_at","write_to_record_at"]}},"components/schemas/WriteToRecordStatusQuery":{"id":"components/schemas/WriteToRecordStatusQuery","kind":"json-schema","title":"WriteToRecordStatusQuery","data":{"properties":{"resource_type":{"type":"string","enum":["form_response","communication","consultation","prescription"]},"resource_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["resource_type","resource_id"]}},"components/schemas/AccessTokenResponse":{"id":"components/schemas/AccessTokenResponse","kind":"json-schema","title":"AccessTokenResponse","data":{"properties":{"access_token":{"type":"string"}},"type":"object","required":["access_token"]}},"components/schemas/AccessTokenPayload":{"id":"components/schemas/AccessTokenPayload","kind":"json-schema","title":"AccessTokenPayload","data":{"properties":{"practiceGroupId":{"type":"string"},"adminId":{"type":"string"},"partnerId":{"type":"string"},"scopes":{"oneOf":[{"type":"array","items":{"type":"string","enum":["messaging_api","messaging_api_with_auto_write_to_record","form_response_api_with_auto_write_to_record","advanced_messaging_api","booking_link_api","booking_api","diary_api","invoicing_api","prescription_api","tasks_api","webhooks_api","internal_api","inbox_api","medical_record","booking_hca_api","subscriptions_api","registered_practitioner","manage_partners_api_keys","short_link_api","internal_endpoints"]}},{"type":"string","enum":["*"]}]}},"type":"object","required":["practiceGroupId"]}},"components/schemas/AdminDto":{"id":"components/schemas/AdminDto","kind":"json-schema","title":"AdminDto","data":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"external_prescriber_id":{"type":"string","nullable":true},"signature":{"type":"string","nullable":true},"linked_practitioner_id":{"type":"string","nullable":true},"preferences":{"properties":{"default_notification_channel":{"type":"string","enum":["email","sms","nhs_app_email","nhs_app_sms"]}},"type":"object","required":["default_notification_channel"]},"team_memberships":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"role":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"key":{"type":"string","description":"Stable slug for Hero-wide (system) roles; null for practice-group roles","nullable":true},"nhs_role_code":{"type":"string","description":"NHS National RBAC access role code, e.g. R8009","nullable":true},"system":{"type":"boolean","description":"True for Hero-wide roles available to every practice group"},"grants":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policies and wildcard patterns (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patients.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as stored on the role"},"children":[]}]}]}]},"policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"The grants expanded to concrete policies"}},"type":"object","required":["id","name","key","nhs_role_code","system","grants","policies"],"description":"The RBAC role held in the caller practice group","nullable":true},"policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"Effective policies in the caller practice group (role grants expanded); empty without a role"},"revoked_policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"Policies the role grants that this membership has had withdrawn, expanded. Still present in policies, so subtract these to get what this admin may actually do. The API enforces that subtraction on its own endpoints."}},"type":"object","required":["id","first_name","last_name","email","external_prescriber_id","signature","linked_practitioner_id","preferences","team_memberships","role","policies","revoked_policies"]}},"components/schemas/AdminUpdateBody":{"id":"components/schemas/AdminUpdateBody","kind":"json-schema","title":"AdminUpdateBody","data":{"properties":{"external_prescriber_id":{"type":"string","minLength":1,"nullable":true},"prescriber_details":{"properties":{"name":{"type":"string","minLength":1,"nullable":true},"email":{"type":"string","minLength":1,"format":"email","nullable":true},"registration_code":{"type":"string","minLength":1,"nullable":true}},"type":"object","nullable":true}},"type":"object"}},"components/schemas/AdminUpdateResponse":{"id":"components/schemas/AdminUpdateResponse","kind":"json-schema","title":"AdminUpdateResponse","data":{"properties":{"admin_id":{"type":"string"}},"type":"object","required":["admin_id"]}},"components/schemas/AdminUpsertSignatureBody":{"id":"components/schemas/AdminUpsertSignatureBody","kind":"json-schema","title":"AdminUpsertSignatureBody","data":{"properties":{"signature":{"type":"string","minLength":1}},"type":"object","required":["signature"]}},"components/schemas/AdminUpsertPreferencesBody":{"id":"components/schemas/AdminUpsertPreferencesBody","kind":"json-schema","title":"AdminUpsertPreferencesBody","data":{"properties":{"default_notification_channel":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/ListAdminFromDb":{"id":"components/schemas/ListAdminFromDb","kind":"json-schema","title":"ListAdminFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"external_prescriber_id":{"type":"string","nullable":true},"prescriber_details":{"properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"registration_code":{"type":"string","nullable":true}},"type":"object","nullable":true},"linked_practitioner_id":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name","email","external_prescriber_id","linked_practitioner_id"]}},"components/schemas/AdminListResponse":{"id":"components/schemas/AdminListResponse","kind":"json-schema","title":"AdminListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"external_prescriber_id":{"type":"string","nullable":true},"prescriber_details":{"properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"registration_code":{"type":"string","nullable":true}},"type":"object","nullable":true},"linked_practitioner_id":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name","email","external_prescriber_id","linked_practitioner_id"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AdminListQuery":{"id":"components/schemas/AdminListQuery","kind":"json-schema","title":"AdminListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["first_name"]},"order_descending":{"type":"string","enum":["true","false"]},"first_name":{"type":"string"}},"type":"object"}},"components/schemas/AdminPrescriberQuery":{"id":"components/schemas/AdminPrescriberQuery","kind":"json-schema","title":"AdminPrescriberQuery","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/AdminPrescriberResponse":{"id":"components/schemas/AdminPrescriberResponse","kind":"json-schema","title":"AdminPrescriberResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"email":{"type":"string","format":"email"},"full_name":{"type":"string"},"registration_code":{"type":"string"}},"type":"object","required":["id","email","full_name","registration_code"]}},"components/schemas/ApiKeysListQuery":{"id":"components/schemas/ApiKeysListQuery","kind":"json-schema","title":"ApiKeysListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"order_descending":{"type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/ApiKeyFromDb":{"id":"components/schemas/ApiKeyFromDb","kind":"json-schema","title":"ApiKeyFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"key":{"type":"string"},"expire_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"partner":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"type":"object","required":["id","key","expire_at","created_at","partner"]}},"components/schemas/ApiKeysListResponse":{"id":"components/schemas/ApiKeysListResponse","kind":"json-schema","title":"ApiKeysListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"key":{"type":"string"},"expire_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"partner":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"type":"object","required":["id","key","expire_at","created_at","partner"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CreateApiKeysBody":{"id":"components/schemas/CreateApiKeysBody","kind":"json-schema","title":"CreateApiKeysBody","data":{"properties":{"partner_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["partner_id"]}},"components/schemas/CreateApiKeysBodyResponse":{"id":"components/schemas/CreateApiKeysBodyResponse","kind":"json-schema","title":"CreateApiKeysBodyResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"key":{"type":"string"},"partner":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"expire_at":{"type":"string","nullable":true},"created_at":{"type":"string"}},"type":"object","required":["id","key","partner","created_at"]}},"components/schemas/ApiKeyGetParam":{"id":"components/schemas/ApiKeyGetParam","kind":"json-schema","title":"ApiKeyGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AssigneeType":{"id":"components/schemas/AssigneeType","kind":"json-schema","title":"AssigneeType","data":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true}},"components/schemas/StripeAppointmentItem":{"id":"components/schemas/StripeAppointmentItem","kind":"json-schema","title":"StripeAppointmentItem","data":{"properties":{"product_id":{"type":"string"},"price_id":{"type":"string","nullable":true},"quantity":{"type":"number","nullable":true}},"type":"object","required":["product_id","price_id","quantity"]}},"components/schemas/AppointmentTypeListDto":{"id":"components/schemas/AppointmentTypeListDto","kind":"json-schema","title":"AppointmentTypeListDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_slot_name":{"type":"string"},"next_available_at":{"type":"string","format":"date-time","nullable":true},"slot_count":{"type":"number"},"price":{"type":"number"},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"sector":{"type":"string","enum":["nhs","paid"]},"duration":{"type":"number","nullable":true},"video":{"default":false,"type":"boolean"},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"use_partner_bookable_slots":{"type":"boolean"},"admin_booking_invoice_required":{"type":"boolean"},"stripe_appointment_items":{"type":"array","items":{"properties":{"product_id":{"type":"string"},"price_id":{"type":"string","nullable":true},"quantity":{"type":"number","nullable":true}},"type":"object","required":["product_id","price_id","quantity"]}},"form_id":{"type":"string","nullable":true},"practitioner_type":{"type":"string","enum":["GP","Nurse","Psychologist","Radiologist","Psychiatrist","Health and Exercise Consultant","Personal Trainer","Cognitive Behavioural Therapist","GP – Dermatology Specialist","Rheumatologist","Pharmacy Service","Yoga Instructor","Plastic and Reconstructive Surgeon","Gastroenterologist"]}},"type":"object","required":["id","name","partner_slot_name","next_available_at","slot_count","price","assignee_id","assignee_type","duration","use_partner_bookable_slots","form_id","practitioner_type"]}},"components/schemas/AppointmentTypeListQuery":{"id":"components/schemas/AppointmentTypeListQuery","kind":"json-schema","title":"AppointmentTypeListQuery","data":{"properties":{"location_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"has_availability":{"type":"boolean","nullable":true}},"type":"object"}},"components/schemas/AppointmentTypeList":{"id":"components/schemas/AppointmentTypeList","kind":"json-schema","title":"AppointmentTypeList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_slot_name":{"type":"string"},"next_available_at":{"type":"string","format":"date-time","nullable":true},"slot_count":{"type":"number"},"price":{"type":"number"},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"sector":{"type":"string","enum":["nhs","paid"]},"duration":{"type":"number","nullable":true},"video":{"default":false,"type":"boolean"},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"use_partner_bookable_slots":{"type":"boolean"},"admin_booking_invoice_required":{"type":"boolean"},"stripe_appointment_items":{"type":"array","items":{"properties":{"product_id":{"type":"string"},"price_id":{"type":"string","nullable":true},"quantity":{"type":"number","nullable":true}},"type":"object","required":["product_id","price_id","quantity"]}},"form_id":{"type":"string","nullable":true},"practitioner_type":{"type":"string","enum":["GP","Nurse","Psychologist","Radiologist","Psychiatrist","Health and Exercise Consultant","Personal Trainer","Cognitive Behavioural Therapist","GP – Dermatology Specialist","Rheumatologist","Pharmacy Service","Yoga Instructor","Plastic and Reconstructive Surgeon","Gastroenterologist"]}},"type":"object","required":["id","name","partner_slot_name","next_available_at","slot_count","price","assignee_id","assignee_type","duration","use_partner_bookable_slots","form_id","practitioner_type"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/BookingMechanism":{"id":"components/schemas/BookingMechanism","kind":"json-schema","title":"BookingMechanism","data":{"type":"string","enum":["hero_confirmed","ehr_confirmed"]}},"components/schemas/TriggeredByBody":{"id":"components/schemas/TriggeredByBody","kind":"json-schema","title":"TriggeredByBody","data":{"type":"string","enum":["patient","admin"]}},"components/schemas/HeroConfirmedStatus":{"id":"components/schemas/HeroConfirmedStatus","kind":"json-schema","title":"HeroConfirmedStatus","data":{"type":"string","enum":["reserved","confirmed","cancelled"]}},"components/schemas/EhrConfirmedStatus":{"id":"components/schemas/EhrConfirmedStatus","kind":"json-schema","title":"EhrConfirmedStatus","data":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"components/schemas/AppointmentActionParam":{"id":"components/schemas/AppointmentActionParam","kind":"json-schema","title":"AppointmentActionParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentGetParam":{"id":"components/schemas/AppointmentGetParam","kind":"json-schema","title":"AppointmentGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentGet":{"id":"components/schemas/AppointmentGet","kind":"json-schema","title":"AppointmentGet","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient_id":{"type":"string","pattern":"^\\d+$","nullable":true},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"duration":{"type":"number","minimum":1},"start_time":{"type":"string","format":"date-time","nullable":true},"video":{"default":false,"type":"boolean"},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"video_url":{"type":"string","nullable":true},"link_id":{"type":"string","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"suppress_mail":{"default":false,"type":"boolean"},"reason":{"type":"string","nullable":true},"appointment_template_name":{"type":"string","nullable":true},"location_name":{"type":"string","nullable":true},"appointment_source":{"type":"string","nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"]},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id"],"nullable":true},"practitioner":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id"],"nullable":true}},"type":"object","required":["id","practitioner_id","location_id","appointment_type_id","start_time","reason","appointment_template_name","location_name","appointment_source","booking_mechanism","booking_status","cancelled_at"]}},"components/schemas/AppointmentReserveBody":{"id":"components/schemas/AppointmentReserveBody","kind":"json-schema","title":"AppointmentReserveBody","data":{"properties":{"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"duration":{"type":"number"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"patient_id":{"type":"string","pattern":"^\\d+$"},"billpayer_id":{"type":"string","pattern":"^\\d+$"},"reason":{"type":"string"},"suppress_mail":{"type":"boolean"},"suppress_availability_check":{"type":"boolean"},"suppress_eligibility_check":{"default":true,"type":"boolean"},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ehr_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appointments must be managed via the v2 endpoints; v1 supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hero_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]}},"type":"object","required":["appointment_type_id","location_id","practitioner_id","duration","start_time"]}},"components/schemas/AppointmentReserveResponse":{"id":"components/schemas/AppointmentReserveResponse","kind":"json-schema","title":"AppointmentReserveResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"reserved_until":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","reserved_until"]}},"components/schemas/AppointmentBookParam":{"id":"components/schemas/AppointmentBookParam","kind":"json-schema","title":"AppointmentBookParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentBookBody":{"id":"components/schemas/AppointmentBookBody","kind":"json-schema","title":"AppointmentBookBody","data":{"properties":{"reason":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"billpayer_id":{"type":"string","pattern":"^\\d+$"},"suppress_invoice":{"type":"boolean"},"suppress_availability_check":{"type":"boolean"},"externally_paid":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/AppointmentCancelParam":{"id":"components/schemas/AppointmentCancelParam","kind":"json-schema","title":"AppointmentCancelParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentCancelBody":{"id":"components/schemas/AppointmentCancelBody","kind":"json-schema","title":"AppointmentCancelBody","data":{"properties":{"suppress_mail":{"type":"boolean"},"suppress_cancellation_policy":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object"}},"components/schemas/AppointmentRescheduleParam":{"id":"components/schemas/AppointmentRescheduleParam","kind":"json-schema","title":"AppointmentRescheduleParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentRescheduleBody":{"id":"components/schemas/AppointmentRescheduleBody","kind":"json-schema","title":"AppointmentRescheduleBody","data":{"properties":{"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"duration":{"type":"number"},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"suppress_availability_check":{"type":"boolean"},"suppress_mail":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["start_time","duration","practitioner_id"]}},"components/schemas/AppointmentStatusGetParam":{"id":"components/schemas/AppointmentStatusGetParam","kind":"json-schema","title":"AppointmentStatusGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentStatusGet":{"id":"components/schemas/AppointmentStatusGet","kind":"json-schema","title":"AppointmentStatusGet","data":{"properties":{"status":{"oneOf":[{"type":"string","enum":["reserved","confirmed","cancelled"]},{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}]},"ehr_partner_status":{"type":"string","nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"]},"failure_reason":{"type":"string","nullable":true},"failure_code":{"type":"string","nullable":true}},"type":"object","required":["status","ehr_partner_status","booking_mechanism","failure_reason","failure_code"]}},"components/schemas/AttachmentLinkCreateObject":{"id":"components/schemas/AttachmentLinkCreateObject","kind":"json-schema","title":"AttachmentLinkCreateObject","data":{"properties":{"expiry_date":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"},"ehr_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID retrieved from List Patient Attachments endpoint. If not provided, file_data must be provided."},"children":[]}]}]}]},"file_data":{"type":"string","description":"Base 64 representation of a file. Up to 2MB."},"file_name":{"type":"string","minLength":1},"patient_id":{"type":"string","pattern":"^\\d+$"},"maximum_use_count":{"type":"number","minimum":1}},"type":"object","required":["file_name","patient_id"]}},"components/schemas/AttachmentLinkCreateBody":{"id":"components/schemas/AttachmentLinkCreateBody","kind":"json-schema","title":"AttachmentLinkCreateBody","data":{"properties":{"expiry_date":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"},"ehr_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File ID retrieved from List Patient Attachments endpoint. If not provided, file_data must be provided."},"children":[]}]}]}]},"file_data":{"type":"string","description":"Base 64 representation of a file. Up to 2MB."},"file_name":{"type":"string","minLength":1},"patient_id":{"type":"string","pattern":"^\\d+$"},"maximum_use_count":{"type":"number","minimum":1}},"type":"object","required":["file_name","patient_id"]}},"components/schemas/AttachmentLinkCreateResponse":{"id":"components/schemas/AttachmentLinkCreateResponse","kind":"json-schema","title":"AttachmentLinkCreateResponse","data":{"properties":{"attachment_link":{"type":"string"},"attachment_uuid":{"type":"string"}},"type":"object","required":["attachment_link","attachment_uuid"]}},"components/schemas/AttachmentDto":{"id":"components/schemas/AttachmentDto","kind":"json-schema","title":"AttachmentDto","data":{"properties":{"ehr_partner_file_id":{"type":"string"},"file_name":{"type":"string"},"file_extension":{"type":"string"},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["ehr_partner_file_id","file_name","file_extension","created_at"]}},"components/schemas/AttachmentList":{"id":"components/schemas/AttachmentList","kind":"json-schema","title":"AttachmentList","data":{"properties":{"data":{"type":"array","items":{"properties":{"ehr_partner_file_id":{"type":"string"},"file_name":{"type":"string"},"file_extension":{"type":"string"},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["ehr_partner_file_id","file_name","file_extension","created_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AutocompleteAddressQuery":{"id":"components/schemas/AutocompleteAddressQuery","kind":"json-schema","title":"AutocompleteAddressQuery","data":{"properties":{"search":{"type":"string"}},"type":"object","required":["search"]}},"components/schemas/AutocompleteSuggestionResponse":{"id":"components/schemas/AutocompleteSuggestionResponse","kind":"json-schema","title":"AutocompleteSuggestionResponse","data":{"properties":{"address":{"type":"string"},"id":{"type":"string"}},"type":"object","required":["address","id"]}},"components/schemas/AutocompleteSuggestionResponseBody":{"id":"components/schemas/AutocompleteSuggestionResponseBody","kind":"json-schema","title":"AutocompleteSuggestionResponseBody","data":{"properties":{"data":{"type":"array","items":{"properties":{"address":{"type":"string"},"id":{"type":"string"}},"type":"object","required":["address","id"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AddressDetailsGetParams":{"id":"components/schemas/AddressDetailsGetParams","kind":"json-schema","title":"AddressDetailsGetParams","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/AddressDetailsResponse":{"id":"components/schemas/AddressDetailsResponse","kind":"json-schema","title":"AddressDetailsResponse","data":{"properties":{"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"county":{"type":"string"},"town":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"}},"type":"object","required":["line_1","line_2","line_3","county","town","postcode","country"]}},"components/schemas/NhsRecipient":{"id":"components/schemas/NhsRecipient","kind":"json-schema","title":"NhsRecipient","data":{"properties":{"nhs_number":{"type":"string"},"dob":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["nhs_number","dob"]}},"components/schemas/HeroRecipient":{"id":"components/schemas/HeroRecipient","kind":"json-schema","title":"HeroRecipient","data":{"properties":{"patient_record_id":{"type":"string"}},"type":"object","required":["patient_record_id"]}},"components/schemas/RecipientInput":{"id":"components/schemas/RecipientInput","kind":"json-schema","title":"RecipientInput","data":{"oneOf":[{"properties":{"nhs_number":{"type":"string"},"dob":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["nhs_number","dob"]},{"properties":{"patient_record_id":{"type":"string"}},"type":"object","required":["patient_record_id"]}]}},"components/schemas/Recipient":{"id":"components/schemas/Recipient","kind":"json-schema","title":"Recipient","data":{"properties":{"enrichment_status":{"type":"string","enum":["CREATED","ENRICHMENT_ERROR","ENRICHED","INVALID_PAYLOAD","QUEUED"]},"first_name":{"type":"string"},"last_name":{"type":"string"},"nhs_number":{"type":"string"},"mobile":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["enrichment_status"]}},"components/schemas/BatchMessage":{"id":"components/schemas/BatchMessage","kind":"json-schema","title":"BatchMessage","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["CREATED","PENDING","SENDING","COMPLETED"]},"channel":{"type":"string","enum":["SMS","EMAIL","NHS_APP"]},"subject":{"type":"string"},"content":{"type":"string"}},"type":"object","required":["id","name","status","channel","content"]}},"components/schemas/BatchMessageActionParam":{"id":"components/schemas/BatchMessageActionParam","kind":"json-schema","title":"BatchMessageActionParam","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/BatchMessageListQuery":{"id":"components/schemas/BatchMessageListQuery","kind":"json-schema","title":"BatchMessageListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"order_descending":{"type":"string"},"status":{"type":"string","enum":["CREATED","PENDING","SENDING","COMPLETED"]}},"type":"object"}},"components/schemas/BatchMessageCreateBody":{"id":"components/schemas/BatchMessageCreateBody","kind":"json-schema","title":"BatchMessageCreateBody","data":{"properties":{"name":{"type":"string"},"channel":{"type":"string","enum":["SMS","EMAIL","NHS_APP"]},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subject is required when channel = EMAIL"},"children":[]}]}]}]},"content":{"type":"string"},"recipients":{"type":"array","items":{"oneOf":[{"properties":{"nhs_number":{"type":"string"},"dob":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["nhs_number","dob"]},{"properties":{"patient_record_id":{"type":"string"}},"type":"object","required":["patient_record_id"]}]}}},"type":"object","required":["name","channel","content","recipients"]}},"components/schemas/RecipientList":{"id":"components/schemas/RecipientList","kind":"json-schema","title":"RecipientList","data":{"properties":{"data":{"type":"array","items":{"properties":{"enrichment_status":{"type":"string","enum":["CREATED","ENRICHMENT_ERROR","ENRICHED","INVALID_PAYLOAD","QUEUED"]},"first_name":{"type":"string"},"last_name":{"type":"string"},"nhs_number":{"type":"string"},"mobile":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["enrichment_status"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/RecipientListQuery":{"id":"components/schemas/RecipientListQuery","kind":"json-schema","title":"RecipientListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"order_descending":{"type":"string"}},"type":"object"}},"components/schemas/Message":{"id":"components/schemas/Message","kind":"json-schema","title":"Message","data":{"properties":{"id":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string","nullable":true},"recipient":{"type":"string"},"channel":{"type":"string","enum":["SMS","EMAIL","NHS_APP"]},"content":{"type":"string"},"sent_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","status","recipient","channel","content","sent_at","created_at"]}},"components/schemas/MessageListQuery":{"id":"components/schemas/MessageListQuery","kind":"json-schema","title":"MessageListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"order_descending":{"type":"string"}},"type":"object"}},"components/schemas/MessageList":{"id":"components/schemas/MessageList","kind":"json-schema","title":"MessageList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"status":{"type":"string"},"subject":{"type":"string","nullable":true},"recipient":{"type":"string"},"channel":{"type":"string","enum":["SMS","EMAIL","NHS_APP"]},"content":{"type":"string"},"sent_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","status","recipient","channel","content","sent_at","created_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/HcaConsultantSearchGet":{"id":"components/schemas/HcaConsultantSearchGet","kind":"json-schema","title":"HcaConsultantSearchGet","data":{"properties":{"search":{"type":"string"},"fields":{"type":"array","items":{"type":"string","enum":["first_name","last_name","speciality","mnemonic","gmc_number","service"]},"minItems":1}},"type":"object","required":["search","fields"]}},"components/schemas/HcaConsultantSearchResponse":{"id":"components/schemas/HcaConsultantSearchResponse","kind":"json-schema","title":"HcaConsultantSearchResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"speciality":{"type":"string"},"mnemonic":{"type":"string"},"gmc_number":{"type":"string","pattern":"^\\d{7}$"},"available_to_book_with_online":{"type":"boolean"},"service":{"type":"string"}},"type":"object","required":["first_name","last_name","speciality","mnemonic","gmc_number","available_to_book_with_online","service"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/HcaConsultantDetailsParams":{"id":"components/schemas/HcaConsultantDetailsParams","kind":"json-schema","title":"HcaConsultantDetailsParams","data":{"properties":{"gmc_number":{"type":"string","pattern":"^\\d{7}$"}},"type":"object","required":["gmc_number"]}},"components/schemas/HcaConsultantDetailsQuery":{"id":"components/schemas/HcaConsultantDetailsQuery","kind":"json-schema","title":"HcaConsultantDetailsQuery","data":{"properties":{"booking_type":{"type":"string","enum":["initial","follow_on"]}},"type":"object","required":["booking_type"]}},"components/schemas/HcaConsultantDetailsResponse":{"id":"components/schemas/HcaConsultantDetailsResponse","kind":"json-schema","title":"HcaConsultantDetailsResponse","data":{"properties":{"hca_consultant_id":{"type":"string"},"crm_id":{"type":"string","format":"uuid"},"provider_type":{"type":"string"},"professional_registration_number":{"type":"string","pattern":"^\\d{7}$"},"provider_main_specialty":{"type":"string"},"title":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"live_diary_booking_available":{"type":"boolean"},"availability":{"type":"array","items":{"properties":{"facility_location":{"type":"string"},"facility_crm_id":{"type":"string","format":"uuid"},"facility_full_name":{"type":"string"},"facility_address":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"first_appointment_slot_date_time":{"type":"string","format":"date-time"}},"type":"object","required":["facility_location","facility_crm_id","facility_full_name","facility_address","latitude","longitude","first_appointment_slot_date_time"]}}},"type":"object","required":["hca_consultant_id","crm_id","provider_type","professional_registration_number","provider_main_specialty","title","first_name","last_name","live_diary_booking_available","availability"]}},"components/schemas/HcaConsultantAvailabilityParams":{"id":"components/schemas/HcaConsultantAvailabilityParams","kind":"json-schema","title":"HcaConsultantAvailabilityParams","data":{"properties":{"crm_id":{"type":"string","format":"uuid"}},"type":"object","required":["crm_id"]}},"components/schemas/HcaConsultantAvailabilityQuery":{"id":"components/schemas/HcaConsultantAvailabilityQuery","kind":"json-schema","title":"HcaConsultantAvailabilityQuery","data":{"properties":{"booking_type":{"type":"string","enum":["initial","follow_on"]},"location_id":{"type":"string","format":"uuid"},"date_from":{"type":"string"},"date_to":{"type":"string"}},"type":"object","required":["booking_type","location_id","date_from","date_to"]}},"components/schemas/HcaConsultantAvailabilityResponse":{"id":"components/schemas/HcaConsultantAvailabilityResponse","kind":"json-schema","title":"HcaConsultantAvailabilityResponse","data":{"properties":{"date_from":{"type":"string","format":"date-time"},"date_to":{"type":"string","format":"date-time"},"slots":{"type":"array","items":{"properties":{"start_time":{"type":"string","format":"date-time"},"end_time":{"type":"string","format":"date-time"},"is_blocked":{"type":"boolean"}},"type":"object","required":["start_time","end_time","is_blocked"]}}},"type":"object","required":["date_from","date_to","slots"]}},"components/schemas/HcaCreateDiaryBookingBody":{"id":"components/schemas/HcaCreateDiaryBookingBody","kind":"json-schema","title":"HcaCreateDiaryBookingBody","data":{"properties":{"consultant_gmc_number":{"type":"string","pattern":"^\\d{7}$"},"booking_type":{"type":"string","enum":["initial","follow_on"]},"facility_id":{"type":"string"},"date_from":{"type":"string","format":"date-time"},"visit_reason_details":{"properties":{"selected_speciality":{"type":"string"},"reason_for_appointment":{"type":"string","maxLength":512}},"type":"object","required":["selected_speciality","reason_for_appointment"]},"demographics":{"properties":{"booking_by":{"type":"string","enum":["patient","insurer","practitioner"]},"paid_by":{"type":"string","enum":["self-pay","insurance"]},"gp_referral":{"type":"boolean"},"insurance_provider":{"type":"string"},"insurance_policy_number":{"type":"string"},"insurance_authorisation_code":{"type":"string"},"previously_been_with_hca":{"type":"boolean"},"patient_code":{"type":"string"},"title":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"postcode":{"type":"string"},"town_city":{"type":"string"},"country":{"type":"string"},"gender":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"date_of_birth":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"marketing_preference_email":{"type":"boolean"},"marketing_preference_phone":{"type":"boolean"},"marketing_preference_sms":{"type":"boolean"},"marketing_preference_post":{"type":"boolean"},"representative_title":{"type":"string"},"representative_first_name":{"type":"string"},"representative_last_name":{"type":"string"},"representative_email":{"type":"string","format":"email"},"representative_phone":{"type":"string"},"representative_relation":{"type":"string"}},"type":"object","required":["booking_by","paid_by","gp_referral","previously_been_with_hca","title","first_name","last_name","address_1","postcode","town_city","country","gender","date_of_birth","email","phone","marketing_preference_email","marketing_preference_phone","marketing_preference_sms","marketing_preference_post"]}},"type":"object","required":["consultant_gmc_number","booking_type","facility_id","date_from","visit_reason_details","demographics"]}},"components/schemas/HcaCreateDiaryBookingResponse":{"id":"components/schemas/HcaCreateDiaryBookingResponse","kind":"json-schema","title":"HcaCreateDiaryBookingResponse","data":{"properties":{"date_from":{"type":"string","format":"date-time"},"date_to":{"type":"string","format":"date-time"},"hca_reservation_id":{"type":"string","format":"uuid"},"booking_status":{"type":"string"},"booking_message":{"type":"string"}},"type":"object","required":["date_from","date_to","hca_reservation_id","booking_status","booking_message"]}},"components/schemas/BookingLinkCreateBody":{"id":"components/schemas/BookingLinkCreateBody","kind":"json-schema","title":"BookingLinkCreateBody","data":{"properties":{"slot_id":{"type":"string"},"appointment_type_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"location_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"patient_id":{"type":"string","pattern":"^\\d+$"},"practitioner_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"from_date":{"type":"string","format":"date-time","description":"Display only the slots available after this date","example":"1989-04-11"},"to_date":{"type":"string","format":"date-time","description":"Display only the slots available before this date","example":"1989-04-11"},"expiry_date":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"},"maximum_use_count":{"type":"number","minimum":1},"link_name":{"type":"string"}},"type":"object"}},"components/schemas/BookingLinkMetaFromDb":{"id":"components/schemas/BookingLinkMetaFromDb","kind":"json-schema","title":"BookingLinkMetaFromDb","data":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["appointment_type_id","location_id"]}},"components/schemas/BookingLinkFromDb":{"id":"components/schemas/BookingLinkFromDb","kind":"json-schema","title":"BookingLinkFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"practice_group_id":{"type":"string","nullable":true},"short_link":{"type":"string","nullable":true},"active":{"default":false,"type":"boolean"},"expiry_date":{"type":"string","format":"date-time","nullable":true},"maximum_uses":{"type":"number"},"number_of_uses":{"type":"number"},"open_count":{"type":"number"},"unlimited_use":{"type":"boolean"},"meta":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["appointment_type_id","location_id"]},"created_at":{"type":"string","format":"date-time","nullable":true},"link_name":{"type":"string","nullable":true},"patient_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["id","maximum_uses","number_of_uses","open_count","unlimited_use","meta"]}},"components/schemas/BookingLinkGetParams":{"id":"components/schemas/BookingLinkGetParams","kind":"json-schema","title":"BookingLinkGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/BookingLinkCreateResponse":{"id":"components/schemas/BookingLinkCreateResponse","kind":"json-schema","title":"BookingLinkCreateResponse","data":{"properties":{"booking_link":{"type":"string"},"short_link_id":{"type":"string"}},"type":"object","required":["booking_link","short_link_id"]}},"components/schemas/BookingLinkUpdateBody":{"id":"components/schemas/BookingLinkUpdateBody","kind":"json-schema","title":"BookingLinkUpdateBody","data":{"properties":{"appointment_type_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"location_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"practitioner_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},{"type":"null"}]},"expiry_date":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"maximum_use_count":{"type":"number","minimum":1,"nullable":true},"from_date":{"type":"string","format":"date-time","description":"Display only the slots available after this date","example":"1989-04-11","nullable":true},"to_date":{"type":"string","format":"date-time","description":"Display only the slots available before this date","example":"1989-04-11","nullable":true},"active":{"type":"boolean"},"link_name":{"type":"string"}},"type":"object"}},"components/schemas/BookingLinkUpdateResponse":{"id":"components/schemas/BookingLinkUpdateResponse","kind":"json-schema","title":"BookingLinkUpdateResponse","data":{"properties":{"booking_link":{"type":"string"},"short_link_id":{"type":"string"}},"type":"object","required":["booking_link","short_link_id"]}},"components/schemas/DayOfWeek":{"id":"components/schemas/DayOfWeek","kind":"json-schema","title":"DayOfWeek","data":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]}},"components/schemas/CareNavOpeningHourDto":{"id":"components/schemas/CareNavOpeningHourDto","kind":"json-schema","title":"CareNavOpeningHourDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"day_of_week":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"start_time":{"type":"string","nullable":true},"end_time":{"type":"string","nullable":true},"suspended":{"type":"boolean"}},"type":"object","required":["id","day_of_week","start_time","end_time","suspended"]}},"components/schemas/CareNavSettingsBaseDto":{"id":"components/schemas/CareNavSettingsBaseDto","kind":"json-schema","title":"CareNavSettingsBaseDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"suspended":{"type":"boolean"},"suspended_reason":{"type":"string","nullable":true},"suspended_welcome_text":{"type":"string","nullable":true},"suspended_welcome_text_enabled":{"type":"boolean"},"in_hours":{"type":"boolean"},"in_hours_welcome_text":{"type":"string","nullable":true},"in_hours_welcome_text_enabled":{"type":"boolean"},"out_of_hours_welcome_text":{"type":"string","nullable":true},"out_of_hours_welcome_text_enabled":{"type":"boolean"},"confirmation_message":{"type":"string","nullable":true},"submission_text":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","suspended","suspended_reason","suspended_welcome_text","suspended_welcome_text_enabled","in_hours","in_hours_welcome_text","in_hours_welcome_text_enabled","out_of_hours_welcome_text","out_of_hours_welcome_text_enabled","confirmation_message","submission_text","url","updated_at"]}},"components/schemas/CareNavSettingsDto":{"id":"components/schemas/CareNavSettingsDto","kind":"json-schema","title":"CareNavSettingsDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"suspended":{"type":"boolean"},"suspended_reason":{"type":"string","nullable":true},"suspended_welcome_text":{"type":"string","nullable":true},"suspended_welcome_text_enabled":{"type":"boolean"},"in_hours":{"type":"boolean"},"in_hours_welcome_text":{"type":"string","nullable":true},"in_hours_welcome_text_enabled":{"type":"boolean"},"out_of_hours_welcome_text":{"type":"string","nullable":true},"out_of_hours_welcome_text_enabled":{"type":"boolean"},"confirmation_message":{"type":"string","nullable":true},"submission_text":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"opening_hours":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"day_of_week":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"start_time":{"type":"string","nullable":true},"end_time":{"type":"string","nullable":true},"suspended":{"type":"boolean"}},"type":"object","required":["id","day_of_week","start_time","end_time","suspended"]}}},"type":"object","required":["id","suspended","suspended_reason","suspended_welcome_text","suspended_welcome_text_enabled","in_hours","in_hours_welcome_text","in_hours_welcome_text_enabled","out_of_hours_welcome_text","out_of_hours_welcome_text_enabled","confirmation_message","submission_text","url","updated_at","opening_hours"]}},"components/schemas/CareNavSettingsUpdateBody":{"id":"components/schemas/CareNavSettingsUpdateBody","kind":"json-schema","title":"CareNavSettingsUpdateBody","data":{"properties":{"suspended":{"type":"boolean"},"suspended_reason":{"type":"string","nullable":true},"suspended_welcome_text":{"type":"string","nullable":true},"suspended_welcome_text_enabled":{"type":"boolean"},"in_hours_welcome_text":{"type":"string","nullable":true},"in_hours_welcome_text_enabled":{"type":"boolean"},"out_of_hours_welcome_text":{"type":"string","nullable":true},"out_of_hours_welcome_text_enabled":{"type":"boolean"},"confirmation_message":{"type":"string","nullable":true},"submission_text":{"type":"string","nullable":true}},"type":"object","additionalProperties":false}},"components/schemas/CareNavOpeningHourUpdateBody":{"id":"components/schemas/CareNavOpeningHourUpdateBody","kind":"json-schema","title":"CareNavOpeningHourUpdateBody","data":{"properties":{"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","nullable":true},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","nullable":true},"suspended":{"type":"boolean"}},"type":"object","additionalProperties":false}},"components/schemas/CareNavOpeningHourCreateBody":{"id":"components/schemas/CareNavOpeningHourCreateBody","kind":"json-schema","title":"CareNavOpeningHourCreateBody","data":{"properties":{"day_of_week":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","nullable":true},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","nullable":true},"suspended":{"default":false,"type":"boolean"}},"type":"object","required":["day_of_week","start_time","end_time"],"additionalProperties":false}},"components/schemas/CareNavOpeningHourParam":{"id":"components/schemas/CareNavOpeningHourParam","kind":"json-schema","title":"CareNavOpeningHourParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/CareNavOpeningHourListResponse":{"id":"components/schemas/CareNavOpeningHourListResponse","kind":"json-schema","title":"CareNavOpeningHourListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"day_of_week":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"]},"start_time":{"type":"string","nullable":true},"end_time":{"type":"string","nullable":true},"suspended":{"type":"boolean"}},"type":"object","required":["id","day_of_week","start_time","end_time","suspended"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CareNavSubmissionListFromDb":{"id":"components/schemas/CareNavSubmissionListFromDb","kind":"json-schema","title":"CareNavSubmissionListFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"oc_submission_type":{"type":"string","enum":["admin_request","clinical_request","other_request"]},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","required":["id","created_at","title","oc_submission_type"]}},"components/schemas/CareNavSubmissionListDto":{"id":"components/schemas/CareNavSubmissionListDto","kind":"json-schema","title":"CareNavSubmissionListDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"type":{"type":"string","enum":["Admin request","Clinical request","Other request"],"nullable":true}},"type":"object","required":["id","created_at","title"]}},"components/schemas/CareNavSubmissionListResponse":{"id":"components/schemas/CareNavSubmissionListResponse","kind":"json-schema","title":"CareNavSubmissionListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"type":{"type":"string","enum":["Admin request","Clinical request","Other request"],"nullable":true}},"type":"object","required":["id","created_at","title"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CareNavSubmissionListQuery":{"id":"components/schemas/CareNavSubmissionListQuery","kind":"json-schema","title":"CareNavSubmissionListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"order_descending":{"type":"string","enum":["true","false"]},"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object"}},"components/schemas/CareNavSubmissionGetFromDb":{"id":"components/schemas/CareNavSubmissionGetFromDb","kind":"json-schema","title":"CareNavSubmissionGetFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"oc_submission_type":{"type":"string","enum":["admin_request","clinical_request","other_request"]},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"form_response_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id","created_at","title","oc_submission_type","form_response_id"]}},"components/schemas/CareNavSubmissionGetDto":{"id":"components/schemas/CareNavSubmissionGetDto","kind":"json-schema","title":"CareNavSubmissionGetDto","data":{"properties":{"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"type":{"type":"string","enum":["Admin request","Clinical request","Other request"],"nullable":true},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"form_question_id":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"id":{"type":"string"},"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"condition_question_id":{"type":"string"}},"type":"object","required":["display_condition","cond_type","cond_value","condition_question_id"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"}},"type":"object","required":["form_question_id","name","type","optional"]}},"patient_id":{"type":"string"},"appointment_id":{"type":"number","nullable":true}},"type":"object","required":["id","created_at","title","description","patient_title","patient_description","confirmation_message","fields","appointment_id"]}},"components/schemas/CareNavSubmissionGetResponse":{"id":"components/schemas/CareNavSubmissionGetResponse","kind":"json-schema","title":"CareNavSubmissionGetResponse","data":{"properties":{"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"title":{"type":"string"},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"type":{"type":"string","enum":["Admin request","Clinical request","Other request"],"nullable":true},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"form_question_id":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"id":{"type":"string"},"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"condition_question_id":{"type":"string"}},"type":"object","required":["display_condition","cond_type","cond_value","condition_question_id"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"}},"type":"object","required":["form_question_id","name","type","optional"]}},"patient_id":{"type":"string"},"appointment_id":{"type":"number","nullable":true}},"type":"object","required":["id","created_at","title","description","patient_title","patient_description","confirmation_message","fields","appointment_id"]}},"components/schemas/CareNavSubmissionGetParams":{"id":"components/schemas/CareNavSubmissionGetParams","kind":"json-schema","title":"CareNavSubmissionGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/CareNavSubmissionCreateBody":{"id":"components/schemas/CareNavSubmissionCreateBody","kind":"json-schema","title":"CareNavSubmissionCreateBody","data":{"properties":{"submission_type_id":{"type":"string","pattern":"^\\d+$"},"patient_id":{"type":"string","pattern":"^\\d+$"},"responses":{"type":"array","items":{"properties":{"form_question_id":{"type":"string","pattern":"^\\d+$"},"text_response":{"type":"string"},"integer_response":{"type":"number","nullable":true},"boolean_response":{"type":"boolean"},"checkbox_response":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"datetime_response":{"type":"string"},"observation_value_response":{"type":"string"},"problem_response":{"type":"string"},"immunisation_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"},"base_64_file_response":{"type":"string"}},"type":"object","required":["form_question_id"]}}},"type":"object","required":["submission_type_id","patient_id","responses"]}},"components/schemas/CareNavSubmissionCreateResult":{"id":"components/schemas/CareNavSubmissionCreateResult","kind":"json-schema","title":"CareNavSubmissionCreateResult","data":{"properties":{"care_nav_submission_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["care_nav_submission_id"]}},"components/schemas/ClinicalDocumentSource":{"id":"components/schemas/ClinicalDocumentSource","kind":"json-schema","title":"ClinicalDocumentSource","data":{"type":"string","enum":["upload","email"]}},"components/schemas/ClinicalDocumentStatus":{"id":"components/schemas/ClinicalDocumentStatus","kind":"json-schema","title":"ClinicalDocumentStatus","data":{"type":"string","enum":["received","needs_attention","filed","exception"]}},"components/schemas/ClinicalDocumentAssigneeType":{"id":"components/schemas/ClinicalDocumentAssigneeType","kind":"json-schema","title":"ClinicalDocumentAssigneeType","data":{"type":"string","enum":["Admin","AdminTeam"]}},"components/schemas/ClinicalDocumentScanStage":{"id":"components/schemas/ClinicalDocumentScanStage","kind":"json-schema","title":"ClinicalDocumentScanStage","data":{"type":"string","enum":["waiting","reading_text","finding_patient","reading_details"]}},"components/schemas/ClinicalDocumentCode":{"id":"components/schemas/ClinicalDocumentCode","kind":"json-schema","title":"ClinicalDocumentCode","data":{"properties":{"id":{"type":"string"},"code":{"type":"string","nullable":true},"term":{"type":"string"},"evidence":{"type":"string","nullable":true},"page":{"type":"integer","minimum":0,"exclusiveMinimum":0,"nullable":true},"on_record":{"default":false,"type":"boolean"},"decision":{"type":"string","enum":["pending","approved","rejected"]},"source":{"default":"suggested","type":"string","enum":["suggested","manual"]}},"type":"object","required":["id","code","term","decision"]}},"components/schemas/ClinicalDocumentPatient":{"id":"components/schemas/ClinicalDocumentPatient","kind":"json-schema","title":"ClinicalDocumentPatient","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"dob":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"],"nullable":true},"verified_with":{"type":"array","items":{"type":"string","enum":["PDS","EMIS"]}}},"type":"object","required":["id","full_name","first_name","last_name","title","dob","nhs_number","sex","verified_with"]}},"components/schemas/ClinicalDocumentActor":{"id":"components/schemas/ClinicalDocumentActor","kind":"json-schema","title":"ClinicalDocumentActor","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"components/schemas/ClinicalDocumentAssignee":{"id":"components/schemas/ClinicalDocumentAssignee","kind":"json-schema","title":"ClinicalDocumentAssignee","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"type":{"type":"string","enum":["Admin","AdminTeam"]}},"type":"object","required":["id","name","type"]}},"components/schemas/ClinicalDocumentFile":{"id":"components/schemas/ClinicalDocumentFile","kind":"json-schema","title":"ClinicalDocumentFile","data":{"properties":{"reference":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"}},"type":"object","required":["reference","name","size","type"]}},"components/schemas/ClinicalDocumentNote":{"id":"components/schemas/ClinicalDocumentNote","kind":"json-schema","title":"ClinicalDocumentNote","data":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinical_document_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at","clinical_document_id"]}},"components/schemas/ClinicalDocumentTask":{"id":"components/schemas/ClinicalDocumentTask","kind":"json-schema","title":"ClinicalDocumentTask","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"category":{"type":"string"},"details":{"type":"string","nullable":true},"title":{"type":"string"},"title_sub_text":{"type":"string"},"taskable_type":{"type":"string","enum":["ClinicalDocument"]},"document_id":{"type":"string","pattern":"^\\d+$"},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"assignee_name":{"type":"string","nullable":true},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"episode_id":{"type":"string","pattern":"^\\d+$","nullable":true},"due_at":{"type":"string","nullable":true},"created_at":{"type":"string"}},"type":"object","required":["id","type_label","name","status","priority","category","details","title","title_sub_text","taskable_type","document_id","assignee_id","assignee_type","assignee_name","triggered_by","episode_id","due_at","created_at"]}},"components/schemas/ClinicalDocumentExceptionType":{"id":"components/schemas/ClinicalDocumentExceptionType","kind":"json-schema","title":"ClinicalDocumentExceptionType","data":{"type":"string","enum":["no_readable_text","password_protected","unreadable_file","no_patient_details","several_patients_in_document","conflicting_patient_details","several_possible_patients","no_matching_patient","not_scanned"]}},"components/schemas/ClinicalDocumentPatientIdentification":{"id":"components/schemas/ClinicalDocumentPatientIdentification","kind":"json-schema","title":"ClinicalDocumentPatientIdentification","data":{"properties":{"basis":{"type":"string","enum":["nhs_number","demographics","manual"],"nullable":true},"needs_confirmation":{"type":"boolean"},"evidence":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"},"page":{"type":"number"}},"type":"object","required":["field","text","page"]}},"rejected":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"},"page":{"type":"number"},"reason":{"type":"string"}},"type":"object","required":["field","text","page","reason"]}},"candidates":{"type":"array","items":{"properties":{"patient_record_id":{"type":"number"},"name":{"type":"string"},"date_of_birth":{"type":"string"}},"type":"object"}}},"type":"object","required":["basis","needs_confirmation","evidence","rejected","candidates"]}},"components/schemas/ClinicalDocumentGet":{"id":"components/schemas/ClinicalDocumentGet","kind":"json-schema","title":"ClinicalDocumentGet","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uuid":{"type":"string"},"practice_group_id":{"type":"string","pattern":"^\\d+$"},"source":{"type":"string","enum":["upload","email"]},"status":{"type":"string","enum":["received","needs_attention","filed","exception"]},"exception_type":{"type":"string","enum":["no_readable_text","password_protected","unreadable_file","no_patient_details","several_patients_in_document","conflicting_patient_details","several_possible_patients","no_matching_patient","not_scanned"],"nullable":true},"exception_reason":{"type":"string","nullable":true},"patient_identification":{"properties":{"basis":{"type":"string","enum":["nhs_number","demographics","manual"],"nullable":true},"needs_confirmation":{"type":"boolean"},"evidence":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"},"page":{"type":"number"}},"type":"object","required":["field","text","page"]}},"rejected":{"type":"array","items":{"properties":{"field":{"type":"string"},"text":{"type":"string"},"page":{"type":"number"},"reason":{"type":"string"}},"type":"object","required":["field","text","page","reason"]}},"candidates":{"type":"array","items":{"properties":{"patient_record_id":{"type":"number"},"name":{"type":"string"},"date_of_birth":{"type":"string"}},"type":"object"}}},"type":"object","required":["basis","needs_confirmation","evidence","rejected","candidates"],"nullable":true},"title":{"type":"string","nullable":true},"document_type":{"type":"string","nullable":true},"document_date":{"type":"string","nullable":true},"sender":{"type":"string","nullable":true},"page_count":{"type":"number","nullable":true},"file":{"properties":{"reference":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"}},"type":"object","required":["reference","name","size","type"],"nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"dob":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"],"nullable":true},"verified_with":{"type":"array","items":{"type":"string","enum":["PDS","EMIS"]}}},"type":"object","required":["id","full_name","first_name","last_name","title","dob","nhs_number","sex","verified_with"],"nullable":true},"codes":{"type":"array","items":{"properties":{"id":{"type":"string"},"code":{"type":"string","nullable":true},"term":{"type":"string"},"evidence":{"type":"string","nullable":true},"page":{"type":"integer","minimum":0,"exclusiveMinimum":0,"nullable":true},"on_record":{"default":false,"type":"boolean"},"decision":{"type":"string","enum":["pending","approved","rejected"]},"source":{"default":"suggested","type":"string","enum":["suggested","manual"]}},"type":"object","required":["id","code","term","decision"]}},"codes_pending":{"type":"boolean"},"scan_stage":{"type":"string","enum":["waiting","reading_text","finding_patient","reading_details"],"nullable":true},"assignee":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"type":{"type":"string","enum":["Admin","AdminTeam"]}},"type":"object","required":["id","name","type"],"nullable":true},"created_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"],"nullable":true},"filed_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"],"nullable":true},"filed_at":{"type":"string","nullable":true},"consultation_id":{"type":"string","pattern":"^\\d+$","nullable":true},"episode_id":{"type":"string","pattern":"^\\d+$","nullable":true},"tasks":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"category":{"type":"string"},"details":{"type":"string","nullable":true},"title":{"type":"string"},"title_sub_text":{"type":"string"},"taskable_type":{"type":"string","enum":["ClinicalDocument"]},"document_id":{"type":"string","pattern":"^\\d+$"},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"assignee_name":{"type":"string","nullable":true},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"episode_id":{"type":"string","pattern":"^\\d+$","nullable":true},"due_at":{"type":"string","nullable":true},"created_at":{"type":"string"}},"type":"object","required":["id","type_label","name","status","priority","category","details","title","title_sub_text","taskable_type","document_id","assignee_id","assignee_type","assignee_name","triggered_by","episode_id","due_at","created_at"]}},"notes":{"type":"array","items":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinical_document_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at","clinical_document_id"]}},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","uuid","practice_group_id","source","status","exception_type","exception_reason","patient_identification","title","document_type","document_date","sender","page_count","file","patient","codes","codes_pending","scan_stage","assignee","created_by","filed_by","filed_at","consultation_id","episode_id","tasks","notes","created_at","updated_at"]}},"components/schemas/ClinicalDocumentGetParam":{"id":"components/schemas/ClinicalDocumentGetParam","kind":"json-schema","title":"ClinicalDocumentGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/ClinicalDocumentSummary":{"id":"components/schemas/ClinicalDocumentSummary","kind":"json-schema","title":"ClinicalDocumentSummary","data":{"properties":{"my_documents":{"type":"number"},"all_documents":{"type":"number"},"exceptions":{"type":"number"},"in_queue":{"type":"number"},"recent_uploads":{"type":"number"},"document_types":{"type":"array","items":{"type":"string"}}},"type":"object","required":["my_documents","all_documents","exceptions","in_queue","recent_uploads","document_types"]}},"components/schemas/ClinicalDocumentListPatient":{"id":"components/schemas/ClinicalDocumentListPatient","kind":"json-schema","title":"ClinicalDocumentListPatient","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"},"dob":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true}},"type":"object","required":["id","full_name","dob","nhs_number"]}},"components/schemas/ClinicalDocumentListItem":{"id":"components/schemas/ClinicalDocumentListItem","kind":"json-schema","title":"ClinicalDocumentListItem","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uuid":{"type":"string"},"status":{"type":"string","enum":["received","needs_attention","filed","exception"]},"exception_type":{"type":"string","enum":["no_readable_text","password_protected","unreadable_file","no_patient_details","several_patients_in_document","conflicting_patient_details","several_possible_patients","no_matching_patient","not_scanned"],"nullable":true},"exception_reason":{"type":"string","nullable":true},"needs_patient_confirmation":{"type":"boolean"},"title":{"type":"string","nullable":true},"document_type":{"type":"string","nullable":true},"sender":{"type":"string","nullable":true},"file_name":{"type":"string","nullable":true},"codes_count":{"type":"number"},"codes_pending":{"type":"boolean"},"scan_stage":{"type":"string","enum":["waiting","reading_text","finding_patient","reading_details"],"nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"},"dob":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true}},"type":"object","required":["id","full_name","dob","nhs_number"],"nullable":true},"assignee":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"type":{"type":"string","enum":["Admin","AdminTeam"]}},"type":"object","required":["id","name","type"],"nullable":true},"consultation_id":{"type":"string","pattern":"^\\d+$","nullable":true},"write_to_record_status":{"type":"string","enum":["pending","success","failed"],"nullable":true},"created_at":{"type":"string"}},"type":"object","required":["id","uuid","status","exception_type","exception_reason","needs_patient_confirmation","title","document_type","sender","file_name","codes_count","codes_pending","scan_stage","patient","assignee","consultation_id","write_to_record_status","created_at"]}},"components/schemas/ClinicalDocumentList":{"id":"components/schemas/ClinicalDocumentList","kind":"json-schema","title":"ClinicalDocumentList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uuid":{"type":"string"},"status":{"type":"string","enum":["received","needs_attention","filed","exception"]},"exception_type":{"type":"string","enum":["no_readable_text","password_protected","unreadable_file","no_patient_details","several_patients_in_document","conflicting_patient_details","several_possible_patients","no_matching_patient","not_scanned"],"nullable":true},"exception_reason":{"type":"string","nullable":true},"needs_patient_confirmation":{"type":"boolean"},"title":{"type":"string","nullable":true},"document_type":{"type":"string","nullable":true},"sender":{"type":"string","nullable":true},"file_name":{"type":"string","nullable":true},"codes_count":{"type":"number"},"codes_pending":{"type":"boolean"},"scan_stage":{"type":"string","enum":["waiting","reading_text","finding_patient","reading_details"],"nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"},"dob":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true}},"type":"object","required":["id","full_name","dob","nhs_number"],"nullable":true},"assignee":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"type":{"type":"string","enum":["Admin","AdminTeam"]}},"type":"object","required":["id","name","type"],"nullable":true},"consultation_id":{"type":"string","pattern":"^\\d+$","nullable":true},"write_to_record_status":{"type":"string","enum":["pending","success","failed"],"nullable":true},"created_at":{"type":"string"}},"type":"object","required":["id","uuid","status","exception_type","exception_reason","needs_patient_confirmation","title","document_type","sender","file_name","codes_count","codes_pending","scan_stage","patient","assignee","consultation_id","write_to_record_status","created_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/ClinicalDocumentOrderBy":{"id":"components/schemas/ClinicalDocumentOrderBy","kind":"json-schema","title":"ClinicalDocumentOrderBy","data":{"type":"string","enum":["created_at","document_date","document_type","sender","status","patient_name"]}},"components/schemas/ClinicalDocumentListQuery":{"id":"components/schemas/ClinicalDocumentListQuery","kind":"json-schema","title":"ClinicalDocumentListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"status":{"default":[],"type":"array","items":{"type":"string","enum":["received","needs_attention","filed","exception"]}},"assignee_id":{"default":[],"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"assignee_type":{"default":[],"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient":{"type":"string","maxLength":100},"document":{"type":"string","maxLength":100},"document_type":{"default":[],"type":"array","items":{"type":"string","maxLength":100}},"in_queue":{"type":"string","enum":["true","false"]},"uploaded_by":{"type":"string","pattern":"^\\d+$"},"uploaded_within_hours":{"type":"integer","minimum":1,"maximum":168},"has_codes":{"type":"string","enum":["true","false"]},"order_by":{"default":"created_at","type":"string","enum":["created_at","document_date","document_type","sender","status","patient_name"]},"order_descending":{"default":"true","type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/ClinicalDocumentContentType":{"id":"components/schemas/ClinicalDocumentContentType","kind":"json-schema","title":"ClinicalDocumentContentType","data":{"type":"string","enum":["application/pdf"]}},"components/schemas/ClinicalDocumentDirectUploadBody":{"id":"components/schemas/ClinicalDocumentDirectUploadBody","kind":"json-schema","title":"ClinicalDocumentDirectUploadBody","data":{"properties":{"filename":{"type":"string","minLength":1,"maxLength":255},"byte_size":{"type":"integer","minimum":0,"exclusiveMinimum":0,"maximum":20971520,"exclusiveMaximum":20971520},"content_type":{"type":"string","enum":["application/pdf"]}},"type":"object","required":["filename","byte_size","content_type"]}},"components/schemas/ClinicalDocumentDirectUpload":{"id":"components/schemas/ClinicalDocumentDirectUpload","kind":"json-schema","title":"ClinicalDocumentDirectUpload","data":{"properties":{"upload_token":{"type":"string"},"direct_upload":{"properties":{"url":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}}},"type":"object","required":["url","headers"]}},"type":"object","required":["upload_token","direct_upload"]}},"components/schemas/ClinicalDocumentCreateBody":{"id":"components/schemas/ClinicalDocumentCreateBody","kind":"json-schema","title":"ClinicalDocumentCreateBody","data":{"properties":{"upload_token":{"type":"string","minLength":1,"maxLength":2000}},"type":"object","required":["upload_token"]}},"components/schemas/ClinicalDocumentAssignPatientBody":{"id":"components/schemas/ClinicalDocumentAssignPatientBody","kind":"json-schema","title":"ClinicalDocumentAssignPatientBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/ClinicalDocumentFileToRecordBody":{"id":"components/schemas/ClinicalDocumentFileToRecordBody","kind":"json-schema","title":"ClinicalDocumentFileToRecordBody","data":{"properties":{"consultation_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["consultation_id"]}},"components/schemas/ClinicalDocumentCodesBody":{"id":"components/schemas/ClinicalDocumentCodesBody","kind":"json-schema","title":"ClinicalDocumentCodesBody","data":{"properties":{"decisions":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","minLength":1,"maxLength":100},"decision":{"type":"string","enum":["pending","approved","rejected"]}},"type":"object","required":["id","decision"]},"maxItems":100},"additions":{"default":[],"type":"array","items":{"properties":{"code":{"type":"string","pattern":"^\\d{6,18}$"},"term":{"type":"string","minLength":1,"maxLength":255}},"type":"object","required":["code","term"]},"maxItems":50}},"type":"object"}},"components/schemas/ConsultationElementType":{"id":"components/schemas/ConsultationElementType","kind":"json-schema","title":"ConsultationElementType","data":{"type":"string","enum":["problem","observation","code","note","attachment"]}},"components/schemas/ConsultationCreatedBy":{"id":"components/schemas/ConsultationCreatedBy","kind":"json-schema","title":"ConsultationCreatedBy","data":{"type":"string","enum":["hero","heidi","clinical_document"]}},"components/schemas/ProblemEpisode":{"id":"components/schemas/ProblemEpisode","kind":"json-schema","title":"ProblemEpisode","data":{"type":"string","enum":["review","flare_up"]}},"components/schemas/ProblemSignificance":{"id":"components/schemas/ProblemSignificance","kind":"json-schema","title":"ProblemSignificance","data":{"type":"string","enum":["significant","minor"]}},"components/schemas/ProblemStatus":{"id":"components/schemas/ProblemStatus","kind":"json-schema","title":"ProblemStatus","data":{"type":"string","enum":["active","past","administrative"]}},"components/schemas/ProblemMeta":{"id":"components/schemas/ProblemMeta","kind":"json-schema","title":"ProblemMeta","data":{"properties":{"episode":{"type":"string","enum":["review","flare_up"]},"significance":{"type":"string","enum":["significant","minor"]},"status":{"type":"string","enum":["active","past","administrative"]},"expected_duration":{"type":"integer","minimum":0},"onset":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object"}},"components/schemas/ConsultationElement":{"id":"components/schemas/ConsultationElement","kind":"json-schema","title":"ConsultationElement","data":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["note"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"guid":{"type":"string"},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"]},"significance":{"type":"string","enum":["significant","minor"]},"status":{"type":"string","enum":["active","past","administrative"]},"expected_duration":{"type":"integer","minimum":0},"onset":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object"}},"type":"object","required":["type"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["observation"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["code"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","code"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"base_64_file_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"}},"type":"object","required":["type","base_64_file_response","base_64_content_type","base_64_file_name"]}]}},"components/schemas/ConsultationCreateBody":{"id":"components/schemas/ConsultationCreateBody","kind":"json-schema","title":"ConsultationCreateBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"},"occurred_at":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"created_by":{"default":"hero","type":"string","enum":["hero","heidi","clinical_document"]},"status":{"default":"draft","type":"string","enum":["draft","final"]},"transcript":{"type":"string","nullable":true},"transcript_saved_at":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"elements":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["note"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"guid":{"type":"string"},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"]},"significance":{"type":"string","enum":["significant","minor"]},"status":{"type":"string","enum":["active","past","administrative"]},"expected_duration":{"type":"integer","minimum":0},"onset":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object"}},"type":"object","required":["type"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["observation"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["code"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","code"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"base_64_file_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"}},"type":"object","required":["type","base_64_file_response","base_64_content_type","base_64_file_name"]}]}}},"type":"object","required":["patient_id","occurred_at"]}},"components/schemas/ConsultationUpdateParam":{"id":"components/schemas/ConsultationUpdateParam","kind":"json-schema","title":"ConsultationUpdateParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/ConsultationUpdateBody":{"id":"components/schemas/ConsultationUpdateBody","kind":"json-schema","title":"ConsultationUpdateBody","data":{"properties":{"occurred_at":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"created_by":{"type":"string","enum":["hero","heidi","clinical_document"]},"transcript":{"type":"string","nullable":true},"transcript_saved_at":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"elements":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["note"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"guid":{"type":"string"},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"]},"significance":{"type":"string","enum":["significant","minor"]},"status":{"type":"string","enum":["active","past","administrative"]},"expected_duration":{"type":"integer","minimum":0},"onset":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object"}},"type":"object","required":["type"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["observation"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","text"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["code"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"}},"type":"object","required":["type","code"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string"},"base_64_file_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"}},"type":"object","required":["type","base_64_file_response","base_64_content_type","base_64_file_name"]}]}}},"type":"object"}},"components/schemas/ConsultationGetParam":{"id":"components/schemas/ConsultationGetParam","kind":"json-schema","title":"ConsultationGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/ConsultationPatientSummary":{"id":"components/schemas/ConsultationPatientSummary","kind":"json-schema","title":"ConsultationPatientSummary","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"}},"type":"object","required":["id","full_name"]}},"components/schemas/ConsultationGet":{"id":"components/schemas/ConsultationGet","kind":"json-schema","title":"ConsultationGet","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"occurred_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["draft","final"]},"created_by":{"type":"string","enum":["hero","heidi","clinical_document"]},"transcript":{"type":"string","nullable":true},"elements":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem","observation","code","note","attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string","nullable":true},"attachment_url":{"type":"string","nullable":true},"guid":{"type":"string","nullable":true},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"],"nullable":true},"significance":{"type":"string","enum":["significant","minor"],"nullable":true},"status":{"type":"string","enum":["active","past","administrative"],"nullable":true},"expected_duration":{"type":"number","nullable":true},"onset":{"type":"string","nullable":true},"end_date":{"type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","required":["id","type","attachment_url"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"}},"type":"object","required":["id","full_name"]},"write_to_record":{"properties":{"status":{"type":"string"},"failure_reason":{"type":"string","nullable":true},"written_by_admin":{"properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name"],"nullable":true}},"type":"object","required":["status","failure_reason","written_by_admin"]}},"type":"object","required":["id","occurred_at","status","elements"]}},"components/schemas/ConsultationList":{"id":"components/schemas/ConsultationList","kind":"json-schema","title":"ConsultationList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"occurred_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["draft","final"]},"created_by":{"type":"string","enum":["hero","heidi","clinical_document"]},"transcript":{"type":"string","nullable":true},"elements":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem","observation","code","note","attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string","nullable":true},"attachment_url":{"type":"string","nullable":true},"guid":{"type":"string","nullable":true},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"],"nullable":true},"significance":{"type":"string","enum":["significant","minor"],"nullable":true},"status":{"type":"string","enum":["active","past","administrative"],"nullable":true},"expected_duration":{"type":"number","nullable":true},"onset":{"type":"string","nullable":true},"end_date":{"type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","required":["id","type","attachment_url"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"}},"type":"object","required":["id","full_name"]},"write_to_record":{"properties":{"status":{"type":"string"},"failure_reason":{"type":"string","nullable":true},"written_by_admin":{"properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name"],"nullable":true}},"type":"object","required":["status","failure_reason","written_by_admin"]}},"type":"object","required":["id","occurred_at","status","elements"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/ConsultationFinaliseParam":{"id":"components/schemas/ConsultationFinaliseParam","kind":"json-schema","title":"ConsultationFinaliseParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/ConsultationFinaliseResponse":{"id":"components/schemas/ConsultationFinaliseResponse","kind":"json-schema","title":"ConsultationFinaliseResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"occurred_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["draft","final"]},"created_by":{"type":"string","enum":["hero","heidi","clinical_document"]},"transcript":{"type":"string","nullable":true},"elements":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["problem","observation","code","note","attachment"]},"name":{"type":"string"},"code":{"type":"string"},"code_system":{"type":"string"},"term":{"type":"string"},"value":{"type":"number"},"value_text":{"type":"string"},"unit":{"type":"string"},"text":{"type":"string"},"group_id":{"type":"string","nullable":true},"attachment_url":{"type":"string","nullable":true},"guid":{"type":"string","nullable":true},"meta":{"properties":{"episode":{"type":"string","enum":["review","flare_up"],"nullable":true},"significance":{"type":"string","enum":["significant","minor"],"nullable":true},"status":{"type":"string","enum":["active","past","administrative"],"nullable":true},"expected_duration":{"type":"number","nullable":true},"onset":{"type":"string","nullable":true},"end_date":{"type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","required":["id","type","attachment_url"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"full_name":{"type":"string"}},"type":"object","required":["id","full_name"]},"write_to_record":{"properties":{"status":{"type":"string"},"failure_reason":{"type":"string","nullable":true},"written_by_admin":{"properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name"],"nullable":true}},"type":"object","required":["status","failure_reason","written_by_admin"]}},"type":"object","required":["id","occurred_at","status","elements"]}},"components/schemas/ConsultationWtrStatus":{"id":"components/schemas/ConsultationWtrStatus","kind":"json-schema","title":"ConsultationWtrStatus","data":{"type":"string","enum":["success","failed","not_written"]}},"components/schemas/ConsultationListQuery":{"id":"components/schemas/ConsultationListQuery","kind":"json-schema","title":"ConsultationListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_full_name":{"type":"string"},"occurred_at":{"type":"array","items":{"type":"string","format":"date-time","nullable":true}},"admin_full_name":{"type":"string"},"status":{"type":"string","enum":["success","failed","not_written"]}},"type":"object"}},"components/schemas/ContentTemplateFromDb":{"id":"components/schemas/ContentTemplateFromDb","kind":"json-schema","title":"ContentTemplateFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"token":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"meta":{"type":"object","additionalProperties":{},"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","token","content","meta","created_at","updated_at"]}},"components/schemas/ContentTemplateDto":{"id":"components/schemas/ContentTemplateDto","kind":"json-schema","title":"ContentTemplateDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"token":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"meta":{"type":"object","additionalProperties":{},"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","token","content","meta","created_at","updated_at"]}},"components/schemas/ContentTemplateList":{"id":"components/schemas/ContentTemplateList","kind":"json-schema","title":"ContentTemplateList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"token":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"meta":{"type":"object","additionalProperties":{},"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","token","content","meta","created_at","updated_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/ContentTemplateListParams":{"id":"components/schemas/ContentTemplateListParams","kind":"json-schema","title":"ContentTemplateListParams","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true}},"type":"object"}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"applies_to":{"properties":{"products":{"type":"array","items":{"type":"string"}}},"type":"object","required":["products"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"}},"type":"object","required":["id","name"]}},"components/schemas/CouponList":{"id":"components/schemas/CouponList","kind":"json-schema","title":"CouponList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"applies_to":{"properties":{"products":{"type":"array","items":{"type":"string"}}},"type":"object","required":["products"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"}},"type":"object","required":["id","name"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CouponListQuery":{"id":"components/schemas/CouponListQuery","kind":"json-schema","title":"CouponListQuery","data":{"properties":{"query":{"type":"string"}},"type":"object"}},"components/schemas/DirectDebit":{"id":"components/schemas/DirectDebit","kind":"json-schema","title":"DirectDebit","data":{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bacs_debit"]},"fingerprint":{"type":"string"},"sort_code":{"type":"string"},"last4":{"type":"string"}},"type":"object","required":["id","type","fingerprint","sort_code","last4"]}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["card"]},"fingerprint":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"exp_month":{"type":"number"},"exp_year":{"type":"number"}},"type":"object","required":["id","type","fingerprint","brand","last4","exp_month","exp_year"]}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"PaymentMethod","data":{"oneOf":[{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["card"]},"fingerprint":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"exp_month":{"type":"number"},"exp_year":{"type":"number"}},"type":"object","required":["id","type","fingerprint","brand","last4","exp_month","exp_year"]},{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bacs_debit"]},"fingerprint":{"type":"string"},"sort_code":{"type":"string"},"last4":{"type":"string"}},"type":"object","required":["id","type","fingerprint","sort_code","last4"]}]}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"sources":{"type":"array","items":{"oneOf":[{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["card"]},"fingerprint":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"exp_month":{"type":"number"},"exp_year":{"type":"number"}},"type":"object","required":["id","type","fingerprint","brand","last4","exp_month","exp_year"]},{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bacs_debit"]},"fingerprint":{"type":"string"},"sort_code":{"type":"string"},"last4":{"type":"string"}},"type":"object","required":["id","type","fingerprint","sort_code","last4"]}]}}},"type":"object","required":["id","name"]}},"components/schemas/CustomerListQuery":{"id":"components/schemas/CustomerListQuery","kind":"json-schema","title":"CustomerListQuery","data":{"properties":{"query":{"type":"string"}},"type":"object","required":["query"]}},"components/schemas/CustomerCreateBody":{"id":"components/schemas/CustomerCreateBody","kind":"json-schema","title":"CustomerCreateBody","data":{"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"sources":{"type":"array","items":{"oneOf":[{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["card"]},"fingerprint":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"exp_month":{"type":"number"},"exp_year":{"type":"number"}},"type":"object","required":["id","type","fingerprint","brand","last4","exp_month","exp_year"]},{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bacs_debit"]},"fingerprint":{"type":"string"},"sort_code":{"type":"string"},"last4":{"type":"string"}},"type":"object","required":["id","type","fingerprint","sort_code","last4"]}]}}},"type":"object","required":["name"]}},"components/schemas/CustomerList":{"id":"components/schemas/CustomerList","kind":"json-schema","title":"CustomerList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"sources":{"type":"array","items":{"oneOf":[{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["card"]},"fingerprint":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"exp_month":{"type":"number"},"exp_year":{"type":"number"}},"type":"object","required":["id","type","fingerprint","brand","last4","exp_month","exp_year"]},{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bacs_debit"]},"fingerprint":{"type":"string"},"sort_code":{"type":"string"},"last4":{"type":"string"}},"type":"object","required":["id","type","fingerprint","sort_code","last4"]}]}}},"type":"object","required":["id","name"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CustomerGetDefaultQuery":{"id":"components/schemas/CustomerGetDefaultQuery","kind":"json-schema","title":"CustomerGetDefaultQuery","data":{"properties":{"patient_id":{"type":"string","format":"uuid"}},"type":"object","required":["patient_id"]}},"components/schemas/DiaryItemType":{"id":"components/schemas/DiaryItemType","kind":"json-schema","title":"DiaryItemType","data":{"type":"string","enum":["booked_appointment","availability"]}},"components/schemas/DiaryItemBase":{"id":"components/schemas/DiaryItemBase","kind":"json-schema","title":"DiaryItemBase","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["booked_appointment","availability"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time"]}},"components/schemas/DiaryAppointmentItemFromDb":{"id":"components/schemas/DiaryAppointmentItemFromDb","kind":"json-schema","title":"DiaryAppointmentItemFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["booked_appointment"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"attendance_type":{"type":"string","enum":["video","telephone","in_person"]},"invoice_status":{"type":"string","enum":["paid","unpaid","no_invoice"],"nullable":true},"ehr_partner_sync_error":{"type":"boolean"},"patient_has_membership":{"type":"boolean"},"has_insurance":{"type":"boolean"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time","patient_id","patient_first_name","patient_last_name","attendance_type","invoice_status","ehr_partner_sync_error","patient_has_membership","has_insurance"]}},"components/schemas/DiaryAppointmentItemDto":{"id":"components/schemas/DiaryAppointmentItemDto","kind":"json-schema","title":"DiaryAppointmentItemDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["booked_appointment"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"has_insurance":{"type":"boolean"},"has_membership":{"type":"boolean"}},"type":"object","required":["id","first_name","last_name","has_insurance","has_membership"]},"attendance_type":{"type":"string","enum":["video","telephone","in_person"]},"invoice_status":{"type":"string","enum":["paid","unpaid","no_invoice"],"nullable":true},"ehr_partner_sync_error":{"type":"boolean"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time","patient","attendance_type","invoice_status","ehr_partner_sync_error"]}},"components/schemas/DiaryAvailabilityItem":{"id":"components/schemas/DiaryAvailabilityItem","kind":"json-schema","title":"DiaryAvailabilityItem","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["availability"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time"]}},"components/schemas/DiaryItem":{"id":"components/schemas/DiaryItem","kind":"json-schema","title":"DiaryItem","data":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["booked_appointment"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"has_insurance":{"type":"boolean"},"has_membership":{"type":"boolean"}},"type":"object","required":["id","first_name","last_name","has_insurance","has_membership"]},"attendance_type":{"type":"string","enum":["video","telephone","in_person"]},"invoice_status":{"type":"string","enum":["paid","unpaid","no_invoice"],"nullable":true},"ehr_partner_sync_error":{"type":"boolean"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time","patient","attendance_type","invoice_status","ehr_partner_sync_error"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["availability"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time"]}]}},"components/schemas/DiaryItemsListQuery":{"id":"components/schemas/DiaryItemsListQuery","kind":"json-schema","title":"DiaryItemsListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"practitioner_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"location_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"start_date":{"type":"string","format":"date-time","nullable":true,"description":"Filter items starting on and from this date","example":"1989-04-11"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"Filter items ending on and before this date","example":"1989-04-11"}},"type":"object","required":["start_date","end_date"]}},"components/schemas/DiaryItemsListResponse":{"id":"components/schemas/DiaryItemsListResponse","kind":"json-schema","title":"DiaryItemsListResponse","data":{"properties":{"data":{"type":"array","items":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["booked_appointment"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"has_insurance":{"type":"boolean"},"has_membership":{"type":"boolean"}},"type":"object","required":["id","first_name","last_name","has_insurance","has_membership"]},"attendance_type":{"type":"string","enum":["video","telephone","in_person"]},"invoice_status":{"type":"string","enum":["paid","unpaid","no_invoice"],"nullable":true},"ehr_partner_sync_error":{"type":"boolean"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time","patient","attendance_type","invoice_status","ehr_partner_sync_error"]},{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["availability"]},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"finish_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object","required":["id","type","practitioner_id","location_id","appointment_type_id","start_time","finish_time"]}]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AssigneeSchema":{"id":"components/schemas/AssigneeSchema","kind":"json-schema","title":"AssigneeSchema","data":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"components/schemas/EpisodeDto":{"id":"components/schemas/EpisodeDto","kind":"json-schema","title":"EpisodeDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"]},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"full_name":{"type":"string"},"contact_emails":{"type":"array","items":{"type":"string"},"nullable":true},"registered_practitioner_name":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"membership_scheme_names":{"type":"array","items":{"type":"string"},"nullable":true},"address":{"properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["town","country","postcode"]},"verification_credentials_list":{"type":"array","items":{"type":"string"},"description":"An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private"}},"type":"object","required":["id","dob","sex","full_name","contact_emails","registered_practitioner_name","notes","membership_scheme_names","address"]},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"assignee_id":{"type":"string","nullable":true},"assignee_type":{"type":"string"},"assignee_name":{"type":"string","nullable":true},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"}},"type":"object","required":["id","type_label","status","category","patient","priority","created_at","title","title_sub_text"]}},"patient":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"],"nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}},"components/schemas/EpisodeListQuery":{"id":"components/schemas/EpisodeListQuery","kind":"json-schema","title":"EpisodeListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"assignee_id":{"default":[],"type":"array","items":{"type":"string"}},"assignee_type":{"default":[],"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"status":{"default":[],"type":"array","items":{"type":"string","enum":["open","closed","in_progress"]}},"priority":{"default":[],"type":"array","items":{"type":"string","enum":["lowest","low","medium","high","highest"]}},"order_by":{"default":[],"type":"array","items":{"type":"string"}},"order_descending":{"default":[],"type":"array","items":{"type":"string"}}},"type":"object"}},"components/schemas/EpisodeCountQuery":{"id":"components/schemas/EpisodeCountQuery","kind":"json-schema","title":"EpisodeCountQuery","data":{"properties":{"assignee_id":{"default":[],"type":"array","items":{"type":"string"}},"assignee_type":{"default":[],"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"status":{"default":[],"type":"array","items":{"type":"string","enum":["open","closed","in_progress"]}},"priority":{"default":[],"type":"array","items":{"type":"string","enum":["lowest","low","medium","high","highest"]}}},"type":"object"}},"components/schemas/EpisodeCountResponse":{"id":"components/schemas/EpisodeCountResponse","kind":"json-schema","title":"EpisodeCountResponse","data":{"properties":{"count":{"type":"number"}},"type":"object","required":["count"]}},"components/schemas/EpisodeListDto":{"id":"components/schemas/EpisodeListDto","kind":"json-schema","title":"EpisodeListDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"full_name":{"type":"string"}},"type":"object","required":["id"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"assignee_id":{"type":"string","nullable":true},"assignee_type":{"type":"string"},"assignee_name":{"type":"string","nullable":true},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"}},"type":"object","required":["id","type_label","status","category","patient","priority","created_at","title","title_sub_text"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"uid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}},"components/schemas/EpisodeListResponse":{"id":"components/schemas/EpisodeListResponse","kind":"json-schema","title":"EpisodeListResponse","data":{"properties":{"count":{"type":"number"},"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"full_name":{"type":"string"}},"type":"object","required":["id"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"assignee_id":{"type":"string","nullable":true},"assignee_type":{"type":"string"},"assignee_name":{"type":"string","nullable":true},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"}},"type":"object","required":["id","type_label","status","category","patient","priority","created_at","title","title_sub_text"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"uid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}}},"type":"object","required":["count","data"]}},"components/schemas/EpisodeGetParams":{"id":"components/schemas/EpisodeGetParams","kind":"json-schema","title":"EpisodeGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/EpisodeUpdateParams":{"id":"components/schemas/EpisodeUpdateParams","kind":"json-schema","title":"EpisodeUpdateParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/EpisodeUpdateBody":{"id":"components/schemas/EpisodeUpdateBody","kind":"json-schema","title":"EpisodeUpdateBody","data":{"properties":{"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}}},"type":"object"}},"components/schemas/EpisodeUpdateResponse":{"id":"components/schemas/EpisodeUpdateResponse","kind":"json-schema","title":"EpisodeUpdateResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/EventDispatchBody":{"id":"components/schemas/EventDispatchBody","kind":"json-schema","title":"EventDispatchBody","data":{"properties":{"type":{"type":"string"},"payload":{"allOf":[{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]},{"type":"object","additionalProperties":{}}]}},"type":"object","required":["type","payload"]}},"components/schemas/FormLinkCreateBody":{"id":"components/schemas/FormLinkCreateBody","kind":"json-schema","title":"FormLinkCreateBody","data":{"properties":{"form_id":{"type":"string","pattern":"^\\d+$"},"patient_id":{"type":"string","pattern":"^\\d+$"},"expiry_date":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"},"maximum_use_count":{"type":"number","minimum":1}},"type":"object","required":["form_id"]}},"components/schemas/FormLinkCreateResponse":{"id":"components/schemas/FormLinkCreateResponse","kind":"json-schema","title":"FormLinkCreateResponse","data":{"properties":{"form_link":{"type":"string"},"short_link_id":{"type":"string"}},"type":"object","required":["form_link","short_link_id"]}},"components/schemas/FormResponseDto":{"id":"components/schemas/FormResponseDto","kind":"json-schema","title":"FormResponseDto","data":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error"]}},"components/schemas/FormResponseGetParam":{"id":"components/schemas/FormResponseGetParam","kind":"json-schema","title":"FormResponseGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormSubmissionResponseDTO":{"id":"components/schemas/FormSubmissionResponseDTO","kind":"json-schema","title":"FormSubmissionResponseDTO","data":{"properties":{"id":{"type":"string"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"form_question_id":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"id":{"type":"string"},"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"condition_question_id":{"type":"string"}},"type":"object","required":["display_condition","cond_type","cond_value","condition_question_id"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"}},"type":"object","required":["form_question_id","name","type","optional"]}},"patient_id":{"type":"string"},"emis_file_record_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"appointment_id":{"type":"number","nullable":true},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_type","title","description","patient_title","patient_description","confirmation_message","snomed_code","fields","emis_file_record_at","created_at","appointment_id","write_to_record_status"]}},"components/schemas/FormType":{"id":"components/schemas/FormType","kind":"json-schema","title":"FormType","data":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]}},"components/schemas/FormListQuery":{"id":"components/schemas/FormListQuery","kind":"json-schema","title":"FormListQuery","data":{"properties":{"search":{"type":"string"},"reply_form":{"type":"string","enum":["0","1","true","false"]},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]}},"type":"object"}},"components/schemas/FormGetParams":{"id":"components/schemas/FormGetParams","kind":"json-schema","title":"FormGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormListDto":{"id":"components/schemas/FormListDto","kind":"json-schema","title":"FormListDto","data":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]}},"components/schemas/FormList":{"id":"components/schemas/FormList","kind":"json-schema","title":"FormList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/FormField":{"id":"components/schemas/FormField","kind":"json-schema","title":"FormField","data":{"properties":{"form_question_id":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"id":{"type":"string"},"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"condition_question_id":{"type":"string"}},"type":"object","required":["display_condition","cond_type","cond_value","condition_question_id"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"}},"type":"object","required":["form_question_id","name","type","optional"]}},"components/schemas/FormDto":{"id":"components/schemas/FormDto","kind":"json-schema","title":"FormDto","data":{"properties":{"id":{"type":"string"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"form_question_id":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"id":{"type":"string"},"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"condition_question_id":{"type":"string"}},"type":"object","required":["display_condition","cond_type","cond_value","condition_question_id"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"}},"type":"object","required":["form_question_id","name","type","optional"]}}},"type":"object","required":["id","form_type","title","description","patient_title","patient_description","confirmation_message","snomed_code","fields"]}},"components/schemas/FormFieldResponse":{"id":"components/schemas/FormFieldResponse","kind":"json-schema","title":"FormFieldResponse","data":{"properties":{"form_question_id":{"type":"string","pattern":"^\\d+$"},"text_response":{"type":"string"},"integer_response":{"type":"number","nullable":true},"boolean_response":{"type":"boolean"},"checkbox_response":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"datetime_response":{"type":"string"},"observation_value_response":{"type":"string"},"problem_response":{"type":"string"},"immunisation_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"},"base_64_file_response":{"type":"string"}},"type":"object","required":["form_question_id"]}},"components/schemas/FormResponseCreateBody":{"id":"components/schemas/FormResponseCreateBody","kind":"json-schema","title":"FormResponseCreateBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"},"write_to_record":{"default":false,"type":"boolean"},"responses":{"type":"array","items":{"properties":{"form_question_id":{"type":"string","pattern":"^\\d+$"},"text_response":{"type":"string"},"integer_response":{"type":"number","nullable":true},"boolean_response":{"type":"boolean"},"checkbox_response":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"datetime_response":{"type":"string"},"observation_value_response":{"type":"string"},"problem_response":{"type":"string"},"immunisation_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"},"base_64_file_response":{"type":"string"}},"type":"object","required":["form_question_id"]}},"appointment_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id","responses"]}},"components/schemas/FormResponseSaveToRecordBody":{"id":"components/schemas/FormResponseSaveToRecordBody","kind":"json-schema","title":"FormResponseSaveToRecordBody","data":{"properties":{"write_to_record":{"default":false,"type":"boolean"}},"type":"object"}},"components/schemas/FormResponseCreateParam":{"id":"components/schemas/FormResponseCreateParam","kind":"json-schema","title":"FormResponseCreateParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormResponseSaveToRecordParam":{"id":"components/schemas/FormResponseSaveToRecordParam","kind":"json-schema","title":"FormResponseSaveToRecordParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormResponseBody":{"id":"components/schemas/FormResponseBody","kind":"json-schema","title":"FormResponseBody","data":{"properties":{"form_response_id":{"type":"string","pattern":"^\\d+$"},"confirm_write_to_record_url":{"type":"string","nullable":true}},"type":"object","required":["form_response_id"]}},"components/schemas/FormResponseCreateResponse":{"id":"components/schemas/FormResponseCreateResponse","kind":"json-schema","title":"FormResponseCreateResponse","data":{"properties":{"form_response_id":{"type":"string","pattern":"^\\d+$"},"confirm_write_to_record_url":{"type":"string","nullable":true}},"type":"object","required":["form_response_id"]}},"components/schemas/FormResponseSaveToRecordResponse":{"id":"components/schemas/FormResponseSaveToRecordResponse","kind":"json-schema","title":"FormResponseSaveToRecordResponse","data":{"properties":{"form_response_id":{"type":"string","pattern":"^\\d+$"},"confirm_write_to_record_url":{"type":"string","nullable":true}},"type":"object","required":["form_response_id"]}},"components/schemas/FormCreateField":{"id":"components/schemas/FormCreateField","kind":"json-schema","title":"FormCreateField","data":{"properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering reference field. Use this instead of condition_sequential_id."},"children":[]}]}]}]},"condition_sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["display_condition","cond_type","cond_value"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering field. Use this instead of sequential_id."},"children":[]}]}]}]},"sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["name","type","optional"]}},"components/schemas/FormCreateBody":{"id":"components/schemas/FormCreateBody","kind":"json-schema","title":"FormCreateBody","data":{"properties":{"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering reference field. Use this instead of condition_sequential_id."},"children":[]}]}]}]},"condition_sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["display_condition","cond_type","cond_value"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering field. Use this instead of sequential_id."},"children":[]}]}]}]},"sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["name","type","optional"]},"minItems":1}},"type":"object","required":["form_type","title","description","patient_title","patient_description","confirmation_message","snomed_code","fields"]}},"components/schemas/FormCreateResponse":{"id":"components/schemas/FormCreateResponse","kind":"json-schema","title":"FormCreateResponse","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/FormUpdateParams":{"id":"components/schemas/FormUpdateParams","kind":"json-schema","title":"FormUpdateParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormUpdateBody":{"id":"components/schemas/FormUpdateBody","kind":"json-schema","title":"FormUpdateBody","data":{"properties":{"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"confirmation_message":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"fields":{"type":"array","items":{"properties":{"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["string","integer","boolean","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]},"observation_name":{"type":"string","enum":["systolic_blood_pressure","diastolic_blood_pressure","height","weight","body_mass_index"]},"problem_name":{"type":"string","enum":["asthmatic","type_2_diabetes_mellitus","heart_disease","essential_hypertension","copd","atrial_fibrillation","cerebrovascular_accident","type_1_diabetes","ischaemic_heart_disease","rheumatoid_arthritis"]},"immunisation_name":{"type":"string","enum":["administration_of_men_a_c_w135_and_y_vaccine","first_measles_mumps_and_rubella_vaccination_first_mmr","second_measles_mumps_and_rubella_vaccination_second_mmr"]},"hint":{"type":"string","nullable":true},"optional":{"type":"boolean"},"text":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true},"options":{"type":"array","items":{"properties":{"value":{"type":"string"},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["value"]},"nullable":true},"validation":{"properties":{"date_range_validation":{"type":"string","enum":["unrestricted","future","past"]}},"type":"object","nullable":true},"conditions":{"properties":{"display_condition":{"type":"string","enum":["show_when","hide_when"]},"cond_type":{"type":"string","enum":["is equal to","is not equal to"]},"cond_value":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering reference field. Use this instead of condition_sequential_id."},"children":[]}]}]}]},"condition_sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["display_condition","cond_type","cond_value"],"nullable":true},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"string","format":"null","nullable":true},{"type":"null"}]},"attachment_url":{"type":"string"},"order":{"type":"string","pattern":"^\\d+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred ordering field. Use this instead of sequential_id."},"children":[]}]}]}]},"sequential_id":{"type":"string","pattern":"^\\d+$","deprecated":true,"description":"Deprecated. Use order instead."}},"type":"object","required":["name","type","optional"]},"minItems":1}},"type":"object","required":["form_type","title","description","patient_title","patient_description","confirmation_message","snomed_code","fields"]}},"components/schemas/FormUpdateResponse":{"id":"components/schemas/FormUpdateResponse","kind":"json-schema","title":"FormUpdateResponse","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/HeidiTokenResponse":{"id":"components/schemas/HeidiTokenResponse","kind":"json-schema","title":"HeidiTokenResponse","data":{"properties":{"token":{"type":"string"},"expiration_time":{"type":"string","format":"date-time"}},"type":"object","required":["token","expiration_time"]}},"components/schemas/UnauthorisedError":{"id":"components/schemas/UnauthorisedError","kind":"json-schema","title":"UnauthorisedError","data":{"properties":{"error":{"type":"boolean","example":true},"statusCode":{"type":"number","example":401},"message":{"type":"string","example":"Invalid or missing API key"}},"type":"object","required":["error","statusCode","message"]}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"error":{"type":"boolean","example":true},"statusCode":{"type":"number","example":400},"message":{"type":"array","items":{"properties":{"code":{"type":"string","example":"invalid_type"},"expected":{"type":"string","example":"string"},"path":{"type":"array","items":{"type":"string"},"example":["patient_id"]},"message":{"type":"string","example":"Required"}},"type":"object","required":["code","expected","path","message"]}}},"type":"object","required":["error","statusCode","message"]}},"components/schemas/Headers":{"id":"components/schemas/Headers","kind":"json-schema","title":"Headers","data":{"properties":{"x-api-key":{"type":"string"},"x-practice-group-id":{"type":"string"},"x-caller-practice-group-id":{"type":"string"}},"type":"object","required":["x-api-key","x-practice-group-id"]}},"components/schemas/Success":{"id":"components/schemas/Success","kind":"json-schema","title":"Success","data":{"properties":{"success":{"type":"boolean"}},"type":"object","required":["success"]}},"components/schemas/InvoiceItemInput":{"id":"components/schemas/InvoiceItemInput","kind":"json-schema","title":"InvoiceItemInput","data":{"properties":{"price":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"integer","minimum":0,"exclusiveMinimum":0},"unit_amount":{"type":"integer"},"unit_amount_in_pounds":{"type":"number"},"create":{"type":"boolean"},"stripe_id":{"type":"string"}},"type":"object","required":["quantity"]}},"components/schemas/CouponInput":{"id":"components/schemas/CouponInput","kind":"json-schema","title":"CouponInput","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/InvoiceCreateBody":{"id":"components/schemas/InvoiceCreateBody","kind":"json-schema","title":"InvoiceCreateBody","data":{"properties":{"issuer_id":{"type":"string"},"patient_id":{"type":"string"},"appointment_id":{"type":"string"},"practitioner_id":{"type":"string"},"service_date":{"type":"string"},"customer_stripe_id":{"type":"string"},"set_default_customer":{"type":"boolean"},"due_date":{"type":"string"},"collection_method":{"type":"string","enum":["request_payment","charge_automatically"]},"payment_source":{"type":"string"},"insurer":{"type":"string"},"authentication_code":{"type":"string"},"membership_number":{"type":"string"},"diagnosis":{"type":"string"},"memo":{"type":"string"},"footer":{"type":"string"},"confidential":{"type":"boolean"},"mode":{"default":"draft","type":"string","enum":["draft","finalize"]},"coupons":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id"]}},"invoice_items_attributes":{"type":"array","items":{"properties":{"price":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"integer","minimum":0,"exclusiveMinimum":0},"unit_amount":{"type":"integer"},"unit_amount_in_pounds":{"type":"number"},"create":{"type":"boolean"},"stripe_id":{"type":"string"}},"type":"object","required":["quantity"]}}},"type":"object","required":["issuer_id"]}},"components/schemas/Invoice":{"id":"components/schemas/Invoice","kind":"json-schema","title":"Invoice","data":{"properties":{"id":{"type":"string","nullable":true},"stripe_id":{"type":"string"},"status":{"type":"string"},"subtotal":{"type":"number"},"amount_due":{"type":"number"},"customer_id":{"type":"string","nullable":true},"patient_record_id":{"type":"string","nullable":true},"appointment_id":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["stripe_id"]}},"components/schemas/InvoiceUpdateParams":{"id":"components/schemas/InvoiceUpdateParams","kind":"json-schema","title":"InvoiceUpdateParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/InvoiceUpdateBody":{"id":"components/schemas/InvoiceUpdateBody","kind":"json-schema","title":"InvoiceUpdateBody","data":{"properties":{"issuer_id":{"type":"string"},"appointment_id":{"type":"string"},"practitioner_id":{"type":"string"},"service_date":{"type":"string"},"customer_stripe_id":{"type":"string"},"set_default_customer":{"type":"boolean"},"due_date":{"type":"string"},"collection_method":{"type":"string","enum":["request_payment","charge_automatically"]},"payment_source":{"type":"string"},"insurer":{"type":"string"},"authentication_code":{"type":"string"},"membership_number":{"type":"string"},"diagnosis":{"type":"string"},"memo":{"type":"string"},"footer":{"type":"string"},"confidential":{"type":"boolean"},"mode":{"type":"string","enum":["draft","finalize"]},"coupons":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id"]}},"invoice_items_attributes":{"type":"array","items":{"properties":{"price":{"type":"string"},"product":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"integer","minimum":0,"exclusiveMinimum":0},"unit_amount":{"type":"integer"},"unit_amount_in_pounds":{"type":"number"},"create":{"type":"boolean"},"stripe_id":{"type":"string"}},"type":"object","required":["quantity"]}}},"type":"object","required":["issuer_id"]}},"components/schemas/InvoiceLinkBody":{"id":"components/schemas/InvoiceLinkBody","kind":"json-schema","title":"InvoiceLinkBody","data":{"properties":{"stripe_invoice_id":{"type":"string"},"appointment_id":{"type":"string"},"issuer_id":{"type":"string"}},"type":"object","required":["stripe_invoice_id","appointment_id","issuer_id"]}},"components/schemas/LinkStatusObjectType":{"id":"components/schemas/LinkStatusObjectType","kind":"json-schema","title":"LinkStatusObjectType","data":{"type":"string","enum":["booking","questionnaire","attachment","patient_reply","video"]}},"components/schemas/LinkStatusQuery":{"id":"components/schemas/LinkStatusQuery","kind":"json-schema","title":"LinkStatusQuery","data":{"oneOf":[{"properties":{"url":{"type":"string"}},"type":"object","required":["url"]},{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}]}},"components/schemas/LinkStatusResponseReferences":{"id":"components/schemas/LinkStatusResponseReferences","kind":"json-schema","title":"LinkStatusResponseReferences","data":{"properties":{"type":{"type":"string","enum":["booking","questionnaire","attachment","patient_reply","video"]},"id":{"type":"string"}},"type":"object","required":["type","id"]}},"components/schemas/LinkStatusResponse":{"id":"components/schemas/LinkStatusResponse","kind":"json-schema","title":"LinkStatusResponse","data":{"properties":{"status":{"type":"string","enum":["unused","used","partially_used","expired","disabled"]},"type":{"type":"string","enum":["booking","questionnaire","attachment","patient_reply","video"]},"reference":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["booking","questionnaire","attachment","patient_reply","video"]},"id":{"type":"string"}},"type":"object","required":["type","id"]}}},"type":"object","required":["status","type"]}},"components/schemas/LocationInclude":{"id":"components/schemas/LocationInclude","kind":"json-schema","title":"LocationInclude","data":{"type":"string","enum":["archived"]}},"components/schemas/LocationOrderBy":{"id":"components/schemas/LocationOrderBy","kind":"json-schema","title":"LocationOrderBy","data":{"type":"string","enum":["name","slot_count"]}},"components/schemas/LocationListQuery":{"id":"components/schemas/LocationListQuery","kind":"json-schema","title":"LocationListQuery","data":{"properties":{"appointment_type_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"has_availability":{"type":"boolean","nullable":true},"search":{"type":"string","minLength":1},"include":{"type":"array","items":{"type":"string","enum":["archived"]},"minItems":1},"order_by":{"type":"string","enum":["name","slot_count"]},"order_descending":{"default":"false","type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/LocationGetQuery":{"id":"components/schemas/LocationGetQuery","kind":"json-schema","title":"LocationGetQuery","data":{"properties":{"include":{"type":"array","items":{"type":"string","enum":["archived"]},"minItems":1}},"type":"object"}},"components/schemas/LocationDto":{"id":"components/schemas/LocationDto","kind":"json-schema","title":"LocationDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_site_name":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"map_url":{"type":"string","nullable":true},"latitude":{"type":"string","nullable":true},"longitude":{"type":"string","nullable":true},"no_availability_text":{"type":"string","nullable":true},"address":{"properties":{"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["line_1","line_2","line_3","town","county","postcode"],"nullable":true},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","partner_site_name","about","email","phone_number","map_url","latitude","longitude","no_availability_text","address","archived_at","created_at","updated_at"]}},"components/schemas/LocationListItem":{"id":"components/schemas/LocationListItem","kind":"json-schema","title":"LocationListItem","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_site_name":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"map_url":{"type":"string","nullable":true},"latitude":{"type":"string","nullable":true},"longitude":{"type":"string","nullable":true},"no_availability_text":{"type":"string","nullable":true},"address":{"properties":{"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["line_1","line_2","line_3","town","county","postcode"],"nullable":true},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"slot_count":{"type":"number"},"next_available_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","partner_site_name","about","email","phone_number","map_url","latitude","longitude","no_availability_text","address","archived_at","created_at","updated_at","slot_count","next_available_at"]}},"components/schemas/LocationList":{"id":"components/schemas/LocationList","kind":"json-schema","title":"LocationList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_site_name":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"map_url":{"type":"string","nullable":true},"latitude":{"type":"string","nullable":true},"longitude":{"type":"string","nullable":true},"no_availability_text":{"type":"string","nullable":true},"address":{"properties":{"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["line_1","line_2","line_3","town","county","postcode"],"nullable":true},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"slot_count":{"type":"number"},"next_available_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","partner_site_name","about","email","phone_number","map_url","latitude","longitude","no_availability_text","address","archived_at","created_at","updated_at","slot_count","next_available_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/LocationGetResponse":{"id":"components/schemas/LocationGetResponse","kind":"json-schema","title":"LocationGetResponse","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"partner_site_name":{"type":"string","nullable":true},"about":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"map_url":{"type":"string","nullable":true},"latitude":{"type":"string","nullable":true},"longitude":{"type":"string","nullable":true},"no_availability_text":{"type":"string","nullable":true},"address":{"properties":{"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["line_1","line_2","line_3","town","county","postcode"],"nullable":true},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"slot_count":{"type":"number"},"next_available_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","partner_site_name","about","email","phone_number","map_url","latitude","longitude","no_availability_text","address","archived_at","created_at","updated_at","slot_count","next_available_at"]}},"components/schemas/LocationGetParam":{"id":"components/schemas/LocationGetParam","kind":"json-schema","title":"LocationGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/LocationCreateBody":{"id":"components/schemas/LocationCreateBody","kind":"json-schema","title":"LocationCreateBody","data":{"properties":{"name":{"type":"string"},"about":{"type":"string"},"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"map_url":{"type":"string","format":"uri"},"latitude":{"type":"number"},"longitude":{"type":"number"},"no_availability_text":{"type":"string"},"address":{"properties":{"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"}},"type":"object"}},"type":"object","required":["name"],"additionalProperties":false}},"components/schemas/LocationUpdateBody":{"id":"components/schemas/LocationUpdateBody","kind":"json-schema","title":"LocationUpdateBody","data":{"properties":{"name":{"type":"string"},"about":{"type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"phone_number":{"type":"string","nullable":true},"map_url":{"type":"string","format":"uri","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"no_availability_text":{"type":"string","nullable":true},"address":{"properties":{"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"}},"type":"object","nullable":true}},"type":"object","additionalProperties":false}},"components/schemas/MedicationCollectionGetParams":{"id":"components/schemas/MedicationCollectionGetParams","kind":"json-schema","title":"MedicationCollectionGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/MedicationCollection":{"id":"components/schemas/MedicationCollection","kind":"json-schema","title":"MedicationCollection","data":{"properties":{"date":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"string"},"quantity_units":{"type":"string"},"quantity_representation":{"type":"string"},"directions":{"type":"string"},"snomed_code":{"type":"string"}},"type":"object","required":["date","name","quantity","quantity_units","quantity_representation","directions","snomed_code"]}},"components/schemas/MedicationCollectionResponse":{"id":"components/schemas/MedicationCollectionResponse","kind":"json-schema","title":"MedicationCollectionResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"date":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"string"},"quantity_units":{"type":"string"},"quantity_representation":{"type":"string"},"directions":{"type":"string"},"snomed_code":{"type":"string"}},"type":"object","required":["date","name","quantity","quantity_units","quantity_representation","directions","snomed_code"]},"nullable":true},"count":{"type":"number","nullable":true},"last_updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["data","count","last_updated_at"]}},"components/schemas/MembershipPolicy":{"id":"components/schemas/MembershipPolicy","kind":"json-schema","title":"MembershipPolicy","data":{"properties":{"id":{"type":"string","nullable":true},"practice_group_id":{"type":"string","nullable":true},"membership_scheme_id":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/MembershipPolicyCreateBody":{"id":"components/schemas/MembershipPolicyCreateBody","kind":"json-schema","title":"MembershipPolicyCreateBody","data":{"allOf":[{"oneOf":[{"properties":{"collection_method":{"type":"string","enum":["charge_automatically"]},"payment_method":{"type":"string"}},"type":"object","required":["collection_method","payment_method"]},{"properties":{"collection_method":{"type":"string","enum":["send_invoice"]},"days_until_due":{"type":"number"}},"type":"object","required":["collection_method","days_until_due"]}]},{"properties":{"membership_scheme_id":{"type":"string","minLength":1},"customer":{"type":"string"},"price":{"type":"string"},"quantity":{"type":"number"},"starts_on":{"type":"number"},"billing_cycle_anchor":{"type":"number"},"discounts":{"type":"array","items":{"properties":{"coupon":{"type":"string"}},"type":"object","required":["coupon"]}},"members":{"type":"array","items":{"properties":{"patient_id":{"type":"string"}},"type":"object","required":["patient_id"]}}},"type":"object","required":["membership_scheme_id","customer","price","quantity","starts_on","billing_cycle_anchor","discounts","members"]}]}},"components/schemas/MembershipPolicyIdParam":{"id":"components/schemas/MembershipPolicyIdParam","kind":"json-schema","title":"MembershipPolicyIdParam","data":{"properties":{"id":{"type":"string","minLength":1}},"type":"object","required":["id"]}},"components/schemas/MembershipMemberParam":{"id":"components/schemas/MembershipMemberParam","kind":"json-schema","title":"MembershipMemberParam","data":{"properties":{"id":{"type":"string","minLength":1},"patient_id":{"type":"string","minLength":1}},"type":"object","required":["id","patient_id"]}},"components/schemas/MembershipMemberCreateBody":{"id":"components/schemas/MembershipMemberCreateBody","kind":"json-schema","title":"MembershipMemberCreateBody","data":{"properties":{"patient_id":{"type":"string","minLength":1}},"type":"object","required":["patient_id"]}},"components/schemas/MembershipMember":{"id":"components/schemas/MembershipMember","kind":"json-schema","title":"MembershipMember","data":{"properties":{"id":{"type":"string","nullable":true},"patient_id":{"type":"string","nullable":true},"membership_policy_id":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/MembershipScheme":{"id":"components/schemas/MembershipScheme","kind":"json-schema","title":"MembershipScheme","data":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]},"product":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"default_price":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]},"prices":{"type":"array","items":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]}}},"type":"object","required":["id","name","prices"]}},"type":"object","required":["name","length","product"]}},"components/schemas/MembershipSchemeList":{"id":"components/schemas/MembershipSchemeList","kind":"json-schema","title":"MembershipSchemeList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]},"product":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"default_price":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]},"prices":{"type":"array","items":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]}}},"type":"object","required":["id","name","prices"]}},"type":"object","required":["name","length","product"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/MessageStatusEnum":{"id":"components/schemas/MessageStatusEnum","kind":"json-schema","title":"MessageStatusEnum","data":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]}},"components/schemas/MessageGetParams":{"id":"components/schemas/MessageGetParams","kind":"json-schema","title":"MessageGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/MessageGetResponse":{"id":"components/schemas/MessageGetResponse","kind":"json-schema","title":"MessageGetResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","title","first_name","last_name"]},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["write_to_record_at","status","failure_reason","snomed_code"]},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"campaign":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"scheduled_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]},"sent_by_admin":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name"]},"recipient_contact_detail":{"type":"string"},"message_type":{"type":"string"},"message":{"type":"string","nullable":true},"attachments":{"type":"array","items":{"properties":{"file_name":{"type":"string","nullable":true},"file_key":{"type":"string","nullable":true},"attachment_url":{"type":"string","nullable":true}},"type":"object"}},"fallback_attempts":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"message_type":{"type":"string"},"created_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"],"nullable":true},"recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","message_type","created_at","sent_at","status","recipient_contact_detail","failure_reason"]}}},"type":"object","required":["id","patient","write_to_record","short_link","campaign","created_at","sent_at","scheduled_at","status","sent_by_admin","recipient_contact_detail","message_type","message"]}},"components/schemas/MessageStatus":{"id":"components/schemas/MessageStatus","kind":"json-schema","title":"MessageStatus","data":{"properties":{"id":{"type":"string"},"scheduled_send_at":{"type":"string","format":"date-time","nullable":true},"write_to_record":{"type":"boolean"},"status":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"response":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["write_to_record_at","sent_at","response","failure_reason"]},"errors":{"properties":{"write_to_record":{"type":"string","nullable":true},"send":{"type":"string","nullable":true}},"type":"object","required":["write_to_record","send"]}},"type":"object","required":["id","scheduled_send_at","write_to_record","status","errors"]}},"components/schemas/MessageStatusGetParams":{"id":"components/schemas/MessageStatusGetParams","kind":"json-schema","title":"MessageStatusGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/MessageSendBody":{"id":"components/schemas/MessageSendBody","kind":"json-schema","title":"MessageSendBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$","description":"The Hero patient the message relates to"},"message_type":{"type":"string","enum":["hero","sms","email","nhs_app"],"description":"Defines if the message will be sent on via Hero's comms tools, and by what method"},"message_string":{"type":"string","minLength":1,"description":"Message content to be sent from Hero"},"recipient_contact_detail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the message will be sent (e.g. patient@email.com or +44 79000000000). If no value is provided a default will be picked from the patients record (for that contact method, SMS/Email)."},"children":[]}]}]}]},"fallback_contact_detail":{"type":"string"},"fallback_message_type":{"type":"string","enum":["sms","email"]},"write_to_record":{"default":false,"type":"boolean","description":"Flags if the message should be written to the EHR record post-approval"},"encrypted":{"default":false,"oneOf":[{"type":"boolean"},{"type":"string","enum":["dob_authenticated"]}],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. This field is ignored — messages are no longer encrypted at the platform layer."},"children":[]}]}]}]},"snomed_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SNOMED code to be attached to the EHR record entry.  Default value applied if not passed and write_to_record is true"},"children":[]}]}]}]},"snomed_term":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SNOMED term to be attached to the EHR record entry. Default value applied if not passed and write_to_record is true"},"children":[]}]}]}]},"task_id":{"type":"string","description":"Task ID to be attached to a task"},"attachment_uuid":{"type":"string","minLength":1},"short_link_id":{"type":"string","minLength":1},"assignee_id":{"type":"number","description":"Optional. ID of the Admin or AdminTeam assigned to the message"},"assignee_type":{"type":"string","description":"Type of the assignee, either Admin or AdminTeam, assigned to the message"},"send_at":{"type":"string","format":"date-time","description":"Specifies the scheduled date and time to send the message."},"episode_id":{"type":"string","minLength":1}},"type":"object","required":["patient_id","message_type","message_string"]}},"components/schemas/MessageSendResult":{"id":"components/schemas/MessageSendResult","kind":"json-schema","title":"MessageSendResult","data":{"properties":{"message_id":{"type":"string"},"content":{"type":"string"},"created_at":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"write_to_record":{"type":"boolean"},"auth_token":{"type":"string","nullable":true},"confirm_write_to_record_url":{"type":"string","nullable":true},"submitted_by":{"type":"string","nullable":true},"send_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["message_id","content","created_at","write_to_record"]}},"components/schemas/AssigneesCollectionDto":{"id":"components/schemas/AssigneesCollectionDto","kind":"json-schema","title":"AssigneesCollectionDto","data":{"properties":{"label":{"type":"string"},"value":{"type":"number","nullable":true},"type":{"type":"string"},"key":{"type":"string"}},"type":"object","required":["label","value","type","key"]}},"components/schemas/AssigneesCollectionResult":{"id":"components/schemas/AssigneesCollectionResult","kind":"json-schema","title":"AssigneesCollectionResult","data":{"properties":{"data":{"type":"array","items":{"properties":{"label":{"type":"string"},"value":{"type":"number","nullable":true},"type":{"type":"string"},"key":{"type":"string"}},"type":"object","required":["label","value","type","key"]}}},"type":"object","required":["data"]}},"components/schemas/NoteCreateBody":{"id":"components/schemas/NoteCreateBody","kind":"json-schema","title":"NoteCreateBody","data":{"properties":{"episode_id":{"type":"string","pattern":"^\\d+$"},"description":{"type":"string","minLength":1,"description":"The content of the note to add to the episode.","example":"Patient reported improved symptoms today."}},"type":"object","required":["episode_id","description"]}},"components/schemas/NoteDto":{"id":"components/schemas/NoteDto","kind":"json-schema","title":"NoteDto","data":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]}},"components/schemas/NoteCreateResponse":{"id":"components/schemas/NoteCreateResponse","kind":"json-schema","title":"NoteCreateResponse","data":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]}},"components/schemas/ListPartnersFromDb":{"id":"components/schemas/ListPartnersFromDb","kind":"json-schema","title":"ListPartnersFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string","nullable":true}},"type":"object","required":["id","name"]}},"components/schemas/PartnersListQuery":{"id":"components/schemas/PartnersListQuery","kind":"json-schema","title":"PartnersListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"hero_api_partner":{"type":"boolean","nullable":true}},"type":"object"}},"components/schemas/PartnersListResponse":{"id":"components/schemas/PartnersListResponse","kind":"json-schema","title":"PartnersListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string","nullable":true}},"type":"object","required":["id","name"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PathwayDto":{"id":"components/schemas/PathwayDto","kind":"json-schema","title":"PathwayDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string"},"summary":{"type":"string","nullable":true},"in_hours":{"type":"boolean","nullable":true},"out_of_hours":{"type":"boolean","nullable":true},"suspended":{"type":"boolean","nullable":true},"order":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","title","summary","in_hours","out_of_hours","suspended","order","created_at","updated_at"]}},"components/schemas/PathwayList":{"id":"components/schemas/PathwayList","kind":"json-schema","title":"PathwayList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string"},"summary":{"type":"string","nullable":true},"in_hours":{"type":"boolean","nullable":true},"out_of_hours":{"type":"boolean","nullable":true},"suspended":{"type":"boolean","nullable":true},"order":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","title","summary","in_hours","out_of_hours","suspended","order","created_at","updated_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PathwayGetParams":{"id":"components/schemas/PathwayGetParams","kind":"json-schema","title":"PathwayGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PathwayListParams":{"id":"components/schemas/PathwayListParams","kind":"json-schema","title":"PathwayListParams","data":{"properties":{"has_forms":{"type":"string","enum":["0","1","true","false"]}},"type":"object"}},"components/schemas/PathwayCreateBody":{"id":"components/schemas/PathwayCreateBody","kind":"json-schema","title":"PathwayCreateBody","data":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"in_hours":{"default":false,"type":"boolean"},"out_of_hours":{"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0},"submission_types":{"type":"array","items":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"in_hours":{"default":false,"type":"boolean"},"out_of_hours":{"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"form_id":{"type":"string","pattern":"^\\d+$"},"external_url":{"type":"string","format":"uri"},"external_url_name":{"type":"string"},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"]},"default_priority":{"default":"medium","type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","minimum":0,"exclusiveMinimum":0},"patient_eligibility_check":{"default":true,"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$"},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"]},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0}},"type":"object","required":["title"],"additionalProperties":false},"minItems":1}},"type":"object","required":["title","submission_types"],"additionalProperties":false}},"components/schemas/PathwayUpdateBody":{"id":"components/schemas/PathwayUpdateBody","kind":"json-schema","title":"PathwayUpdateBody","data":{"properties":{"title":{"type":"string"},"summary":{"type":"string","nullable":true},"in_hours":{"type":"boolean"},"out_of_hours":{"type":"boolean"},"suspended":{"type":"boolean"},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0}},"type":"object","additionalProperties":false}},"components/schemas/PatientRegisterPdsDobObject":{"id":"components/schemas/PatientRegisterPdsDobObject","kind":"json-schema","title":"PatientRegisterPdsDobObject","data":{"properties":{"nhs_number":{"type":"string","description":"A valid NHS number"},"dob":{"type":"string","format":"date-time","nullable":true},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object","required":["nhs_number","dob"]}},"components/schemas/PatientRegisterPdsDemographicsObject":{"id":"components/schemas/PatientRegisterPdsDemographicsObject","kind":"json-schema","title":"PatientRegisterPdsDemographicsObject","data":{"properties":{"dob":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"postcode":{"type":"string","minLength":1},"forename":{"type":"string","minLength":1},"surname":{"type":"string","minLength":1},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object"}},"components/schemas/PatientRegisterPdsBodyObject":{"id":"components/schemas/PatientRegisterPdsBodyObject","kind":"json-schema","title":"PatientRegisterPdsBodyObject","data":{"oneOf":[{"properties":{"nhs_number":{"type":"string","description":"A valid NHS number"},"dob":{"type":"string","format":"date-time","nullable":true},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object","required":["nhs_number","dob"]},{"properties":{"dob":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"postcode":{"type":"string","minLength":1},"forename":{"type":"string","minLength":1},"surname":{"type":"string","minLength":1},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object"}]}},"components/schemas/PatientRegisterPdsBody":{"id":"components/schemas/PatientRegisterPdsBody","kind":"json-schema","title":"PatientRegisterPdsBody","data":{"oneOf":[{"properties":{"nhs_number":{"type":"string","description":"A valid NHS number"},"dob":{"type":"string","format":"date-time","nullable":true},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object","required":["nhs_number","dob"]},{"properties":{"dob":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"postcode":{"type":"string","minLength":1},"forename":{"type":"string","minLength":1},"surname":{"type":"string","minLength":1},"ehr_partner":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1}},"type":"object"}]}},"components/schemas/RegisteredPractitionerFromDb":{"id":"components/schemas/RegisteredPractitionerFromDb","kind":"json-schema","title":"RegisteredPractitionerFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"email":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"contact_number":{"type":"string","nullable":true},"sex":{"type":"number","minimum":0,"maximum":3,"nullable":true},"ehr_partner_name":{"type":"string","nullable":true}},"type":"object","required":["id","title","first_name","last_name"]}},"components/schemas/RegisteredPractitionerDto":{"id":"components/schemas/RegisteredPractitionerDto","kind":"json-schema","title":"RegisteredPractitionerDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"email":{"type":"string","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"contact_number":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"ehr_partner_name":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name"]}},"components/schemas/BillingDetailsFromDb":{"id":"components/schemas/BillingDetailsFromDb","kind":"json-schema","title":"BillingDetailsFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"external_billing_id":{"type":"string"},"insurance":{"properties":{"insurer":{"type":"string","nullable":true},"membership_number":{"type":"string","nullable":true},"auth_code":{"type":"string","nullable":true}},"type":"object","required":["insurer","membership_number","auth_code"]},"billing_note":{"type":"string","nullable":true},"confidential":{"type":"boolean","nullable":true}},"type":"object","required":["id","external_billing_id","insurance","billing_note","confidential"]}},"components/schemas/PatientRegisterResponse":{"id":"components/schemas/PatientRegisterResponse","kind":"json-schema","title":"PatientRegisterResponse","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/PatientRegisterPdsResponse":{"id":"components/schemas/PatientRegisterPdsResponse","kind":"json-schema","title":"PatientRegisterPdsResponse","data":{"oneOf":[{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]},{"properties":{"message":{"type":"string"},"login_url":{"type":"string"}},"type":"object","required":["message","login_url"]}]}},"components/schemas/PatientGetParams":{"id":"components/schemas/PatientGetParams","kind":"json-schema","title":"PatientGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PatientGetByIdentifierParams":{"id":"components/schemas/PatientGetByIdentifierParams","kind":"json-schema","title":"PatientGetByIdentifierParams","data":{"properties":{"id":{"type":"string"},"identifier":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]}},"type":"object","required":["id","identifier"]}},"components/schemas/ChecksSchema":{"id":"components/schemas/ChecksSchema","kind":"json-schema","title":"ChecksSchema","data":{"properties":{"address_line1_check":{"type":"string","nullable":true},"address_postal_code_check":{"type":"string","nullable":true},"cvc_check":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/NetworksSchema":{"id":"components/schemas/NetworksSchema","kind":"json-schema","title":"NetworksSchema","data":{"properties":{"available":{"type":"array","items":{"type":"string"}},"preferred":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/ThreeDSecureUsageSchema":{"id":"components/schemas/ThreeDSecureUsageSchema","kind":"json-schema","title":"ThreeDSecureUsageSchema","data":{"properties":{"supported":{"type":"boolean"}},"type":"object","required":["supported"]}},"components/schemas/PaymentMethodsFromDb":{"id":"components/schemas/PaymentMethodsFromDb","kind":"json-schema","title":"PaymentMethodsFromDb","data":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"checks":{"properties":{"address_line1_check":{"type":"string","nullable":true},"address_postal_code_check":{"type":"string","nullable":true},"cvc_check":{"type":"string","nullable":true}},"type":"object"},"wallet":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true},"exp_year":{"type":"number","nullable":true},"networks":{"properties":{"available":{"type":"array","items":{"type":"string"}},"preferred":{"type":"string","nullable":true}},"type":"object"},"exp_month":{"type":"number","nullable":true},"display_brand":{"type":"string","nullable":true},"generated_from":{"type":"string","nullable":true},"fingerprint":{"type":"string","nullable":true},"regulated_status":{"type":"string","nullable":true},"three_d_secure_usage":{"properties":{"supported":{"type":"boolean"}},"type":"object","required":["supported"]}},"type":"object","required":["id","type","brand","last4","country","funding","exp_year","exp_month","fingerprint","regulated_status"]}},"components/schemas/PatientPaymentMethodsResponse":{"id":"components/schemas/PatientPaymentMethodsResponse","kind":"json-schema","title":"PatientPaymentMethodsResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"brand":{"type":"string"},"last4":{"type":"string"},"checks":{"properties":{"address_line1_check":{"type":"string","nullable":true},"address_postal_code_check":{"type":"string","nullable":true},"cvc_check":{"type":"string","nullable":true}},"type":"object"},"wallet":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true},"exp_year":{"type":"number","nullable":true},"networks":{"properties":{"available":{"type":"array","items":{"type":"string"}},"preferred":{"type":"string","nullable":true}},"type":"object"},"exp_month":{"type":"number","nullable":true},"display_brand":{"type":"string","nullable":true},"generated_from":{"type":"string","nullable":true},"fingerprint":{"type":"string","nullable":true},"regulated_status":{"type":"string","nullable":true},"three_d_secure_usage":{"properties":{"supported":{"type":"boolean"}},"type":"object","required":["supported"]}},"type":"object","required":["id","type","brand","last4","country","funding","exp_year","exp_month","fingerprint","regulated_status"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PatientFromDb":{"id":"components/schemas/PatientFromDb","kind":"json-schema","title":"PatientFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"number","minimum":0,"maximum":3,"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"number"},"restricted":{"default":false,"type":"boolean"}},"type":"object","required":["id","dob","data_source"]}},"components/schemas/PatientDto":{"id":"components/schemas/PatientDto","kind":"json-schema","title":"PatientDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"address_line_1":{"type":"string","nullable":true},"address_line_2":{"type":"string","nullable":true},"address_line_3":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"verification_credentials":{"type":"array","items":{"type":"string"},"nullable":true},"patient_memberships":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"active":{"type":"boolean"},"membership":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]}},"type":"object","required":["name","length"]}},"type":"object","required":["id","active","membership"]},"nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]},"restricted":{"default":false,"type":"boolean"},"sex_changed_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["archived","unarchived"]},"ods_code":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["id","dob","data_source","status","identifiers","ehr_registered"]}},"components/schemas/EhrPatientDto":{"id":"components/schemas/EhrPatientDto","kind":"json-schema","title":"EhrPatientDto","data":{"properties":{"ehr_partner_id":{"type":"string"},"nhs_number":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["ehr_partner_id","dob"]}},"components/schemas/PatientListResponse":{"id":"components/schemas/PatientListResponse","kind":"json-schema","title":"PatientListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"address_line_1":{"type":"string","nullable":true},"address_line_2":{"type":"string","nullable":true},"address_line_3":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"verification_credentials":{"type":"array","items":{"type":"string"},"nullable":true},"patient_memberships":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"active":{"type":"boolean"},"membership":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]}},"type":"object","required":["name","length"]}},"type":"object","required":["id","active","membership"]},"nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]},"restricted":{"default":false,"type":"boolean"},"sex_changed_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["archived","unarchived"]},"ods_code":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["id","dob","data_source","status","identifiers","ehr_registered"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PatientListQuery":{"id":"components/schemas/PatientListQuery","kind":"json-schema","title":"PatientListQuery","data":{"properties":{"field":{"type":"string","enum":["emis_id","nhs_number","dob"]},"search":{"type":"string"}},"type":"object"}},"components/schemas/PatientRegisterBodyObject":{"id":"components/schemas/PatientRegisterBodyObject","kind":"json-schema","title":"PatientRegisterBodyObject","data":{"properties":{"ehr_partner_id":{"type":"string"},"nhs_number":{"type":"string","minLength":1},"dob":{"type":"string","minLength":1},"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"oneOf":[{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]},{"type":"string"}]},"landline":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"address_line_3":{"type":"string"},"country":{"type":"string"},"postcode":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"data_source":{"default":"emis","type":"string","enum":["hero","emis","pds","gha","systm_one"]},"caller":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Internal use only] The name of the application calling the register endpoint"},"children":[]}]}]}]}},"type":"object","required":["dob","first_name","last_name"]}},"components/schemas/PatientRegisterBody":{"id":"components/schemas/PatientRegisterBody","kind":"json-schema","title":"PatientRegisterBody","data":{"oneOf":[{"properties":{"ehr_partner_id":{"type":"string"},"nhs_number":{"type":"string"},"dob":{"type":"string","minLength":1},"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"oneOf":[{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]},{"type":"string"}]},"landline":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"address_line_3":{"type":"string"},"country":{"type":"string"},"postcode":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"data_source":{"default":"emis","type":"string","enum":["hero","emis","pds","gha","systm_one"]},"caller":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Internal use only] The name of the application calling the register endpoint"},"children":[]}]}]}]},"mobile":{"type":"string","minLength":1},"email":{"type":"string"}},"type":"object","required":["dob","first_name","last_name","mobile"]},{"properties":{"ehr_partner_id":{"type":"string"},"nhs_number":{"type":"string"},"dob":{"type":"string","minLength":1},"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"oneOf":[{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]},{"type":"string"}]},"landline":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"address_line_3":{"type":"string"},"country":{"type":"string"},"postcode":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"data_source":{"default":"emis","type":"string","enum":["hero","emis","pds","gha","systm_one"]},"caller":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Internal use only] The name of the application calling the register endpoint"},"children":[]}]}]}]},"mobile":{"type":"string"},"email":{"type":"string","minLength":1}},"type":"object","required":["dob","first_name","last_name","email"]},{"properties":{"ehr_partner_id":{"type":"string"},"nhs_number":{"type":"string","minLength":1},"dob":{"type":"string","minLength":1},"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"oneOf":[{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]},{"type":"string"}]},"landline":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"address_line_3":{"type":"string"},"country":{"type":"string"},"postcode":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"data_source":{"default":"emis","type":"string","enum":["hero","emis","pds","gha","systm_one"]},"caller":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Internal use only] The name of the application calling the register endpoint"},"children":[]}]}]}]},"mobile":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["nhs_number","dob","first_name","last_name"]},{"properties":{"ehr_partner_id":{"type":"string","minLength":1},"nhs_number":{"type":"string"},"dob":{"type":"string","minLength":1},"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"oneOf":[{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","Viscount","Viscountess",""]},{"type":"string"}]},"landline":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"address_line_3":{"type":"string"},"country":{"type":"string"},"postcode":{"type":"string"},"town":{"type":"string"},"county":{"type":"string"},"data_source":{"default":"emis","type":"string","enum":["hero","emis","pds","gha","systm_one"]},"caller":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Internal use only] The name of the application calling the register endpoint"},"children":[]}]}]}]},"mobile":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["ehr_partner_id","dob","first_name","last_name"]}]}},"components/schemas/PatientAttachmentGetParams":{"id":"components/schemas/PatientAttachmentGetParams","kind":"json-schema","title":"PatientAttachmentGetParams","data":{"properties":{"id":{"type":"string","description":"The ID of the patient"},"attachmentId":{"type":"string","description":"The ID of the attachment to download"}},"type":"object","required":["id","attachmentId"]}},"components/schemas/PatientListEhrCandidatesResponse":{"id":"components/schemas/PatientListEhrCandidatesResponse","kind":"json-schema","title":"PatientListEhrCandidatesResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PatientEhrProblemDto":{"id":"components/schemas/PatientEhrProblemDto","kind":"json-schema","title":"PatientEhrProblemDto","data":{"properties":{"guid":{"type":"string"},"code":{"type":"string"},"code_scheme":{"type":"string"},"emis_code":{"type":"string"},"term":{"type":"string"},"status":{"type":"string"},"significance":{"type":"string"},"expected_duration":{"type":"string"},"onset":{"type":"string"}},"type":"object"}},"components/schemas/PatientListEhrProblemsResponse":{"id":"components/schemas/PatientListEhrProblemsResponse","kind":"json-schema","title":"PatientListEhrProblemsResponse","data":{"properties":{"problems":{"type":"array","items":{"properties":{"guid":{"type":"string"},"code":{"type":"string"},"code_scheme":{"type":"string"},"emis_code":{"type":"string"},"term":{"type":"string"},"status":{"type":"string"},"significance":{"type":"string"},"expected_duration":{"type":"string"},"onset":{"type":"string"}},"type":"object"}}},"type":"object","required":["problems"]}},"components/schemas/PatientConnectEhrBody":{"id":"components/schemas/PatientConnectEhrBody","kind":"json-schema","title":"PatientConnectEhrBody","data":{"properties":{"ehr_partner_id":{"type":"string"}},"type":"object","required":["ehr_partner_id"]}},"components/schemas/PatientRegisterWithEhrBody":{"id":"components/schemas/PatientRegisterWithEhrBody","kind":"json-schema","title":"PatientRegisterWithEhrBody","data":{"properties":{"ehr_partner_id":{"type":"string","minLength":1},"dob":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["ehr_partner_id","dob"]}},"components/schemas/PatientMergePreviewBody":{"id":"components/schemas/PatientMergePreviewBody","kind":"json-schema","title":"PatientMergePreviewBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/PatientMergePreviewResponse":{"id":"components/schemas/PatientMergePreviewResponse","kind":"json-schema","title":"PatientMergePreviewResponse","data":{"properties":{"main_patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"address_line_1":{"type":"string","nullable":true},"address_line_2":{"type":"string","nullable":true},"address_line_3":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"verification_credentials":{"type":"array","items":{"type":"string"},"nullable":true},"patient_memberships":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"active":{"type":"boolean"},"membership":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]}},"type":"object","required":["name","length"]}},"type":"object","required":["id","active","membership"]},"nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]},"restricted":{"default":false,"type":"boolean"},"sex_changed_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["archived","unarchived"]},"ods_code":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["id","dob","data_source","status","identifiers","ehr_registered"]},"incoming_patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"address_line_1":{"type":"string","nullable":true},"address_line_2":{"type":"string","nullable":true},"address_line_3":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"verification_credentials":{"type":"array","items":{"type":"string"},"nullable":true},"patient_memberships":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"active":{"type":"boolean"},"membership":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]}},"type":"object","required":["name","length"]}},"type":"object","required":["id","active","membership"]},"nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]},"restricted":{"default":false,"type":"boolean"},"sex_changed_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["archived","unarchived"]},"ods_code":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["id","dob","data_source","status","identifiers","ehr_registered"]},"result_patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"address_line_1":{"type":"string","nullable":true},"address_line_2":{"type":"string","nullable":true},"address_line_3":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"verification_credentials":{"type":"array","items":{"type":"string"},"nullable":true},"patient_memberships":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"active":{"type":"boolean"},"membership":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"length":{"type":"string","enum":["yearly","monthly"]}},"type":"object","required":["name","length"]}},"type":"object","required":["id","active","membership"]},"nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]},"restricted":{"default":false,"type":"boolean"},"sex_changed_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["archived","unarchived"]},"ods_code":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["id","dob","data_source","status","identifiers","ehr_registered"]},"merge_token":{"type":"string"}},"type":"object","required":["main_patient","incoming_patient","result_patient","merge_token"]}},"components/schemas/PatientMergeBody":{"id":"components/schemas/PatientMergeBody","kind":"json-schema","title":"PatientMergeBody","data":{"properties":{"merge_token":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["merge_token","patient_id"]}},"components/schemas/PharmaciesListGetParams":{"id":"components/schemas/PharmaciesListGetParams","kind":"json-schema","title":"PharmaciesListGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PharmacyBaseSchema":{"id":"components/schemas/PharmacyBaseSchema","kind":"json-schema","title":"PharmacyBaseSchema","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"prescriber_id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"email":{"type":"string"},"mobile":{"type":"string"}},"type":"object","required":["id","prescriber_id","name","email","mobile"]}},"components/schemas/PharmaciesListSchema":{"id":"components/schemas/PharmaciesListSchema","kind":"json-schema","title":"PharmaciesListSchema","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"prescriber_id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"email":{"type":"string"},"mobile":{"type":"string"}},"type":"object","required":["id","prescriber_id","name","email","mobile"]}},"components/schemas/PharmaciesListResponseBody":{"id":"components/schemas/PharmaciesListResponseBody","kind":"json-schema","title":"PharmaciesListResponseBody","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"prescriber_id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"email":{"type":"string"},"mobile":{"type":"string"}},"type":"object","required":["id","prescriber_id","name","email","mobile"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/CreatePharmacyBody":{"id":"components/schemas/CreatePharmacyBody","kind":"json-schema","title":"CreatePharmacyBody","data":{"properties":{"name":{"type":"string"},"email":{"type":"string"},"mobile":{"type":"string"},"prescriber_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["name","email","mobile","prescriber_id"]}},"components/schemas/CreatePharmacyBodyResponse":{"id":"components/schemas/CreatePharmacyBodyResponse","kind":"json-schema","title":"CreatePharmacyBodyResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"prescriber_id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"},"email":{"type":"string"},"mobile":{"type":"string"}},"type":"object","required":["id","prescriber_id","name","email","mobile"]}},"components/schemas/PracticeGroupDto":{"id":"components/schemas/PracticeGroupDto","kind":"json-schema","title":"PracticeGroupDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"write_to_record":{"type":"boolean"}},"type":"object","required":["id","name","write_to_record"]}},"components/schemas/ListNetworkPracticeGroupDto":{"id":"components/schemas/ListNetworkPracticeGroupDto","kind":"json-schema","title":"ListNetworkPracticeGroupDto","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PracticeGroupSmsCreditStatus":{"id":"components/schemas/PracticeGroupSmsCreditStatus","kind":"json-schema","title":"PracticeGroupSmsCreditStatus","data":{"type":"string","enum":["ok","invalid_api_key","unavailable"]}},"components/schemas/PracticeGroupSmsCountResponse":{"id":"components/schemas/PracticeGroupSmsCountResponse","kind":"json-schema","title":"PracticeGroupSmsCountResponse","data":{"properties":{"sms_credit_count":{"type":"number","nullable":true},"status":{"type":"string","enum":["ok","invalid_api_key","unavailable"]}},"type":"object","required":["status"]}},"components/schemas/PracticeGroupCapabilitiesResponse":{"id":"components/schemas/PracticeGroupCapabilitiesResponse","kind":"json-schema","title":"PracticeGroupCapabilitiesResponse","data":{"properties":{"capabilities":{"type":"array","items":{"type":"string","enum":["sms_messaging","questionnaire","booking","ehr_connection","nhs_notify","care_navigation","subscriptions","invoicing","pds_trace","ehr_confirmed_booking","specify_slot"]}}},"type":"object","required":["capabilities"]}},"components/schemas/PracticeGroupConfigurationResponse":{"id":"components/schemas/PracticeGroupConfigurationResponse","kind":"json-schema","title":"PracticeGroupConfigurationResponse","data":{"properties":{"configuration":{"properties":{"sidekick":{"properties":{"elements":{"type":"array","items":{"type":"string","enum":["booking","booking-hca","care-nav","inbox","invoice-builder","link-builder","memberships","message-builder","oviva-add-to-sequence","oviva-send-medical-record","patient-search","prescription-builder","questionnaire-submission","quick-consult","heidi"]}}},"type":"object","required":["elements"]}},"type":"object","required":["sidekick"]}},"type":"object","required":["configuration"]}},"components/schemas/EhrPartnerSettings":{"id":"components/schemas/EhrPartnerSettings","kind":"json-schema","title":"EhrPartnerSettings","data":{"oneOf":[{"properties":{"emis_ip_address":{"type":"string","nullable":true},"emis_ip_address_internal":{"type":"string","nullable":true},"emis_supplier_id":{"type":"string","nullable":true},"emis_username":{"type":"string","nullable":true},"emis_orgid":{"type":"string","nullable":true},"emis_user_id":{"type":"string","nullable":true},"emis_password":{"type":"string","nullable":true}},"type":"object","required":["emis_ip_address","emis_ip_address_internal","emis_supplier_id","emis_username","emis_orgid","emis_user_id","emis_password"]},{"properties":{"systm_one_api_key":{"type":"string","nullable":true}},"type":"object","required":["systm_one_api_key"]}]}},"components/schemas/ExtendedPracticeGroupDto":{"id":"components/schemas/ExtendedPracticeGroupDto","kind":"json-schema","title":"ExtendedPracticeGroupDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"sector":{"type":"string","enum":["nhs","paid"]},"ods_code":{"type":"string","nullable":true},"write_to_record":{"type":"boolean"},"ehr_partner":{"type":"string","enum":["emis","systm_one"],"nullable":true},"ehr_partner_enabled":{"type":"boolean"},"custom_slot_to_slot":{"type":"boolean"},"use_partner_bookable_slots":{"type":"boolean"},"data_source_priorities":{"type":"array","items":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]}},"time_zone":{"type":"string","description":"IANA time zone the practice group operates in, eg Europe/London. Defaults to Europe/London where the practice group has none set."},"js_booking_service":{"type":"boolean"},"prescription_partner_enabled":{"type":"boolean"},"prescription_partner":{"type":"string","enum":["signature_rx","chem4u","pharmacierge"],"nullable":true},"prescription_partner_credentials":{"properties":{"email":{"type":"string"}},"type":"object","required":["email"],"nullable":true},"address":{"properties":{"line_1":{"type":"string"},"postcode":{"type":"string"},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"type":"object","required":["line_1","postcode"],"nullable":true}},"type":"object","required":["id","name","sector","ods_code","write_to_record","ehr_partner","ehr_partner_enabled","custom_slot_to_slot","use_partner_bookable_slots","data_source_priorities","time_zone","js_booking_service","prescription_partner_enabled","prescription_partner","address"]}},"components/schemas/MeDto":{"id":"components/schemas/MeDto","kind":"json-schema","title":"MeDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"sector":{"type":"string","enum":["nhs","paid"]},"ods_code":{"type":"string","nullable":true},"write_to_record":{"type":"boolean"},"ehr_partner":{"type":"string","enum":["emis","systm_one"],"nullable":true},"ehr_partner_enabled":{"type":"boolean"},"custom_slot_to_slot":{"type":"boolean"},"use_partner_bookable_slots":{"type":"boolean"},"data_source_priorities":{"type":"array","items":{"type":"string","enum":["hero","emis","pds","gha","systm_one"]}},"time_zone":{"type":"string","description":"IANA time zone the practice group operates in, eg Europe/London. Defaults to Europe/London where the practice group has none set."},"js_booking_service":{"type":"boolean"},"prescription_partner_enabled":{"type":"boolean"},"prescription_partner":{"type":"string","enum":["signature_rx","chem4u","pharmacierge"],"nullable":true},"prescription_partner_credentials":{"properties":{"email":{"type":"string"}},"type":"object","required":["email"],"nullable":true},"address":{"properties":{"line_1":{"type":"string"},"postcode":{"type":"string"},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"type":"object","required":["line_1","postcode"],"nullable":true},"authenticated_as":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"external_prescriber_id":{"type":"string","nullable":true},"signature":{"type":"string","nullable":true},"linked_practitioner_id":{"type":"string","nullable":true},"preferences":{"properties":{"default_notification_channel":{"type":"string","enum":["email","sms","nhs_app_email","nhs_app_sms"]}},"type":"object","required":["default_notification_channel"]},"team_memberships":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id","name"]}},"role":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"key":{"type":"string","description":"Stable slug for Hero-wide (system) roles; null for practice-group roles","nullable":true},"nhs_role_code":{"type":"string","description":"NHS National RBAC access role code, e.g. R8009","nullable":true},"system":{"type":"boolean","description":"True for Hero-wide roles available to every practice group"},"grants":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policies and wildcard patterns (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patients.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as stored on the role"},"children":[]}]}]}]},"policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"The grants expanded to concrete policies"}},"type":"object","required":["id","name","key","nhs_role_code","system","grants","policies"],"description":"The RBAC role held in the caller practice group","nullable":true},"policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"Effective policies in the caller practice group (role grants expanded); empty without a role"},"revoked_policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"Policies the role grants that this membership has had withdrawn, expanded. Still present in policies, so subtract these to get what this admin may actually do. The API enforces that subtraction on its own endpoints."}},"type":"object","required":["id","first_name","last_name","email","external_prescriber_id","signature","linked_practitioner_id","preferences","team_memberships","role","policies","revoked_policies"],"nullable":true},"ehr_healthy":{"type":"boolean"}},"type":"object","required":["id","name","sector","ods_code","write_to_record","ehr_partner","ehr_partner_enabled","custom_slot_to_slot","use_partner_bookable_slots","data_source_priorities","time_zone","js_booking_service","prescription_partner_enabled","prescription_partner","address","authenticated_as"]}},"components/schemas/GetPracticeGroupQuery":{"id":"components/schemas/GetPracticeGroupQuery","kind":"json-schema","title":"GetPracticeGroupQuery","data":{"properties":{"admin_id":{"type":"string","pattern":"^\\d+$"}},"type":"object"}},"components/schemas/Cis2ConnectionStatusResponse":{"id":"components/schemas/Cis2ConnectionStatusResponse","kind":"json-schema","title":"Cis2ConnectionStatusResponse","data":{"properties":{"status":{"type":"string","enum":["need_authentication","connected"]},"login_url":{"type":"string","nullable":true}},"type":"object","required":["status","login_url"]}},"components/schemas/PracticeGroupUpdateBody":{"id":"components/schemas/PracticeGroupUpdateBody","kind":"json-schema","title":"PracticeGroupUpdateBody","data":{"properties":{"name":{"type":"string"},"prescription_partner_enabled":{"type":"boolean"},"prescription_partner":{"type":"string","enum":["signature_rx","chem4u","pharmacierge"],"nullable":true},"prescription_partner_credentials":{"properties":{"email":{"type":"string","minLength":1},"password":{"type":"string","minLength":1}},"type":"object","required":["email","password"],"nullable":true},"address":{"properties":{"line_1":{"type":"string"},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string"},"country":{"type":"string","nullable":true}},"type":"object","nullable":true},"partners":{"type":"array","items":{"properties":{"name":{"type":"string","enum":["heidi"]},"active":{"type":"boolean"}},"type":"object","required":["name","active"]},"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is accepted but ignored. A partner connection is now live until it is soft-deleted, so the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag no longer exists."},"children":[]}]}]}]}},"type":"object"}},"components/schemas/PracticeGroupUpdateResponse":{"id":"components/schemas/PracticeGroupUpdateResponse","kind":"json-schema","title":"PracticeGroupUpdateResponse","data":{"properties":{"practice_group_id":{"type":"string"}},"type":"object","required":["practice_group_id"]}},"components/schemas/AssignmentsListResponse":{"id":"components/schemas/AssignmentsListResponse","kind":"json-schema","title":"AssignmentsListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"version":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":{"nullable":true}},"element":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"score":{"type":"number","nullable":true},"package_uri":{"type":"string"},"latest_version":{"type":"string"},"active_version":{"type":"string"},"meta":{"type":"object","additionalProperties":{"nullable":true}}},"type":"object","nullable":true}},"type":"object","required":["version"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PractitionerInclude":{"id":"components/schemas/PractitionerInclude","kind":"json-schema","title":"PractitionerInclude","data":{"type":"string","enum":["archived"]}},"components/schemas/PractitionerOrderBy":{"id":"components/schemas/PractitionerOrderBy","kind":"json-schema","title":"PractitionerOrderBy","data":{"type":"string","enum":["name","slot_count"]}},"components/schemas/PractitionerListQuery":{"id":"components/schemas/PractitionerListQuery","kind":"json-schema","title":"PractitionerListQuery","data":{"properties":{"location_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"has_availability":{"type":"boolean","nullable":true},"appointment_type_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"search":{"type":"string","minLength":1},"include":{"type":"array","items":{"type":"string","enum":["archived"]},"minItems":1},"order_by":{"type":"string","enum":["name","slot_count"]},"order_descending":{"default":"false","type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/PractitionerGetQuery":{"id":"components/schemas/PractitionerGetQuery","kind":"json-schema","title":"PractitionerGetQuery","data":{"properties":{"include":{"type":"array","items":{"type":"string","enum":["archived"]},"minItems":1}},"type":"object"}},"components/schemas/PractitionerType":{"id":"components/schemas/PractitionerType","kind":"json-schema","title":"PractitionerType","data":{"type":"string","enum":["GP","Nurse","Psychologist","Radiologist","Psychiatrist","Health and Exercise Consultant","Personal Trainer","Cognitive Behavioural Therapist","GP – Dermatology Specialist","Rheumatologist","Pharmacy Service","Yoga Instructor","Plastic and Reconstructive Surgeon","Gastroenterologist"]}},"components/schemas/PractitionerNotifications":{"id":"components/schemas/PractitionerNotifications","kind":"json-schema","title":"PractitionerNotifications","data":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]}},"components/schemas/PractitionerNotificationsPatch":{"id":"components/schemas/PractitionerNotificationsPatch","kind":"json-schema","title":"PractitionerNotificationsPatch","data":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false}},"components/schemas/PractitionerListDto":{"id":"components/schemas/PractitionerListDto","kind":"json-schema","title":"PractitionerListDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string","nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"ehr_partner_name":{"type":"string","nullable":true},"slot_count":{"type":"number"},"next_available_at":{"type":"string","format":"date-time","nullable":true},"email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"type":{"type":"string","enum":["GP","Nurse","Psychologist","Radiologist","Psychiatrist","Health and Exercise Consultant","Personal Trainer","Cognitive Behavioural Therapist","GP – Dermatology Specialist","Rheumatologist","Pharmacy Service","Yoga Instructor","Plastic and Reconstructive Surgeon","Gastroenterologist"]},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","first_name","last_name","ehr_partner_name","slot_count","next_available_at","email","contact_number","type","notifications","archived_at"]}},"components/schemas/PractitionerList":{"id":"components/schemas/PractitionerList","kind":"json-schema","title":"PractitionerList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string","nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"},"ehr_partner_name":{"type":"string","nullable":true},"slot_count":{"type":"number"},"next_available_at":{"type":"string","format":"date-time","nullable":true},"email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"type":{"type":"string"},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","name","first_name","last_name","ehr_partner_name","slot_count","next_available_at","email","contact_number","type","notifications","archived_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PractitionerTitle":{"id":"components/schemas/PractitionerTitle","kind":"json-schema","title":"PractitionerTitle","data":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"]}},"components/schemas/PractitionerSex":{"id":"components/schemas/PractitionerSex","kind":"json-schema","title":"PractitionerSex","data":{"type":"string","enum":["male","female","other"]}},"components/schemas/PractitionerDto":{"id":"components/schemas/PractitionerDto","kind":"json-schema","title":"PractitionerDto","data":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"],"nullable":true},"sex":{"type":"string","enum":["male","female","other"]},"ehr_partner_name":{"type":"string","nullable":true},"contact_email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["id","first_name","last_name","title","sex","ehr_partner_name","contact_email","contact_number","notifications","archived_at","created_at","updated_at"]}},"components/schemas/PractitionerResponse":{"id":"components/schemas/PractitionerResponse","kind":"json-schema","title":"PractitionerResponse","data":{"properties":{"data":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"],"nullable":true},"sex":{"type":"string","enum":["male","female","other"]},"ehr_partner_name":{"type":"string","nullable":true},"contact_email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["id","first_name","last_name","title","sex","ehr_partner_name","contact_email","contact_number","notifications","archived_at","created_at","updated_at"]}},"type":"object","required":["data"]}},"components/schemas/PractitionerIdParam":{"id":"components/schemas/PractitionerIdParam","kind":"json-schema","title":"PractitionerIdParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PractitionerCreateBody":{"id":"components/schemas/PractitionerCreateBody","kind":"json-schema","title":"PractitionerCreateBody","data":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"]},"sex":{"type":"string","enum":["male","female","other"]},"contact_email":{"type":"string","format":"email"},"contact_number":{"type":"string"},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false}},"type":"object","required":["first_name","last_name","sex"],"additionalProperties":false}},"components/schemas/PractitionerUpdateBody":{"id":"components/schemas/PractitionerUpdateBody","kind":"json-schema","title":"PractitionerUpdateBody","data":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"],"nullable":true},"sex":{"type":"string","enum":["male","female","other"]},"contact_email":{"type":"string","format":"email","nullable":true},"contact_number":{"type":"string","nullable":true},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","additionalProperties":false},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false}},"components/schemas/PractitionerCreateResponse":{"id":"components/schemas/PractitionerCreateResponse","kind":"json-schema","title":"PractitionerCreateResponse","data":{"properties":{"data":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"],"nullable":true},"sex":{"type":"string","enum":["male","female","other"]},"ehr_partner_name":{"type":"string","nullable":true},"contact_email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["id","first_name","last_name","title","sex","ehr_partner_name","contact_email","contact_number","notifications","archived_at","created_at","updated_at"]}},"type":"object","required":["data"]}},"components/schemas/PractitionerUpdateResponse":{"id":"components/schemas/PractitionerUpdateResponse","kind":"json-schema","title":"PractitionerUpdateResponse","data":{"properties":{"data":{"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string","enum":["unknown","mr","ms","mrs","miss","dr","prof","mx","sir","dame","lord","lady","rev","maj","col"],"nullable":true},"sex":{"type":"string","enum":["male","female","other"]},"ehr_partner_name":{"type":"string","nullable":true},"contact_email":{"type":"string","nullable":true},"contact_number":{"type":"string","nullable":true},"notifications":{"properties":{"appointment_confirmed":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_cancelled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"appointment_rescheduled":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object","required":["email","sms"]},"video_appointment":{"properties":{"email":{"type":"boolean"}},"type":"object","required":["email"]}},"type":"object","required":["appointment_confirmed","appointment_cancelled","appointment_rescheduled","video_appointment"]},"archived_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["id","first_name","last_name","title","sex","ehr_partner_name","contact_email","contact_number","notifications","archived_at","created_at","updated_at"]}},"type":"object","required":["data"]}},"components/schemas/PractitionerDeleteResponse":{"id":"components/schemas/PractitionerDeleteResponse","kind":"json-schema","title":"PractitionerDeleteResponse","data":{"properties":{"data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"type":"object","required":["data"]}},"components/schemas/AddressSchema":{"id":"components/schemas/AddressSchema","kind":"json-schema","title":"AddressSchema","data":{"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["line1","town","country","postcode"]}},"components/schemas/PatientSchema":{"id":"components/schemas/PatientSchema","kind":"json-schema","title":"PatientSchema","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"first_name":{"type":"string"},"last_name":{"type":"string"},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"]},"dob":{"type":"string","format":"date-time","nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"mobile":{"type":"string"},"address":{"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["line1","town","country","postcode"]}},"type":"object","required":["id","first_name","last_name","sex","dob","email","mobile","address"]}},"components/schemas/PrescriberSchema":{"id":"components/schemas/PrescriberSchema","kind":"json-schema","title":"PrescriberSchema","data":{"properties":{"name":{"type":"string"},"code":{"type":"string","pattern":"^\\d+$","nullable":true},"contact_number":{"type":"string","nullable":true},"prescriber_id":{"type":"string"}},"type":"object","required":["name","prescriber_id"]}},"components/schemas/MedicinesSchema":{"id":"components/schemas/MedicinesSchema","kind":"json-schema","title":"MedicinesSchema","data":{"properties":{"name":{"type":"string"},"quantity":{"type":"string"},"directions":{"type":"string"},"snomed_code":{"type":"string"}},"type":"object","required":["name","quantity","directions"]}},"components/schemas/DeliverySchema":{"id":"components/schemas/DeliverySchema","kind":"json-schema","title":"DeliverySchema","data":{"properties":{"issue_method":{"type":"string","enum":["messaging","pharmacy","delivery","provider"]},"send_sms":{"default":false,"type":"boolean"},"pharmacy_id":{"type":"string"},"invoice_clinic":{"type":"boolean"},"delivery_address":{"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["line1","town","country","postcode"]}},"type":"object","required":["issue_method"]}},"components/schemas/PrescriberGetParam":{"id":"components/schemas/PrescriberGetParam","kind":"json-schema","title":"PrescriberGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PrescriberGetResponse":{"id":"components/schemas/PrescriberGetResponse","kind":"json-schema","title":"PrescriberGetResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"email":{"type":"string","format":"email"},"full_name":{"type":"string"},"tokens":{"type":"string","nullable":true},"active":{"type":"boolean"},"verified":{"type":"boolean"}},"type":"object","required":["id","email","full_name","active","verified"]}},"components/schemas/CreatePrescriptionBody":{"id":"components/schemas/CreatePrescriptionBody","kind":"json-schema","title":"CreatePrescriptionBody","data":{"properties":{"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"first_name":{"type":"string"},"last_name":{"type":"string"},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"]},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"]},"dob":{"type":"string","format":"date-time","nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"mobile":{"type":"string"},"address":{"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["line1","town","country","postcode"]}},"type":"object","required":["id","first_name","last_name","sex","dob","email","mobile","address"]},"prescriber":{"properties":{"name":{"type":"string"},"code":{"type":"string","pattern":"^\\d+$","nullable":true},"contact_number":{"type":"string","nullable":true},"prescriber_id":{"type":"string"}},"type":"object","required":["name","prescriber_id"]},"medicines":{"type":"array","items":{"properties":{"name":{"type":"string"},"quantity":{"type":"string"},"directions":{"type":"string"},"snomed_code":{"type":"string"}},"type":"object","required":["name","quantity","directions"]}},"delivery":{"properties":{"issue_method":{"type":"string","enum":["messaging","pharmacy","delivery","provider"]},"send_sms":{"default":false,"type":"boolean"},"pharmacy_id":{"type":"string"},"invoice_clinic":{"type":"boolean"},"delivery_address":{"properties":{"line1":{"type":"string"},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["line1","town","country","postcode"]}},"type":"object","required":["issue_method"]},"secure_pin":{"type":"string"},"notes":{"type":"string"}},"type":"object","required":["patient","prescriber","medicines","delivery","secure_pin"]}},"components/schemas/CreatePrescriptionResponseBody":{"id":"components/schemas/CreatePrescriptionResponseBody","kind":"json-schema","title":"CreatePrescriptionResponseBody","data":{"properties":{"prescription_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["prescription_id"]}},"components/schemas/GetPrescriptionParams":{"id":"components/schemas/GetPrescriptionParams","kind":"json-schema","title":"GetPrescriptionParams","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/GetPrescriptionResponseBody":{"id":"components/schemas/GetPrescriptionResponseBody","kind":"json-schema","title":"GetPrescriptionResponseBody","data":{"properties":{"id":{"type":"string"},"external_prescription_id":{"type":"string"},"status":{"type":"string"},"signed_at":{"type":"string","format":"date-time","nullable":true},"notes":{"type":"string","nullable":true},"medicines":{"type":"array","items":{"properties":{"quantity":{"type":"string"},"name":{"type":"string"},"directions":{"type":"string"}},"type":"object","required":["quantity","name","directions"]}},"patient":{"properties":{"id":{"type":"string"},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","required":["id","first_name","last_name"],"nullable":true},"prescriber":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email"}},"type":"object","required":["id","name","email"],"nullable":true}},"type":"object","required":["id","external_prescription_id","status","signed_at","notes","medicines","patient","prescriber"]}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"default_price":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]},"prices":{"type":"array","items":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]}}},"type":"object","required":["id","name","prices"]}},"components/schemas/ProductListQuery":{"id":"components/schemas/ProductListQuery","kind":"json-schema","title":"ProductListQuery","data":{"properties":{"query":{"type":"string"},"active":{"type":"boolean"},"type":{"type":"string","enum":["one_time","recurring"]}},"type":"object","required":["query"]}},"components/schemas/ProductList":{"id":"components/schemas/ProductList","kind":"json-schema","title":"ProductList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"default_price":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]},"prices":{"type":"array","items":{"properties":{"id":{"type":"string"},"unit_amount":{"type":"number"},"nickname":{"type":"string"},"recurring":{"properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}},"type":"object","required":["interval","interval_count"]}},"type":"object","required":["id","unit_amount","recurring"]}}},"type":"object","required":["id","name","prices"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/Policy":{"id":"components/schemas/Policy","kind":"json-schema","title":"Policy","data":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]}},"components/schemas/RoleDto":{"id":"components/schemas/RoleDto","kind":"json-schema","title":"RoleDto","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"key":{"type":"string","description":"Stable slug for Hero-wide (system) roles; null for practice-group roles","nullable":true},"nhs_role_code":{"type":"string","description":"NHS National RBAC access role code, e.g. R8009","nullable":true},"system":{"type":"boolean","description":"True for Hero-wide roles available to every practice group"},"grants":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policies and wildcard patterns (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patients.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as stored on the role"},"children":[]}]}]}]},"policies":{"type":"array","items":{"type":"string","enum":["patients.search","patients.profile.read","patients.demographics.read","patients.register","patients.demographics.write","patients.merge","patients.ehr_record.connect","patients.verification_credentials.manage","booking.diary.read","booking.appointments.read","booking.links.read","booking.catalogue.read","booking.appointments.write","booking.availability.create","booking.links.write","booking.catalogue.manage","booking.resources.manage","clinical_records.summary.read","clinical_records.detailed.read","clinical_records.consultation_notes.read","clinical_records.coded_entries.read","clinical_records.documents.read","clinical_records.consultation_notes.write","clinical_records.entries.write","clinical_records.coded_entries.write","clinical_records.documents.write","clinical_records.write_to_record","messaging.messages.read","messaging.templates.read","messaging.messages.send","messaging.attachments.upload","messaging.batch.send","messaging.short_links.create","messaging.record_content.attach","messaging.templates.manage","forms.read","forms.responses.read","forms.responses.clinical_content.read","forms.send","forms.responses.submit","forms.templates.manage","care_navigation.requests.read","care_navigation.requests.action","care_navigation.requests.submit","care_navigation.settings.manage","inbox.tasks.read","inbox.notes.read","inbox.record_tasks.read","inbox.tasks.write","inbox.notes.write","inbox.episodes.create","inbox.routing.manage","practice.settings.read","practice.settings.manage","practice.slot_configuration.manage","practice.branding.manage","practice.registration_fields.manage","practice.patient_authentication.manage","practice.cancellation_policy.manage","staff.accounts.read","staff.accounts.manage","staff.roles.assign","staff.teams.manage","staff.self.write","platform.integrations.read","platform.webhooks.manage","platform.api_keys.manage","platform.partners.manage","platform.address_lookup.read"]},"description":"The grants expanded to concrete policies"}},"type":"object","required":["id","name","key","nhs_role_code","system","grants","policies"]}},"components/schemas/ListShortLinkFromDb":{"id":"components/schemas/ListShortLinkFromDb","kind":"json-schema","title":"ListShortLinkFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"link_name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"status":{"type":"string","enum":["expired","unexpired"]},"created_at":{"type":"string","format":"date-time","nullable":true},"expiry_date":{"type":"string","format":"date-time","nullable":true},"link_type":{"type":"string","enum":["booking","patient_reply","questionnaire","video","attachment"],"nullable":true},"linked_resource_type":{"type":"string","nullable":true},"linked_resource_id":{"type":"number","nullable":true},"meta":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true},"room_token":{"type":"string"}},"type":"object","required":["appointment_type_id","location_id"],"nullable":true}},"type":"object","required":["id","link_name","url","status","created_at","expiry_date","link_type","linked_resource_type","linked_resource_id","meta"]}},"components/schemas/ShortLinksListResponse":{"id":"components/schemas/ShortLinksListResponse","kind":"json-schema","title":"ShortLinksListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"link_name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"status":{"type":"string","enum":["expired","unexpired"]},"created_at":{"type":"string","format":"date-time","nullable":true},"expiry_date":{"type":"string","format":"date-time","nullable":true},"link_type":{"type":"string","enum":["booking","patient_reply","questionnaire","video","attachment"],"nullable":true},"linked_resource_type":{"type":"string","nullable":true},"linked_resource_id":{"type":"number","nullable":true},"meta":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true},"room_token":{"type":"string"}},"type":"object","required":["appointment_type_id","location_id"],"nullable":true}},"type":"object","required":["id","link_name","url","status","created_at","expiry_date","link_type","linked_resource_type","linked_resource_id","meta"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/ShortLinksListQuery":{"id":"components/schemas/ShortLinksListQuery","kind":"json-schema","title":"ShortLinksListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at","expiry_date"]},"order_descending":{"type":"string","enum":["true","false"]},"type":{"type":"string","enum":["booking","patient_reply","questionnaire","video","attachment"]},"status":{"type":"string","enum":["expired","unexpired"]},"url":{"type":"string"},"exclude_patient_specific_links":{"type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/ShortLinkExpireParams":{"id":"components/schemas/ShortLinkExpireParams","kind":"json-schema","title":"ShortLinkExpireParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/ShortLinkExpireResponse":{"id":"components/schemas/ShortLinkExpireResponse","kind":"json-schema","title":"ShortLinkExpireResponse","data":{"properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"type":"object","required":["success","message"]}},"components/schemas/SignatureRxPrescriber":{"id":"components/schemas/SignatureRxPrescriber","kind":"json-schema","title":"SignatureRxPrescriber","data":{"properties":{"object":{"type":"string","enum":["prescriber"]},"prescriber_id":{"type":"number"},"prescriber_full_name":{"type":"string"},"prescriber_email":{"type":"string","format":"email"},"is_archived":{"type":"number","enum":[0,1]},"active":{"type":"boolean"},"verified":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["object","prescriber_id","prescriber_full_name","prescriber_email","is_archived","active","verified","created_at","updated_at"]}},"components/schemas/SignatureRxLinks":{"id":"components/schemas/SignatureRxLinks","kind":"json-schema","title":"SignatureRxLinks","data":{"properties":{"first":{"type":"string","format":"uri","nullable":true},"last":{"type":"string","format":"uri","nullable":true},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}},"type":"object","required":["first","last","prev","next"]}},"components/schemas/SignatureRxMetaLink":{"id":"components/schemas/SignatureRxMetaLink","kind":"json-schema","title":"SignatureRxMetaLink","data":{"properties":{"url":{"type":"string","format":"uri","nullable":true},"label":{"type":"string"},"active":{"type":"boolean"}},"type":"object","required":["url","label","active"]}},"components/schemas/SignatureRxMeta":{"id":"components/schemas/SignatureRxMeta","kind":"json-schema","title":"SignatureRxMeta","data":{"properties":{"current_page":{"type":"number"},"from":{"type":"number"},"last_page":{"type":"number"},"links":{"type":"array","items":{"properties":{"url":{"type":"string","format":"uri","nullable":true},"label":{"type":"string"},"active":{"type":"boolean"}},"type":"object","required":["url","label","active"]}},"path":{"type":"string","format":"uri"},"per_page":{"type":"number"},"to":{"type":"number"},"total":{"type":"number"},"resource":{"type":"string"},"filter":{"type":"string"}},"type":"object","required":["current_page","from","last_page","links","path","per_page","to","total","resource","filter"]}},"components/schemas/SignatureRxResponse":{"id":"components/schemas/SignatureRxResponse","kind":"json-schema","title":"SignatureRxResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"object":{"type":"string","enum":["prescriber"]},"prescriber_id":{"type":"number"},"prescriber_full_name":{"type":"string"},"prescriber_email":{"type":"string","format":"email"},"is_archived":{"type":"number","enum":[0,1]},"active":{"type":"boolean"},"verified":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["object","prescriber_id","prescriber_full_name","prescriber_email","is_archived","active","verified","created_at","updated_at"]}},"links":{"properties":{"first":{"type":"string","format":"uri","nullable":true},"last":{"type":"string","format":"uri","nullable":true},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}},"type":"object","required":["first","last","prev","next"]},"meta":{"properties":{"current_page":{"type":"number"},"from":{"type":"number"},"last_page":{"type":"number"},"links":{"type":"array","items":{"properties":{"url":{"type":"string","format":"uri","nullable":true},"label":{"type":"string"},"active":{"type":"boolean"}},"type":"object","required":["url","label","active"]}},"path":{"type":"string","format":"uri"},"per_page":{"type":"number"},"to":{"type":"number"},"total":{"type":"number"},"resource":{"type":"string"},"filter":{"type":"string"}},"type":"object","required":["current_page","from","last_page","links","path","per_page","to","total","resource","filter"]}},"type":"object","required":["data","links","meta"]}},"components/schemas/SignatureRxPrescriberList":{"id":"components/schemas/SignatureRxPrescriberList","kind":"json-schema","title":"SignatureRxPrescriberList","data":{"properties":{"data":{"type":"array","items":{"properties":{"object":{"type":"string","enum":["prescriber"]},"prescriber_id":{"type":"number"},"prescriber_full_name":{"type":"string"},"prescriber_email":{"type":"string","format":"email"},"is_archived":{"type":"number","enum":[0,1]},"active":{"type":"boolean"},"verified":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object","required":["object","prescriber_id","prescriber_full_name","prescriber_email","is_archived","active","verified","created_at","updated_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/SlotGetParam":{"id":"components/schemas/SlotGetParam","kind":"json-schema","title":"SlotGetParam","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/SlotGet":{"id":"components/schemas/SlotGet","kind":"json-schema","title":"SlotGet","data":{"properties":{"id":{"type":"string"},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time"},"finish_time":{"type":"string","format":"date-time"}},"type":"object","required":["id","practitioner_id","appointment_type_id","location_id","start_time","finish_time"]}},"components/schemas/SlotList":{"id":"components/schemas/SlotList","kind":"json-schema","title":"SlotList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time"},"finish_time":{"type":"string","format":"date-time"}},"type":"object","required":["id","practitioner_id","appointment_type_id","location_id","start_time","finish_time"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/SlotCount":{"id":"components/schemas/SlotCount","kind":"json-schema","title":"SlotCount","data":{"properties":{"count":{"type":"number"}},"type":"object","required":["count"]}},"components/schemas/SlotAvailability":{"id":"components/schemas/SlotAvailability","kind":"json-schema","title":"SlotAvailability","data":{"properties":{"available":{"type":"boolean"}},"type":"object","required":["available"]}},"components/schemas/SlotListQuery":{"id":"components/schemas/SlotListQuery","kind":"json-schema","title":"SlotListQuery","data":{"properties":{"start_date":{"type":"string","format":"date-time","nullable":true,"default":"Now"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"Within the next 3 months"},"practitioner_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"appointment_type_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"location_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]}},"type":"object"}},"components/schemas/SlotListQueryArrays":{"id":"components/schemas/SlotListQueryArrays","kind":"json-schema","title":"SlotListQueryArrays","data":{"properties":{"start_date":{"type":"string","format":"date-time","nullable":true,"default":"Now"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"Within the next 3 months"},"practitioner_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"appointment_type_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_ids":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}},"type":"object"}},"components/schemas/SlotAvailabilityBody":{"id":"components/schemas/SlotAvailabilityBody","kind":"json-schema","title":"SlotAvailabilityBody","data":{"properties":{"practitioner_id":{"type":"string","pattern":"^\\d+$"},"appointment_type_id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"},"duration":{"type":"number"}},"type":"object","required":["practitioner_id","appointment_type_id","location_id","start_time","duration"]}},"components/schemas/SlotCountQuery":{"id":"components/schemas/SlotCountQuery","kind":"json-schema","title":"SlotCountQuery","data":{"properties":{"start_date":{"type":"string","format":"date-time","nullable":true,"default":"Now"},"end_date":{"type":"string","format":"date-time","nullable":true,"description":"Within the next 3 months"},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}},"type":"object","required":["appointment_type_id"]}},"components/schemas/SlotCountBulkItemRequest":{"id":"components/schemas/SlotCountBulkItemRequest","kind":"json-schema","title":"SlotCountBulkItemRequest","data":{"properties":{"key":{"type":"string"},"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["key","appointment_type_id"]}},"components/schemas/SlotCountBulkItemBody":{"id":"components/schemas/SlotCountBulkItemBody","kind":"json-schema","title":"SlotCountBulkItemBody","data":{"properties":{"items":{"type":"array","items":{"properties":{"key":{"type":"string"},"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"start_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["key","appointment_type_id"]}}},"type":"object","required":["items"]}},"components/schemas/SlotCountBulkItem":{"id":"components/schemas/SlotCountBulkItem","kind":"json-schema","title":"SlotCountBulkItem","data":{"properties":{"key":{"type":"string"},"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"count":{"type":"number"}},"type":"object","required":["key","appointment_type_id","count"]}},"components/schemas/SlotCountBulk":{"id":"components/schemas/SlotCountBulk","kind":"json-schema","title":"SlotCountBulk","data":{"type":"array","items":{"properties":{"key":{"type":"string"},"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"count":{"type":"number"}},"type":"object","required":["key","appointment_type_id","count"]}}},"components/schemas/SnomedValidateResult":{"id":"components/schemas/SnomedValidateResult","kind":"json-schema","title":"SnomedValidateResult","data":{"properties":{"valid":{"type":"boolean"}},"type":"object","required":["valid"]}},"components/schemas/SnomedValidateBody":{"id":"components/schemas/SnomedValidateBody","kind":"json-schema","title":"SnomedValidateBody","data":{"properties":{"code":{"type":"string"}},"type":"object","required":["code"]}},"components/schemas/SnomedConcept":{"id":"components/schemas/SnomedConcept","kind":"json-schema","title":"SnomedConcept","data":{"properties":{"code":{"type":"string"},"term":{"type":"string"}},"type":"object","required":["code","term"]}},"components/schemas/SnomedSearchQuery":{"id":"components/schemas/SnomedSearchQuery","kind":"json-schema","title":"SnomedSearchQuery","data":{"properties":{"query":{"type":"string","minLength":1}},"type":"object","required":["query"]}},"components/schemas/SnomedSearchResult":{"id":"components/schemas/SnomedSearchResult","kind":"json-schema","title":"SnomedSearchResult","data":{"properties":{"data":{"type":"array","items":{"properties":{"code":{"type":"string"},"term":{"type":"string"}},"type":"object","required":["code","term"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/SubmissionTypeEnum":{"id":"components/schemas/SubmissionTypeEnum","kind":"json-schema","title":"SubmissionTypeEnum","data":{"type":"string","enum":["form","external_url"]}},"components/schemas/SubmissionTypeListQuery":{"id":"components/schemas/SubmissionTypeListQuery","kind":"json-schema","title":"SubmissionTypeListQuery","data":{"properties":{"pathway_id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","enum":["form","external_url"],"nullable":true}},"type":"object"}},"components/schemas/SubmissionTypeGetParam":{"id":"components/schemas/SubmissionTypeGetParam","kind":"json-schema","title":"SubmissionTypeGetParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/SubmissionTypeOcType":{"id":"components/schemas/SubmissionTypeOcType","kind":"json-schema","title":"SubmissionTypeOcType","data":{"type":"string","enum":["admin_request","clinical_request","other_request"]}},"components/schemas/SubmissionTypePriority":{"id":"components/schemas/SubmissionTypePriority","kind":"json-schema","title":"SubmissionTypePriority","data":{"type":"string","enum":["lowest","low","medium","high","highest"]}},"components/schemas/SubmissionTypeAssigneeType":{"id":"components/schemas/SubmissionTypeAssigneeType","kind":"json-schema","title":"SubmissionTypeAssigneeType","data":{"type":"string","enum":["Admin","AdminTeam"]}},"components/schemas/SubmissionTypeNestedCreateBody":{"id":"components/schemas/SubmissionTypeNestedCreateBody","kind":"json-schema","title":"SubmissionTypeNestedCreateBody","data":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"in_hours":{"default":false,"type":"boolean"},"out_of_hours":{"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"form_id":{"type":"string","pattern":"^\\d+$"},"external_url":{"type":"string","format":"uri"},"external_url_name":{"type":"string"},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"]},"default_priority":{"default":"medium","type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","minimum":0,"exclusiveMinimum":0},"patient_eligibility_check":{"default":true,"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$"},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"]},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0}},"type":"object","required":["title"],"additionalProperties":false}},"components/schemas/SubmissionTypeCreateBody":{"id":"components/schemas/SubmissionTypeCreateBody","kind":"json-schema","title":"SubmissionTypeCreateBody","data":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"in_hours":{"default":false,"type":"boolean"},"out_of_hours":{"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"form_id":{"type":"string","pattern":"^\\d+$"},"external_url":{"type":"string","format":"uri"},"external_url_name":{"type":"string"},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"]},"default_priority":{"default":"medium","type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","minimum":0,"exclusiveMinimum":0},"patient_eligibility_check":{"default":true,"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$"},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"]},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0},"pathway_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["title","pathway_id"],"additionalProperties":false}},"components/schemas/SubmissionTypeUpdateBody":{"id":"components/schemas/SubmissionTypeUpdateBody","kind":"json-schema","title":"SubmissionTypeUpdateBody","data":{"properties":{"title":{"type":"string"},"description":{"type":"string","nullable":true},"in_hours":{"type":"boolean"},"out_of_hours":{"type":"boolean"},"suspended":{"type":"boolean"},"form_id":{"type":"string","pattern":"^\\d+$","nullable":true},"external_url":{"type":"string","format":"uri","nullable":true},"external_url_name":{"type":"string","nullable":true},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"],"nullable":true},"default_priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","minimum":0,"exclusiveMinimum":0,"nullable":true},"patient_eligibility_check":{"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"order":{"type":"integer","minimum":0,"exclusiveMinimum":0}},"type":"object","additionalProperties":false}},"components/schemas/SubmissionTypeDto":{"id":"components/schemas/SubmissionTypeDto","kind":"json-schema","title":"SubmissionTypeDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"pathway_id":{"type":"string","pattern":"^\\d+$"},"form_id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string"},"description":{"type":"string","nullable":true},"in_hours":{"type":"boolean"},"out_of_hours":{"type":"boolean"},"suspended":{"type":"boolean"},"external_url":{"type":"string","nullable":true},"external_url_name":{"type":"string","nullable":true},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"],"nullable":true},"default_priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","nullable":true},"forms_submitted_today":{"type":"integer","minimum":0,"description":"Number of forms submitted for this submission type on the current day."},"patient_eligibility_check":{"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"order":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","pathway_id","form_id","title","description","in_hours","out_of_hours","suspended","external_url","external_url_name","type","default_priority","daily_limit","forms_submitted_today","patient_eligibility_check","assignee_id","assignee_type","order","created_at","updated_at"]}},"components/schemas/SubmissionTypeList":{"id":"components/schemas/SubmissionTypeList","kind":"json-schema","title":"SubmissionTypeList","data":{"properties":{"count":{"type":"number"},"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"pathway_id":{"type":"string","pattern":"^\\d+$"},"form_id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string"},"description":{"type":"string","nullable":true},"in_hours":{"type":"boolean"},"out_of_hours":{"type":"boolean"},"suspended":{"type":"boolean"},"external_url":{"type":"string","nullable":true},"external_url_name":{"type":"string","nullable":true},"type":{"type":"string","enum":["admin_request","clinical_request","other_request"],"nullable":true},"default_priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"daily_limit":{"type":"integer","nullable":true},"forms_submitted_today":{"type":"integer","minimum":0,"description":"Number of forms submitted for this submission type on the current day."},"patient_eligibility_check":{"type":"boolean","nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true},"assignee_type":{"type":"string","enum":["Admin","AdminTeam"],"nullable":true},"order":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","pathway_id","form_id","title","description","in_hours","out_of_hours","suspended","external_url","external_url_name","type","default_priority","daily_limit","forms_submitted_today","patient_eligibility_check","assignee_id","assignee_type","order","created_at","updated_at"]}}},"type":"object","required":["count","data"]}},"components/schemas/OrderByEnum":{"id":"components/schemas/OrderByEnum","kind":"json-schema","title":"OrderByEnum","data":{"type":"string","enum":["created_at","expires_on","cancelled_at","members"]}},"components/schemas/StatusEnum":{"id":"components/schemas/StatusEnum","kind":"json-schema","title":"StatusEnum","data":{"type":"string","enum":["cancelled","expired","active","not_started"]}},"components/schemas/SubscriptionListQuery":{"id":"components/schemas/SubscriptionListQuery","kind":"json-schema","title":"SubscriptionListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"patient_id":{"type":"string","pattern":"^\\d+$"},"order_by":{"default":[],"type":"array","items":{"type":"string","enum":["created_at","expires_on","cancelled_at","members"]}},"order_descending":{"default":[],"type":"array","items":{"type":"string"}},"scheme_id":{"type":"string"},"scheme_name":{"type":"string"},"status":{"default":"active","type":"string","enum":["cancelled","expired","active","not_started"]}},"type":"object","required":["patient_id"]}},"components/schemas/SubscriptionDto":{"id":"components/schemas/SubscriptionDto","kind":"json-schema","title":"SubscriptionDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"subscription_id":{"type":"string"},"scheme":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"customer":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"],"nullable":true},"status":{"type":"string"},"members_count":{"type":"number"},"created_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","nullable":true},"cancelled_at":{"type":"string","nullable":true}},"type":"object","required":["id","subscription_id","scheme","customer","status","members_count","created_at","expires_at","cancelled_at"]}},"components/schemas/SubscriptionListResponse":{"id":"components/schemas/SubscriptionListResponse","kind":"json-schema","title":"SubscriptionListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"subscription_id":{"type":"string"},"scheme":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"customer":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"],"nullable":true},"status":{"type":"string"},"members_count":{"type":"number"},"created_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","nullable":true},"cancelled_at":{"type":"string","nullable":true}},"type":"object","required":["id","subscription_id","scheme","customer","status","members_count","created_at","expires_at","cancelled_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/SubscriberListQuery":{"id":"components/schemas/SubscriberListQuery","kind":"json-schema","title":"SubscriberListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"patient_id":{"type":"string","pattern":"^\\d+$"},"order_by":{"default":[],"type":"array","items":{"type":"string","enum":["created_at","expires_on"]}},"order_descending":{"default":[],"type":"array","items":{"type":"string"}},"scheme_id":{"type":"string"},"scheme_name":{"type":"string"},"status":{"default":"active","type":"string","enum":["cancelled","expired","active","not_started"]},"subscription_id":{"type":"string","pattern":"^M?\\d+$"}},"type":"object"}},"components/schemas/SubscriberFromDB":{"id":"components/schemas/SubscriberFromDB","kind":"json-schema","title":"SubscriberFromDB","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","title","first_name","last_name"]},"subscription":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"subscription_id":{"type":"string"},"status":{"type":"string","enum":["cancelled","expired","active","not_started"]},"expires_at":{"type":"string","nullable":true}},"type":"object","required":["id","subscription_id","status","expires_at"]},"scheme":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","patient","subscription","scheme","created_at"]}},"components/schemas/SubscriberDto":{"id":"components/schemas/SubscriberDto","kind":"json-schema","title":"SubscriberDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name"]},"subscription":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"subscription_id":{"type":"string"},"status":{"type":"string","enum":["cancelled","expired","active","not_started"]},"expires_at":{"type":"string","nullable":true}},"type":"object","required":["id","subscription_id","status","expires_at"]},"scheme":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","patient","subscription","scheme","created_at"]}},"components/schemas/SubscriberListResponse":{"id":"components/schemas/SubscriberListResponse","kind":"json-schema","title":"SubscriberListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name"]},"subscription":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"subscription_id":{"type":"string"},"status":{"type":"string","enum":["cancelled","expired","active","not_started"]},"expires_at":{"type":"string","nullable":true}},"type":"object","required":["id","subscription_id","status","expires_at"]},"scheme":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"name":{"type":"string"}},"type":"object","required":["id","name"]},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","patient","subscription","scheme","created_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/TaskUpdateParam":{"id":"components/schemas/TaskUpdateParam","kind":"json-schema","title":"TaskUpdateParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/TaskUpdateBody":{"id":"components/schemas/TaskUpdateBody","kind":"json-schema","title":"TaskUpdateBody","data":{"properties":{"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignee_type":{"type":"string","enum":["admin","admin_team"],"nullable":true},"assignee_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object"}},"components/schemas/TaskUpdateResponse":{"id":"components/schemas/TaskUpdateResponse","kind":"json-schema","title":"TaskUpdateResponse","data":{"properties":{"data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"type":"object","required":["data"]}},"components/schemas/TemplateListQuery":{"id":"components/schemas/TemplateListQuery","kind":"json-schema","title":"TemplateListQuery","data":{"properties":{"has_follow_up":{"type":"string","enum":["0","1","true","false"]}},"type":"object"}},"components/schemas/Template":{"id":"components/schemas/Template","kind":"json-schema","title":"Template","data":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"content":{"type":"string"},"link":{"default":"no_link","type":"string","enum":["no_link","booking","form"]},"type":{"default":"hero","type":"string","enum":["hero","external","user"]},"sms_snomed_code":{"type":"string","nullable":true},"sms_follow_up_1_snomed_code":{"type":"string","nullable":true},"sms_follow_up_2_snomed_code":{"type":"string","nullable":true},"email_snomed_code":{"type":"string","nullable":true},"email_follow_up_1_snomed_code":{"type":"string","nullable":true},"email_follow_up_2_snomed_code":{"type":"string","nullable":true},"send_follow_up_one":{"default":false,"type":"boolean"},"send_follow_up_two":{"default":false,"type":"boolean"},"reminder_time":{"type":"number","nullable":true}},"type":"object","required":["id","name","content"]}},"components/schemas/TemplateList":{"id":"components/schemas/TemplateList","kind":"json-schema","title":"TemplateList","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"content":{"type":"string"},"link":{"default":"no_link","type":"string","enum":["no_link","booking","form"]},"type":{"default":"hero","type":"string","enum":["hero","external","user"]},"sms_snomed_code":{"type":"string","nullable":true},"sms_follow_up_1_snomed_code":{"type":"string","nullable":true},"sms_follow_up_2_snomed_code":{"type":"string","nullable":true},"email_snomed_code":{"type":"string","nullable":true},"email_follow_up_1_snomed_code":{"type":"string","nullable":true},"email_follow_up_2_snomed_code":{"type":"string","nullable":true},"send_follow_up_one":{"default":false,"type":"boolean"},"send_follow_up_two":{"default":false,"type":"boolean"},"reminder_time":{"type":"number","nullable":true}},"type":"object","required":["id","name","content"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/VerificationCredentialType":{"id":"components/schemas/VerificationCredentialType","kind":"json-schema","title":"VerificationCredentialType","data":{"type":"string","enum":["email","sms"]}},"components/schemas/VerificationCredentialStatus":{"id":"components/schemas/VerificationCredentialStatus","kind":"json-schema","title":"VerificationCredentialStatus","data":{"type":"string","enum":["pending","code_sent","expired","verified","connected"]}},"components/schemas/VerificationCredentialResponse":{"id":"components/schemas/VerificationCredentialResponse","kind":"json-schema","title":"VerificationCredentialResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"credential":{"type":"string"},"credential_type":{"type":"string","enum":["email","sms"]},"status":{"type":"string","enum":["pending","code_sent","expired","verified","connected"]},"patient_id":{"type":"string","pattern":"^\\d+$","nullable":true},"remember":{"type":"boolean"},"verified_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","credential","credential_type","status","patient_id","remember","verified_at","created_at","updated_at"]}},"components/schemas/VerificationCredentialIdParam":{"id":"components/schemas/VerificationCredentialIdParam","kind":"json-schema","title":"VerificationCredentialIdParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/VerificationCredentialCreateBody":{"id":"components/schemas/VerificationCredentialCreateBody","kind":"json-schema","title":"VerificationCredentialCreateBody","data":{"properties":{"credential_type":{"type":"string","enum":["email","sms"]},"credential":{"type":"string","minLength":1},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_proxy_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["credential_type"]}},"components/schemas/VerificationCredentialUpdateBody":{"id":"components/schemas/VerificationCredentialUpdateBody","kind":"json-schema","title":"VerificationCredentialUpdateBody","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"},"remember":{"type":"boolean"}},"type":"object","required":["patient_id"]}},"components/schemas/VerificationCredentialConfirmOtpBody":{"id":"components/schemas/VerificationCredentialConfirmOtpBody","kind":"json-schema","title":"VerificationCredentialConfirmOtpBody","data":{"properties":{"code":{"type":"string","minLength":1},"remember":{"type":"boolean"},"patient_record":{"properties":{"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"dob":{"type":"string","minLength":1}},"type":"object","required":["first_name","last_name","dob"]}},"type":"object","required":["code"]}},"components/schemas/VideoLinkCreateBody":{"id":"components/schemas/VideoLinkCreateBody","kind":"json-schema","title":"VideoLinkCreateBody","data":{"properties":{"link_name":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"expiry_date":{"type":"string","format":"date-time","description":"ISO 8601 date format","example":"1989-04-11"}},"type":"object"}},"components/schemas/VideoLinkCreateResponse":{"id":"components/schemas/VideoLinkCreateResponse","kind":"json-schema","title":"VideoLinkCreateResponse","data":{"properties":{"video_link":{"type":"string"},"short_link_id":{"type":"string"},"main_room_url":{"type":"string","description":"URL of the video call room that the creator can access"}},"type":"object","required":["video_link","short_link_id","main_room_url"]}},"components/schemas/WebhookEventType":{"id":"components/schemas/WebhookEventType","kind":"json-schema","title":"WebhookEventType","data":{"type":"string","enum":["appointment.confirmed","appointment.cancelled","appointment.rescheduled","form-submission.created","prescription.issued","patient.medical-record-updated","patient.added-to-sequence","write-to-record.succeeded","write-to-record.failed"]}},"components/schemas/WebhookCreateBody":{"id":"components/schemas/WebhookCreateBody","kind":"json-schema","title":"WebhookCreateBody","data":{"properties":{"description":{"type":"string"},"event_type":{"type":"string","enum":["appointment.confirmed","appointment.cancelled","appointment.rescheduled","form-submission.created","prescription.issued","patient.medical-record-updated","patient.added-to-sequence","write-to-record.succeeded","write-to-record.failed"]},"signing_key":{"type":"string"},"url":{"type":"string","format":"uri"},"headers":{"type":"object","additionalProperties":{"type":"string"}}},"type":"object","required":["event_type","url"]}},"components/schemas/WebhookDto":{"id":"components/schemas/WebhookDto","kind":"json-schema","title":"WebhookDto","data":{"properties":{"id":{"type":"string"},"event_type":{"type":"string"},"url":{"type":"string"},"signing_key":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","event_type","url","created_at","updated_at"]}},"components/schemas/WebhookListResponse":{"id":"components/schemas/WebhookListResponse","kind":"json-schema","title":"WebhookListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"event_type":{"type":"string"},"url":{"type":"string"},"signing_key":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","event_type","url","created_at","updated_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/WebhookDeleteParam":{"id":"components/schemas/WebhookDeleteParam","kind":"json-schema","title":"WebhookDeleteParam","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/WebhookListQuery":{"id":"components/schemas/WebhookListQuery","kind":"json-schema","title":"WebhookListQuery","data":{"properties":{"event_type":{"type":"string"}},"type":"object"}},"components/schemas/WebhookListExecutionsParam":{"id":"components/schemas/WebhookListExecutionsParam","kind":"json-schema","title":"WebhookListExecutionsParam","data":{"properties":{"id":{"type":"string","format":"uuid"}},"type":"object","required":["id"]}},"components/schemas/WebhookTaskDto":{"id":"components/schemas/WebhookTaskDto","kind":"json-schema","title":"WebhookTaskDto","data":{"properties":{"execution_id":{"type":"string","format":"uuid"},"webhook_id":{"type":"string","format":"uuid"},"event_type":{"type":"string","enum":["appointment.confirmed","appointment.cancelled","appointment.rescheduled","form-submission.created","prescription.issued","patient.medical-record-updated","patient.added-to-sequence","write-to-record.succeeded","write-to-record.failed"]},"status":{"type":"string","enum":["success","failed"]},"request_body":{"type":"string"},"response_body":{"type":"string"},"response_status":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["execution_id","webhook_id","event_type","status","request_body","response_body","response_status","created_at","updated_at"]}},"components/schemas/WebhookListExecutionResponse":{"id":"components/schemas/WebhookListExecutionResponse","kind":"json-schema","title":"WebhookListExecutionResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"execution_id":{"type":"string","format":"uuid"},"webhook_id":{"type":"string","format":"uuid"},"event_type":{"type":"string","enum":["appointment.confirmed","appointment.cancelled","appointment.rescheduled","form-submission.created","prescription.issued","patient.medical-record-updated","patient.added-to-sequence","write-to-record.succeeded","write-to-record.failed"]},"status":{"type":"string","enum":["success","failed"]},"request_body":{"type":"string"},"response_body":{"type":"string"},"response_status":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["execution_id","webhook_id","event_type","status","request_body","response_body","response_status","created_at","updated_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AppointmentFromDb":{"id":"components/schemas/AppointmentFromDb","kind":"json-schema","title":"AppointmentFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"type":"object","nullable":true},"practitioner":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]}},"components/schemas/AppointmentDto":{"id":"components/schemas/AppointmentDto","kind":"json-schema","title":"AppointmentDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"type":"object","nullable":true},"practitioner":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"type":"object","required":["id","location_id","start_time","booking_status"]}},"components/schemas/AppointmentDtoV2":{"id":"components/schemas/AppointmentDtoV2","kind":"json-schema","title":"AppointmentDtoV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]}},"components/schemas/AppointmentsListResponse":{"id":"components/schemas/AppointmentsListResponse","kind":"json-schema","title":"AppointmentsListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}},"type":"object","nullable":true},"practitioner":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"type":"object","required":["id","location_id","start_time","booking_status"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AppointmentV2BookParam":{"id":"components/schemas/AppointmentV2BookParam","kind":"json-schema","title":"AppointmentV2BookParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentV2BookBody":{"id":"components/schemas/AppointmentV2BookBody","kind":"json-schema","title":"AppointmentV2BookBody","data":{"properties":{"reason":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"billpayer_id":{"type":"string","pattern":"^\\d+$"},"suppress_invoice":{"type":"boolean"},"suppress_availability_check":{"type":"boolean"},"externally_paid":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/AppointmentV2BookResponse":{"id":"components/schemas/AppointmentV2BookResponse","kind":"json-schema","title":"AppointmentV2BookResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"type":"object","required":["id","status"]}},"components/schemas/AppointmentV2CancelParam":{"id":"components/schemas/AppointmentV2CancelParam","kind":"json-schema","title":"AppointmentV2CancelParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentV2CancelBody":{"id":"components/schemas/AppointmentV2CancelBody","kind":"json-schema","title":"AppointmentV2CancelBody","data":{"properties":{"suppress_mail":{"type":"boolean"},"suppress_cancellation_policy":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object"}},"components/schemas/AppointmentV2CancelResponse":{"id":"components/schemas/AppointmentV2CancelResponse","kind":"json-schema","title":"AppointmentV2CancelResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"type":"object","required":["id","status"]}},"components/schemas/AppointmentV2RescheduleParam":{"id":"components/schemas/AppointmentV2RescheduleParam","kind":"json-schema","title":"AppointmentV2RescheduleParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentV2RescheduleBody":{"id":"components/schemas/AppointmentV2RescheduleBody","kind":"json-schema","title":"AppointmentV2RescheduleBody","data":{"properties":{"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"duration":{"type":"number","minimum":1},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"suppress_availability_check":{"type":"boolean"},"suppress_mail":{"type":"boolean"},"episode_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["start_time","duration","practitioner_id"]}},"components/schemas/AppointmentV2RescheduleResponse":{"id":"components/schemas/AppointmentV2RescheduleResponse","kind":"json-schema","title":"AppointmentV2RescheduleResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"]}},"type":"object","required":["id","status"]}},"components/schemas/AppointmentV2EditParam":{"id":"components/schemas/AppointmentV2EditParam","kind":"json-schema","title":"AppointmentV2EditParam","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/AppointmentV2EditBody":{"id":"components/schemas/AppointmentV2EditBody","kind":"json-schema","title":"AppointmentV2EditBody","data":{"properties":{"start_time":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"practitioner_id":{"type":"string","pattern":"^\\d+$"},"duration":{"type":"number","minimum":1},"reason":{"type":"string"},"patient_proxy_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["start_time","practitioner_id"]}},"components/schemas/AppointmentV2EditResponse":{"id":"components/schemas/AppointmentV2EditResponse","kind":"json-schema","title":"AppointmentV2EditResponse","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"reserved_until":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","reserved_until"]}},"components/schemas/AppointmentsListQuery":{"id":"components/schemas/AppointmentsListQuery","kind":"json-schema","title":"AppointmentsListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["patient_first_name","patient_last_name","patient_full_name","practitioner_first_name","practitioner_last_name","practitioner_full_name","appointment_template_name","appointment_source","location_name","confirmed_at","start_time","end_time"]},"order_descending":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"patient_full_name":{"type":"string"},"practitioner_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"practitioner_first_name":{"type":"string"},"practitioner_last_name":{"type":"string"},"practitioner_full_name":{"type":"string"},"location_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"array","items":{"type":"string","pattern":"^\\d+$"}}]},"appointment_template_name":{"type":"string"},"location_name":{"type":"string"},"has_been_cancelled":{"type":"string"},"start_time":{"type":"string","format":"date-time","nullable":true},"end_time":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","enum":["Hero patient led","Hero admin led","Hero booking link","Hero booking API","EMIS","Cliniko"]}},"type":"object"}},"components/schemas/AutomatedMessageGetParams":{"id":"components/schemas/AutomatedMessageGetParams","kind":"json-schema","title":"AutomatedMessageGetParams","data":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}},"components/schemas/AutomatedMessageGetDto":{"id":"components/schemas/AutomatedMessageGetDto","kind":"json-schema","title":"AutomatedMessageGetDto","data":{"properties":{"id":{"type":"string"},"recipient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"subject":{"type":"string","nullable":true},"channel":{"type":"string","nullable":true},"content":{"type":"string","nullable":true},"contact_detail":{"type":"string","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"message_type":{"type":"string","nullable":true},"appointment":{"properties":{"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"start_time":{"type":"string","format":"date-time","nullable":true}},"type":"object","nullable":true},"notification_type":{"type":"string","nullable":true}},"type":"object","required":["id"]}},"components/schemas/AutomatedMessageDto":{"id":"components/schemas/AutomatedMessageDto","kind":"json-schema","title":"AutomatedMessageDto","data":{"properties":{"id":{"type":"string"},"recipient":{"properties":{"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"channel":{"type":"string","nullable":true},"contact_detail":{"type":"string","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"message_type":{"type":"string","nullable":true},"appointment_id":{"type":"string","nullable":true},"appointment_type":{"type":"string","nullable":true},"appointment_start_time":{"type":"string","format":"date-time","nullable":true},"notification_type":{"type":"string","nullable":true}},"type":"object","required":["id"]}},"components/schemas/AutomatedMessagesListResponse":{"id":"components/schemas/AutomatedMessagesListResponse","kind":"json-schema","title":"AutomatedMessagesListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"recipient":{"properties":{"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"channel":{"type":"string","nullable":true},"contact_detail":{"type":"string","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"message_type":{"type":"string","nullable":true},"appointment_id":{"type":"string","nullable":true},"appointment_type":{"type":"string","nullable":true},"appointment_start_time":{"type":"string","format":"date-time","nullable":true},"notification_type":{"type":"string","nullable":true}},"type":"object","required":["id"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/AutomatedMessagesListQuery":{"id":"components/schemas/AutomatedMessagesListQuery","kind":"json-schema","title":"AutomatedMessagesListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["createdAt","sentAt"]},"order_descending":{"type":"string","enum":["true","false"]},"recipient_id":{"type":"string","pattern":"^\\d+$"},"status":{"oneOf":[{"type":"array","items":{"type":"string","enum":["INVALIDATED","QUEUED","SENT","ERROR","SUCCESS","EXPIRED"]}},{"type":"string","enum":["INVALIDATED","QUEUED","SENT","ERROR","SUCCESS","EXPIRED"]}]},"notification_type":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},"type":"object"}},"components/schemas/ListBookingLinkFromDb":{"id":"components/schemas/ListBookingLinkFromDb","kind":"json-schema","title":"ListBookingLinkFromDb","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"short_link":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"expiry_date":{"type":"string","format":"date-time","nullable":true},"active":{"default":false,"type":"boolean"},"link_name":{"type":"string","nullable":true},"slot_count":{"type":"number","nullable":true},"meta":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["appointment_type_id","location_id"],"nullable":true}},"type":"object","required":["id"]}},"components/schemas/BookingLinksListResponse":{"id":"components/schemas/BookingLinksListResponse","kind":"json-schema","title":"BookingLinksListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"short_link":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"expiry_date":{"type":"string","format":"date-time","nullable":true},"active":{"default":false,"type":"boolean"},"link_name":{"type":"string","nullable":true},"slot_count":{"type":"number","nullable":true},"meta":{"properties":{"appointment_type_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"location_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"practitioner_id":{"type":"array","items":{"type":"string","pattern":"^\\d+$"},"nullable":true},"from_date":{"type":"string","format":"date-time","nullable":true},"to_date":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["appointment_type_id","location_id"],"nullable":true}},"type":"object","required":["id"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/BookingLinksListQuery":{"id":"components/schemas/BookingLinksListQuery","kind":"json-schema","title":"BookingLinksListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at","expiry_date"]},"order_descending":{"type":"string","enum":["true","false"]},"status":{"type":"string","enum":["expired","unexpired"]},"exclude_patient_specific_links":{"type":"string","enum":["true","false"]}},"type":"object"}},"components/schemas/EpisodeShowTaskDto":{"id":"components/schemas/EpisodeShowTaskDto","kind":"json-schema","title":"EpisodeShowTaskDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"]}},"components/schemas/EpisodeListTaskDto":{"id":"components/schemas/EpisodeListTaskDto","kind":"json-schema","title":"EpisodeListTaskDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true},"form_response_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"communication_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"appointment_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"note_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"]}},"components/schemas/EpisodeDtoV2":{"id":"components/schemas/EpisodeDtoV2","kind":"json-schema","title":"EpisodeDtoV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"]},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"full_name":{"type":"string"},"contact_emails":{"type":"array","items":{"type":"string"},"nullable":true},"registered_practitioner_name":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"membership_scheme_names":{"type":"array","items":{"type":"string"},"nullable":true},"address":{"properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["town","country","postcode"]},"verification_credentials_list":{"type":"array","items":{"type":"string"},"description":"An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private"},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"type":"boolean"},"ehr_registered":{"type":"boolean","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}}},"type":"object","required":["id","dob","sex","full_name","contact_emails","registered_practitioner_name","notes","membership_scheme_names","address"],"nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}},"components/schemas/EpisodeListDtoV2":{"id":"components/schemas/EpisodeListDtoV2","kind":"json-schema","title":"EpisodeListDtoV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true},"form_response_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"communication_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"appointment_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"note_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"uid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string"}},"type":"object","required":["full_name"],"nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}},"components/schemas/EpisodeListResponseV2":{"id":"components/schemas/EpisodeListResponseV2","kind":"json-schema","title":"EpisodeListResponseV2","data":{"properties":{"count":{"type":"number"},"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"status":{"type":"string","enum":["open","closed","in_progress"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"assignees":{"default":[],"type":"array","items":{"properties":{"type":{"type":"string","enum":["Admin","AdminTeam","Unassigned"],"nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["type","id","name"]}},"tasks":{"default":[],"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true},"form_response_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"communication_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"appointment_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"note_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"]}},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"uid":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"full_name":{"type":"string"}},"type":"object","required":["full_name"],"nullable":true},"category":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","status","priority","patient","category","label","description","created_at","updated_at"]}}},"type":"object","required":["count","data"]}},"components/schemas/EpisodeCountQueryV2":{"id":"components/schemas/EpisodeCountQueryV2","kind":"json-schema","title":"EpisodeCountQueryV2","data":{"properties":{"assignee_id":{"default":[],"type":"array","items":{"type":"string"}},"assignee_type":{"default":[],"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"status":{"default":[],"type":"array","items":{"type":"string","enum":["open","closed","in_progress"]}},"priority":{"default":[],"type":"array","items":{"type":"string","enum":["lowest","low","medium","high","highest"]}},"count_limit":{"type":"integer","minimum":0,"exclusiveMinimum":0}},"type":"object"}},"components/schemas/EpisodeCountResponseV2":{"id":"components/schemas/EpisodeCountResponseV2","kind":"json-schema","title":"EpisodeCountResponseV2","data":{"properties":{"count":{"type":"number"},"has_more":{"type":"boolean"}},"type":"object","required":["count","has_more"]}},"components/schemas/FormResponseListFromDbV2":{"id":"components/schemas/FormResponseListFromDbV2","kind":"json-schema","title":"FormResponseListFromDbV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"form_type":{"type":"string","nullable":true},"form_title":{"type":"string","nullable":true},"service":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/FormResponseListDtoV2":{"id":"components/schemas/FormResponseListDtoV2","kind":"json-schema","title":"FormResponseListDtoV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"form_type":{"type":"string","nullable":true},"form_title":{"type":"string","nullable":true},"service":{"type":"string","nullable":true}},"type":"object"}},"components/schemas/FormResponsesListResponseV2":{"id":"components/schemas/FormResponsesListResponseV2","kind":"json-schema","title":"FormResponsesListResponseV2","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true}},"type":"object","nullable":true},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"form_type":{"type":"string","nullable":true},"form_title":{"type":"string","nullable":true},"service":{"type":"string","nullable":true}},"type":"object"}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/FormResponsesListQueryV2":{"id":"components/schemas/FormResponsesListQueryV2","kind":"json-schema","title":"FormResponsesListQueryV2","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["patient_first_name","patient_last_name","patient_full_name","form_title","created_at","updated_at"]},"order_descending":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"patient_full_name":{"type":"string"},"form_title":{"type":"string"},"form_type":{"type":"string"},"created_at":{"type":"array","items":{"type":"string","format":"date-time","nullable":true}},"status":{"type":"string","enum":["success","failed","not_written"]},"service":{"type":"string"}},"type":"object"}},"components/schemas/FormFieldResponseV2":{"id":"components/schemas/FormFieldResponseV2","kind":"json-schema","title":"FormFieldResponseV2","data":{"properties":{"form_question_id":{"type":"string","pattern":"^\\d+$"},"text_response":{"type":"string"},"integer_response":{"type":"number","nullable":true},"boolean_response":{"type":"boolean"},"checkbox_response":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"datetime_response":{"type":"string"},"observation_value_response":{"type":"string"},"problem_response":{"type":"string"},"immunisation_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"},"base_64_file_response":{"type":"string"}},"type":"object","required":["form_question_id"]}},"components/schemas/FormResponseCreateBodyV2":{"id":"components/schemas/FormResponseCreateBodyV2","kind":"json-schema","title":"FormResponseCreateBodyV2","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$"},"responses":{"type":"array","items":{"properties":{"form_question_id":{"type":"string","pattern":"^\\d+$"},"text_response":{"type":"string"},"integer_response":{"type":"number","nullable":true},"boolean_response":{"type":"boolean"},"checkbox_response":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"datetime_response":{"type":"string"},"observation_value_response":{"type":"string"},"problem_response":{"type":"string"},"immunisation_response":{"type":"string"},"base_64_content_type":{"type":"string"},"base_64_file_name":{"type":"string"},"base_64_file_response":{"type":"string"}},"type":"object","required":["form_question_id"]}},"appointment_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id","responses"]}},"components/schemas/FormResponseCreateParamV2":{"id":"components/schemas/FormResponseCreateParamV2","kind":"json-schema","title":"FormResponseCreateParamV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/FormResponseCreateResponseV2":{"id":"components/schemas/FormResponseCreateResponseV2","kind":"json-schema","title":"FormResponseCreateResponseV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/MessageListFromDbV2":{"id":"components/schemas/MessageListFromDbV2","kind":"json-schema","title":"MessageListFromDbV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","title","first_name","last_name"]},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["write_to_record_at","status","failure_reason","snomed_code"]},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"campaign":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"scheduled_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]},"sent_by":{"type":"string"},"recipient_contact_detail":{"type":"string"},"message_type":{"type":"string"},"message":{"type":"string","nullable":true},"attachment":{"properties":{"filename":{"type":"string","nullable":true},"short_link_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["filename","short_link_id"],"nullable":true}},"type":"object","required":["id","patient","write_to_record","short_link","campaign","created_at","sent_at","scheduled_at","status","sent_by","recipient_contact_detail","message_type","message","attachment"]}},"components/schemas/MessagesListResponseV2":{"id":"components/schemas/MessagesListResponseV2","kind":"json-schema","title":"MessagesListResponseV2","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string"},"last_name":{"type":"string"}},"type":"object","required":["id","title","first_name","last_name"]},"write_to_record":{"properties":{"write_to_record_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["write_to_record_at","status","failure_reason","snomed_code"]},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"campaign":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"scheduled_at":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]},"sent_by":{"type":"string"},"recipient_contact_detail":{"type":"string"},"message_type":{"type":"string"},"message":{"type":"string","nullable":true},"attachment":{"properties":{"filename":{"type":"string","nullable":true},"short_link_id":{"type":"string","pattern":"^\\d+$","nullable":true}},"type":"object","required":["filename","short_link_id"],"nullable":true}},"type":"object","required":["id","patient","write_to_record","short_link","campaign","created_at","sent_at","scheduled_at","status","sent_by","recipient_contact_detail","message_type","message","attachment"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/MessagesListQueryV2":{"id":"components/schemas/MessagesListQueryV2","kind":"json-schema","title":"MessagesListQueryV2","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["patient_first_name","patient_last_name","patient_full_name","created_at","sent_at"]},"order_descending":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"},"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"patient_full_name":{"type":"string"},"created_at":{"type":"string","format":"date-time","nullable":true},"scheduled_at":{"type":"array","items":{"type":"string","format":"date-time","nullable":true}},"sent_at":{"type":"array","items":{"type":"string","format":"date-time","nullable":true}},"recipient_contact_detail":{"type":"string"},"short_link_id":{"type":"string","pattern":"^\\d+$"},"campaign_id":{"type":"string","pattern":"^\\d+$"},"short_link_type":{"type":"string","enum":["booking","patient_reply","questionnaire","video","attachment"]},"status":{"oneOf":[{"type":"array","items":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]}},{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]}]},"message_type":{"oneOf":[{"type":"array","items":{"type":"string","enum":["nhs_app","email","hero","sms"]}},{"type":"string","enum":["nhs_app","email","hero","sms"]}]},"sent_by":{"type":"string"},"scheduled":{"type":"string"},"write_to_record_status":{"type":"string","enum":["success","failed","not_written"]}},"type":"object"}},"components/schemas/MessageSendBodyV2":{"id":"components/schemas/MessageSendBodyV2","kind":"json-schema","title":"MessageSendBodyV2","data":{"properties":{"patient_id":{"type":"string","pattern":"^\\d+$","description":"The Hero patient the message relates to"},"message_type":{"type":"string","enum":["hero","sms","email","nhs_app"],"description":"Defines if the message will be sent on via Hero's comms tools, and by what method"},"message_string":{"type":"string","minLength":1,"description":"Message content to be sent from Hero"},"recipient_contact_detail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the message will be sent (e.g. patient@email.com or +44 79000000000). If no value is provided a default will be picked from the patients record (for that contact method, SMS/Email)."},"children":[]}]}]}]},"fallback_contact_detail":{"type":"string"},"fallback_message_type":{"type":"string","enum":["sms","email"]},"write_to_record":{"default":false,"type":"boolean","description":"Flags if the message should be written to the EHR record post-approval"},"encrypted":{"default":false,"oneOf":[{"type":"boolean"},{"type":"string","enum":["dob_authenticated"]}],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. This field is ignored — messages are no longer encrypted at the platform layer."},"children":[]}]}]}]},"snomed_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SNOMED code to be attached to the EHR record entry.  Default value applied if not passed and write_to_record is true"},"children":[]}]}]}]},"snomed_term":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SNOMED term to be attached to the EHR record entry. Default value applied if not passed and write_to_record is true"},"children":[]}]}]}]},"task_id":{"type":"string","description":"Task ID to be attached to a task"},"attachment_uuid":{"type":"string","minLength":1},"short_link_id":{"type":"string","minLength":1},"assignee_id":{"type":"number","description":"Optional. ID of the Admin or AdminTeam assigned to the message"},"assignee_type":{"type":"string","description":"Type of the assignee, either Admin or AdminTeam, assigned to the message"},"send_at":{"type":"string","format":"date-time","description":"Specifies the scheduled date and time to send the message."},"episode_id":{"type":"string","minLength":1}},"type":"object","required":["patient_id","message_type","message_string"]}},"components/schemas/CommunicationResultDtoV2":{"id":"components/schemas/CommunicationResultDtoV2","kind":"json-schema","title":"CommunicationResultDtoV2","data":{"properties":{"id":{"type":"string"},"content":{"type":"string"},"created_at":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"write_to_record":{"type":"boolean"},"auth_token":{"type":"string","nullable":true},"submitted_by":{"type":"string","nullable":true},"send_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","content","created_at","write_to_record"]}},"components/schemas/MessageSendResultV2":{"id":"components/schemas/MessageSendResultV2","kind":"json-schema","title":"MessageSendResultV2","data":{"properties":{"id":{"type":"string"},"content":{"type":"string"},"created_at":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"write_to_record":{"type":"boolean"},"auth_token":{"type":"string","nullable":true},"submitted_by":{"type":"string","nullable":true},"send_at":{"type":"string","format":"date-time","nullable":true},"task":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true}},"type":"object","required":["id","type_label","status","category","priority","created_at","title","title_sub_text","name","taskable_type"],"nullable":true}},"type":"object","required":["id","content","created_at","write_to_record","task"]}},"components/schemas/PatientFromEhr":{"id":"components/schemas/PatientFromEhr","kind":"json-schema","title":"PatientFromEhr","data":{"properties":{"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true},"sex":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["dob"]}},"components/schemas/PatientRaw":{"id":"components/schemas/PatientRaw","kind":"json-schema","title":"PatientRaw","data":{"oneOf":[{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"number","minimum":0,"maximum":3,"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"number"},"restricted":{"default":false,"type":"boolean"}},"type":"object","required":["id","dob","data_source"]},{"properties":{"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"nhs_number":{"type":"string","nullable":true},"sex":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true}},"type":"object","required":["dob"]}]}},"components/schemas/PatientDtoV2":{"id":"components/schemas/PatientDtoV2","kind":"json-schema","title":"PatientDtoV2","data":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"]}},"components/schemas/PatientListResponseV2":{"id":"components/schemas/PatientListResponseV2","kind":"json-schema","title":"PatientListResponseV2","data":{"properties":{"data":{"type":"array","items":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PatientListQueryV2":{"id":"components/schemas/PatientListQueryV2","kind":"json-schema","title":"PatientListQueryV2","data":{"properties":{"field":{"type":"string","enum":["ehr_partner_id","nhs_number","dob","verified_email","verified_phone"]},"search":{"type":"string"}},"type":"object"}},"components/schemas/PatientListQueryInternalV2":{"id":"components/schemas/PatientListQueryInternalV2","kind":"json-schema","title":"PatientListQueryInternalV2","data":{"properties":{"field":{"type":"string","enum":["ehr_partner_id","nhs_number","dob","verified_email","verified_phone"]},"search":{"type":"string"}},"type":"object"}},"components/schemas/PatientGetParamsV2":{"id":"components/schemas/PatientGetParamsV2","kind":"json-schema","title":"PatientGetParamsV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/PatientGetQueryV2":{"id":"components/schemas/PatientGetQueryV2","kind":"json-schema","title":"PatientGetQueryV2","data":{"properties":{},"type":"object"}},"components/schemas/PatientGetQueryInternalV2":{"id":"components/schemas/PatientGetQueryInternalV2","kind":"json-schema","title":"PatientGetQueryInternalV2","data":{"properties":{},"type":"object"}},"components/schemas/PrescriptionListFromDbV2":{"id":"components/schemas/PrescriptionListFromDbV2","kind":"json-schema","title":"PrescriptionListFromDbV2","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"external_prescription_id":{"type":"string","nullable":true},"prescriber":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["id","name"],"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","external_prescription_id","prescriber","created_at"]}},"components/schemas/PrescriptionsListResponseV2":{"id":"components/schemas/PrescriptionsListResponseV2","kind":"json-schema","title":"PrescriptionsListResponseV2","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"external_prescription_id":{"type":"string","nullable":true},"prescriber":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"name":{"type":"string","nullable":true}},"type":"object","required":["id","name"],"nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true}},"type":"object","required":["id","external_prescription_id","prescriber","created_at"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PrescriptionsListQueryV2":{"id":"components/schemas/PrescriptionsListQueryV2","kind":"json-schema","title":"PrescriptionsListQueryV2","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"order_by":{"type":"string","enum":["created_at"]},"created_at":{"type":"string","format":"date-time","nullable":true},"order_descending":{"type":"string"},"patient_id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["patient_id"]}},"components/schemas/TaskPatientDto":{"id":"components/schemas/TaskPatientDto","kind":"json-schema","title":"TaskPatientDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"]},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"full_name":{"type":"string"},"contact_emails":{"type":"array","items":{"type":"string"},"nullable":true},"registered_practitioner_name":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"membership_scheme_names":{"type":"array","items":{"type":"string"},"nullable":true},"address":{"properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["town","country","postcode"]},"verification_credentials_list":{"type":"array","items":{"type":"string"},"description":"An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private"}},"type":"object","required":["id","dob","sex","full_name","contact_emails","registered_practitioner_name","notes","membership_scheme_names","address"]}},"components/schemas/TaskDto":{"id":"components/schemas/TaskDto","kind":"json-schema","title":"TaskDto","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"]},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"full_name":{"type":"string"},"contact_emails":{"type":"array","items":{"type":"string"},"nullable":true},"registered_practitioner_name":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"membership_scheme_names":{"type":"array","items":{"type":"string"},"nullable":true},"address":{"properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["town","country","postcode"]},"verification_credentials_list":{"type":"array","items":{"type":"string"},"description":"An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private"}},"type":"object","required":["id","dob","sex","full_name","contact_emails","registered_practitioner_name","notes","membership_scheme_names","address"]},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"assignee_id":{"type":"string","nullable":true},"assignee_type":{"type":"string"},"assignee_name":{"type":"string","nullable":true},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"},"name":{"type":"string"},"taskable_type":{"type":"string"},"triggered_by":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type":{"type":"string","enum":["Admin","Client"]},"name":{"type":"string"}},"type":"object","required":["id","type","name"],"nullable":true},"system_alert_details":{"properties":{"type":{"type":"string","enum":["emis_alert","message_failed"]},"title":{"type":"string"},"message":{"type":"string"},"sub_title":{"type":"string"},"action":{"type":"string","nullable":true}},"type":"object","required":["type","title","message","sub_title","action"],"nullable":true},"form_response_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"communication_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"appointment_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]},"note_id":{"oneOf":[{"type":"string","pattern":"^\\d+$"},{"type":"number"},{"type":"null"}]}},"type":"object","required":["id","type_label","status","category","patient","priority","created_at","title","title_sub_text","name","taskable_type"]}},"components/schemas/TaskEventDto":{"id":"components/schemas/TaskEventDto","kind":"json-schema","title":"TaskEventDto","data":{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["task"]},"action":{"type":"string","enum":["create","update","destroy"]},"timestamp":{"type":"string"}},"type":"object","required":["id","type","action","timestamp"]}},"components/schemas/TaskGetParams":{"id":"components/schemas/TaskGetParams","kind":"json-schema","title":"TaskGetParams","data":{"properties":{"id":{"type":"string","pattern":"^\\d+$"}},"type":"object","required":["id"]}},"components/schemas/TasksListQuery":{"id":"components/schemas/TasksListQuery","kind":"json-schema","title":"TasksListQuery","data":{"properties":{"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true},"assignee_id":{"default":[],"type":"array","items":{"type":"string"}},"assignee_type":{"default":[],"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"status":{"default":[],"type":"array","items":{"type":"string","enum":["open","closed","in_progress"]}},"priority":{"default":[],"type":"array","items":{"type":"string","enum":["lowest","low","medium","high","highest"]}},"order_by":{"default":[],"type":"array","items":{"type":"string"}},"order_descending":{"default":[],"type":"array","items":{"type":"string"}}},"type":"object"}},"components/schemas/TaskListResponse":{"id":"components/schemas/TaskListResponse","kind":"json-schema","title":"TaskListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"type_label":{"type":"string"},"status":{"type":"string","enum":["open","closed","in_progress"]},"details":{"type":"string","nullable":true},"category":{"type":"string"},"patient":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"uid":{"type":"string","nullable":true},"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["unspecified","male","female","other"]},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"full_name":{"type":"string"},"contact_emails":{"type":"array","items":{"type":"string"},"nullable":true},"registered_practitioner_name":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"membership_scheme_names":{"type":"array","items":{"type":"string"},"nullable":true},"address":{"properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"line3":{"type":"string","nullable":true},"town":{"type":"string"},"county":{"type":"string","nullable":true},"country":{"type":"string"},"postcode":{"type":"string"}},"type":"object","required":["town","country","postcode"]},"verification_credentials_list":{"type":"array","items":{"type":"string"},"description":"An array of unique emails and mobile numbers from the verification credentials associated with the patients practice group, Only applicable for practices using the JS booking flow and marked as private"}},"type":"object","required":["id","dob","sex","full_name","contact_emails","registered_practitioner_name","notes","membership_scheme_names","address"]},"form_response":{"properties":{"id":{"type":"number"},"form_id":{"type":"number"},"client_id":{"type":"number"},"appointment_id":{"type":"number","nullable":true},"invoice_id":{"type":"number","nullable":true},"practice_group_id":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"hidden":{"type":"boolean"},"emis_file_record_at":{"type":"string","nullable":true},"short_link_id":{"type":"number","nullable":true},"admin_id":{"type":"number","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"title":{"type":"string"},"submitted_at":{"type":"string"},"form_questions_responses":{"type":"array","items":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"question":{"type":"string"},"answer":{"type":"string"},"snomed_code":{"type":"string","nullable":true},"type":{"type":"string","enum":["str","int","bool","datepicker","text","radio","dropdown","checkboxes","consent","paragraph","attachment","observation","problem","immunisation"]}},"type":"object","required":["id","question","answer","type"]}},"form":{"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"patient_title":{"type":"string","nullable":true},"patient_description":{"type":"string","nullable":true},"reply_form":{"type":"boolean"},"form_type":{"type":"string","enum":["questionnaire","response","appointment","care_navigation","intake_form","structured_consult"]},"snomed_code":{"type":"string","nullable":true}},"type":"object","required":["id","title","description","patient_title","patient_description","reply_form","form_type","snomed_code"]},"write_to_record_status":{"type":"string","nullable":true}},"type":"object","required":["id","form_id","client_id","appointment_id","invoice_id","practice_group_id","created_at","updated_at","hidden","emis_file_record_at","short_link_id","admin_id","write_to_record_error","title","submitted_at","form_questions_responses","form","write_to_record_status"]},"appointment":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"location_id":{"type":"string","pattern":"^\\d+$"},"start_time":{"type":"string","format":"date-time","nullable":true},"reserved_until":{"type":"string","format":"date-time","nullable":true},"booking_confirmed_at":{"type":"string","format":"date-time","nullable":true},"can_be_cancelled":{"default":false,"type":"boolean"},"can_be_rescheduled":{"default":false,"type":"boolean"},"cancellation_policy_hours":{"type":"number"},"appointment_template_name":{"type":"string","nullable":true},"cancelled_at":{"type":"string","format":"date-time","nullable":true},"confirmed_at":{"type":"string","format":"date-time","nullable":true},"appointment_source":{"type":"string","nullable":true},"video":{"default":false,"type":"boolean","nullable":true},"in_person":{"default":false,"type":"boolean"},"telephone":{"default":false,"type":"boolean"},"location_name":{"type":"string","nullable":true},"service":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"appointment_type_id":{"type":"string","nullable":true},"duration":{"type":"number","nullable":true},"patient_uid":{"type":"string","nullable":true},"practitioner_id":{"type":"string","nullable":true},"booking_status":{"type":"string","enum":["reserved","pending","confirmed","cancelling","rescheduling","abandoned","cancelled","failed","unknown"],"nullable":true},"booking_mechanism":{"type":"string","enum":["hero_confirmed","ehr_confirmed"],"nullable":true},"created_at":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"practitioner_name":{"type":"string","nullable":true},"communication_method":{"type":"string","nullable":true},"video_url":{"type":"string","nullable":true},"rescheduled_at":{"type":"string","nullable":true}},"type":"object","required":["id","location_id","start_time"]},"communication":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"content":{"type":"string","nullable":true},"contact_method":{"type":"string","enum":["email","sms","hero","nhs_app"]},"write_to_record_timestamp":{"type":"string","nullable":true},"write_to_record_error":{"type":"string","nullable":true},"write_to_record_status":{"type":"string","nullable":true},"short_link":{"properties":{"id":{"type":"string","pattern":"^\\d+$","nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"type":"object","nullable":true},"notification":{"properties":{"id":{"type":"string","pattern":"^\\d+$"},"sent_at":{"type":"string"},"status":{"type":"string"},"primary_recipient_contact_detail":{"type":"string","nullable":true},"failure_reason":{"type":"string","nullable":true}},"type":"object","required":["id","sent_at","status"]}},"type":"object","required":["id","contact_method","write_to_record_status","notification"]},"note":{"properties":{"id":{"type":"number"},"description":{"type":"string"},"admin":{"properties":{"id":{"type":"number"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"}},"type":"object","required":["id","first_name","last_name","full_name"]},"practice_group_id":{"type":"number"},"archived_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","description","admin","practice_group_id","archived_at","created_at","updated_at"]},"assignee_id":{"type":"string","nullable":true},"assignee_type":{"type":"string"},"assignee_name":{"type":"string","nullable":true},"priority":{"type":"string","enum":["lowest","low","medium","high","highest"]},"created_at":{"type":"string"},"title":{"type":"string"},"title_sub_text":{"type":"string"}},"type":"object","required":["id","type_label","status","category","patient","priority","created_at","title","title_sub_text"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/TaskEventsListQuery":{"id":"components/schemas/TaskEventsListQuery","kind":"json-schema","title":"TaskEventsListQuery","data":{"properties":{"starting_after":{"type":"string"}},"type":"object","required":["starting_after"]}},"components/schemas/TaskEventsListResponse":{"id":"components/schemas/TaskEventsListResponse","kind":"json-schema","title":"TaskEventsListResponse","data":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["task"]},"action":{"type":"string","enum":["create","update","destroy"]},"timestamp":{"type":"string"}},"type":"object","required":["id","type","action","timestamp"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"components/schemas/PatientListQueryV3":{"id":"components/schemas/PatientListQueryV3","kind":"json-schema","title":"PatientListQueryV3","data":{"properties":{"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"dob":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"nhs_number":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1},"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true}},"type":"object","additionalProperties":false}},"components/schemas/PatientListQueryInternalV3":{"id":"components/schemas/PatientListQueryInternalV3","kind":"json-schema","title":"PatientListQueryInternalV3","data":{"properties":{"first_name":{"type":"string","minLength":1},"last_name":{"type":"string","minLength":1},"dob":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 date format","example":"1989-04-11"},"nhs_number":{"type":"string","minLength":1},"ehr_partner_id":{"type":"string","minLength":1},"page_index":{"default":0,"type":"number","nullable":true},"page_size":{"default":20,"type":"number","nullable":true}},"type":"object","additionalProperties":false}},"components/schemas/PatientDtoV3":{"id":"components/schemas/PatientDtoV3","kind":"json-schema","title":"PatientDtoV3","data":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"]}},"components/schemas/PatientListResponseV3":{"id":"components/schemas/PatientListResponseV3","kind":"json-schema","title":"PatientListResponseV3","data":{"properties":{"data":{"type":"array","items":{"properties":{"ehr_partner_id":{"type":"string","nullable":true},"emis_id":{"type":"string","nullable":true},"deceased_at":{"type":"string","format":"date-time","nullable":true},"ods_code":{"type":"string","nullable":true},"dob":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string","enum":["Baron","Baroness","Brigadier","Count","Colonel","Countess","Captain","Dame","The Dowager Viscountess","Dr","Duchess","Duke","Earl","His Excellency","Father","H.E. Ambassador Mr","H.E. Mr","H.E. Mrs","Her Grace","His Grace","The Hon","The Hon Mr","The Hon Mrs","HRH","HRH Prince","HRH Princess","Insurance","HM King","Lady","Lord","Major","Master","Miss","Mr","Mrs","Ms","Mss","Mx","Pr","Professor","HM Queen","Rabbi","Reverend","Sheikh","Sheikha","Sir","The","","Viscount","Viscountess"],"nullable":true},"first_name":{"type":"string","nullable":true},"last_name":{"type":"string","nullable":true},"sex":{"type":"string","enum":["Not known","Not specified","Male","Female","Other"],"nullable":true},"nhs_number":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"last_sync_at":{"type":"string","format":"date-time","nullable":true},"data_source":{"type":"string","enum":["hero","emis","pds","gha","systm_one"],"nullable":true},"restricted":{"default":false,"type":"boolean"},"line_1":{"type":"string","nullable":true},"line_2":{"type":"string","nullable":true},"line_3":{"type":"string","nullable":true},"town":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"hero_id":{"type":"string","pattern":"^\\d+$","nullable":true},"hero_uid":{"type":"string","nullable":true},"identifiers":{"type":"array","items":{"properties":{"source":{"type":"string","enum":["nhs","gha","ehr_partner","hero"]},"name":{"type":"string","enum":["nhs_number","gha_number","ehr_partner_id","hero_id","hero_uid"]},"role":{"type":"string","enum":["main","secondary"]},"label":{"type":"string","enum":["NHS","GHA","EMIS","Hero","Systm One"]},"value":{"type":"string"}},"type":"object","required":["source","name","role","label","value"]}},"ehr_registered":{"type":"boolean","nullable":true}},"type":"object","required":["dob","identifiers","ehr_registered"]}},"count":{"type":"number"}},"type":"object","required":["data","count"]}},"schema_52":{"kind":"json-schema","data":{"type":"string"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"string","enum":["patient_id","patient_first_name","patient_last_name","patient_full_name","practitioner_first_name","practitioner_last_name","practitioner_full_name","appointment_template_name","appointment_source","location_name","confirmed_at","start_time"]},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"string","enum":["Hero patient led","Hero admin led","Hero booking link","Hero booking API","EMIS","Cliniko"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","enum":["createdAt","sentAt"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","enum":[true,false]},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"oneOf":[{"type":"string","enum":["INVALIDATED","QUEUED","SENT","SUCCESS","ERROR"]},{"type":"array","items":{"type":"string","enum":["INVALIDATED","QUEUED","SENT","SUCCESS","ERROR"]}}]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"string","enum":["expiry_date","created_at"]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"enum":["expired","unexpired"]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["archived"]}},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","enum":["true","false"],"default":"false"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"string","enum":["first_name"]},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","enum":["admin_team_name"]},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","example":"0"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","example":"20"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"string","enum":["emis_id","nhs_number","dob"]},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","enum":["ehr_partner_id","nhs_number","dob","verified_email","verified_phone"]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","example":"1990-12-31"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["Admin","AdminTeam","Unassigned"]}},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["open","closed","in_progress"]}},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["lowest","low","medium","high","highest"]}},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["created_at","priority"]}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"string","enum":["created_at"]},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ResourceType"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"string","enum":["patient_first_name","patient_last_name","patient_full_name","created_at","sent_at"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"oneOf":[{"type":"string","enum":["nhs_app","email","hero","sms"]},{"type":"array","items":{"type":"string","enum":["nhs_app","email","hero","sms"]}}]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"oneOf":[{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]},{"type":"array","items":{"type":"string","enum":["delivered","declined","sent","pending","retry","fatal"]}}]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"string","enum":["CREATED","ENRICHMENT_ERROR","ENRICHED","INVALID_PAYLOAD","QUEUED"]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"string","enum":["CREATED","QUEUED","SENT","ERROR","SUCCESS"]},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"string","enum":["booking","patient_reply","questionnaire","video","attachment"]},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["created_at","expires_on","cancelled_at","members"]}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["created_at","expires_on"]}},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"string","example":"M100027"},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"string","enum":["questionnaire","response","appointment","care_navigation"]},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","enum":["patient_first_name","patient_last_name","patient_full_name","form_title","form_type","created_at","updated_at"]},"id":"schema_90"}},"exampleStore":{"paths/~1v1~1appointments/post/requestBody/content/application~1json/example":{"value":{"appointment_type_id":"42","location_id":"7","practitioner_id":"15","duration":15,"start_time":"2026-03-15T09:30:00Z","patient_id":"1234","billpayer_id":"5678","reason":"Annual health check","suppress_mail":false,"suppress_availability_check":false,"suppress_eligibility_check":false,"booking_mechanism":"hero_confirmed"},"id":"paths/~1v1~1appointments/post/requestBody/content/application~1json/example"},"paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example":{"value":{"practitioner_id":"15","duration":15,"start_time":"2026-03-15T09:30:00Z","suppress_mail":false,"suppress_availability_check":false},"id":"paths/~1v1~1appointments~1{id}/put/requestBody/content/application~1json/example"},"paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example":{"value":{"patient_id":"1234","billpayer_id":"5678","reason":"Annual health check","suppress_availability_check":false,"externally_paid":false},"id":"paths/~1v1~1appointments~1{id}~1book/patch/requestBody/content/application~1json/example"},"paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example":{"value":{"practitioner_id":"15","duration":15,"start_time":"2026-03-15T09:30:00Z","suppress_mail":false,"suppress_availability_check":false},"id":"paths/~1v1~1appointments~1{id}~1reschedule/patch/requestBody/content/application~1json/example"},"paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example":{"value":{"patient_id":"1234","message_type":"sms","message_string":"Dear patient, your appointment is confirmed for 15 March at 09:30.","recipient_contact_detail":"+447700900123","write_to_record":true},"id":"paths/~1v1~1messages~1send/post/requestBody/content/application~1json/example"},"paths/~1v1~1webhooks/post/requestBody/content/application~1json/example":{"value":{"description":"Notify our system when appointments are confirmed","event_type":"appointment.confirmed","signing_key":"whsec_your-secret-key-here","url":"https://example.com/webhooks/hero"},"id":"paths/~1v1~1webhooks/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"apiKeyAuth":{"id":"apiKeyAuth","type":"apiKey","description":"Your Hero Health API key. Request one from Hero support with the scopes you need (messaging, booking, booking links).","in":"header","paramName":"x-api-key"},"practiceGroupId":{"id":"practiceGroupId","type":"apiKey","description":"The ID of the practice group you are making requests for. Provided by Hero during onboarding.","in":"header","paramName":"x-practice-group-id"}},"servers":[{"url":"/_mock/apis/public-api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.staging.htech.app","description":"Staging"},{"url":"https://api.herohealth.net","description":"Production"}],"specType":"openapi"},"options":{"downloadUrls":[{"title":"Download API docs","url":"https://herohealthsoftware.github.io/herodoctors.co.uk/api/openapi.yaml"}],"codeSamples":{"languages":[{"lang":"curl","label":"curl"},{"lang":"Node.js","label":"NodeJS"},{"lang":"Ruby","label":"Ruby"}]},"feedback":{"type":"sentiment","settings":{"label":"Was this page helpful?"}},"mockServer":{"url":"/_mock/apis/public-api/openapi","position":"first","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Hero Health Public API","description":"The Hero Health Public API enables healthtech partners to build products that leverage Hero Health's IM1-assured EMIS/TPP integrated functionality.\n\n## Key capabilities\n- **Patient messaging** — Send SMS, email, and NHS App messages on behalf of a practice\n- **Appointment booking** — List available slots, create reservations, and confirm bookings\n- **Patient management** — Register and look up patients via PDS (Personal Demographics Service)\n- **Webhooks** — Subscribe to events such as appointment confirmations and write-to-record outcomes\n- **Booking & form links** — Generate sharable links for patient self-service flows\n- **Elements** — Generate access tokens for embedding pre-built Hero UI components\n\n## Authentication\nAll endpoints require an `x-api-key` and `x-practice-group-id` header. API keys are scoped to specific functionality (messaging, booking, booking links). Contact Hero support to request your key.\n\n## Rate limits\nRate limits are defined in your Partner agreement. If you exceed your limit you will receive a `429 Too Many Requests` response."}},"baseSlug":"/apis/public-api/openapi","routesMapping":{}}