{"items":[{"type":"link","label":"Clinics API","link":"/reference/clinic.v1","routeSlug":"/reference/clinic.v1","content":{"contentType":"overview","meta":{"name":"Clinics API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"clinic.v1.json","url":"/_bundle/reference/clinic.v1.json?download"},{"kind":"download","label":"clinic.v1.yaml","url":"/_bundle/reference/clinic.v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.tidepool.org","url":"https://www.tidepool.org"},{"kind":"email","title":"Tidepool","email":"support@tidepool.org","label":"support@tidepool.org","withCopyButton":true,"copyContent":"support@tidepool.org"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"BSD-2-Clause","url":"https://github.com/tidepool-org/clinic/blob/master/LICENSE"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Clinics API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Web service that stores information about clinics, clinicians and their patients"}],"sectionId":"/reference/clinic.v1"}],"sectionId":"/reference/clinic.v1"}]}]}},{"type":"group","label":"Clinics","link":"/reference/clinic.v1/clinics","routeSlug":"/reference/clinic.v1/clinics","items":[{"label":"List Clinics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinics","routeSlug":"/reference/clinic.v1/clinics/listclinics","metadata":{"seo":{"title":"List Clinics","description":"Retrieve the list of clinics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinics","name":"List Clinics","isWebhook":false,"pointer":"/paths/~1v1~1clinics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of clinics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"shareCode","in":"query","schemaId":"schema_112"},{"name":"createdTimeStart","in":"query","schemaId":"schema_113","description":"Return records created after the given date (inclusive)"},{"name":"createdTimeEnd","in":"query","schemaId":"schema_113","description":"Return records created before the given date (exclusive)"},{"name":"ehrEnabled","in":"query","schemaId":"schema_114","description":"Retrieve clinics with enabled EHR integration"}],"pointer":"/paths/~1v1~1clinics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"shareCode","in":"query","required":false,"schemaId":"schema_112"},{"name":"createdTimeStart","in":"query","required":false,"schemaId":"schema_113"},{"name":"createdTimeEnd","in":"query","required":false,"schemaId":"schema_113"},{"name":"ehrEnabled","in":"query","required":false,"schemaId":"schema_114"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403","500"],"pointer":"/v1/clinics","href":"clinics/listclinics","openApiOperationId":"ListClinics","summary":"List Clinics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinics.v1"}},"schemaId":"components/schemas/clinics.v1"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"}],"pointer":"/paths/~1v1~1clinics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinics.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinics.v1"}}},{"code":"400","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}},{"code":"403","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}},{"code":"500","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listclinics"}],"panels":[]}]},"httpPath":"/v1/clinics"},{"label":"Create Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createclinic","routeSlug":"/reference/clinic.v1/clinics/createclinic","metadata":{"seo":{"title":"Create Clinic","description":"Create a new clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateClinic","name":"Create Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinic.v1"}},"schemaId":"components/schemas/clinic.v1","pointer":"/paths/~1v1~1clinics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/clinic.v1"}},"responseCodes":["200","400","403","500"],"pointer":"/v1/clinics","href":"clinics/createclinic","openApiOperationId":"CreateClinic","summary":"Create Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinic.v1"}},"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","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"},"application/xml":{"schemaId":"schema_115"}},"schemaId":"components/schemas/clinic.v1"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1clinics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"},"application/xml":{"schemaId":"schema_115"}}},{"code":"400"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createclinic"}],"panels":[]}]},"httpPath":"/v1/clinics"},{"label":"Get Clinic by Share Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinicbysharecode","routeSlug":"/reference/clinic.v1/clinics/getclinicbysharecode","metadata":{"seo":{"title":"Get Clinic by Share Code","description":"Retrieve a clinic object with a share code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetClinicByShareCode","name":"Get Clinic by Share Code","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1share_code~1{shareCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinic by Share Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a clinic object with a share code"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shareCode","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1share_code~1{shareCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/share_code/{shareCode}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"shareCode","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/share_code/{shareCode}","href":"clinics/getclinicbysharecode","openApiOperationId":"GetClinicByShareCode","summary":"Get Clinic by Share Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinic.v1"}},"schemaId":"components/schemas/clinic.v1"}],"pointer":"/paths/~1v1~1clinics~1share_code~1{shareCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getclinicbysharecode"}],"panels":[]}]},"httpPath":"/v1/clinics/share_code/{shareCode}"},{"label":"Get Clinic","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinic","routeSlug":"/reference/clinic.v1/clinics/getclinic","metadata":{"seo":{"title":"Get Clinic","description":"Retrieve a clinic by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetClinic","name":"Get Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a clinic by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403","500"],"pointer":"/v1/clinics/{clinicId}","href":"clinics/getclinic","openApiOperationId":"GetClinic","summary":"Get Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinic.v1"}},"schemaId":"components/schemas/clinic.v1"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"}}},{"code":"400"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getclinic"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}"},{"label":"Update Clinic","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinic","routeSlug":"/reference/clinic.v1/clinics/updateclinic","metadata":{"seo":{"title":"Update Clinic","description":"Update an existing clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateClinic","name":"Update Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/xml"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinic.v1"},"application/xml":{"schemaId":"schema_115"}},"schemaId":"components/schemas/clinic.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/clinic.v1"},"application/xml":{"schemaId":"schema_115"}},"responseCodes":["200","400","403","500"],"pointer":"/v1/clinics/{clinicId}","href":"clinics/updateclinic","openApiOperationId":"UpdateClinic","summary":"Update Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json","application/xml"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinic.v1"},"application/xml":{"schemaId":"schema_115"}},"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/clinic.v1"}},"schemaId":"components/schemas/clinic.v1"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"}}},{"code":"400"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updateclinic"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}"},{"label":"Delete Clinic","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteclinic","routeSlug":"/reference/clinic.v1/clinics/deleteclinic","metadata":{"seo":{"title":"Delete Clinic","description":"Deletes a clinic if there are no connected patient accounts (besides demo accounts)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteClinic","name":"Delete Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a clinic if there are no connected patient accounts (besides demo accounts)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}","href":"clinics/deleteclinic","openApiOperationId":"DeleteClinic","summary":"Delete Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deleteclinic"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}"},{"label":"List Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicians","routeSlug":"/reference/clinic.v1/clinics/listclinicians","metadata":{"seo":{"title":"List Clinicians","description":"Retrieve the list of clinic members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinicians","name":"List Clinicians","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinicians","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of clinic members. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_112","description":"Full text search query"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"email","in":"query","schemaId":"schema_118"},{"name":"role","in":"query","schemaId":"schema_112"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_112"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"email","in":"query","required":false,"schemaId":"schema_118"},{"name":"role","in":"query","required":false,"schemaId":"schema_112"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/clinicians","href":"clinics/listclinicians","openApiOperationId":"ListClinicians","summary":"List Clinicians"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinicians.v1"}},"schemaId":"components/schemas/clinicians.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinicians.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinicians.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listclinicians"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/clinicians"},{"label":"Create Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createclinician","routeSlug":"/reference/clinic.v1/clinics/createclinician","metadata":{"seo":{"title":"Create Clinician","description":"Internal endpoint to create a new clinician"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateClinician","name":"Create Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to create a new clinician"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"schemaId":"components/schemas/clinician.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/clinicians","href":"clinics/createclinician","openApiOperationId":"CreateClinician","summary":"Create Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/clinicians"},{"label":"View TIDE Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/tidereport","routeSlug":"/reference/clinic.v1/clinics/tidereport","metadata":{"seo":{"title":"View TIDE Report","description":"Retrieve a report of patients with tags by TIDE categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TideReport","name":"View TIDE Report","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tide_report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View TIDE Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a report of patients with tags by TIDE categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tide_report/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"period","in":"query","schemaId":"schema_119","description":"Time Period to display","required":true},{"name":"tags","in":"query","schemaId":"schema_120","description":"Comma-separated list of patient tag IDs","required":true},{"name":"lastDataCutoff","in":"query","schemaId":"schema_113","description":"Inclusive minimum of date of last data from a patient.","required":true},{"name":"categories","in":"query","schemaId":"schema_121","description":"Comma-separated list of TIDE report categories to return in queried order. If omitted or empty, the default TIDE categories will be returned - see example.\n","example":["timeInVeryLowPercent","timeInAnyLowPercent","timeInVeryHighPercent","timeInAnyHighPercent","dropInTimeInTargetPercent","timeCGMUsePercent","meetingTargets"]},{"name":"excludeNoData","in":"query","schemaId":"schema_122","description":"If true, then exclude / omit patients with no data in the TIDE report."}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tide_report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/tide_report","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[{"name":"period","in":"query","required":true,"example":"7d","schemaId":"schema_119"},{"name":"tags","in":"query","required":true,"schemaId":"schema_120","style":"form","explode":false},{"name":"lastDataCutoff","in":"query","required":true,"schemaId":"schema_113"},{"name":"categories","in":"query","example":["timeInVeryLowPercent","timeInAnyLowPercent","timeInVeryHighPercent","timeInAnyHighPercent","dropInTimeInTargetPercent","timeCGMUsePercent","meetingTargets"],"schemaId":"schema_121","style":"form","explode":false},{"name":"excludeNoData","in":"query","schemaId":"schema_122"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/tide_report","href":"clinics/tidereport","openApiOperationId":"TideReport","summary":"View TIDE Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/tideResponse.v1"}},"schemaId":"components/schemas/tideResponse.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tide_report/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tideResponse.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tideResponse.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/tidereport"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/tide_report"},{"label":"List Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listpatients","routeSlug":"/reference/clinic.v1/clinics/listpatients","metadata":{"seo":{"title":"List Patients","description":"Retrieve a list of patients of a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPatients","name":"List Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~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":"Retrieve a list of patients of a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_112","description":"Full text search query"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"sort","in":"query","schemaId":"schema_123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order and attribute (e.g. +name or -name)"},"children":[]}]}]}]},{"name":"sortType","in":"query","schemaId":"schema_124","description":"Summary type to sort by"},{"name":"period","in":"query","schemaId":"schema_119","description":"Time Period to display, filter, and sort"},{"name":"lastReviewed","in":"query","schemaId":"schema_113","description":"Inclusive"},{"name":"cgm.max","in":"query","schemaId":"schema_125","description":"Max glucose value in mmol/L"},{"name":"cgm.min","in":"query","schemaId":"schema_125","description":"Min glucose value in mmol/L"},{"name":"cgm.averageGlucoseMmol","in":"query","schemaId":"schema_125","description":"Average glucose value of records in mmol/L"},{"name":"cgm.glucoseManagementIndicator","in":"query","schemaId":"schema_125","description":"Glucose management Indicator of records"},{"name":"cgm.timeCGMUsePercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  of CGM use"},"children":[]}]}]}]},{"name":"cgm.timeInVeryLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  below 54 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInAnyLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  below 70 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 54-70 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInTargetPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 70-180 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 180-250 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInVeryHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 250 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInExtremeHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 350 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeInAnyHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 180 mg/dL"},"children":[]}]}]}]},{"name":"cgm.timeCGMUseMinutes","in":"query","schemaId":"schema_126","description":"Minutes of CGM use"},{"name":"cgm.timeInVeryLowMinutes","in":"query","schemaId":"schema_126","description":"Minutes below 54 mg/dL"},{"name":"cgm.timeInAnyLowMinutes","in":"query","schemaId":"schema_126","description":"Minutes below 70 mg/dL"},{"name":"cgm.timeInLowMinutes","in":"query","schemaId":"schema_126","description":"Minutes in range 54-70 mg/dL"},{"name":"cgm.timeInTargetMinutes","in":"query","schemaId":"schema_126","description":"Minutes in range 70-180 mg/dL"},{"name":"cgm.timeInHighMinutes","in":"query","schemaId":"schema_126","description":"Minutes in range 180-250 mg/dL"},{"name":"cgm.timeInVeryHighMinutes","in":"query","schemaId":"schema_126","description":"Minutes above 250 mg/dL"},{"name":"cgm.timeInExtremeHighMinutes","in":"query","schemaId":"schema_126","description":"Minutes above 350 mg/dL"},{"name":"cgm.timeInAnyHighMinutes","in":"query","schemaId":"schema_126","description":"Minutes above 180 mg/dL"},{"name":"cgm.timeCGMUseRecords","in":"query","schemaId":"schema_126","description":"Records of CGM use"},{"name":"cgm.timeInVeryLowRecords","in":"query","schemaId":"schema_126","description":"Records below 54 mg/dL"},{"name":"cgm.timeInAnyLowRecords","in":"query","schemaId":"schema_126","description":"Records below 70 mg/dL"},{"name":"cgm.timeInLowRecords","in":"query","schemaId":"schema_126","description":"Records in range 54-70 mg/dL"},{"name":"cgm.timeInTargetRecords","in":"query","schemaId":"schema_126","description":"Records in range 70-180 mg/dL"},{"name":"cgm.timeInHighRecords","in":"query","schemaId":"schema_126","description":"Records in range 180-250 mg/dL"},{"name":"cgm.timeInVeryHighRecords","in":"query","schemaId":"schema_126","description":"Records above 250 mg/dL"},{"name":"cgm.timeInAnyHighRecords","in":"query","schemaId":"schema_126","description":"Records above 180 mg/dL"},{"name":"cgm.averageDailyRecords","in":"query","schemaId":"schema_125","description":"Average records per day"},{"name":"cgm.totalRecords","in":"query","schemaId":"schema_126","description":"Total records in period"},{"name":"cgm.hoursWithData","in":"query","schemaId":"schema_126","description":"Total hours with data in period"},{"name":"cgm.daysWithData","in":"query","schemaId":"schema_126","description":"Total days with data in period"},{"name":"cgm.standardDeviation","in":"query","schemaId":"schema_125","description":"Standard deviation of glucose values in mmol/L"},{"name":"cgm.coefficientOfVariation","in":"query","schemaId":"schema_125","description":"Coefficient Of Variation of glucose values in mmol/L"},{"name":"bgm.max","in":"query","schemaId":"schema_125","description":"Max glucose value in mmol/L"},{"name":"bgm.min","in":"query","schemaId":"schema_125","description":"Min glucose value in mmol/L"},{"name":"bgm.averageGlucoseMmol","in":"query","schemaId":"schema_125","description":"Average glucose value of records in mmol/L"},{"name":"bgm.timeInVeryLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  below 54 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInAnyLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  below 70 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInLowPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 54-70 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInTargetPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 70-180 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  in range 180-250 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInVeryHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 250 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInExtremeHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 350 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInAnyHighPercent","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of time [0.0-1.0]  above 180 mg/dL"},"children":[]}]}]}]},{"name":"bgm.timeInVeryLowRecords","in":"query","schemaId":"schema_126","description":"Records below 54 mg/dL"},{"name":"bgm.timeInAnyLowRecords","in":"query","schemaId":"schema_126","description":"Records below 70 mg/dL"},{"name":"bgm.timeInLowRecords","in":"query","schemaId":"schema_126","description":"Records in range 54-70 mg/dL"},{"name":"bgm.timeInTargetRecords","in":"query","schemaId":"schema_126","description":"Records in range 70-180 mg/dL"},{"name":"bgm.timeInHighRecords","in":"query","schemaId":"schema_126","description":"Records in range 180-250 mg/dL"},{"name":"bgm.timeInVeryHighRecords","in":"query","schemaId":"schema_126","description":"Records above 250 mg/dL"},{"name":"bgm.timeInAnyHighRecords","in":"query","schemaId":"schema_126","description":"Records above 180 mg/dL"},{"name":"bgm.averageDailyRecords","in":"query","schemaId":"schema_125","description":"Average records per day"},{"name":"bgm.totalRecords","in":"query","schemaId":"schema_126","description":"Total records in period"},{"name":"cgm.maxDelta","in":"query","schemaId":"schema_125","description":"Delta of Max glucose value in mmol/L"},{"name":"cgm.minDelta","in":"query","schemaId":"schema_125","description":"Delta of Min glucose value in mmol/L"},{"name":"cgm.averageGlucoseMmolDelta","in":"query","schemaId":"schema_125","description":"Delta of average glucose value in mmol/L"},{"name":"cgm.glucoseManagementIndicatorDelta","in":"query","schemaId":"schema_125","description":"Glucose management Indicator of records"},{"name":"cgm.timeCGMUsePercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time of CGM use"},{"name":"cgm.timeInVeryLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time below 54 mg/dL"},{"name":"cgm.timeInAnyLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time below 70 mg/dL"},{"name":"cgm.timeInLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 54-70 mg/dL"},{"name":"cgm.timeInTargetPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 70-180 mg/dL"},{"name":"cgm.timeInHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 180-250 mg/dL"},{"name":"cgm.timeInVeryHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 250 mg/dL"},{"name":"cgm.timeInExtremeHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 350 mg/dL"},{"name":"cgm.timeInAnyHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 180 mg/dL"},{"name":"cgm.timeCGMUseMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes of CGM use"},{"name":"cgm.timeInVeryLowMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes below 54 mg/dL"},{"name":"cgm.timeInAnyLowMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes below 70 mg/dL"},{"name":"cgm.timeInLowMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes in range 54-70 mg/dL"},{"name":"cgm.timeInTargetMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes in range 70-180 mg/dL"},{"name":"cgm.timeInHighMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes in range 180-250 mg/dL"},{"name":"cgm.timeInVeryHighMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes above 250 mg/dL"},{"name":"cgm.timeInExtremeHighMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes above 350 mg/dL"},{"name":"cgm.timeInAnyHighMinutesDelta","in":"query","schemaId":"schema_126","description":"Delta of minutes above 180 mg/dL"},{"name":"cgm.timeCGMUseRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records count"},{"name":"cgm.timeInVeryLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records below 54 mg/dL"},{"name":"cgm.timeInAnyLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records below 70 mg/dL"},{"name":"cgm.timeInLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 54-70 mg/dL"},{"name":"cgm.timeInTargetRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 70-180 mg/dL"},{"name":"cgm.timeInHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 180-250 mg/dL"},{"name":"cgm.timeInVeryHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records above 250 mg/dL"},{"name":"cgm.timeInAnyHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records above 180 mg/dL"},{"name":"cgm.averageDailyRecordsDelta","in":"query","schemaId":"schema_125","description":"Delta of average records per day"},{"name":"cgm.totalRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of total records"},{"name":"cgm.hoursWithDataDelta","in":"query","schemaId":"schema_126","description":"Delta of total hours with data"},{"name":"cgm.daysWithDataDelta","in":"query","schemaId":"schema_126","description":"Delta of total days with data"},{"name":"cgm.standardDeviationDelta","in":"query","schemaId":"schema_125","description":"Delta of the standard deviation of glucose values in mmol/L"},{"name":"cgm.coefficientOfVariationDelta","in":"query","schemaId":"schema_125","description":"Delta of the coefficient of glucose values in mmol/L"},{"name":"cgm.lastDataFrom","in":"query","schemaId":"schema_113","description":"Inclusive"},{"name":"cgm.lastDataTo","in":"query","schemaId":"schema_113","description":"Exclusive"},{"name":"bgm.maxDelta","in":"query","schemaId":"schema_125","description":"Delta of Max glucose value in mmol/L"},{"name":"bgm.minDelta","in":"query","schemaId":"schema_125","description":"Delta of Min glucose value in mmol/L"},{"name":"bgm.averageGlucoseMmolDelta","in":"query","schemaId":"schema_125","description":"Delta of the average glucose values in mmol/L"},{"name":"bgm.timeInVeryLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time below 54 mg/dL"},{"name":"bgm.timeInAnyLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time below 70 mg/dL"},{"name":"bgm.timeInLowPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 54-70 mg/dL"},{"name":"bgm.timeInTargetPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 70-180 mg/dL"},{"name":"bgm.timeInHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time in range 180-250 mg/dL"},{"name":"bgm.timeInVeryHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 250 mg/dL"},{"name":"bgm.timeInExtremeHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 350 mg/dL"},{"name":"bgm.timeInAnyHighPercentDelta","in":"query","schemaId":"schema_125","description":"Delta of time above 180 mg/dL"},{"name":"bgm.timeInVeryLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records below 54 mg/dL"},{"name":"bgm.timeInAnyLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records below 70 mg/dL"},{"name":"bgm.timeInLowRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 54-70 mg/dL"},{"name":"bgm.timeInTargetRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 70-180 mg/dL"},{"name":"bgm.timeInHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records in range 180-250 mg/dL"},{"name":"bgm.timeInVeryHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records above 250 mg/dL"},{"name":"bgm.timeInAnyHighRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of records above 180 mg/dL"},{"name":"bgm.averageDailyRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of average records per day"},{"name":"bgm.totalRecordsDelta","in":"query","schemaId":"schema_126","description":"Delta of total record count"},{"name":"bgm.lastDataFrom","in":"query","schemaId":"schema_113","description":"Inclusive"},{"name":"bgm.lastDataTo","in":"query","schemaId":"schema_113","description":"Exclusive"},{"name":"tags","in":"query","schemaId":"schema_127","description":"Comma-separated list of patient tag IDs"},{"name":"sites","in":"query","schemaId":"schema_127","description":"Comma-separated list of clinic site IDs"},{"name":"omitNonStandardRanges","in":"query","schemaId":"schema_114","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether patients whose glycemic ranges selection is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the ADA standard ranges (e.g. as used by the TIDE report)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be omitted."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/patients","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_112"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"sort","in":"query","required":false,"schemaId":"schema_123"},{"name":"sortType","in":"query","example":"cgm","schemaId":"schema_124"},{"name":"period","in":"query","example":"7d","schemaId":"schema_119"},{"name":"lastReviewed","in":"query","schemaId":"schema_113"},{"name":"cgm.max","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.min","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.averageGlucoseMmol","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.glucoseManagementIndicator","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeCGMUsePercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInVeryLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInAnyLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInTargetPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInVeryHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInExtremeHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInAnyHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeCGMUseMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryLowMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyLowMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInLowMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInTargetMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInHighMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryHighMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInExtremeHighMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyHighMinutes","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeCGMUseRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInTargetRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.averageDailyRecords","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.totalRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.hoursWithData","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.daysWithData","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.standardDeviation","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.coefficientOfVariation","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.max","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.min","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.averageGlucoseMmol","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInAnyLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInLowPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInTargetPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInExtremeHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInAnyHighPercent","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInAnyLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInLowRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInTargetRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInVeryHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInAnyHighRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.averageDailyRecords","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.totalRecords","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.maxDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.minDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.averageGlucoseMmolDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.glucoseManagementIndicatorDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeCGMUsePercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInVeryLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInAnyLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInTargetPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInVeryHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInExtremeHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeInAnyHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.timeCGMUseMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryLowMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyLowMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInLowMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInTargetMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInHighMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryHighMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInExtremeHighMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyHighMinutesDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeCGMUseRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInTargetRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInVeryHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.timeInAnyHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.averageDailyRecordsDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.totalRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.hoursWithDataDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.daysWithDataDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"cgm.standardDeviationDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.coefficientOfVariationDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"cgm.lastDataFrom","in":"query","schemaId":"schema_113"},{"name":"cgm.lastDataTo","in":"query","schemaId":"schema_113"},{"name":"bgm.maxDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.minDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.averageGlucoseMmolDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInAnyLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInLowPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInTargetPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInExtremeHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInAnyHighPercentDelta","in":"query","example":">=5.5","schemaId":"components/schemas/FloatFilter"},{"name":"bgm.timeInVeryLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInAnyLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInLowRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInTargetRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInVeryHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.timeInAnyHighRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.averageDailyRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.totalRecordsDelta","in":"query","example":">=7","schemaId":"components/schemas/IntFilter"},{"name":"bgm.lastDataFrom","in":"query","schemaId":"schema_113"},{"name":"bgm.lastDataTo","in":"query","schemaId":"schema_113"},{"name":"tags","in":"query","schemaId":"schema_127","style":"form","explode":false},{"name":"sites","in":"query","schemaId":"schema_127","style":"form","explode":false},{"name":"omitNonStandardRanges","in":"query","schemaId":"schema_114"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients","href":"clinics/listpatients","openApiOperationId":"ListPatients","summary":"List Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientsResponse.v1"}},"schemaId":"components/schemas/patientsResponse.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientsResponse.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientsResponse.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients"},{"label":"Create Patient Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatientaccount","routeSlug":"/reference/clinic.v1/clinics/createpatientaccount","metadata":{"seo":{"title":"Create Patient Account","description":"Create a custodial account for a patient"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePatientAccount","name":"Create Patient Account","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Patient Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a custodial account for a patient"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"schemaId":"components/schemas/patient.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients","href":"clinics/createpatientaccount","openApiOperationId":"CreatePatientAccount","summary":"Create Patient Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"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/patient.v1"}},"schemaId":"components/schemas/patient.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patient.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createpatientaccount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients"},{"label":"Create Patient Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatienttag","routeSlug":"/reference/clinic.v1/clinics/createpatienttag","metadata":{"seo":{"title":"Create Patient Tag","description":"Create a new patient tag"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePatientTag","name":"Create Patient Tag","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Patient Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new patient tag"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"schemaId":"components/schemas/patientTag.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patient_tags","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patient_tags","href":"clinics/createpatienttag","openApiOperationId":"CreatePatientTag","summary":"Create Patient Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientTag.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The newly-created patient tag","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"schemaId":"components/schemas/patientTag.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientTag.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createpatienttag"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_tags"},{"label":"Create a Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createsite","routeSlug":"/reference/clinic.v1/clinics/createsite","metadata":{"seo":{"title":"Create a Site","description":"Create a Site"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateSite","name":"Create a Site","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Site"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/siteCreation.v1"}},"schemaId":"components/schemas/siteCreation.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/sites","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/siteCreation.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/sites","href":"clinics/createsite","openApiOperationId":"CreateSite","summary":"Create a Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/siteCreation.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/siteCreation.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The newly-created clinic site","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}},"schemaId":"components/schemas/site.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/site.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createsite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/sites"},{"label":"Update a Site","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatesite","routeSlug":"/reference/clinic.v1/clinics/updatesite","metadata":{"seo":{"title":"Update a Site","description":"Update a Site"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateSite","name":"Update a Site","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Site"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"siteId","in":"path","schemaId":"schema_128","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/site.v1"}},"schemaId":"components/schemas/site.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/sites/{siteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"siteId","in":"path","required":true,"schemaId":"components/schemas/objectId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/site.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/sites/{siteId}","href":"clinics/updatesite","openApiOperationId":"UpdateSite","summary":"Update a Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/site.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/site.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated clinic site","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}},"schemaId":"components/schemas/site.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/site.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatesite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}"},{"label":"Delete a Site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletesite","routeSlug":"/reference/clinic.v1/clinics/deletesite","metadata":{"seo":{"title":"Delete a Site","description":"Delete a Site"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSite","name":"Delete a Site","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Site"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"siteId","in":"path","schemaId":"schema_128","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/sites/{siteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"siteId","in":"path","required":true,"schemaId":"components/schemas/objectId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/sites/{siteId}","href":"clinics/deletesite","openApiOperationId":"DeleteSite","summary":"Delete a Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletesite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}"},{"label":"Merge two sites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/mergesite","routeSlug":"/reference/clinic.v1/clinics/mergesite","metadata":{"seo":{"title":"Merge two sites","description":"Merge a site, identified in the request body, into the site identified in the URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MergeSite","name":"Merge two sites","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge two sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merge a site, identified in the request body, into the site identified in the URL."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"siteId","in":"path","schemaId":"schema_128","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/siteById.v1"}},"schemaId":"components/schemas/siteById.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/sites/{siteId}/merge","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"siteId","in":"path","required":true,"schemaId":"components/schemas/objectId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/siteById.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/sites/{siteId}/merge","href":"clinics/mergesite","openApiOperationId":"MergeSite","summary":"Merge two sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/siteById.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/siteById.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merged clinic site","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}},"schemaId":"components/schemas/site.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1sites~1{siteId}~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/site.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/mergesite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}/merge"},{"label":"Get Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinician","routeSlug":"/reference/clinic.v1/clinics/getclinician","metadata":{"seo":{"title":"Get Clinician","description":"Retrieve a member of clinic given their user id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetClinician","name":"Get Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a member of clinic given their user id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"clinicianId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"clinicianId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","href":"clinics/getclinician","openApiOperationId":"GetClinician","summary":"Get Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Update Clinician","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinician","routeSlug":"/reference/clinic.v1/clinics/updateclinician","metadata":{"seo":{"title":"Update Clinician","description":"Update existing clinician"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateClinician","name":"Update Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update existing clinician"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"clinicianId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"schemaId":"components/schemas/clinician.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"clinicianId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","href":"clinics/updateclinician","openApiOperationId":"UpdateClinician","summary":"Update Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clinician.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updateclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Delete Clinician","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteclinician","routeSlug":"/reference/clinic.v1/clinics/deleteclinician","metadata":{"seo":{"title":"Delete Clinician","description":"Removes a clinician from a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteClinician","name":"Delete Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a clinician from a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"clinicianId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"clinicianId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","href":"clinics/deleteclinician","openApiOperationId":"DeleteClinician","summary":"Delete Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1clinicians~1{clinicianId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deleteclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Get Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatient","routeSlug":"/reference/clinic.v1/clinics/getpatient","metadata":{"seo":{"title":"Get Patient","description":"Retrieve a patient of clinic given their user id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPatient","name":"Get Patient","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a patient of clinic given their user id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/patients/{patientId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}","href":"clinics/getpatient","openApiOperationId":"GetPatient","summary":"Get Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patient.v1"}},"schemaId":"components/schemas/patient.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patient.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getpatient"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Create Patient from Existing User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatientfromuser","routeSlug":"/reference/clinic.v1/clinics/createpatientfromuser","metadata":{"seo":{"title":"Create Patient from Existing User","description":"Internal endpoint for creating a patient from an existing user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePatientFromUser","name":"Create Patient from Existing User","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Patient from Existing User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint for creating a patient from an existing user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPatient.v1"}},"schemaId":"components/schemas/createPatient.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/{patientId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createPatient.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}","href":"clinics/createpatientfromuser","openApiOperationId":"CreatePatientFromUser","summary":"Create Patient from Existing User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/createPatient.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPatient.v1"}},"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/patient.v1"}},"schemaId":"components/schemas/patient.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patient.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/createpatientfromuser"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Update Patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatient","routeSlug":"/reference/clinic.v1/clinics/updatepatient","metadata":{"seo":{"title":"Update Patient","description":"Update existing patient of a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatient","name":"Update Patient","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update existing patient of a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"schemaId":"components/schemas/patient.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/patients/{patientId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}","href":"clinics/updatepatient","openApiOperationId":"UpdatePatient","summary":"Update Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patient.v1"}},"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/patient.v1"}},"schemaId":"components/schemas/patient.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patient.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patient.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatient"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Delete Patient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatient","routeSlug":"/reference/clinic.v1/clinics/deletepatient","metadata":{"seo":{"title":"Delete Patient","description":"Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatient","name":"Delete Patient","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/patients/{patientId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}","href":"clinics/deletepatient","openApiOperationId":"DeletePatient","summary":"Delete Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatient"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Update Patient Tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatienttag","routeSlug":"/reference/clinic.v1/clinics/updatepatienttag","metadata":{"seo":{"title":"Update Patient Tag","description":"Update existing patient tag"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientTag","name":"Update Patient Tag","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update existing patient tag"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"schemaId":"components/schemas/patientTag.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","href":"clinics/updatepatienttag","openApiOperationId":"UpdatePatientTag","summary":"Update Patient Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientTag.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated patient tag","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}},"schemaId":"components/schemas/patientTag.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientTag.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientTag.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatienttag"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}"},{"label":"Delete Patient Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatienttag","routeSlug":"/reference/clinic.v1/clinics/deletepatienttag","metadata":{"seo":{"title":"Delete Patient Tag","description":"Removes a patient tag from a clinic and tagged patients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientTag","name":"Delete Patient Tag","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a patient tag from a clinic and tagged patients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","href":"clinics/deletepatienttag","openApiOperationId":"DeletePatientTag","summary":"Delete Patient Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatienttag"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}"},{"label":"Convert Patient Tag to Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/convertpatienttagtosite","routeSlug":"/reference/clinic.v1/clinics/convertpatienttagtosite","metadata":{"seo":{"title":"Convert Patient Tag to Site","description":"Convert a patient tag to a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConvertPatientTagToSite","name":"Convert Patient Tag to Site","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}~1site/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert Patient Tag to Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Convert a patient tag to a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}~1site/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}/site","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","409"],"pointer":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}/site","href":"clinics/convertpatienttagtosite","openApiOperationId":"ConvertPatientTagToSite","summary":"Convert Patient Tag to Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The newly converted site.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}},"schemaId":"components/schemas/site.v1"},{"code":"409","description":"Cannot convert the tag to a site. This could occur for example when the maximum number of sites has already been reached."}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_tags~1{patientTagId}~1site/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/site.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/site.v1"}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/convertpatienttagtosite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}/site"},{"label":"Invite Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/inviteclinician","routeSlug":"/reference/clinic.v1/clinics/inviteclinician","metadata":{"seo":{"title":"Invite Clinician","description":"Send an invite to clinician's email address to join a clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InviteClinician","name":"Invite Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invite Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send an invite to clinician's email address to join a clinic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"schemaId":"components/schemas/inviteClinician.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/invites/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians","href":"clinics/inviteclinician","openApiOperationId":"InviteClinician","summary":"Invite Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/inviteClinician.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/inviteclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians"},{"label":"Resend Clinician Invite","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/resendinvite","routeSlug":"/reference/clinic.v1/clinics/resendinvite","metadata":{"seo":{"title":"Resend Clinician Invite","description":"Resend invite to the email address of the clinician."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ResendInvite","name":"Resend Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resend invite to the email address of the clinician."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","href":"clinics/resendinvite","openApiOperationId":"ResendInvite","summary":"Resend Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/confirmation.v1"}},"schemaId":"components/schemas/confirmation.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/confirmation.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/confirmation.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/resendinvite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Delete Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteinvite","routeSlug":"/reference/clinic.v1/clinics/deleteinvite","metadata":{"seo":{"title":"Delete Invite","description":"Deletes unaccepted invite"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteInvite","name":"Delete Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes unaccepted invite"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","href":"clinics/deleteinvite","openApiOperationId":"DeleteInvite","summary":"Delete Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deleteinvite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Associate Clinician to User","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/associatecliniciantouser","routeSlug":"/reference/clinic.v1/clinics/associatecliniciantouser","metadata":{"seo":{"title":"Associate Clinician to User","description":"Internal endpoint to associate a clinician to a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AssociateClinicianToUser","name":"Associate Clinician to User","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate Clinician to User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to associate a clinician to a user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/associateClinicianToUser.v1"}},"schemaId":"components/schemas/associateClinicianToUser.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/associateClinicianToUser.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","href":"clinics/associatecliniciantouser","openApiOperationId":"AssociateClinicianToUser","summary":"Associate Clinician to User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/associateClinicianToUser.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/associateClinicianToUser.v1"}},"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/associatecliniciantouser"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Delete Invited Clinician","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteinvitedclinician","routeSlug":"/reference/clinic.v1/clinics/deleteinvitedclinician","metadata":{"seo":{"title":"Delete Invited Clinician","description":"Internal endpoint to delete an invited clinician object"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteInvitedClinician","name":"Delete Invited Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Invited Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to delete an invited clinician object"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","href":"clinics/deleteinvitedclinician","openApiOperationId":"DeleteInvitedClinician","summary":"Delete Invited Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deleteinvitedclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Get Invited Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getinvitedclinician","routeSlug":"/reference/clinic.v1/clinics/getinvitedclinician","metadata":{"seo":{"title":"Get Invited Clinician","description":"Internal endpoint to retrieve invited clinician."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetInvitedClinician","name":"Get Invited Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Invited Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to retrieve invited clinician."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","href":"clinics/getinvitedclinician","openApiOperationId":"GetInvitedClinician","summary":"Get Invited Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}~1clinician/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getinvitedclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Get Patient Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientinvites","routeSlug":"/reference/clinic.v1/clinics/getpatientinvites","metadata":{"seo":{"title":"Get Patient Invites","description":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPatientInvites","name":"Get Patient Invites","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient Invites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/invites/patients","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/patients","href":"clinics/getpatientinvites","openApiOperationId":"GetPatientInvites","summary":"Get Patient Invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getpatientinvites"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/patients"},{"label":"Accept Patient Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/acceptpatientinvitation","routeSlug":"/reference/clinic.v1/clinics/acceptpatientinvitation","metadata":{"seo":{"title":"Accept Patient Invitation","description":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AcceptPatientInvitation","name":"Accept Patient Invitation","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept Patient Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"schemaId":"components/schemas/AcceptPatientInvitation","pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","href":"clinics/acceptpatientinvitation","openApiOperationId":"AcceptPatientInvitation","summary":"Accept Patient Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/AcceptPatientInvitation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/acceptpatientinvitation"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/patients/{inviteId}"},{"label":"Update Patient Reviews","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientreviews","routeSlug":"/reference/clinic.v1/clinics/updatepatientreviews","metadata":{"seo":{"title":"Update Patient Reviews","description":"Update the patient's last reviewed date and clinician ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientReviews","name":"Update Patient Reviews","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient Reviews","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the patient's last reviewed date and clinician ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","href":"clinics/updatepatientreviews","openApiOperationId":"UpdatePatientReviews","summary":"Update Patient Reviews"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientReviews.v1"}},"schemaId":"components/schemas/patientReviews.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientReviews.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientReviews.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatientreviews"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/reviews"},{"label":"Delete Patient Reviews","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientreviews","routeSlug":"/reference/clinic.v1/clinics/deletepatientreviews","metadata":{"seo":{"title":"Delete Patient Reviews","description":"Revert the patient's last reviewed date to the previous set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientReviews","name":"Delete Patient Reviews","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient Reviews","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revert the patient's last reviewed date to the previous set"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","href":"clinics/deletepatientreviews","openApiOperationId":"DeletePatientReviews","summary":"Delete Patient Reviews"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientReviews.v1"}},"schemaId":"components/schemas/patientReviews.v1"},{"code":"404","description":"No review to delete"},{"code":"409","description":"Cannot revert a different clinician's review"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1reviews/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientReviews.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientReviews.v1"}}},{"code":"404"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatientreviews"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/reviews"},{"label":"Update Patient Permissions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientpermissions","routeSlug":"/reference/clinic.v1/clinics/updatepatientpermissions","metadata":{"seo":{"title":"Update Patient Permissions","description":"Update permissions that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientPermissions","name":"Update Patient Permissions","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient Permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update permissions that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic.\n\nOnly patients can change the permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientPermissions.v1"}},"schemaId":"components/schemas/patientPermissions.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/patients/{patientId}/permissions","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientPermissions.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/permissions","href":"clinics/updatepatientpermissions","openApiOperationId":"UpdatePatientPermissions","summary":"Update Patient Permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientPermissions.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientPermissions.v1"}},"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/patientPermissions.v1"}},"schemaId":"components/schemas/patientPermissions.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientPermissions.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientPermissions.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatientpermissions"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/permissions"},{"label":"Delete Patient Permission","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientpermission","routeSlug":"/reference/clinic.v1/clinics/deletepatientpermission","metadata":{"seo":{"title":"Delete Patient Permission","description":"Remove a single permission that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientPermission","name":"Delete Patient Permission","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions~1{permission}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient Permission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a single permission that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic.\n\nOnly patients can change the permissions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true},{"name":"permission","in":"path","schemaId":"schema_130","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions~1{permission}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"},{"name":"permission","in":"path","required":true,"schemaId":"schema_130"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}","href":"clinics/deletepatientpermission","openApiOperationId":"DeletePatientPermission","summary":"Delete Patient Permission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1permissions~1{permission}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatientpermission"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}"},{"label":"List Clinics for Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicsforpatient","routeSlug":"/reference/clinic.v1/clinics/listclinicsforpatient","metadata":{"seo":{"title":"List Clinics for Patient","description":"Get all clinics a user is a patient of"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinicsForPatient","name":"List Clinics for Patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{userId}~1clinics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinics for Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all clinics a user is a patient of"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1patients~1{userId}~1clinics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"pointer":"/paths/~1v1~1patients~1{userId}~1clinics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/patients/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/patients/{userId}/clinics","href":"clinics/listclinicsforpatient","openApiOperationId":"ListClinicsForPatient","summary":"List Clinics for Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientClinicRelationships.v1"}},"schemaId":"components/schemas/patientClinicRelationships.v1"}],"pointer":"/paths/~1v1~1patients~1{userId}~1clinics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientClinicRelationships.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientClinicRelationships.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listclinicsforpatient"}],"panels":[]}]},"httpPath":"/v1/patients/{userId}/clinics"},{"label":"List Clinician Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicianinvites","routeSlug":"/reference/clinic.v1/clinics/listclinicianinvites","metadata":{"seo":{"title":"List Clinician Invites","description":"Retrieve a list of the outstanding invites to join a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinicianInvites","name":"List Clinician Invites","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinician Invites","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 the outstanding invites to join a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinicians/{userId}/invites","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites","href":"clinics/listclinicianinvites","openApiOperationId":"ListClinicianInvites","summary":"List Clinician Invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listclinicianinvites"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites"},{"label":"Dismiss Clinician Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/dismissclinicianinvite","routeSlug":"/reference/clinic.v1/clinics/dismissclinicianinvite","metadata":{"seo":{"title":"Dismiss Clinician Invite","description":"Dismisses an invite sent from a clinic to clinician"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DismissClinicianInvite","name":"Dismiss Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dismiss Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Dismisses an invite sent from a clinic to clinician"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinicians/{userId}/invites/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites/{inviteId}","href":"clinics/dismissclinicianinvite","openApiOperationId":"DismissClinicianInvite","summary":"Dismiss Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/dismissclinicianinvite"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"Accept Clinician Invite","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/acceptclinicianinvite","routeSlug":"/reference/clinic.v1/clinics/acceptclinicianinvite","metadata":{"seo":{"title":"Accept Clinician Invite","description":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AcceptClinicianInvite","name":"Accept Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinicians/{userId}/invites/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites/{inviteId}","href":"clinics/acceptclinicianinvite","openApiOperationId":"AcceptClinicianInvite","summary":"Accept Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/acceptclinicianinvite"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"List Clinics for Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicsforclinician","routeSlug":"/reference/clinic.v1/clinics/listclinicsforclinician","metadata":{"seo":{"title":"List Clinics for Clinician","description":"Returns a list of all clinics a clinician is a member of"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinicsForClinician","name":"List Clinics for Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1clinics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinics for Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all clinics a clinician is a member of"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1clinics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1clinics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinicians/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/clinics","href":"clinics/listclinicsforclinician","openApiOperationId":"ListClinicsForClinician","summary":"List Clinics for Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinicianClinicRelationships.v1"}},"schemaId":"components/schemas/clinicianClinicRelationships.v1"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1clinics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinicianClinicRelationships.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinicianClinicRelationships.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listclinicsforclinician"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/clinics"},{"label":"Migrate Legacy Clinician Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/migratelegacyclinicianpatients","routeSlug":"/reference/clinic.v1/clinics/migratelegacyclinicianpatients","metadata":{"seo":{"title":"Migrate Legacy Clinician Patients","description":"Migrate the patients of a legacy clinic account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MigrateLegacyClinicianPatients","name":"Migrate Legacy Clinician Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate Legacy Clinician Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Migrate the patients of a legacy clinic account. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"schemaId":"components/schemas/migration.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/migrations","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"responseCodes":["202"],"pointer":"/v1/clinics/{clinicId}/migrations","href":"clinics/migratelegacyclinicianpatients","openApiOperationId":"MigrateLegacyClinicianPatients","summary":"Migrate Legacy Clinician Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/migratelegacyclinicianpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Retrieve Migration Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listmigrations","routeSlug":"/reference/clinic.v1/clinics/listmigrations","metadata":{"seo":{"title":"Retrieve Migration Status","description":"ListMigrations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListMigrations","name":"Retrieve Migration Status","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Migration Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"ListMigrations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/migrations","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations","href":"clinics/listmigrations","openApiOperationId":"ListMigrations","summary":"Retrieve Migration Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/migrations.v1"}},"schemaId":"components/schemas/migrations.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migrations.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migrations.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listmigrations"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Enable Clinics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/enablenewclinicexperience","routeSlug":"/reference/clinic.v1/clinics/enablenewclinicexperience","metadata":{"seo":{"title":"Enable Clinics","description":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EnableNewClinicExperience","name":"Enable Clinics","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable Clinics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinicians/{userId}/migrate","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/migrate","href":"clinics/enablenewclinicexperience","openApiOperationId":"EnableNewClinicExperience","summary":"Enable Clinics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinic.v1"}},"schemaId":"components/schemas/clinic.v1"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/enablenewclinicexperience"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/migrate"},{"label":"Trigger initial migration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/triggerinitialmigration","routeSlug":"/reference/clinic.v1/clinics/triggerinitialmigration","metadata":{"seo":{"title":"Trigger initial migration","description":"Trigger the initial migration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TriggerInitialMigration","name":"Trigger initial migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger initial migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger the initial migration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"schemaId":"components/schemas/triggerMigration.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/migrate","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrate","href":"clinics/triggerinitialmigration","openApiOperationId":"TriggerInitialMigration","summary":"Trigger initial migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/triggerMigration.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/triggerinitialmigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrate"},{"label":"Get Migration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getmigration","routeSlug":"/reference/clinic.v1/clinics/getmigration","metadata":{"seo":{"title":"Get Migration","description":"Get a migration by user id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMigration","name":"Get Migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a migration by user id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_132","description":"Clinic ID","required":true},{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/migrations/{userId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/clinicId.v1"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations/{userId}","href":"clinics/getmigration","openApiOperationId":"GetMigration","summary":"Get Migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getmigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Update Migration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemigration","routeSlug":"/reference/clinic.v1/clinics/updatemigration","metadata":{"seo":{"title":"Update Migration","description":"Internal endpoint to update the status of a migration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMigration","name":"Update Migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update the status of a migration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_132","description":"Clinic ID","required":true},{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"schemaId":"components/schemas/migrationUpdate.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clinics/{clinicId}/migrations/{userId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/clinicId.v1"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations/{userId}","href":"clinics/updatemigration","openApiOperationId":"UpdateMigration","summary":"Update Migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/migrationUpdate.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatemigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Remove User from Clinics","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteuserfromclinics","routeSlug":"/reference/clinic.v1/clinics/deleteuserfromclinics","metadata":{"seo":{"title":"Remove User from Clinics","description":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUserFromClinics","name":"Remove User from Clinics","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove User from Clinics","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":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is a patient of a clinic the service will delete the patient-clinic relationship."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is the only admin of a clinic the service will:"},"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":"text","inline":true,"attributes":{"content":"delete the clinician record, leaving the clinic without an admin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete all non-custodial patient relationships of the clinic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep all custodian relationships, allowing users to claim custodial accounts with an email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/users/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/users/{userId}/clinics","href":"clinics/deleteuserfromclinics","openApiOperationId":"DeleteUserFromClinics","summary":"Remove User from Clinics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deleteuserfromclinics"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/clinics"},{"label":"Update User Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinicuserdetails","routeSlug":"/reference/clinic.v1/clinics/updateclinicuserdetails","metadata":{"seo":{"title":"Update User Details","description":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateClinicUserDetails","name":"Update User Details","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"schemaId":"components/schemas/updateUserDetails.v1","pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"responseCodes":["204"],"pointer":"/v1/users/{userId}/clinics","href":"clinics/updateclinicuserdetails","openApiOperationId":"UpdateClinicUserDetails","summary":"Update User Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/updateUserDetails.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"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"}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updateclinicuserdetails"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/clinics"},{"label":"List All Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listallclinicians","routeSlug":"/reference/clinic.v1/clinics/listallclinicians","metadata":{"seo":{"title":"List All Clinicians","description":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAllClinicians","name":"List All Clinicians","isWebhook":false,"pointer":"/paths/~1v1~1clinicians/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Clinicians","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"createdTimeStart","in":"query","schemaId":"schema_113","description":"Return records created after the given date (inclusive)"},{"name":"createdTimeEnd","in":"query","schemaId":"schema_113","description":"Return records created before the given date (exclusive)"}],"pointer":"/paths/~1v1~1clinicians/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"createdTimeStart","in":"query","required":false,"schemaId":"schema_113"},{"name":"createdTimeEnd","in":"query","required":false,"schemaId":"schema_113"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians","href":"clinics/listallclinicians","openApiOperationId":"ListAllClinicians","summary":"List All Clinicians"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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":"schema_133"}},"schemaId":"schema_133"}],"pointer":"/paths/~1v1~1clinicians/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_133","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listallclinicians"}],"panels":[]}]},"httpPath":"/v1/clinicians"},{"label":"UpdatePatientSummary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientsummary","routeSlug":"/reference/clinic.v1/clinics/updatepatientsummary","metadata":{"seo":{"title":"UpdatePatientSummary","description":"Internal endpoint which updates the summary in all patient records which match the user id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientSummary","name":"UpdatePatientSummary","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdatePatientSummary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint which updates the summary in all patient records which match the user id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"schemaId":"components/schemas/patientSummary.v1","pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{patientId}/summary","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"responseCodes":["200","404"],"pointer":"/v1/patients/{patientId}/summary","href":"clinics/updatepatientsummary","openApiOperationId":"UpdatePatientSummary","summary":"UpdatePatientSummary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientSummary.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatientsummary"}],"panels":[]}]},"httpPath":"/v1/patients/{patientId}/summary"},{"label":"DeletePatientSummary","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientsummary","routeSlug":"/reference/clinic.v1/clinics/deletepatientsummary","metadata":{"seo":{"title":"DeletePatientSummary","description":"Internal endpoint which deletes the summary in all patient records which match the summary id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientSummary","name":"DeletePatientSummary","isWebhook":false,"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DeletePatientSummary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint which deletes the summary in all patient records which match the summary id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"summaryId","in":"path","schemaId":"schema_134","required":true}],"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/summaries/{summaryId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"summaryId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/summaryId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/v1/summaries/{summaryId}/clinics","href":"clinics/deletepatientsummary","openApiOperationId":"DeletePatientSummary","summary":"DeletePatientSummary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"204","description":"No Change"}],"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatientsummary"}],"panels":[]}]},"httpPath":"/v1/summaries/{summaryId}/clinics"},{"label":"Create or update a data source for a patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientdatasources","routeSlug":"/reference/clinic.v1/clinics/updatepatientdatasources","metadata":{"seo":{"title":"Create or update a data source for a patient","description":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientDataSources","name":"Create or update a data source for a patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a data source for a patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"schemaId":"components/schemas/dataSources.v1","pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/patients/{userId}/data_sources","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"responseCodes":["200","404"],"pointer":"/v1/patients/{userId}/data_sources","href":"clinics/updatepatientdatasources","openApiOperationId":"UpdatePatientDataSources","summary":"Create or update a data source for a patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/dataSources.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatientdatasources"}],"panels":[]}]},"httpPath":"/v1/patients/{userId}/data_sources"},{"label":"Update Tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatetier","routeSlug":"/reference/clinic.v1/clinics/updatetier","metadata":{"seo":{"title":"Update Tier","description":"Internal endpoint to update clinic service tier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTier","name":"Update Tier","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update clinic service tier"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"schemaId":"components/schemas/UpdateTier","pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/tier","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/tier","href":"clinics/updatetier","openApiOperationId":"UpdateTier","summary":"Update Tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/UpdateTier","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatetier"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/tier"},{"label":"Update Suppressed Notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatesuppressednotifications","routeSlug":"/reference/clinic.v1/clinics/updatesuppressednotifications","metadata":{"seo":{"title":"Update Suppressed Notifications","description":"Endpoint to update clinic suppressed notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateSuppressedNotifications","name":"Update Suppressed Notifications","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1suppressed_notifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Suppressed Notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to update clinic suppressed notifications"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1suppressed_notifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSuppressedNotifications"}},"schemaId":"components/schemas/UpdateSuppressedNotifications","pointer":"/paths/~1v1~1clinics~1{clinicId}~1suppressed_notifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/suppressed_notifications","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSuppressedNotifications"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/suppressed_notifications","href":"clinics/updatesuppressednotifications","openApiOperationId":"UpdateSuppressedNotifications","summary":"Update Suppressed Notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/UpdateSuppressedNotifications","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSuppressedNotifications"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1suppressed_notifications/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatesuppressednotifications"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/suppressed_notifications"},{"label":"Send Upload Reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/senduploadreminder","routeSlug":"/reference/clinic.v1/clinics/senduploadreminder","metadata":{"seo":{"title":"Send Upload Reminder","description":"Sends upload reminder to the patient"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendUploadReminder","name":"Send Upload Reminder","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1upload_reminder/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Upload Reminder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends upload reminder to the patient"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1upload_reminder/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder","href":"clinics/senduploadreminder","openApiOperationId":"SendUploadReminder","summary":"Send Upload Reminder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1upload_reminder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/senduploadreminder"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder"},{"label":"Assign Patient Tag To Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients","routeSlug":"/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients","metadata":{"seo":{"title":"Assign Patient Tag To Clinic Patients","description":"Assign a patient tag to a subset of clinic patients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AssignPatientTagToClinicPatients","name":"Assign Patient Tag To Clinic Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Patient Tag To Clinic Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assign a patient tag to a subset of clinic patients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"schemaId":"components/schemas/tidepoolUserIds.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/requestBody","description":"Array of clinic patient user IDs to target for tag assignment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","href":"clinics/assignpatienttagtoclinicpatients","openApiOperationId":"AssignPatientTagToClinicPatients","summary":"Assign Patient Tag To Clinic Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/tidepoolUserIds.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/assignpatienttagtoclinicpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}"},{"label":"Delete Patient Tag From Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients","routeSlug":"/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients","metadata":{"seo":{"title":"Delete Patient Tag From Clinic Patients","description":"Delete a patient tag from all or a subset of clinic patients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientTagFromClinicPatients","name":"Delete Patient Tag From Clinic Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient Tag From Clinic Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a patient tag from all or a subset of clinic patients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"schemaId":"components/schemas/tidepoolUserIds.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/requestBody","description":"Pass an array of patient IDs to target a subset of the clinic patients. Omit request body to target all clinic patients."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","href":"clinics/deletepatienttagfromclinicpatients","openApiOperationId":"DeletePatientTagFromClinicPatients","summary":"Delete Patient Tag From Clinic Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/tidepoolUserIds.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/deletepatienttagfromclinicpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}"},{"label":"List Membership Restrictions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listmembershiprestrictions","routeSlug":"/reference/clinic.v1/clinics/listmembershiprestrictions","metadata":{"seo":{"title":"List Membership Restrictions","description":"Returns a list of the membership restrictions that will be evaluated when a user joins a clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListMembershipRestrictions","name":"List Membership Restrictions","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Membership Restrictions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of the membership restrictions that will be evaluated when a user joins a clinic.\n\nOnly clinic admins can access this endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/membership_restrictions","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/membership_restrictions","href":"clinics/listmembershiprestrictions","openApiOperationId":"ListMembershipRestrictions","summary":"List Membership Restrictions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/membershipRestrictions.v1"}},"schemaId":"components/schemas/membershipRestrictions.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/membershipRestrictions.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/listmembershiprestrictions"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Update Membership Restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemembershiprestrictions","routeSlug":"/reference/clinic.v1/clinics/updatemembershiprestrictions","metadata":{"seo":{"title":"Update Membership Restrictions","description":"An internal endpoint to update clinic membership restrictions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMembershipRestrictions","name":"Update Membership Restrictions","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Membership Restrictions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint to update clinic membership restrictions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"schemaId":"components/schemas/membershipRestrictions.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/membership_restrictions","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/membership_restrictions","href":"clinics/updatemembershiprestrictions","openApiOperationId":"UpdateMembershipRestrictions","summary":"Update Membership Restrictions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/membershipRestrictions.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"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/membershipRestrictions.v1"}},"schemaId":"components/schemas/membershipRestrictions.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/membershipRestrictions.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatemembershiprestrictions"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/processehrmessage","routeSlug":"/reference/clinic.v1/clinics/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessEHRMessage","name":"Redox EHR Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox EHR Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An endpoint for incoming Redox messages"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1v1~1redox/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115"}},"responseCodes":["200"],"pointer":"/v1/redox","href":"clinics/processehrmessage","openApiOperationId":"ProcessEHRMessage","summary":"Redox EHR Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/processehrmessage"}],"panels":[]}]},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/verifyendpoint","routeSlug":"/reference/clinic.v1/clinics/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerifyEndpoint","name":"Redox Verify Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox Verify Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint for Redox challenge verification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox/verify","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/redox/verify","href":"clinics/verifyendpoint","openApiOperationId":"VerifyEndpoint","summary":"Redox Verify Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox~1verify/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/verifyendpoint"}],"panels":[]}]},"httpPath":"/v1/redox/verify"},{"label":"Get EHR Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getehrsettings","routeSlug":"/reference/clinic.v1/clinics/getehrsettings","metadata":{"seo":{"title":"Get EHR Settings","description":"Returns EHR related settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetEHRSettings","name":"Get EHR Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get EHR Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns EHR related settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/settings/ehr","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/ehr","href":"clinics/getehrsettings","openApiOperationId":"GetEHRSettings","summary":"Get EHR Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/ehrSettings.v1"}},"schemaId":"components/schemas/ehrSettings.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ehrSettings.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getehrsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Update EHR Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateehrsettings","routeSlug":"/reference/clinic.v1/clinics/updateehrsettings","metadata":{"seo":{"title":"Update EHR Settings","description":"Update EHR related settings for a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateEHRSettings","name":"Update EHR Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update EHR Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update EHR related settings for a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"schemaId":"components/schemas/ehrSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/ehr","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/ehr","href":"clinics/updateehrsettings","openApiOperationId":"UpdateEHRSettings","summary":"Update EHR Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/ehrSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updateehrsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Match Clinic and Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/matchclinicandpatient","routeSlug":"/reference/clinic.v1/clinics/matchclinicandpatient","metadata":{"seo":{"title":"Match Clinic and Patient","description":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MatchClinicAndPatient","name":"Match Clinic and Patient","isWebhook":false,"pointer":"/paths/~1v1~1redox~1match/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Match Clinic and 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":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a clinic with the provided details cannot be found, the service will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will not attempt to match patients to the provided details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"schemaId":"components/schemas/ehrMatchRequest.v1","pointer":"/paths/~1v1~1redox~1match/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox/match","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"responseCodes":["200","404"],"pointer":"/v1/redox/match","href":"clinics/matchclinicandpatient","openApiOperationId":"MatchClinicAndPatient","summary":"Match Clinic and Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/ehrMatchRequest.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"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/ehrMatchResponse.v1"}},"schemaId":"components/schemas/ehrMatchResponse.v1"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1redox~1match/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ehrMatchResponse.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ehrMatchResponse.v1"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/matchclinicandpatient"}],"panels":[]}]},"httpPath":"/v1/redox/match"},{"label":"Get MRN Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getmrnsettings","routeSlug":"/reference/clinic.v1/clinics/getmrnsettings","metadata":{"seo":{"title":"Get MRN Settings","description":"Retrieve MRN settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMRNSettings","name":"Get MRN Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get MRN Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve MRN settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/settings/mrn","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/mrn","href":"clinics/getmrnsettings","openApiOperationId":"GetMRNSettings","summary":"Get MRN Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/mrnSettings.v1"}},"schemaId":"components/schemas/mrnSettings.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mrnSettings.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getmrnsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update MRN Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemrnsettings","routeSlug":"/reference/clinic.v1/clinics/updatemrnsettings","metadata":{"seo":{"title":"Update MRN Settings","description":"Update MRN Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMRNSettings","name":"Update MRN Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update MRN Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update MRN Settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"schemaId":"components/schemas/mrnSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/mrn","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/mrn","href":"clinics/updatemrnsettings","openApiOperationId":"UpdateMRNSettings","summary":"Update MRN Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/mrnSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatemrnsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Get Patient Count Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientcountsettings","routeSlug":"/reference/clinic.v1/clinics/getpatientcountsettings","metadata":{"seo":{"title":"Get Patient Count Settings","description":"Get Patient Count settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPatientCountSettings","name":"Get Patient Count Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient Count Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Patient Count settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/settings/patient_count","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/patient_count","href":"clinics/getpatientcountsettings","openApiOperationId":"GetPatientCountSettings","summary":"Get Patient Count Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientCountSettings.v1"}},"schemaId":"components/schemas/patientCountSettings.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientCountSettings.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getpatientcountsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Update Patient Count Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientcountsettings","routeSlug":"/reference/clinic.v1/clinics/updatepatientcountsettings","metadata":{"seo":{"title":"Update Patient Count Settings","description":"Update Patient Count Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientCountSettings","name":"Update Patient Count Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient Count Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Patient Count Settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"schemaId":"components/schemas/patientCountSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/patient_count","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/patient_count","href":"clinics/updatepatientcountsettings","openApiOperationId":"UpdatePatientCountSettings","summary":"Update Patient Count Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientCountSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/updatepatientcountsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Get Patient Count","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientcount","routeSlug":"/reference/clinic.v1/clinics/getpatientcount","metadata":{"seo":{"title":"Get Patient Count","description":"Get Patient Count"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPatientCount","name":"Get Patient Count","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient Count","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Patient Count"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/patient_count","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patient_count","href":"clinics/getpatientcount","openApiOperationId":"GetPatientCount","summary":"Get Patient Count"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientCount.v1"}},"schemaId":"components/schemas/patientCount.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientCount.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientCount.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/getpatientcount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_count"},{"label":"Refresh Patient Count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/refreshpatientcount","routeSlug":"/reference/clinic.v1/clinics/refreshpatientcount","metadata":{"seo":{"title":"Refresh Patient Count","description":"An internal endpoint to refresh the patient count for the specified clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RefreshPatientCount","name":"Refresh Patient Count","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh Patient Count","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint to refresh the patient count for the specified clinic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patient_count/refresh","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patient_count/refresh","href":"clinics/refreshpatientcount","openApiOperationId":"RefreshPatientCount","summary":"Refresh Patient Count"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/refreshpatientcount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_count/refresh"},{"label":"Sync EHR Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/syncehrdata","routeSlug":"/reference/clinic.v1/clinics/syncehrdata","metadata":{"seo":{"title":"Sync EHR Data","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SyncEHRData","name":"Sync EHR Data","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync EHR Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription.\n\nWill return 404 Not Found if the clinic does not have an active EHR connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/ehr/sync","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/v1/clinics/{clinicId}/ehr/sync","href":"clinics/syncehrdata","openApiOperationId":"SyncEHRData","summary":"Sync EHR Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/syncehrdata"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/ehr/sync"},{"label":"Find Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/findpatients","routeSlug":"/reference/clinic.v1/clinics/findpatients","metadata":{"seo":{"title":"Find Patients","description":"Returns all patients to which the clinician has access to"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FindPatients","name":"Find Patients","isWebhook":false,"pointer":"/paths/~1v1~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all patients to which the clinician has access to"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"mrn","in":"query","schemaId":"schema_112"},{"name":"birthDate","in":"query","schemaId":"schema_112"},{"name":"workspaceId","in":"query","schemaId":"schema_112","description":"The identifier of the workspace"},{"name":"workspaceIdType","in":"query","schemaId":"schema_135","description":"The type of the workspace identifier"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"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/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"mrn","in":"query","schemaId":"schema_112"},{"name":"birthDate","in":"query","schemaId":"schema_112"},{"name":"workspaceId","in":"query","schemaId":"schema_112"},{"name":"workspaceIdType","in":"query","schemaId":"schema_135"},{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/patients","href":"clinics/findpatients","openApiOperationId":"FindPatients","summary":"Find Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/patientClinicRelationships.v1"}},"schemaId":"components/schemas/patientClinicRelationships.v1"}],"pointer":"/paths/~1v1~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/patientClinicRelationships.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/patientClinicRelationships.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/findpatients"}],"panels":[]}]},"httpPath":"/v1/patients"},{"label":"Preorder Form Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthpreorder","routeSlug":"/reference/clinic.v1/clinics/xealthpreorder","metadata":{"seo":{"title":"Preorder Form Webhook","description":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthPreorder","name":"Preorder Form Webhook","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1preorder/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preorder Form 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":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/xealth/preorder","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/preorder","href":"clinics/xealthpreorder","openApiOperationId":"XealthPreorder","summary":"Preorder Form Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1preorder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/xealthpreorder"}],"panels":[]}]},"httpPath":"/v1/xealth/preorder"},{"label":"Get Programs","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthgetprograms","routeSlug":"/reference/clinic.v1/clinics/xealthgetprograms","metadata":{"seo":{"title":"Get Programs","description":"Get programs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthGetPrograms","name":"Get Programs","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1programs/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get programs"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/xealth/programs","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/programs","href":"clinics/xealthgetprograms","openApiOperationId":"XealthGetPrograms","summary":"Get Programs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1programs/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/xealthgetprograms"}],"panels":[]}]},"httpPath":"/v1/xealth/programs"},{"label":"Get Program Url","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthgetprogramurl","routeSlug":"/reference/clinic.v1/clinics/xealthgetprogramurl","metadata":{"seo":{"title":"Get Program Url","description":"Get program URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthGetProgramUrl","name":"Get Program Url","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1program/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Program Url","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get program URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/xealth/program","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/program","href":"clinics/xealthgetprogramurl","openApiOperationId":"XealthGetProgramUrl","summary":"Get Program Url"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1program/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/xealthgetprogramurl"}],"panels":[]}]},"httpPath":"/v1/xealth/program"},{"label":"Notification Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthnotification","routeSlug":"/reference/clinic.v1/clinics/xealthnotification","metadata":{"seo":{"title":"Notification Webhook","description":"Notification webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthNotification","name":"Notification Webhook","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1notification/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification webhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/xealth/notification","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/notification","href":"clinics/xealthnotification","openApiOperationId":"XealthNotification","summary":"Notification Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1notification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/xealthnotification"}],"panels":[]}]},"httpPath":"/v1/xealth/notification"},{"label":"View PDF Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/viewpdfreport","routeSlug":"/reference/clinic.v1/clinics/viewpdfreport","metadata":{"seo":{"title":"View PDF Report","description":"View PDF report for a given patient of a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ViewPDFReport","name":"View PDF Report","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View PDF Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"View PDF report for a given patient of a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clinicId","in":"query","schemaId":"schema_112","required":true},{"name":"patientId","in":"query","schemaId":"schema_112","required":true},{"name":"restricted_token","in":"query","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/xealth/report/web/viewer.html","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"clinicId","in":"query","required":true,"schemaId":"schema_112"},{"name":"patientId","in":"query","required":true,"schemaId":"schema_112"},{"name":"restricted_token","in":"query","required":true,"schemaId":"schema_112"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/report/web/viewer.html","href":"clinics/viewpdfreport","openApiOperationId":"ViewPDFReport","summary":"View PDF Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/viewpdfreport"}],"panels":[]}]},"httpPath":"/v1/xealth/report/web/viewer.html"},{"label":"Add Service Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/addserviceaccount","routeSlug":"/reference/clinic.v1/clinics/addserviceaccount","metadata":{"seo":{"title":"Add Service Account","description":"Adds authentication client's service account as a new clinician member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddServiceAccount","name":"Add Service Account","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Service Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds authentication client's service account as a new clinician member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"schemaId":"components/schemas/addServiceAccount.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/service_accounts","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/service_accounts","href":"clinics/addserviceaccount","openApiOperationId":"AddServiceAccount","summary":"Add Service Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/addServiceAccount.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/addserviceaccount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/service_accounts"},{"label":"Sync EHR Data for Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/syncehrdataforpatient","routeSlug":"/reference/clinic.v1/clinics/syncehrdataforpatient","metadata":{"seo":{"title":"Sync EHR Data for Patient","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SyncEHRDataForPatient","name":"Sync EHR Data for Patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync EHR Data for Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled.\n\nA 404 response will be returned if no active subscriptions can be found for given patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{patientId}/ehr/sync","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/v1/patients/{patientId}/ehr/sync","href":"clinics/syncehrdataforpatient","openApiOperationId":"SyncEHRDataForPatient","summary":"Sync EHR Data for Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"}],"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/syncehrdataforpatient"}],"panels":[]}]},"httpPath":"/v1/patients/{patientId}/ehr/sync"},{"label":"Generate Clinic Merge Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/generatemergereport","routeSlug":"/reference/clinic.v1/clinics/generatemergereport","metadata":{"seo":{"title":"Generate Clinic Merge Report","description":"Generates a spreadsheet report for merging two clinics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GenerateMergeReport","name":"Generate Clinic Merge Report","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1reports~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Clinic Merge Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a spreadsheet report for merging two clinics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1reports~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/generateMergeReport.v1"}},"schemaId":"components/schemas/generateMergeReport.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1reports~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/reports/merge","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/generateMergeReport.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/reports/merge","href":"clinics/generatemergereport","openApiOperationId":"GenerateMergeReport","summary":"Generate Clinic Merge Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/generateMergeReport.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/generateMergeReport.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1reports~1merge/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/generatemergereport"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/reports/merge"},{"label":"Merge Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/mergeclinic","routeSlug":"/reference/clinic.v1/clinics/mergeclinic","metadata":{"seo":{"title":"Merge Clinic","description":"Merges tags, patients, clinicians, invites and share codes of the source clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MergeClinic","name":"Merge Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merges tags, patients, clinicians, invites and share codes of the source clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"schemaId":"components/schemas/mergeClinic.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/merge","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/merge","href":"clinics/mergeclinic","openApiOperationId":"MergeClinic","summary":"Merge Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/mergeClinic.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/mergeclinic"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/merge"},{"label":"Connect Provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/connectprovider","routeSlug":"/reference/clinic.v1/clinics/connectprovider","metadata":{"seo":{"title":"Connect Provider","description":"Send a new request to the patient to connect a data provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConnectProvider","name":"Connect Provider","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connect Provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a new request to the patient to connect a data provider"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true},{"name":"providerId","in":"path","schemaId":"schema_136","description":"Provider ID","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"},{"name":"providerId","in":"path","required":true,"schemaId":"components/schemas/providerId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","href":"clinics/connectprovider","openApiOperationId":"ConnectProvider","summary":"Connect Provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clinics/connectprovider"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}"}],"content":{"contentType":"group","meta":{"name":"Clinics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clinics","showPageActions":true},{"nodeType":"markdoc","content":"Manage clinics, clinians and patients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/clinics","summary":"List Clinics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listclinics","deprecated":false},{"title":"/v1/clinics","summary":"Create Clinic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createclinic","deprecated":false},{"title":"/v1/clinics/share_code/{shareCode}","summary":"Get Clinic by Share Code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getclinicbysharecode","deprecated":false},{"title":"/v1/clinics/{clinicId}","summary":"Get Clinic","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getclinic","deprecated":false},{"title":"/v1/clinics/{clinicId}","summary":"Update Clinic","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updateclinic","deprecated":false},{"title":"/v1/clinics/{clinicId}","summary":"Delete Clinic","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deleteclinic","deprecated":false},{"title":"/v1/clinics/{clinicId}/clinicians","summary":"List Clinicians","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listclinicians","deprecated":false},{"title":"/v1/clinics/{clinicId}/clinicians","summary":"Create Clinician","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/tide_report","summary":"View TIDE Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/tidereport","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients","summary":"List Patients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients","summary":"Create Patient Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createpatientaccount","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_tags","summary":"Create Patient Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createpatienttag","deprecated":false},{"title":"/v1/clinics/{clinicId}/sites","summary":"Create a Site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createsite","deprecated":false},{"title":"/v1/clinics/{clinicId}/sites/{siteId}","summary":"Update a Site","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatesite","deprecated":false},{"title":"/v1/clinics/{clinicId}/sites/{siteId}","summary":"Delete a Site","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletesite","deprecated":false},{"title":"/v1/clinics/{clinicId}/sites/{siteId}/merge","summary":"Merge two sites","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/mergesite","deprecated":false},{"title":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","summary":"Get Clinician","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","summary":"Update Clinician","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updateclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/clinicians/{clinicianId}","summary":"Delete Clinician","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deleteclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}","summary":"Get Patient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getpatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}","summary":"Create Patient from Existing User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/createpatientfromuser","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}","summary":"Update Patient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}","summary":"Delete Patient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletepatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","summary":"Update Patient Tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatienttag","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}","summary":"Delete Patient Tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletepatienttag","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}/site","summary":"Convert Patient Tag to Site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/convertpatienttagtosite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians","summary":"Invite Clinician","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/inviteclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","summary":"Resend Clinician Invite","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/clinics/resendinvite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","summary":"Delete Invite","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deleteinvite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","summary":"Associate Clinician to User","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/clinics/associatecliniciantouser","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","summary":"Delete Invited Clinician","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deleteinvitedclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician","summary":"Get Invited Clinician","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getinvitedclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/patients","summary":"Get Patient Invites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getpatientinvites","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","summary":"Accept Patient Invitation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/acceptpatientinvitation","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","summary":"Update Patient Reviews","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatientreviews","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/reviews","summary":"Delete Patient Reviews","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletepatientreviews","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/permissions","summary":"Update Patient Permissions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatientpermissions","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}","summary":"Delete Patient Permission","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletepatientpermission","deprecated":false},{"title":"/v1/patients/{userId}/clinics","summary":"List Clinics for Patient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listclinicsforpatient","deprecated":false},{"title":"/v1/clinicians/{userId}/invites","summary":"List Clinician Invites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listclinicianinvites","deprecated":false},{"title":"/v1/clinicians/{userId}/invites/{inviteId}","summary":"Dismiss Clinician Invite","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/dismissclinicianinvite","deprecated":false},{"title":"/v1/clinicians/{userId}/invites/{inviteId}","summary":"Accept Clinician Invite","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/acceptclinicianinvite","deprecated":false},{"title":"/v1/clinicians/{userId}/clinics","summary":"List Clinics for Clinician","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listclinicsforclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations","summary":"Migrate Legacy Clinician Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/migratelegacyclinicianpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations","summary":"Retrieve Migration Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listmigrations","deprecated":false},{"title":"/v1/clinicians/{userId}/migrate","summary":"Enable Clinics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/enablenewclinicexperience","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrate","summary":"Trigger initial migration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/triggerinitialmigration","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations/{userId}","summary":"Get Migration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getmigration","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations/{userId}","summary":"Update Migration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/clinics/updatemigration","deprecated":false},{"title":"/v1/users/{userId}/clinics","summary":"Remove User from Clinics","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deleteuserfromclinics","deprecated":false},{"title":"/v1/users/{userId}/clinics","summary":"Update User Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/updateclinicuserdetails","deprecated":false},{"title":"/v1/clinicians","summary":"List All Clinicians","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listallclinicians","deprecated":false},{"title":"/v1/patients/{patientId}/summary","summary":"UpdatePatientSummary","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/updatepatientsummary","deprecated":false},{"title":"/v1/summaries/{summaryId}/clinics","summary":"DeletePatientSummary","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clinics/deletepatientsummary","deprecated":false},{"title":"/v1/patients/{userId}/data_sources","summary":"Create or update a data source for a patient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatientdatasources","deprecated":false},{"title":"/v1/clinics/{clinicId}/tier","summary":"Update Tier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/updatetier","deprecated":false},{"title":"/v1/clinics/{clinicId}/suppressed_notifications","summary":"Update Suppressed Notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/updatesuppressednotifications","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder","summary":"Send Upload Reminder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/senduploadreminder","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","summary":"Assign Patient Tag To Clinic Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/assignpatienttagtoclinicpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","summary":"Delete Patient Tag From Clinic Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/deletepatienttagfromclinicpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/membership_restrictions","summary":"List Membership Restrictions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/listmembershiprestrictions","deprecated":false},{"title":"/v1/clinics/{clinicId}/membership_restrictions","summary":"Update Membership Restrictions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatemembershiprestrictions","deprecated":false},{"title":"/v1/redox","summary":"Redox EHR Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/processehrmessage","deprecated":false},{"title":"/v1/redox/verify","summary":"Redox Verify Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/verifyendpoint","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/ehr","summary":"Get EHR Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getehrsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/ehr","summary":"Update EHR Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updateehrsettings","deprecated":false},{"title":"/v1/redox/match","summary":"Match Clinic and Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/matchclinicandpatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/mrn","summary":"Get MRN Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getmrnsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/mrn","summary":"Update MRN Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatemrnsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/patient_count","summary":"Get Patient Count Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getpatientcountsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/patient_count","summary":"Update Patient Count Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/updatepatientcountsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_count","summary":"Get Patient Count","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/getpatientcount","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_count/refresh","summary":"Refresh Patient Count","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/refreshpatientcount","deprecated":false},{"title":"/v1/clinics/{clinicId}/ehr/sync","summary":"Sync EHR Data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/syncehrdata","deprecated":false},{"title":"/v1/patients","summary":"Find Patients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/findpatients","deprecated":false},{"title":"/v1/xealth/preorder","summary":"Preorder Form Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/xealthpreorder","deprecated":false},{"title":"/v1/xealth/programs","summary":"Get Programs","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/xealthgetprograms","deprecated":false},{"title":"/v1/xealth/program","summary":"Get Program Url","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clinics/xealthgetprogramurl","deprecated":false},{"title":"/v1/xealth/notification","summary":"Notification Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/xealthnotification","deprecated":false},{"title":"/v1/xealth/report/web/viewer.html","summary":"View PDF Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clinics/viewpdfreport","deprecated":false},{"title":"/v1/clinics/{clinicId}/service_accounts","summary":"Add Service Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/addserviceaccount","deprecated":false},{"title":"/v1/patients/{patientId}/ehr/sync","summary":"Sync EHR Data for Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/syncehrdataforpatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/reports/merge","summary":"Generate Clinic Merge Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/generatemergereport","deprecated":false},{"title":"/v1/clinics/{clinicId}/merge","summary":"Merge Clinic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/mergeclinic","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","summary":"Connect Provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clinics/connectprovider","deprecated":false}]}]}]}]}},{"type":"group","label":"Confirmations","link":"/reference/clinic.v1/confirmations","routeSlug":"/reference/clinic.v1/confirmations","items":[{"label":"Invite Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/inviteclinician","routeSlug":"/reference/clinic.v1/confirmations/inviteclinician","metadata":{"seo":{"title":"Invite Clinician","description":"Send an invite to clinician's email address to join a clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InviteClinician","name":"Invite Clinician","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invite Clinician","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send an invite to clinician's email address to join a clinic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"schemaId":"components/schemas/inviteClinician.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/invites/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians","href":"confirmations/inviteclinician","openApiOperationId":"InviteClinician","summary":"Invite Clinician"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/inviteClinician.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/inviteClinician.v1"}},"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/inviteclinician"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians"},{"label":"Resend Clinician Invite","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/resendinvite","routeSlug":"/reference/clinic.v1/confirmations/resendinvite","metadata":{"seo":{"title":"Resend Clinician Invite","description":"Resend invite to the email address of the clinician."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ResendInvite","name":"Resend Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resend invite to the email address of the clinician."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","href":"confirmations/resendinvite","openApiOperationId":"ResendInvite","summary":"Resend Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/confirmation.v1"}},"schemaId":"components/schemas/confirmation.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/confirmation.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/confirmation.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/resendinvite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Delete Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/deleteinvite","routeSlug":"/reference/clinic.v1/confirmations/deleteinvite","metadata":{"seo":{"title":"Delete Invite","description":"Deletes unaccepted invite"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteInvite","name":"Delete Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes unaccepted invite"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","href":"confirmations/deleteinvite","openApiOperationId":"DeleteInvite","summary":"Delete Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/deleteinvite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Get Clinician Invite","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/getclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/getclinicianinvite","metadata":{"seo":{"title":"Get Clinician Invite","description":"Retrieve an invitation sent to clinician to join the clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetClinicianInvite","name":"Get Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an invitation sent to clinician to join the clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","href":"confirmations/getclinicianinvite","openApiOperationId":"GetClinicianInvite","summary":"Get Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/confirmation.v1"}},"schemaId":"components/schemas/confirmation.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1clinicians~1{inviteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/confirmation.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/confirmation.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/getclinicianinvite"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Get Patient Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/getpatientinvites","routeSlug":"/reference/clinic.v1/confirmations/getpatientinvites","metadata":{"seo":{"title":"Get Patient Invites","description":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPatientInvites","name":"Get Patient Invites","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Patient Invites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/invites/patients","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/patients","href":"confirmations/getpatientinvites","openApiOperationId":"GetPatientInvites","summary":"Get Patient Invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/getpatientinvites"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/patients"},{"label":"Accept Patient Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/acceptpatientinvitation","routeSlug":"/reference/clinic.v1/confirmations/acceptpatientinvitation","metadata":{"seo":{"title":"Accept Patient Invitation","description":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AcceptPatientInvitation","name":"Accept Patient Invitation","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept Patient Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"schemaId":"components/schemas/AcceptPatientInvitation","pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","href":"confirmations/acceptpatientinvitation","openApiOperationId":"AcceptPatientInvitation","summary":"Accept Patient Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/AcceptPatientInvitation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptPatientInvitation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1invites~1patients~1{inviteId}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/acceptpatientinvitation"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/invites/patients/{inviteId}"},{"label":"List Clinician Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/listclinicianinvites","routeSlug":"/reference/clinic.v1/confirmations/listclinicianinvites","metadata":{"seo":{"title":"List Clinician Invites","description":"Retrieve a list of the outstanding invites to join a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClinicianInvites","name":"List Clinician Invites","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clinician Invites","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 the outstanding invites to join a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinicians/{userId}/invites","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites","href":"confirmations/listclinicianinvites","openApiOperationId":"ListClinicianInvites","summary":"List Clinician Invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/listclinicianinvites"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites"},{"label":"Dismiss Clinician Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/dismissclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/dismissclinicianinvite","metadata":{"seo":{"title":"Dismiss Clinician Invite","description":"Dismisses an invite sent from a clinic to clinician"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DismissClinicianInvite","name":"Dismiss Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dismiss Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Dismisses an invite sent from a clinic to clinician"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/clinicians/{userId}/invites/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites/{inviteId}","href":"confirmations/dismissclinicianinvite","openApiOperationId":"DismissClinicianInvite","summary":"Dismiss Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/dismissclinicianinvite"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"Accept Clinician Invite","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/acceptclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/acceptclinicianinvite","metadata":{"seo":{"title":"Accept Clinician Invite","description":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AcceptClinicianInvite","name":"Accept Clinician Invite","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept Clinician Invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true},{"name":"inviteId","in":"path","schemaId":"schema_116","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinicians/{userId}/invites/{inviteId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"inviteId","in":"path","required":true,"schemaId":"schema_116"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/invites/{inviteId}","href":"confirmations/acceptclinicianinvite","openApiOperationId":"AcceptClinicianInvite","summary":"Accept Clinician Invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinician.v1"}},"schemaId":"components/schemas/clinician.v1"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1invites~1{inviteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinician.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinician.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmations/acceptclinicianinvite"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"}],"content":{"contentType":"group","meta":{"name":"Confirmations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirmations","showPageActions":true},{"nodeType":"markdoc","content":"Manage confirmations for account creation, sharing invites, etc."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/clinics/{clinicId}/invites/clinicians","summary":"Invite Clinician","prefix":{"name":"post","color":"post"},"badges":[],"link":"/confirmations/inviteclinician","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","summary":"Resend Clinician Invite","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/confirmations/resendinvite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","summary":"Delete Invite","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/confirmations/deleteinvite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}","summary":"Get Clinician Invite","prefix":{"name":"get","color":"get"},"badges":[],"link":"/confirmations/getclinicianinvite","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/patients","summary":"Get Patient Invites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/confirmations/getpatientinvites","deprecated":false},{"title":"/v1/clinics/{clinicId}/invites/patients/{inviteId}","summary":"Accept Patient Invitation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirmations/acceptpatientinvitation","deprecated":false},{"title":"/v1/clinicians/{userId}/invites","summary":"List Clinician Invites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/confirmations/listclinicianinvites","deprecated":false},{"title":"/v1/clinicians/{userId}/invites/{inviteId}","summary":"Dismiss Clinician Invite","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/confirmations/dismissclinicianinvite","deprecated":false},{"title":"/v1/clinicians/{userId}/invites/{inviteId}","summary":"Accept Clinician Invite","prefix":{"name":"put","color":"put"},"badges":[],"link":"/confirmations/acceptclinicianinvite","deprecated":false}]}]}]}]}},{"type":"group","label":"Internal","link":"/reference/clinic.v1/internal","routeSlug":"/reference/clinic.v1/internal","items":[{"label":"Migrate Legacy Clinician Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/migratelegacyclinicianpatients","routeSlug":"/reference/clinic.v1/internal/migratelegacyclinicianpatients","metadata":{"seo":{"title":"Migrate Legacy Clinician Patients","description":"Migrate the patients of a legacy clinic account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MigrateLegacyClinicianPatients","name":"Migrate Legacy Clinician Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate Legacy Clinician Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Migrate the patients of a legacy clinic account. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"schemaId":"components/schemas/migration.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/migrations","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"responseCodes":["202"],"pointer":"/v1/clinics/{clinicId}/migrations","href":"internal/migratelegacyclinicianpatients","openApiOperationId":"MigrateLegacyClinicianPatients","summary":"Migrate Legacy Clinician Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/migratelegacyclinicianpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Retrieve Migration Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/listmigrations","routeSlug":"/reference/clinic.v1/internal/listmigrations","metadata":{"seo":{"title":"Retrieve Migration Status","description":"ListMigrations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListMigrations","name":"Retrieve Migration Status","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Migration Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"ListMigrations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/migrations","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations","href":"internal/listmigrations","openApiOperationId":"ListMigrations","summary":"Retrieve Migration Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/migrations.v1"}},"schemaId":"components/schemas/migrations.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migrations.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migrations.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/listmigrations"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Enable Clinics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/enablenewclinicexperience","routeSlug":"/reference/clinic.v1/internal/enablenewclinicexperience","metadata":{"seo":{"title":"Enable Clinics","description":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EnableNewClinicExperience","name":"Enable Clinics","isWebhook":false,"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable Clinics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinicians/{userId}/migrate","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians/{userId}/migrate","href":"internal/enablenewclinicexperience","openApiOperationId":"EnableNewClinicExperience","summary":"Enable Clinics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/clinic.v1"}},"schemaId":"components/schemas/clinic.v1"}],"pointer":"/paths/~1v1~1clinicians~1{userId}~1migrate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clinic.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clinic.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/enablenewclinicexperience"}],"panels":[]}]},"httpPath":"/v1/clinicians/{userId}/migrate"},{"label":"Trigger initial migration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/triggerinitialmigration","routeSlug":"/reference/clinic.v1/internal/triggerinitialmigration","metadata":{"seo":{"title":"Trigger initial migration","description":"Trigger the initial migration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TriggerInitialMigration","name":"Trigger initial migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger initial migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger the initial migration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"schemaId":"components/schemas/triggerMigration.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/migrate","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_112"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrate","href":"internal/triggerinitialmigration","openApiOperationId":"TriggerInitialMigration","summary":"Trigger initial migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/triggerMigration.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggerMigration.v1"}},"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/triggerinitialmigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrate"},{"label":"Get Migration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getmigration","routeSlug":"/reference/clinic.v1/internal/getmigration","metadata":{"seo":{"title":"Get Migration","description":"Get a migration by user id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMigration","name":"Get Migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a migration by user id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_132","description":"Clinic ID","required":true},{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/migrations/{userId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/clinicId.v1"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations/{userId}","href":"internal/getmigration","openApiOperationId":"GetMigration","summary":"Get Migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/getmigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Update Migration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemigration","routeSlug":"/reference/clinic.v1/internal/updatemigration","metadata":{"seo":{"title":"Update Migration","description":"Internal endpoint to update the status of a migration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMigration","name":"Update Migration","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Migration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update the status of a migration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_132","description":"Clinic ID","required":true},{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"schemaId":"components/schemas/migrationUpdate.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clinics/{clinicId}/migrations/{userId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/clinicId.v1"},{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/migrations/{userId}","href":"internal/updatemigration","openApiOperationId":"UpdateMigration","summary":"Update Migration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/migrationUpdate.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/migrationUpdate.v1"}},"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/migration.v1"}},"schemaId":"components/schemas/migration.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1migrations~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/migration.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/migration.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatemigration"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Remove User from Clinics","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deleteuserfromclinics","routeSlug":"/reference/clinic.v1/internal/deleteuserfromclinics","metadata":{"seo":{"title":"Remove User from Clinics","description":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUserFromClinics","name":"Remove User from Clinics","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove User from Clinics","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":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is a patient of a clinic the service will delete the patient-clinic relationship."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is the only admin of a clinic the service will:"},"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":"text","inline":true,"attributes":{"content":"delete the clinician record, leaving the clinic without an admin"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete all non-custodial patient relationships of the clinic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep all custodian relationships, allowing users to claim custodial accounts with an email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/users/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/users/{userId}/clinics","href":"internal/deleteuserfromclinics","openApiOperationId":"DeleteUserFromClinics","summary":"Remove User from Clinics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/deleteuserfromclinics"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/clinics"},{"label":"Update User Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updateclinicuserdetails","routeSlug":"/reference/clinic.v1/internal/updateclinicuserdetails","metadata":{"seo":{"title":"Update User Details","description":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateClinicUserDetails","name":"Update User Details","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"schemaId":"components/schemas/updateUserDetails.v1","pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{userId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"responseCodes":["204"],"pointer":"/v1/users/{userId}/clinics","href":"internal/updateclinicuserdetails","openApiOperationId":"UpdateClinicUserDetails","summary":"Update User Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/updateUserDetails.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateUserDetails.v1"}},"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"}],"pointer":"/paths/~1v1~1users~1{userId}~1clinics/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updateclinicuserdetails"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/clinics"},{"label":"List All Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/listallclinicians","routeSlug":"/reference/clinic.v1/internal/listallclinicians","metadata":{"seo":{"title":"List All Clinicians","description":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAllClinicians","name":"List All Clinicians","isWebhook":false,"pointer":"/paths/~1v1~1clinicians/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Clinicians","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"createdTimeStart","in":"query","schemaId":"schema_113","description":"Return records created after the given date (inclusive)"},{"name":"createdTimeEnd","in":"query","schemaId":"schema_113","description":"Return records created before the given date (exclusive)"}],"pointer":"/paths/~1v1~1clinicians/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinicians","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","schemaId":"schema_111"},{"name":"limit","in":"query","schemaId":"schema_110"},{"name":"createdTimeStart","in":"query","required":false,"schemaId":"schema_113"},{"name":"createdTimeEnd","in":"query","required":false,"schemaId":"schema_113"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinicians","href":"internal/listallclinicians","openApiOperationId":"ListAllClinicians","summary":"List All Clinicians"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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":"schema_133"}},"schemaId":"schema_133"}],"pointer":"/paths/~1v1~1clinicians/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_133","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/listallclinicians"}],"panels":[]}]},"httpPath":"/v1/clinicians"},{"label":"UpdatePatientSummary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientsummary","routeSlug":"/reference/clinic.v1/internal/updatepatientsummary","metadata":{"seo":{"title":"UpdatePatientSummary","description":"Internal endpoint which updates the summary in all patient records which match the user id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientSummary","name":"UpdatePatientSummary","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdatePatientSummary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint which updates the summary in all patient records which match the user id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"schemaId":"components/schemas/patientSummary.v1","pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{patientId}/summary","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"responseCodes":["200","404"],"pointer":"/v1/patients/{patientId}/summary","href":"internal/updatepatientsummary","openApiOperationId":"UpdatePatientSummary","summary":"UpdatePatientSummary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientSummary.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientSummary.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1patients~1{patientId}~1summary/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatepatientsummary"}],"panels":[]}]},"httpPath":"/v1/patients/{patientId}/summary"},{"label":"DeletePatientSummary","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deletepatientsummary","routeSlug":"/reference/clinic.v1/internal/deletepatientsummary","metadata":{"seo":{"title":"DeletePatientSummary","description":"Internal endpoint which deletes the summary in all patient records which match the summary id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientSummary","name":"DeletePatientSummary","isWebhook":false,"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DeletePatientSummary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint which deletes the summary in all patient records which match the summary id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"summaryId","in":"path","schemaId":"schema_134","required":true}],"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/summaries/{summaryId}/clinics","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"summaryId","in":"path","required":true,"example":"2fe2488217ee43e1b2e83c2f","schemaId":"components/schemas/summaryId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/v1/summaries/{summaryId}/clinics","href":"internal/deletepatientsummary","openApiOperationId":"DeletePatientSummary","summary":"DeletePatientSummary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"204","description":"No Change"}],"pointer":"/paths/~1v1~1summaries~1{summaryId}~1clinics/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/deletepatientsummary"}],"panels":[]}]},"httpPath":"/v1/summaries/{summaryId}/clinics"},{"label":"Create or update a data source for a patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientdatasources","routeSlug":"/reference/clinic.v1/internal/updatepatientdatasources","metadata":{"seo":{"title":"Create or update a data source for a patient","description":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientDataSources","name":"Create or update a data source for a patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a data source for a patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_131","required":true}],"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"schemaId":"components/schemas/dataSources.v1","pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/patients/{userId}/data_sources","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"responseCodes":["200","404"],"pointer":"/v1/patients/{userId}/data_sources","href":"internal/updatepatientdatasources","openApiOperationId":"UpdatePatientDataSources","summary":"Create or update a data source for a patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/dataSources.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/dataSources.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1patients~1{userId}~1data_sources/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatepatientdatasources"}],"panels":[]}]},"httpPath":"/v1/patients/{userId}/data_sources"},{"label":"Update Tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatetier","routeSlug":"/reference/clinic.v1/internal/updatetier","metadata":{"seo":{"title":"Update Tier","description":"Internal endpoint to update clinic service tier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTier","name":"Update Tier","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint to update clinic service tier"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"schemaId":"components/schemas/UpdateTier","pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/tier","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/tier","href":"internal/updatetier","openApiOperationId":"UpdateTier","summary":"Update Tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/UpdateTier","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTier"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1tier/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatetier"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/tier"},{"label":"Assign Patient Tag To Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/assignpatienttagtoclinicpatients","routeSlug":"/reference/clinic.v1/internal/assignpatienttagtoclinicpatients","metadata":{"seo":{"title":"Assign Patient Tag To Clinic Patients","description":"Assign a patient tag to a subset of clinic patients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AssignPatientTagToClinicPatients","name":"Assign Patient Tag To Clinic Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Patient Tag To Clinic Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assign a patient tag to a subset of clinic patients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"schemaId":"components/schemas/tidepoolUserIds.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/requestBody","description":"Array of clinic patient user IDs to target for tag assignment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","href":"internal/assignpatienttagtoclinicpatients","openApiOperationId":"AssignPatientTagToClinicPatients","summary":"Assign Patient Tag To Clinic Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/tidepoolUserIds.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1assign_tag~1{patientTagId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/assignpatienttagtoclinicpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}"},{"label":"Delete Patient Tag From Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deletepatienttagfromclinicpatients","routeSlug":"/reference/clinic.v1/internal/deletepatienttagfromclinicpatients","metadata":{"seo":{"title":"Delete Patient Tag From Clinic Patients","description":"Delete a patient tag from all or a subset of clinic patients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePatientTagFromClinicPatients","name":"Delete Patient Tag From Clinic Patients","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Patient Tag From Clinic Patients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a patient tag from all or a subset of clinic patients"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientTagId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"schemaId":"components/schemas/tidepoolUserIds.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/requestBody","description":"Pass an array of patient IDs to target a subset of the clinic patients. Omit request body to target all clinic patients."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientTagId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","href":"internal/deletepatienttagfromclinicpatients","openApiOperationId":"DeletePatientTagFromClinicPatients","summary":"Delete Patient Tag From Clinic Patients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/tidepoolUserIds.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tidepoolUserIds.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1delete_tag~1{patientTagId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/deletepatienttagfromclinicpatients"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}"},{"label":"Update Membership Restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemembershiprestrictions","routeSlug":"/reference/clinic.v1/internal/updatemembershiprestrictions","metadata":{"seo":{"title":"Update Membership Restrictions","description":"An internal endpoint to update clinic membership restrictions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMembershipRestrictions","name":"Update Membership Restrictions","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Membership Restrictions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint to update clinic membership restrictions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"schemaId":"components/schemas/membershipRestrictions.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/membership_restrictions","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/membership_restrictions","href":"internal/updatemembershiprestrictions","openApiOperationId":"UpdateMembershipRestrictions","summary":"Update Membership Restrictions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/membershipRestrictions.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}},"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/membershipRestrictions.v1"}},"schemaId":"components/schemas/membershipRestrictions.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1membership_restrictions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/membershipRestrictions.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/membershipRestrictions.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatemembershiprestrictions"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/processehrmessage","routeSlug":"/reference/clinic.v1/internal/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessEHRMessage","name":"Redox EHR Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox EHR Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An endpoint for incoming Redox messages"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1v1~1redox/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115"}},"responseCodes":["200"],"pointer":"/v1/redox","href":"internal/processehrmessage","openApiOperationId":"ProcessEHRMessage","summary":"Redox EHR Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/processehrmessage"}],"panels":[]}]},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/verifyendpoint","routeSlug":"/reference/clinic.v1/internal/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerifyEndpoint","name":"Redox Verify Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox Verify Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint for Redox challenge verification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox/verify","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/redox/verify","href":"internal/verifyendpoint","openApiOperationId":"VerifyEndpoint","summary":"Redox Verify Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox~1verify/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/verifyendpoint"}],"panels":[]}]},"httpPath":"/v1/redox/verify"},{"label":"Get EHR Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getehrsettings","routeSlug":"/reference/clinic.v1/internal/getehrsettings","metadata":{"seo":{"title":"Get EHR Settings","description":"Returns EHR related settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetEHRSettings","name":"Get EHR Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get EHR Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns EHR related settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/settings/ehr","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/ehr","href":"internal/getehrsettings","openApiOperationId":"GetEHRSettings","summary":"Get EHR Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/ehrSettings.v1"}},"schemaId":"components/schemas/ehrSettings.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ehrSettings.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/getehrsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Update EHR Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updateehrsettings","routeSlug":"/reference/clinic.v1/internal/updateehrsettings","metadata":{"seo":{"title":"Update EHR Settings","description":"Update EHR related settings for a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateEHRSettings","name":"Update EHR Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update EHR Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update EHR related settings for a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"schemaId":"components/schemas/ehrSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/ehr","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/ehr","href":"internal/updateehrsettings","openApiOperationId":"UpdateEHRSettings","summary":"Update EHR Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/ehrSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1ehr/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updateehrsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Match Clinic and Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/matchclinicandpatient","routeSlug":"/reference/clinic.v1/internal/matchclinicandpatient","metadata":{"seo":{"title":"Match Clinic and Patient","description":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MatchClinicAndPatient","name":"Match Clinic and Patient","isWebhook":false,"pointer":"/paths/~1v1~1redox~1match/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Match Clinic and 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":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a clinic with the provided details cannot be found, the service will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will not attempt to match patients to the provided details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due to lack of uniqueness constraints on the MRN and DOB fields it's possible that multiple patient records match the provided attributes. All results will be returned in the response and it's the calling services responsiblity to determine how to handle duplicates records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a unique match is found, the patient matching criteria will be added to the patient record for future use (e.g. pushing data on a schedule)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"schemaId":"components/schemas/ehrMatchRequest.v1","pointer":"/paths/~1v1~1redox~1match/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox/match","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"responseCodes":["200","404"],"pointer":"/v1/redox/match","href":"internal/matchclinicandpatient","openApiOperationId":"MatchClinicAndPatient","summary":"Match Clinic and Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/ehrMatchRequest.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ehrMatchRequest.v1"}},"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/ehrMatchResponse.v1"}},"schemaId":"components/schemas/ehrMatchResponse.v1"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1redox~1match/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ehrMatchResponse.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ehrMatchResponse.v1"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/matchclinicandpatient"}],"panels":[]}]},"httpPath":"/v1/redox/match"},{"label":"Get MRN Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getmrnsettings","routeSlug":"/reference/clinic.v1/internal/getmrnsettings","metadata":{"seo":{"title":"Get MRN Settings","description":"Retrieve MRN settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMRNSettings","name":"Get MRN Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get MRN Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve MRN settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clinics/{clinicId}/settings/mrn","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/mrn","href":"internal/getmrnsettings","openApiOperationId":"GetMRNSettings","summary":"Get MRN Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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/mrnSettings.v1"}},"schemaId":"components/schemas/mrnSettings.v1"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mrnSettings.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/getmrnsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update MRN Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemrnsettings","routeSlug":"/reference/clinic.v1/internal/updatemrnsettings","metadata":{"seo":{"title":"Update MRN Settings","description":"Update MRN Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateMRNSettings","name":"Update MRN Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update MRN Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update MRN Settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"schemaId":"components/schemas/mrnSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/mrn","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/mrn","href":"internal/updatemrnsettings","openApiOperationId":"UpdateMRNSettings","summary":"Update MRN Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/mrnSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mrnSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1mrn/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatemrnsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update Patient Count Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientcountsettings","routeSlug":"/reference/clinic.v1/internal/updatepatientcountsettings","metadata":{"seo":{"title":"Update Patient Count Settings","description":"Update Patient Count Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePatientCountSettings","name":"Update Patient Count Settings","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Patient Count Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Patient Count Settings"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"schemaId":"components/schemas/patientCountSettings.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clinics/{clinicId}/settings/patient_count","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/settings/patient_count","href":"internal/updatepatientcountsettings","openApiOperationId":"UpdatePatientCountSettings","summary":"Update Patient Count Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/patientCountSettings.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patientCountSettings.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1settings~1patient_count/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/updatepatientcountsettings"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Refresh Patient Count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/refreshpatientcount","routeSlug":"/reference/clinic.v1/internal/refreshpatientcount","metadata":{"seo":{"title":"Refresh Patient Count","description":"An internal endpoint to refresh the patient count for the specified clinic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RefreshPatientCount","name":"Refresh Patient Count","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh Patient Count","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint to refresh the patient count for the specified clinic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patient_count/refresh","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/patient_count/refresh","href":"internal/refreshpatientcount","openApiOperationId":"RefreshPatientCount","summary":"Refresh Patient Count"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patient_count~1refresh/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/refreshpatientcount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patient_count/refresh"},{"label":"Sync EHR Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/syncehrdata","routeSlug":"/reference/clinic.v1/internal/syncehrdata","metadata":{"seo":{"title":"Sync EHR Data","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SyncEHRData","name":"Sync EHR Data","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync EHR Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription.\n\nWill return 404 Not Found if the clinic does not have an active EHR connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/ehr/sync","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/v1/clinics/{clinicId}/ehr/sync","href":"internal/syncehrdata","openApiOperationId":"SyncEHRData","summary":"Sync EHR Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1ehr~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/syncehrdata"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/ehr/sync"},{"label":"Preorder Form Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthpreorder","routeSlug":"/reference/clinic.v1/internal/xealthpreorder","metadata":{"seo":{"title":"Preorder Form Webhook","description":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthPreorder","name":"Preorder Form Webhook","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1preorder/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preorder Form 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":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://sandbox.xealth.io/app/api-docs#tag/Digital-Care/paths/preorder/post"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/xealth/preorder","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/preorder","href":"internal/xealthpreorder","openApiOperationId":"XealthPreorder","summary":"Preorder Form Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1preorder/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/xealthpreorder"}],"panels":[]}]},"httpPath":"/v1/xealth/preorder"},{"label":"Get Programs","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthgetprograms","routeSlug":"/reference/clinic.v1/internal/xealthgetprograms","metadata":{"seo":{"title":"Get Programs","description":"Get programs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthGetPrograms","name":"Get Programs","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1programs/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get programs"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/xealth/programs","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/programs","href":"internal/xealthgetprograms","openApiOperationId":"XealthGetPrograms","summary":"Get Programs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1programs/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/xealthgetprograms"}],"panels":[]}]},"httpPath":"/v1/xealth/programs"},{"label":"Get Program Url","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthgetprogramurl","routeSlug":"/reference/clinic.v1/internal/xealthgetprogramurl","metadata":{"seo":{"title":"Get Program Url","description":"Get program URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthGetProgramUrl","name":"Get Program Url","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1program/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Program Url","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get program URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/xealth/program","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/program","href":"internal/xealthgetprogramurl","openApiOperationId":"XealthGetProgramUrl","summary":"Get Program Url"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1program/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/xealthgetprogramurl"}],"panels":[]}]},"httpPath":"/v1/xealth/program"},{"label":"Notification Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthnotification","routeSlug":"/reference/clinic.v1/internal/xealthnotification","metadata":{"seo":{"title":"Notification Webhook","description":"Notification webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"XealthNotification","name":"Notification Webhook","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1notification/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification webhook"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/xealth/notification","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/notification","href":"internal/xealthnotification","openApiOperationId":"XealthNotification","summary":"Notification Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1notification/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/xealthnotification"}],"panels":[]}]},"httpPath":"/v1/xealth/notification"},{"label":"View PDF Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/viewpdfreport","routeSlug":"/reference/clinic.v1/internal/viewpdfreport","metadata":{"seo":{"title":"View PDF Report","description":"View PDF report for a given patient of a clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ViewPDFReport","name":"View PDF Report","isWebhook":false,"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View PDF Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"View PDF report for a given patient of a clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clinicId","in":"query","schemaId":"schema_112","required":true},{"name":"patientId","in":"query","schemaId":"schema_112","required":true},{"name":"restricted_token","in":"query","schemaId":"schema_112","required":true}],"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/xealth/report/web/viewer.html","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[{"name":"clinicId","in":"query","required":true,"schemaId":"schema_112"},{"name":"patientId","in":"query","required":true,"schemaId":"schema_112"},{"name":"restricted_token","in":"query","required":true,"schemaId":"schema_112"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/xealth/report/web/viewer.html","href":"internal/viewpdfreport","openApiOperationId":"ViewPDFReport","summary":"View PDF Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1xealth~1report~1web~1viewer.html/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/viewpdfreport"}],"panels":[]}]},"httpPath":"/v1/xealth/report/web/viewer.html"},{"label":"Add Service Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/addserviceaccount","routeSlug":"/reference/clinic.v1/internal/addserviceaccount","metadata":{"seo":{"title":"Add Service Account","description":"Adds authentication client's service account as a new clinician member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddServiceAccount","name":"Add Service Account","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Service Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds authentication client's service account as a new clinician member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"schemaId":"components/schemas/addServiceAccount.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/service_accounts","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/service_accounts","href":"internal/addserviceaccount","openApiOperationId":"AddServiceAccount","summary":"Add Service Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/addServiceAccount.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/addServiceAccount.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1service_accounts/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/addserviceaccount"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/service_accounts"},{"label":"Sync EHR Data for Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/syncehrdataforpatient","routeSlug":"/reference/clinic.v1/internal/syncehrdataforpatient","metadata":{"seo":{"title":"Sync EHR Data for Patient","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SyncEHRDataForPatient","name":"Sync EHR Data for Patient","isWebhook":false,"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync EHR Data for Patient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled.\n\nA 404 response will be returned if no active subscriptions can be found for given patient."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"patientId","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/patients/{patientId}/ehr/sync","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/v1/patients/{patientId}/ehr/sync","href":"internal/syncehrdataforpatient","openApiOperationId":"SyncEHRDataForPatient","summary":"Sync EHR Data for Patient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"}],"pointer":"/paths/~1v1~1patients~1{patientId}~1ehr~1sync/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/syncehrdataforpatient"}],"panels":[]}]},"httpPath":"/v1/patients/{patientId}/ehr/sync"},{"label":"Merge Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/mergeclinic","routeSlug":"/reference/clinic.v1/internal/mergeclinic","metadata":{"seo":{"title":"Merge Clinic","description":"Merges tags, patients, clinicians, invites and share codes of the source clinic"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MergeClinic","name":"Merge Clinic","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Clinic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merges tags, patients, clinicians, invites and share codes of the source clinic"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"schemaId":"components/schemas/mergeClinic.v1","pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/merge","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"responseCodes":["200"],"pointer":"/v1/clinics/{clinicId}/merge","href":"internal/mergeclinic","openApiOperationId":"MergeClinic","summary":"Merge Clinic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/mergeClinic.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/mergeClinic.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1merge/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/mergeclinic"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/merge"},{"label":"Connect Provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/connectprovider","routeSlug":"/reference/clinic.v1/internal/connectprovider","metadata":{"seo":{"title":"Connect Provider","description":"Send a new request to the patient to connect a data provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ConnectProvider","name":"Connect Provider","isWebhook":false,"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connect Provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a new request to the patient to connect a data provider"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clinicId","in":"path","schemaId":"schema_117","required":true},{"name":"patientId","in":"path","schemaId":"schema_129","required":true},{"name":"providerId","in":"path","schemaId":"schema_136","description":"Provider ID","required":true}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"clinicId","in":"path","required":true,"schemaId":"schema_117"},{"name":"patientId","in":"path","required":true,"schemaId":"schema_129"},{"name":"providerId","in":"path","required":true,"schemaId":"components/schemas/providerId.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","href":"internal/connectprovider","openApiOperationId":"ConnectProvider","summary":"Connect Provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"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"}],"pointer":"/paths/~1v1~1clinics~1{clinicId}~1patients~1{patientId}~1connect~1{providerId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/connectprovider"}],"panels":[]}]},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}"}],"content":{"contentType":"group","meta":{"name":"Internal"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal","showPageActions":true},{"nodeType":"markdoc","content":"APIs intended for internal use by Tidepool."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/clinics/{clinicId}/migrations","summary":"Migrate Legacy Clinician Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/migratelegacyclinicianpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations","summary":"Retrieve Migration Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/listmigrations","deprecated":false},{"title":"/v1/clinicians/{userId}/migrate","summary":"Enable Clinics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/enablenewclinicexperience","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrate","summary":"Trigger initial migration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/triggerinitialmigration","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations/{userId}","summary":"Get Migration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/getmigration","deprecated":false},{"title":"/v1/clinics/{clinicId}/migrations/{userId}","summary":"Update Migration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/internal/updatemigration","deprecated":false},{"title":"/v1/users/{userId}/clinics","summary":"Remove User from Clinics","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/internal/deleteuserfromclinics","deprecated":false},{"title":"/v1/users/{userId}/clinics","summary":"Update User Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/updateclinicuserdetails","deprecated":false},{"title":"/v1/clinicians","summary":"List All Clinicians","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/listallclinicians","deprecated":false},{"title":"/v1/patients/{patientId}/summary","summary":"UpdatePatientSummary","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/updatepatientsummary","deprecated":false},{"title":"/v1/summaries/{summaryId}/clinics","summary":"DeletePatientSummary","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/internal/deletepatientsummary","deprecated":false},{"title":"/v1/patients/{userId}/data_sources","summary":"Create or update a data source for a patient","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/updatepatientdatasources","deprecated":false},{"title":"/v1/clinics/{clinicId}/tier","summary":"Update Tier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/updatetier","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}","summary":"Assign Patient Tag To Clinic Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/assignpatienttagtoclinicpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}","summary":"Delete Patient Tag From Clinic Patients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/deletepatienttagfromclinicpatients","deprecated":false},{"title":"/v1/clinics/{clinicId}/membership_restrictions","summary":"Update Membership Restrictions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/updatemembershiprestrictions","deprecated":false},{"title":"/v1/redox","summary":"Redox EHR Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/processehrmessage","deprecated":false},{"title":"/v1/redox/verify","summary":"Redox Verify Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/verifyendpoint","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/ehr","summary":"Get EHR Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/getehrsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/ehr","summary":"Update EHR Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/updateehrsettings","deprecated":false},{"title":"/v1/redox/match","summary":"Match Clinic and Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/matchclinicandpatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/mrn","summary":"Get MRN Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/getmrnsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/mrn","summary":"Update MRN Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/updatemrnsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/settings/patient_count","summary":"Update Patient Count Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/updatepatientcountsettings","deprecated":false},{"title":"/v1/clinics/{clinicId}/patient_count/refresh","summary":"Refresh Patient Count","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/refreshpatientcount","deprecated":false},{"title":"/v1/clinics/{clinicId}/ehr/sync","summary":"Sync EHR Data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/syncehrdata","deprecated":false},{"title":"/v1/xealth/preorder","summary":"Preorder Form Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/xealthpreorder","deprecated":false},{"title":"/v1/xealth/programs","summary":"Get Programs","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/xealthgetprograms","deprecated":false},{"title":"/v1/xealth/program","summary":"Get Program Url","prefix":{"name":"put","color":"put"},"badges":[],"link":"/internal/xealthgetprogramurl","deprecated":false},{"title":"/v1/xealth/notification","summary":"Notification Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/xealthnotification","deprecated":false},{"title":"/v1/xealth/report/web/viewer.html","summary":"View PDF Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/viewpdfreport","deprecated":false},{"title":"/v1/clinics/{clinicId}/service_accounts","summary":"Add Service Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/addserviceaccount","deprecated":false},{"title":"/v1/patients/{patientId}/ehr/sync","summary":"Sync EHR Data for Patient","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/syncehrdataforpatient","deprecated":false},{"title":"/v1/clinics/{clinicId}/merge","summary":"Merge Clinic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/mergeclinic","deprecated":false},{"title":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}","summary":"Connect Provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal/connectprovider","deprecated":false}]}]}]}]}},{"type":"group","label":"Redox","link":"/reference/clinic.v1/redox","routeSlug":"/reference/clinic.v1/redox","items":[{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/redox/processehrmessage","routeSlug":"/reference/clinic.v1/redox/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessEHRMessage","name":"Redox EHR Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox EHR Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An endpoint for incoming Redox messages"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1v1~1redox/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115"}},"responseCodes":["200"],"pointer":"/v1/redox","href":"redox/processehrmessage","openApiOperationId":"ProcessEHRMessage","summary":"Redox EHR Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/redox/processehrmessage"}],"panels":[]}]},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/redox/verifyendpoint","routeSlug":"/reference/clinic.v1/redox/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VerifyEndpoint","name":"Redox Verify Endpoint","isWebhook":false,"pointer":"/paths/~1v1~1redox~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox Verify Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Internal endpoint for Redox challenge verification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"x-tidepool-session-token","description":"A Tidepool session token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/redox/verify","servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"x-tidepool-session-token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/redox/verify","href":"redox/verifyendpoint","openApiOperationId":"VerifyEndpoint","summary":"Redox Verify Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/clinic.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v1~1redox~1verify/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/redox/verifyendpoint"}],"panels":[]}]},"httpPath":"/v1/redox/verify"}],"content":{"contentType":"group","meta":{"name":"Redox"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redox","showPageActions":true},{"nodeType":"markdoc","content":"Public endpoints invoked by Redox."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/redox","summary":"Redox EHR Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/redox/processehrmessage","deprecated":false},{"title":"/v1/redox/verify","summary":"Redox Verify Endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/redox/verifyendpoint","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/clinics.v1":{"id":"components/schemas/clinics.v1","kind":"json-schema","title":"clinics.v1","data":{"type":"array","items":{"$ref":"#/components/schemas/clinic.v1"}}},"components/schemas/clinicians.v1":{"id":"components/schemas/clinicians.v1","kind":"json-schema","title":"clinicians.v1","data":{"type":"array","items":{"$ref":"#/components/schemas/clinician.v1"}}},"components/schemas/patients.v1":{"id":"components/schemas/patients.v1","kind":"json-schema","title":"patients.v1","data":{"type":"array","items":{"$ref":"#/components/schemas/patient.v1"}}},"components/schemas/patientTag.v1":{"id":"components/schemas/patientTag.v1","kind":"json-schema","title":"Patient Tag","data":{"type":"object","title":"Patient Tag","description":"","properties":{"id":{"$ref":"#/components/schemas/objectid.v1"},"name":{"type":"string","description":"The tag display name","minLength":1,"maxLength":20,"pattern":"^[\\p{L}\\p{N}_+><-]{1}[\\p{L}\\p{N}\\s_+><-]*$"},"numPatients":{"type":"integer","x-go-type-skip-optional-pointer":true,"x-omitzero":true,"readOnly":true}},"required":["id","name"]}},"components/schemas/dataSources.v1":{"id":"components/schemas/dataSources.v1","kind":"json-schema","title":"dataSources.v1","data":{"type":"array","items":{"$ref":"#/components/schemas/dataSource.v1"}}},"components/schemas/site.v1":{"id":"components/schemas/site.v1","kind":"json-schema","title":"Site","data":{"type":"object","title":"Site","description":"A clinic's physical or logical location.","properties":{"id":{"$ref":"#/components/schemas/siteId.v1"},"name":{"$ref":"#/components/schemas/siteName.v1"},"numPatients":{"type":"integer","x-go-type-skip-optional-pointer":true,"x-omitzero":true,"readOnly":true}},"required":["id","name"]}},"components/schemas/siteCreation.v1":{"id":"components/schemas/siteCreation.v1","kind":"json-schema","title":"Site","data":{"type":"object","title":"Site","description":"A clinic's physical or logical location.","properties":{"name":{"$ref":"#/components/schemas/siteName.v1"}},"required":["name"]}},"components/schemas/tidepoolUserIds.v1":{"id":"components/schemas/tidepoolUserIds.v1","kind":"json-schema","title":"tidepoolUserIds.v1","data":{"type":"array","nullable":true,"description":"Array of Tidepool User IDs","items":{"$ref":"#/components/schemas/tidepooluserid"},"minItems":1,"maxItems":1000,"uniqueItems":true}},"components/schemas/patientClinicRelationship.v1":{"id":"components/schemas/patientClinicRelationship.v1","kind":"json-schema","title":"PatientClinicRelationship","data":{"title":"PatientClinicRelationship","type":"object","properties":{"patient":{"$ref":"#/components/schemas/patient.v1"},"clinic":{"$ref":"#/components/schemas/clinic.v1"}},"required":["patient","clinic"]}},"components/schemas/patientClinicRelationships.v1":{"id":"components/schemas/patientClinicRelationships.v1","kind":"json-schema","title":"PatientClinicRelationships","data":{"title":"PatientClinicRelationships","type":"array","items":{"$ref":"#/components/schemas/patientClinicRelationship.v1"}}},"components/schemas/createPatient.v1":{"id":"components/schemas/createPatient.v1","kind":"json-schema","title":"Create Patient","data":{"title":"Create Patient","type":"object","properties":{"permissions":{"$ref":"#/components/schemas/patientPermissions.v1"},"isMigrated":{"type":"boolean"},"legacyClinicianId":{"$ref":"#/components/schemas/tidepooluserid"},"attestationSubmitted":{"type":"boolean"},"fullName":{"type":"string","description":"The full name of the patient","minLength":1},"birthDate":{"type":"string","format":"date","example":"2012-08-30"},"mrn":{"type":"string","description":"The medical record number of the patient","minLength":1},"tags":{"$ref":"#/components/schemas/patientTagIds.v1"},"sites":{"type":"array","x-go-type-skip-optional-pointer":true,"x-omitempty":false,"x-omitzero":true,"items":{"$ref":"#/components/schemas/site.v1"}},"glycemicRanges":{"$ref":"#/components/schemas/glycemicRanges.v1"},"diagnosisType":{"$ref":"#/components/schemas/diagnosisType.v1"}}}},"components/schemas/associateClinicianToUser.v1":{"id":"components/schemas/associateClinicianToUser.v1","kind":"json-schema","title":"Associate Clinician","data":{"title":"Associate Clinician","type":"object","properties":{"userId":{"type":"string"}},"required":["userId"]}},"components/schemas/clinicianClinicRelationship.v1":{"id":"components/schemas/clinicianClinicRelationship.v1","kind":"json-schema","title":"ClinicianClinicRelationship","data":{"title":"ClinicianClinicRelationship","type":"object","properties":{"clinician":{"$ref":"#/components/schemas/clinician.v1"},"clinic":{"$ref":"#/components/schemas/clinic.v1"}},"required":["clinician","clinic"]}},"components/schemas/clinicianClinicRelationships.v1":{"id":"components/schemas/clinicianClinicRelationships.v1","kind":"json-schema","title":"ClinicianClinicRelationships","data":{"title":"ClinicianClinicRelationships","type":"array","items":{"$ref":"#/components/schemas/clinicianClinicRelationship.v1"}}},"components/schemas/migration.v1":{"id":"components/schemas/migration.v1","kind":"json-schema","title":"Migration","data":{"title":"Migration","type":"object","properties":{"userId":{"type":"string","description":"The user id of the legacy clinician account that needs to be migrated.","minLength":1},"status":{"$ref":"#/components/schemas/migrationStatus.v1"},"createdTime":{"type":"string","format":"date-time","readOnly":true},"updatedTime":{"type":"string","format":"date-time","readOnly":true},"attestationTime":{"type":"string","format":"date-time","readOnly":true}},"required":["userId","createdTime","updatedTime"]}},"components/schemas/migrations.v1":{"id":"components/schemas/migrations.v1","kind":"json-schema","title":"Migrations","data":{"title":"Migrations","type":"array","items":{"$ref":"#/components/schemas/migration.v1"}}},"components/schemas/migrationUpdate.v1":{"id":"components/schemas/migrationUpdate.v1","kind":"json-schema","title":"MigrationUpdate","data":{"title":"MigrationUpdate","type":"object","properties":{"status":{"$ref":"#/components/schemas/migrationStatus.v1"}},"required":["status"]}},"components/schemas/meta.v1":{"id":"components/schemas/meta.v1","kind":"json-schema","title":"Meta","data":{"title":"Meta","type":"object","properties":{"count":{"description":"The number of items matching the filter","type":"integer"},"totalCount":{"description":"The total number of items","type":"integer"}}}},"components/schemas/patientsResponse.v1":{"id":"components/schemas/patientsResponse.v1","kind":"json-schema","title":"PatientsResponse","data":{"title":"PatientsResponse","type":"object","properties":{"data":{"$ref":"#/components/schemas/patients.v1"},"meta":{"$ref":"#/components/schemas/meta.v1"}}}},"components/schemas/updateUserDetails.v1":{"id":"components/schemas/updateUserDetails.v1","kind":"json-schema","title":"UpdateUserDetails","data":{"title":"UpdateUserDetails","type":"object","properties":{"email":{"type":"string","format":"email","minLength":1}}}},"components/schemas/triggerMigration.v1":{"id":"components/schemas/triggerMigration.v1","kind":"json-schema","title":"TriggerMigration","data":{"title":"TriggerMigration","type":"object","properties":{"attestationSubmitted":{"type":"boolean"}}}},"components/schemas/patientReviews.v1":{"id":"components/schemas/patientReviews.v1","kind":"json-schema","title":"patientReviews.v1","data":{"type":"array","items":{"$ref":"#/components/schemas/patientReview.v1"}}},"components/schemas/FloatFilter":{"id":"components/schemas/FloatFilter","kind":"json-schema","title":"FloatFilter","data":{"type":"string","pattern":"^(>=|>|<=|<)[+-]?((\\d+(\\.\\d*)?)|(\\.\\d+))$","example":">=5.5"}},"components/schemas/IntFilter":{"id":"components/schemas/IntFilter","kind":"json-schema","title":"IntFilter","data":{"type":"string","pattern":"^(>=|>|<=|<)[+-]?\\d+$","example":">=7"}},"components/schemas/UpdateTier":{"id":"components/schemas/UpdateTier","kind":"json-schema","title":"UpdateTier","data":{"title":"UpdateTier","type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier.v1"}},"required":["tier"]}},"components/schemas/tier.v1":{"id":"components/schemas/tier.v1","kind":"json-schema","title":"Clinic Service Tier","data":{"type":"string","title":"Clinic Service Tier","enum":["tier0100","tier0200","tier0300","tier0400"],"example":"tier0100"}},"components/schemas/UpdateSuppressedNotifications":{"id":"components/schemas/UpdateSuppressedNotifications","kind":"json-schema","title":"UpdateSuppressedNotifications","data":{"title":"UpdateSuppressedNotifications","type":"object","properties":{"suppressedNotifications":{"$ref":"#/components/schemas/suppressedNotifications.v1"}},"required":["suppressedNotifications"]}},"components/schemas/ehrMatchRequest.v1":{"id":"components/schemas/ehrMatchRequest.v1","kind":"json-schema","title":"EHR Match Request","data":{"title":"EHR Match Request","x-stoplight":{"id":"nq0mlm5dqdfw0"},"type":"object","x-examples":{},"properties":{"messageRef":{"$ref":"#/components/schemas/ehrMatchMessageRef.v1"},"patients":{"$ref":"#/components/schemas/ehrMatchRequestPatientsOptions.v1"}}}},"components/schemas/ehrMatchResponse.v1":{"id":"components/schemas/ehrMatchResponse.v1","kind":"json-schema","title":"EHRMatchResponse","data":{"title":"EHRMatchResponse","x-stoplight":{"id":"pekkj09rlany0"},"type":"object","properties":{"clinic":{"$ref":"#/components/schemas/clinic.v1"},"patients":{"$ref":"#/components/schemas/patients.v1"},"settings":{"$ref":"#/components/schemas/ehrSettings.v1"}},"required":["clinic","settings"]}},"components/schemas/ehrMatchMessageRef.v1":{"id":"components/schemas/ehrMatchMessageRef.v1","kind":"json-schema","title":"EHRMatchMessageRef","data":{"title":"EHRMatchMessageRef","x-stoplight":{"id":"a1215t5vip3tr"},"type":"object","properties":{"dataModel":{"type":"string","enum":["Order"]},"eventType":{"type":"string","enum":["New"]},"documentId":{"type":"string"}},"required":["dataModel","eventType","documentId"]}},"components/schemas/AcceptPatientInvitation":{"id":"components/schemas/AcceptPatientInvitation","kind":"json-schema","title":"AcceptPatientInvitation","data":{"title":"AcceptPatientInvitation","x-stoplight":{"id":"vo0jck92hztsj"},"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the patient","minLength":1},"birthDate":{"type":"string","format":"date","example":"2012-08-30"},"mrn":{"type":"string","description":"The medical record number of the patient","minLength":1},"tags":{"$ref":"#/components/schemas/patientTagIds.v1"},"sites":{"type":"array","x-go-type-skip-optional-pointer":true,"x-omitempty":false,"x-omitzero":true,"items":{"$ref":"#/components/schemas/site.v1"}},"glycemicRanges":{"$ref":"#/components/schemas/glycemicRanges.v1"},"diagnosisType":{"$ref":"#/components/schemas/diagnosisType.v1"}}}},"components/schemas/addServiceAccount.v1":{"id":"components/schemas/addServiceAccount.v1","kind":"json-schema","title":"AddServiceAccount","data":{"title":"AddServiceAccount","x-stoplight":{"id":"3c7ko800mld31"},"type":"object","properties":{"name":{"type":"string","x-stoplight":{"id":"3333gszyq3x79"},"minLength":1},"client_id":{"type":"string","x-stoplight":{"id":"kgfyaapmfjies"},"minLength":1},"client_secret":{"type":"string","x-stoplight":{"id":"8jdosn0tlbqp5"},"minLength":1}},"required":["name","client_id","client_secret"]}},"components/schemas/generateMergeReport.v1":{"id":"components/schemas/generateMergeReport.v1","kind":"json-schema","title":"GenerateMergeReport","data":{"title":"GenerateMergeReport","x-stoplight":{"id":"3oq18sasrzo0o"},"type":"object","properties":{"sourceId":{"$ref":"#/components/schemas/clinicId.v1"}},"required":["sourceId"]}},"components/schemas/mergeClinic.v1":{"id":"components/schemas/mergeClinic.v1","kind":"json-schema","title":"MergeClinics","data":{"title":"MergeClinics","x-stoplight":{"id":"6hn01uuhln0wx"},"type":"object","properties":{"sourceId":{"$ref":"#/components/schemas/clinicId.v1"}}}},"components/schemas/ehrMatchRequestPatientsOptions.v1":{"id":"components/schemas/ehrMatchRequestPatientsOptions.v1","kind":"json-schema","title":"Patient Matching Options","data":{"title":"Patient Matching Options","x-stoplight":{"id":"43n6iid3zghxm"},"type":"object","properties":{"criteria":{"type":"array","x-stoplight":{"id":"1odrg3q8zzdil"},"description":"Performs an \"OR\" match for each item in the array","minItems":1,"items":{"x-stoplight":{"id":"mgi1k2jyojc4k"},"type":"string","enum":["MRN","MRN_DOB","DOB_FULLNAME"]}},"onUniqueMatch":{"type":"string","x-stoplight":{"id":"s9ujf5ce4vhc1"},"enum":["ENABLE_REPORTS","DISABLE_REPORTS"],"description":"Optional action to be performed when a unique match has been found"}},"required":["criteria"]}},"components/schemas/clinicId.v1":{"id":"components/schemas/clinicId.v1","kind":"json-schema","title":"Clinic ID","data":{"title":"Clinic ID","description":"Clinic identifier.","type":"string","minLength":24,"maxLength":24,"pattern":"^[a-f0-9]{24}$","readOnly":true,"example":"2fe2488217ee43e1b2e83c2f"}},"components/schemas/streetAddress.v1":{"id":"components/schemas/streetAddress.v1","kind":"json-schema","title":"Street Address","data":{"title":"Street Address","description":"Street address.","type":"string","minLength":1}},"components/schemas/city.v1":{"id":"components/schemas/city.v1","kind":"json-schema","title":"City","data":{"title":"City","description":"City name.","type":"string","minLength":1,"example":"Palo Alto"}},"components/schemas/postalCode.v1":{"id":"components/schemas/postalCode.v1","kind":"json-schema","title":"Postal Code","data":{"title":"Postal Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code. In the U.S., typically the zip code such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"94301"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"94301-1704"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","minLength":1,"example":"94301"}},"components/schemas/state.v1":{"id":"components/schemas/state.v1","kind":"json-schema","title":"State","data":{"title":"State","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province. In the U.S., typically something like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"California"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","minLength":1,"example":"CA"}},"components/schemas/country.v1":{"id":"components/schemas/country.v1","kind":"json-schema","title":"Country","data":{"title":"Country","description":"Country name.","type":"string","minLength":1,"example":"USA"}},"components/schemas/objectid.v1":{"id":"components/schemas/objectid.v1","kind":"json-schema","title":"Object Id","data":{"title":"Object Id","type":"string","description":"String representation of a resource id","minLength":24,"maxLength":24,"pattern":"^[a-f0-9]{24}$","readOnly":true}},"components/schemas/siteId.v1":{"id":"components/schemas/siteId.v1","kind":"json-schema","title":"siteId.v1","data":{"allOf":[{"$ref":"#/components/schemas/objectid.v1"},{"x-go-type-skip-optional-pointer":true,"x-go-type":"string","readOnly":true}]}},"components/schemas/siteName.v1":{"id":"components/schemas/siteName.v1","kind":"json-schema","title":"siteName.v1","data":{"type":"string","x-go-type-skip-optional-pointer":true,"description":"The site's name.","minLength":1,"maxLength":200,"pattern":"^[[:graph:]\\p{L}\\p{N}][[:graph:]\\p{L}\\p{N} ]*$"}},"components/schemas/phoneNumber.v1":{"id":"components/schemas/phoneNumber.v1","kind":"json-schema","title":"Phone Number","data":{"title":"Phone Number","type":"object","properties":{"type":{"type":"string","minLength":1},"number":{"type":"string","minLength":1}},"required":["number"],"example":{"type":"main","number":"+1 (555) 555-1212"}}},"components/schemas/phoneNumbers.v1":{"id":"components/schemas/phoneNumbers.v1","kind":"json-schema","title":"Phone phoneNumbers","data":{"title":"Phone phoneNumbers","description":"An array of phone numbers.","type":"array","uniqueItems":true,"minItems":1,"items":{"$ref":"#/components/schemas/phoneNumber.v1"}}},"components/schemas/name.v1":{"id":"components/schemas/name.v1","kind":"json-schema","title":"Clinic Name","data":{"title":"Clinic Name","description":"Name of the clinic.","type":"string","minItems":1}},"components/schemas/shareCode.v1":{"id":"components/schemas/shareCode.v1","kind":"json-schema","title":"Clinic Share Code","data":{"title":"Clinic Share Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Globally unique share code for a clinic. The share code is 3 groups of 4 uppercase alphanumeric characters in each group. Ambiguous characters such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"O"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are excluded."},"children":[]}]}]}],"type":"string","pattern":"^[ABCDEFGHJKLMNPQRSTUVWXYZ23456789]{4}-[ABCDEFGHJKLMNPQRSTUVWXYZ23456789]{4}-[ABCDEFGHJKLMNPQRSTUVWXYZ23456789]{4}$","readOnly":true}},"components/schemas/suppressedNotifications.v1":{"id":"components/schemas/suppressedNotifications.v1","kind":"json-schema","title":"Suppressed Notifications","data":{"title":"Suppressed Notifications","type":"object","properties":{"patientClinicInvitation":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/clinicTimezone.v1":{"id":"components/schemas/clinicTimezone.v1","kind":"json-schema","title":"Clinic Timezone","data":{"title":"Clinic Timezone","x-stoplight":{"id":"7htuwravuo8sn"},"type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]}},"components/schemas/clinic.v1":{"id":"components/schemas/clinic.v1","kind":"json-schema","title":"Clinic","data":{"title":"Clinic","description":"Clinic","type":"object","properties":{"id":{"$ref":"#/components/schemas/clinicId.v1"},"address":{"$ref":"#/components/schemas/streetAddress.v1"},"city":{"$ref":"#/components/schemas/city.v1"},"postalCode":{"$ref":"#/components/schemas/postalCode.v1"},"state":{"$ref":"#/components/schemas/state.v1"},"country":{"$ref":"#/components/schemas/country.v1"},"patientTags":{"type":"array","items":{"$ref":"#/components/schemas/patientTag.v1"}},"sites":{"type":"array","x-go-type-skip-optional-pointer":true,"items":{"$ref":"#/components/schemas/site.v1"}},"lastDeletedPatientTag":{"$ref":"#/components/schemas/patientTag.v1"},"phoneNumbers":{"$ref":"#/components/schemas/phoneNumbers.v1"},"clinicType":{"type":"string","minLength":1,"enum":["provider_practice","healthcare_system","veterinary_clinic","other","researcher"]},"clinicSize":{"type":"string","enum":["0-249","250-499","500-999","1000+"]},"name":{"$ref":"#/components/schemas/name.v1"},"shareCode":{"$ref":"#/components/schemas/shareCode.v1"},"canMigrate":{"type":"boolean","readOnly":true},"website":{"type":"string","format":"uri"},"createdTime":{"type":"string","format":"date-time","readOnly":true},"updatedTime":{"type":"string","format":"date-time","readOnly":true},"tierDescription":{"type":"string","minLength":1,"example":"Free","readOnly":true},"tier":{"type":"string","example":"tier0100","minLength":1,"readOnly":true},"preferredBgUnits":{"type":"string","enum":["mg/dL","mmol/L"]},"suppressedNotifications":{"$ref":"#/components/schemas/suppressedNotifications.v1"},"timezone":{"$ref":"#/components/schemas/clinicTimezone.v1"}},"required":["id","name","shareCode","canMigrate","createdTime","updatedTime","tierDescription","tier","preferredBgUnits"]}},"components/schemas/error.v1":{"id":"components/schemas/error.v1","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"code":{"type":"integer","example":404},"message":{"type":"string","example":"Requested resources was not found"}},"required":["code","message"]}},"components/schemas/tidepooluserid":{"id":"components/schemas/tidepooluserid","kind":"json-schema","title":"Tidepool User ID","data":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4"},"children":[]}]}]}]}],"readOnly":true,"x-go-type":"string"}},"components/schemas/clinicianRoles.v1":{"id":"components/schemas/clinicianRoles.v1","kind":"json-schema","title":"Clinician Permissions","data":{"type":"array","title":"Clinician Permissions","minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["CLINIC_ADMIN","CLINIC_MEMBER","PRESCRIBER"]}}},"components/schemas/clinician.v1":{"id":"components/schemas/clinician.v1","kind":"json-schema","title":"Clinician","data":{"title":"Clinician","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be empty if the clinician invite has not been accepted."},"children":[]}]}]}],"type":"object","properties":{"id":{"$ref":"#/components/schemas/tidepooluserid"},"inviteId":{"type":"string","description":"The id of the invite if it hasn't been accepted"},"email":{"type":"string","x-go-type":"string","format":"email"},"name":{"type":"string","description":"The name of the clinician","minLength":1},"roles":{"$ref":"#/components/schemas/clinicianRoles.v1"},"createdTime":{"type":"string","format":"date-time","readOnly":true},"updatedTime":{"type":"string","format":"date-time","readOnly":true}},"required":["email","roles","createdTime","updatedTime"]}},"components/schemas/objectId.v1":{"id":"components/schemas/objectId.v1","kind":"json-schema","title":"Object Id","data":{"title":"Object Id","type":"string","description":"String representation of a resource id","minLength":24,"maxLength":24,"pattern":"^[a-f0-9]{24}$"}},"components/schemas/patientTagIds.v1":{"id":"components/schemas/patientTagIds.v1","kind":"json-schema","title":"Patient Tag ID List","data":{"type":"array","title":"Patient Tag ID List","uniqueItems":true,"nullable":true,"items":{"title":"Patient Tag ID","description":"Patient Tag identifier.","type":"string","minLength":24,"maxLength":24,"pattern":"^[a-f0-9]{24}$","readOnly":true}}},"components/schemas/tideFilters.v1":{"id":"components/schemas/tideFilters.v1","kind":"json-schema","title":"tidefilters.v1","data":{"type":"object","title":"tidefilters.v1","description":"Visual representation of filtered categories selected","properties":{"dropInTimeInTargetPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeCGMUsePercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInAnyLowPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInExtremeHighPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInHighPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInTargetPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInVeryHighPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"},"timeInVeryLowPercent":{"type":"string","pattern":"^(>=|>|<=|<)\\d\\.\\d\\d?$","example":">0.5"}}}},"components/schemas/tideConfig.v1":{"id":"components/schemas/tideConfig.v1","kind":"json-schema","title":"tideconfig.v1","data":{"type":"object","title":"tideconfig.v1","description":"","properties":{"schemaVersion":{"description":"TIDE schema version","type":"number","x-go-type":"int"},"clinicId":{"$ref":"#/components/schemas/clinicId.v1"},"period":{"type":"string","pattern":"^(1d|7d|14d|30d)$","example":"7d"},"lastDataCutoff":{"type":"string","format":"date-time"},"highGlucoseThreshold":{"description":"Minimum exclusive threshold in mmol/L for categorizing if a glucose value is high as established by the AACE.","type":"number","x-go-type":"float64"},"veryHighGlucoseThreshold":{"description":"Minimum exclusive threshold in mmol/L for categorizing if a glucose value is very high as established by the AACE.","type":"number","x-go-type":"float64"},"extremeHighGlucoseThreshold":{"description":"Minimum inclusive threshold in mmol/L for categorizing if a glucose value is extremely high. Not defined by the AACE.","type":"number","x-go-type":"float64"},"lowGlucoseThreshold":{"description":"Maximum exclusive threshold in mmol/L for categorizing if a glucose value is low as established by the AACE.","type":"number","x-go-type":"float64"},"veryLowGlucoseThreshold":{"description":"Maximum exclusive threshold in mmol/L for categorizing if a glucose value is very low as established by the AACE.","type":"number","x-go-type":"float64"},"tags":{"$ref":"#/components/schemas/patientTagIds.v1"},"filters":{"$ref":"#/components/schemas/tideFilters.v1"}},"required":["schemaVersion","clinicId","period","lastDataCutoff","highGlucoseThreshold","veryHighGlucoseThreshold","lowGlucoseThreshold","veryLowGlucoseThreshold","tags","filters"]}},"components/schemas/patientReview.v1":{"id":"components/schemas/patientReview.v1","kind":"json-schema","title":"patientreview.v1","data":{"type":"object","title":"patientreview.v1","description":"A summary of a patients recent data","properties":{"clinicianId":{"type":"string"},"time":{"type":"string","format":"date-time"}},"required":["clinicianId","time"]}},"components/schemas/providerName.v1":{"id":"components/schemas/providerName.v1","kind":"json-schema","title":"Provider Name","data":{"title":"Provider Name","type":"string","minLength":1,"maxLength":100,"example":"dexcom"}},"components/schemas/datetime.v1":{"id":"components/schemas/datetime.v1","kind":"json-schema","title":"Date/Time","data":{"title":"Date/Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc3339.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timezone information"},"children":[]}]}]}],"type":"string","format":"date-time","example":"2017-02-06T02:37:46Z","x-go-type":"string"}},"components/schemas/dataSource.v1":{"id":"components/schemas/dataSource.v1","kind":"json-schema","title":"Patient data source","data":{"type":"object","title":"Patient data source","properties":{"state":{"type":"string","title":"Data source connection state","enum":["pending","pendingReconnect","connected","disconnected","error"],"example":"connected"},"providerName":{"$ref":"#/components/schemas/providerName.v1"},"dataSourceId":{"title":"Data Source Object Id","type":"string","description":"String representation of a resource id","minLength":24,"maxLength":24,"pattern":"^[a-f0-9]{24}$","readOnly":true},"modifiedTime":{"$ref":"#/components/schemas/datetime.v1"},"expirationTime":{"$ref":"#/components/schemas/datetime.v1"},"latestDataTime":{"$ref":"#/components/schemas/datetime.v1","title":"Time of the latest data point from this source"}},"required":["state","providerName"]}},"components/schemas/tidePatient.v1":{"id":"components/schemas/tidePatient.v1","kind":"json-schema","title":"tidepatient.v1","data":{"type":"object","title":"tidepatient.v1","description":"","properties":{"id":{"$ref":"#/components/schemas/tidepooluserid"},"email":{"type":"string","x-go-type":"string","format":"email"},"fullName":{"type":"string","description":"The full name of the patient","minLength":1},"tags":{"$ref":"#/components/schemas/patientTagIds.v1"},"reviews":{"type":"array","nullable":true,"x-go-type-skip-optional-pointer":true,"items":{"$ref":"#/components/schemas/patientReview.v1"}},"dataSources":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/dataSource.v1"}}},"required":["id","tags"]}},"components/schemas/tideResultPatient.v1":{"id":"components/schemas/tideResultPatient.v1","kind":"json-schema","title":"tideresultpatient.v1","data":{"type":"object","title":"tideresultpatient.v1","description":"","properties":{"averageGlucoseMmol":{"description":"Average Glucose of records in this period","type":"number","example":5.5,"x-go-type":"float64"},"glucoseManagementIndicator":{"type":"number","x-go-type":"float64","description":"A derived value which emulates A1C","example":7.5},"timeInVeryLowPercent":{"description":"Percentage of time spent in very low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyLowPercent":{"description":"Percentage of time spent in any low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInLowPercent":{"description":"Percentage of time spent in low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInTargetPercentDelta":{"description":"Difference between the timeInTargetPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"timeInHighPercent":{"description":"Percentage of time spent in high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInVeryHighPercent":{"description":"Percentage of time spent in very high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInExtremeHighPercent":{"description":"Percentage of time spent in extreme high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyHighPercent":{"description":"Percentage of time spent in any high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInTargetPercent":{"description":"Percentage of time spent in target glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeCGMUsePercent":{"description":"Percentage of time spent wearing a cgm","type":"number","example":0.35,"x-go-type":"float64"},"timeCGMUseMinutes":{"description":"Counter of minutes spent wearing a cgm","type":"number","example":200,"x-go-type":"int"},"lastData":{"type":"string","format":"date-time"},"patient":{"$ref":"#/components/schemas/tidePatient.v1"}},"required":["patient"]}},"components/schemas/tideResults.v1":{"id":"components/schemas/tideResults.v1","kind":"json-schema","title":"tideresults.v1","data":{"type":"object","title":"tideresults.v1","description":"","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/tideResultPatient.v1"}}}},"components/schemas/tideResponse.v1":{"id":"components/schemas/tideResponse.v1","kind":"json-schema","title":"tide.v1","data":{"type":"object","title":"tide.v1","description":"Report of at-risk patients based on specific grouping criteria","properties":{"config":{"$ref":"#/components/schemas/tideConfig.v1"},"results":{"$ref":"#/components/schemas/tideResults.v1"}},"required":["config","results"]}},"components/schemas/targetdevices.v1":{"id":"components/schemas/targetdevices.v1","kind":"json-schema","title":"Target Devices","data":{"title":"Target Devices","description":"When uploading data, the user selects a target device (typically\nmake and model) of their data source (i.e. meter or pump) from a\nlist. This selection is used by the Tidepool Uploader to select the\ncorrect drivers for communicating with the data source.\n\nThese values are stored in the user's profile so that they can be\npre-selected on next use, thereby streamlining the process.\n","type":"array","items":{"type":"string","example":"bayercontournext"}}},"components/schemas/patientPermissions.v1":{"id":"components/schemas/patientPermissions.v1","kind":"json-schema","title":"Patient Permissions","data":{"type":"object","title":"Patient Permissions","properties":{"custodian":{"type":"object"},"view":{"type":"object"},"note":{"type":"object"},"upload":{"type":"object"}}}},"components/schemas/summaryId.v1":{"id":"components/schemas/summaryId.v1","kind":"json-schema","title":"Summary ID","data":{"title":"Summary ID","description":"Summary Unique Identifier","type":"string","minLength":0,"maxLength":24,"pattern":"^[a-f0-9]{0,24}$","example":"2fe2488217ee43e1b2e83c2f"}},"components/schemas/summaryConfig.v1":{"id":"components/schemas/summaryConfig.v1","kind":"json-schema","title":"config.v1","data":{"type":"object","title":"config.v1","x-go-type-skip-optional-pointer":true,"description":"Summary schema version and calculation configuration","properties":{"schemaVersion":{"description":"Summary schema version","type":"number","x-go-type":"int"},"highGlucoseThreshold":{"description":"Threshold used for determining if a value is high","type":"number","x-go-type":"float64"},"veryHighGlucoseThreshold":{"description":"Threshold used for determining if a value is very high","type":"number","x-go-type":"float64"},"lowGlucoseThreshold":{"description":"Threshold used for determining if a value is low","type":"number","x-go-type":"float64"},"veryLowGlucoseThreshold":{"description":"Threshold used for determining if a value is very low","type":"number","x-go-type":"float64"}},"required":["schemaVersion","highGlucoseThreshold","veryHighGlucoseThreshold","lowGlucoseThreshold","veryLowGlucoseThreshold"]}},"components/schemas/summaryDates.v1":{"id":"components/schemas/summaryDates.v1","kind":"json-schema","title":"dates.v1","data":{"type":"object","title":"dates.v1","x-go-type-skip-optional-pointer":true,"description":"dates tracked for summary calculation","properties":{"lastUpdatedDate":{"description":"Date of the last calculation","type":"string","format":"date-time"},"lastUpdatedReason":{"description":"List of reasons the summary was updated for","type":"array","items":{"type":"string"}},"hasFirstData":{"type":"boolean"},"firstData":{"description":"Date of the first included value","type":"string","format":"date-time"},"hasLastData":{"type":"boolean"},"lastData":{"description":"Date of the last calculated value","type":"string","format":"date-time"},"hasLastUploadDate":{"type":"boolean"},"lastUploadDate":{"description":"Created date of the last calculated value","type":"string","format":"date-time"},"hasOutdatedSince":{"type":"boolean"},"outdatedSince":{"description":"Date of the first user upload after lastData, removed when calculated","type":"string","format":"date-time"},"outdatedSinceLimit":{"description":"Upper limit of the OutdatedSince value to prevent infinite queue duration","type":"string","format":"date-time"},"outdatedReason":{"description":"List of reasons the summary was marked outdated for","type":"array","items":{"type":"string"}}},"required":["hasFirstData","hasLastData","hasLastUploadDate","hasOutdatedSince"]}},"components/schemas/cgmPeriod.v1":{"id":"components/schemas/cgmPeriod.v1","kind":"json-schema","title":"cgmperiod.v1","data":{"type":"object","title":"cgmperiod.v1","description":"Summary of a specific CGM time period (currently: 1d, 7d, 14d, 30d)","properties":{"min":{"type":"number","example":3,"x-go-type":"float64"},"minDelta":{"type":"number","example":3,"x-go-type":"float64"},"max":{"type":"number","example":8,"x-go-type":"float64"},"maxDelta":{"type":"number","example":8,"x-go-type":"float64"},"hasAverageGlucoseMmol":{"type":"boolean"},"averageGlucoseMmol":{"description":"Average Glucose of records in this period","type":"number","example":5.5,"x-go-type":"float64"},"averageGlucoseMmolDelta":{"description":"Difference between the averageGlucose in this period and the other offset version","type":"number","example":2.5,"x-go-type":"float64"},"hasGlucoseManagementIndicator":{"type":"boolean"},"glucoseManagementIndicator":{"type":"number","x-go-type":"float64","description":"A derived value which emulates A1C","example":7.5},"glucoseManagementIndicatorDelta":{"type":"number","x-go-type":"float64","description":"Difference between the glucoseManagementIndicator in this period and the other offset version","example":7.5},"hasTimeInTargetPercent":{"type":"boolean"},"timeInTargetPercent":{"description":"Percentage of time spent in target glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInTargetPercentDelta":{"description":"Difference between the timeInTargetPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInTargetMinutes":{"type":"boolean"},"timeInTargetMinutes":{"description":"Counter of minutes spent in target glucose range","type":"number","example":200,"x-go-type":"int"},"timeInTargetMinutesDelta":{"description":"Difference between the timeInTargetMinutes in this period and version in the opposite offset","type":"number","example":20,"x-go-type":"int"},"hasTimeInTargetRecords":{"type":"boolean"},"timeInTargetRecords":{"description":"Counter of records in target glucose range","type":"number","example":10,"x-go-type":"int"},"timeInTargetRecordsDelta":{"description":"Difference between the timeInTargetRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInHighPercent":{"type":"boolean"},"timeInHighPercent":{"description":"Percentage of time spent in high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInHighPercentDelta":{"description":"Difference between the timeInHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInHighMinutes":{"type":"boolean"},"timeInHighMinutes":{"description":"Counter of minutes spent in high glucose range","type":"number","example":200,"x-go-type":"int"},"timeInHighMinutesDelta":{"description":"Difference between the timeInHighMinutes in this period and version in the opposite offset","type":"number","example":20,"x-go-type":"int"},"hasTimeInHighRecords":{"type":"boolean"},"timeInHighRecords":{"description":"Counter of records in high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInHighRecordsDelta":{"description":"Difference between the timeInHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryHighPercent":{"type":"boolean"},"timeInVeryHighPercent":{"description":"Percentage of time spent in very high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInVeryHighPercentDelta":{"description":"Difference between the timeInVeryHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInVeryHighMinutes":{"type":"boolean"},"timeInVeryHighMinutes":{"description":"Counter of minutes spent in very high glucose range","type":"number","example":200,"x-go-type":"int"},"timeInVeryHighMinutesDelta":{"description":"Difference between the timeInVeryHighMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryHighRecords":{"type":"boolean"},"timeInVeryHighRecords":{"description":"Counter of records in very high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInVeryHighRecordsDelta":{"description":"Difference between the timeInVeryHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInExtremeHighPercent":{"type":"boolean"},"timeInExtremeHighPercent":{"description":"Percentage of time spent in extreme high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInExtremeHighPercentDelta":{"description":"Difference between the timeInExtremeHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInExtremeHighMinutes":{"type":"boolean"},"timeInExtremeHighMinutes":{"description":"Counter of minutes spent in extreme high glucose range","type":"number","example":200,"x-go-type":"int"},"timeInExtremeHighMinutesDelta":{"description":"Difference between the timeInExtremeHighMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInExtremeHighRecords":{"type":"boolean"},"timeInExtremeHighRecords":{"description":"Counter of records in extreme high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInExtremeHighRecordsDelta":{"description":"Difference between the timeInExtremeHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyHighPercent":{"type":"boolean"},"timeInAnyHighPercent":{"description":"Percentage of time spent in Any high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyHighPercentDelta":{"description":"Difference between the timeInAnyHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInAnyHighMinutes":{"type":"boolean"},"timeInAnyHighMinutes":{"description":"Counter of minutes spent in Any high glucose range","type":"number","example":200,"x-go-type":"int"},"timeInAnyHighMinutesDelta":{"description":"Difference between the timeInAnyHighMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyHighRecords":{"type":"boolean"},"timeInAnyHighRecords":{"description":"Counter of records in Any high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInAnyHighRecordsDelta":{"description":"Difference between the timeInAnyHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInLowPercent":{"type":"boolean"},"timeInLowPercent":{"description":"Percentage of time spent in low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInLowPercentDelta":{"description":"Difference between the timeInLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInLowMinutes":{"type":"boolean"},"timeInLowMinutes":{"description":"Counter of minutes spent in low glucose range","type":"number","example":200,"x-go-type":"int"},"timeInLowMinutesDelta":{"description":"Difference between the timeInLowMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInLowRecords":{"type":"boolean"},"timeInLowRecords":{"description":"Counter of records in low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInLowRecordsDelta":{"description":"Difference between the timeInLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryLowPercent":{"type":"boolean"},"timeInVeryLowPercent":{"description":"Percentage of time spent in very low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInVeryLowPercentDelta":{"description":"Difference between the timeInVeryLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInVeryLowMinutes":{"type":"boolean"},"timeInVeryLowMinutes":{"description":"Counter of minutes spent in very low glucose range","type":"number","example":200,"x-go-type":"int"},"timeInVeryLowMinutesDelta":{"description":"Difference between the timeInVeryLowMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryLowRecords":{"type":"boolean"},"timeInVeryLowRecords":{"description":"Counter of records in very low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInVeryLowRecordsDelta":{"description":"Difference between the timeInVeryLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyLowPercent":{"type":"boolean"},"timeInAnyLowPercent":{"description":"Percentage of time spent in Any low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyLowPercentDelta":{"description":"Difference between the timeInAnyLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInAnyLowMinutes":{"type":"boolean"},"timeInAnyLowMinutes":{"description":"Counter of minutes spent in Any low glucose range","type":"number","example":200,"x-go-type":"int"},"timeInAnyLowMinutesDelta":{"description":"Difference between the timeInAnyLowMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyLowRecords":{"type":"boolean"},"timeInAnyLowRecords":{"description":"Counter of records in Any low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInAnyLowRecordsDelta":{"description":"Difference between the timeInAnyLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeCGMUsePercent":{"type":"boolean"},"timeCGMUsePercent":{"description":"Percentage of time spent wearing a cgm","type":"number","example":0.35,"x-go-type":"float64"},"timeCGMUsePercentDelta":{"description":"Difference between the timeCGMUsePercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeCGMUseMinutes":{"type":"boolean"},"timeCGMUseMinutes":{"description":"Counter of minutes spent wearing a cgm","type":"number","example":200,"x-go-type":"int"},"timeCGMUseMinutesDelta":{"description":"Difference between the timeCGMUseMinutes in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeCGMUseRecords":{"type":"boolean"},"timeCGMUseRecords":{"description":"Counter of minutes spent wearing a cgm","type":"number","example":10,"x-go-type":"int"},"timeCGMUseRecordsDelta":{"description":"Difference between the timeCGMUseRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTotalRecords":{"type":"boolean"},"totalRecords":{"description":"Counter of records","type":"number","example":10,"x-go-type":"int"},"totalRecordsDelta":{"description":"Difference between the totalRecords in this period and version in the opposite offset","type":"number","example":10,"x-go-type":"int"},"hasAverageDailyRecords":{"type":"boolean"},"averageDailyRecords":{"description":"Average daily readings","type":"number","example":3.5,"x-go-type":"float64"},"averageDailyRecordsDelta":{"description":"Difference between the averageDailyRecords in this period and version in the opposite offset","type":"number","example":2.5,"x-go-type":"float64"},"standardDeviation":{"type":"number","example":2.5,"x-go-type":"float64"},"standardDeviationDelta":{"type":"number","example":2.5,"x-go-type":"float64"},"coefficientOfVariation":{"type":"number","example":2.5,"x-go-type":"float64"},"coefficientOfVariationDelta":{"type":"number","example":2.5,"x-go-type":"float64"},"hoursWithData":{"type":"number","example":2,"x-go-type":"int"},"hoursWithDataDelta":{"type":"number","example":2,"x-go-type":"int"},"daysWithData":{"type":"number","example":2,"x-go-type":"int"},"daysWithDataDelta":{"type":"number","example":2,"x-go-type":"int"}},"required":["hasAverageGlucoseMmol","hasGlucoseManagementIndicator","hasTimeInTargetPercent","hasTimeInTargetMinutes","hasTimeInTargetRecords","hasTimeInHighPercent","hasTimeInHighMinutes","hasTimeInHighRecords","hasTimeInVeryHighPercent","hasTimeInVeryHighMinutes","hasTimeInVeryHighRecords","hasTimeInExtremeHighPercent","hasTimeInExtremeHighMinutes","hasTimeInExtremeHighRecords","hasTimeInLowPercent","hasTimeInLowMinutes","hasTimeInLowRecords","hasTimeInVeryLowPercent","hasTimeInVeryLowMinutes","hasTimeInVeryLowRecords","hasTimeInAnyLowPercent","hasTimeInAnyLowMinutes","hasTimeInAnyLowRecords","hasTimeInAnyHighPercent","hasTimeInAnyHighMinutes","hasTimeInAnyHighRecords","hasTimeCGMUsePercent","hasTimeCGMUseMinutes","hasTimeCGMUseRecords","hasTotalRecords","hasAverageDailyRecords","standardDeviation","standardDeviationDelta","coefficientOfVariation","coefficientOfVariationDelta","hoursWithData","hoursWithDataDelta","daysWithData","daysWithDataDelta","min","minDelta","max","maxDelta"]}},"components/schemas/cgmPeriods.v1":{"id":"components/schemas/cgmPeriods.v1","kind":"json-schema","title":"cgmperiods.v1","data":{"type":"object","title":"cgmperiods.v1","x-go-type-skip-optional-pointer":true,"description":"A map to each supported CGM summary period","additionalProperties":{"$ref":"#/components/schemas/cgmPeriod.v1"}}},"components/schemas/cgmStats.v1":{"id":"components/schemas/cgmStats.v1","kind":"json-schema","title":"cgmstats.v1","data":{"type":"object","title":"cgmstats.v1","description":"A summary of a users recent CGM glucose values","properties":{"id":{"$ref":"#/components/schemas/summaryId.v1"},"config":{"$ref":"#/components/schemas/summaryConfig.v1"},"dates":{"$ref":"#/components/schemas/summaryDates.v1"},"periods":{"$ref":"#/components/schemas/cgmPeriods.v1"}}}},"components/schemas/bgmPeriod.v1":{"id":"components/schemas/bgmPeriod.v1","kind":"json-schema","title":"bgmperiod.v1","data":{"type":"object","title":"bgmperiod.v1","description":"Summary of a specific BGM time period (currently: 1d, 7d, 14d, 30d)","properties":{"min":{"type":"number","example":3,"x-go-type":"float64"},"minDelta":{"type":"number","example":3,"x-go-type":"float64"},"max":{"type":"number","example":8,"x-go-type":"float64"},"maxDelta":{"type":"number","example":8,"x-go-type":"float64"},"hasAverageGlucoseMmol":{"type":"boolean"},"averageGlucoseMmol":{"description":"Average Glucose of records in this period","type":"number","example":5.5,"x-go-type":"float64"},"averageGlucoseMmolDelta":{"description":"Difference between the averageGlucose in this period and the other offset version","type":"number","example":2.5,"x-go-type":"float64"},"hasTimeInTargetPercent":{"type":"boolean"},"timeInTargetPercent":{"description":"Percentage of time spent in target glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInTargetPercentDelta":{"description":"Difference between the timeInTargetPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInTargetRecords":{"type":"boolean"},"timeInTargetRecords":{"description":"Counter of records in target glucose range","type":"number","example":10,"x-go-type":"int"},"timeInTargetRecordsDelta":{"description":"Difference between the timeInTargetRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInHighPercent":{"type":"boolean"},"timeInHighPercent":{"description":"Percentage of time spent in high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInHighPercentDelta":{"description":"Difference between the timeInHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInHighRecords":{"type":"boolean"},"timeInHighRecords":{"description":"Counter of records in high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInHighRecordsDelta":{"description":"Difference between the timeInHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryHighPercent":{"type":"boolean"},"timeInVeryHighPercent":{"description":"Percentage of time spent in very high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInVeryHighPercentDelta":{"description":"Difference between the timeInVeryHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInVeryHighRecords":{"type":"boolean"},"timeInVeryHighRecords":{"description":"Counter of records in very high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInVeryHighRecordsDelta":{"description":"Difference between the timeInVeryHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInExtremeHighPercent":{"type":"boolean"},"timeInExtremeHighPercent":{"description":"Percentage of time spent in extreme high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInExtremeHighPercentDelta":{"description":"Difference between the timeInExtremeHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInExtremeHighRecords":{"type":"boolean"},"timeInExtremeHighRecords":{"description":"Counter of records in extreme high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInExtremeHighRecordsDelta":{"description":"Difference between the timeInExtremeHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyHighPercent":{"type":"boolean"},"timeInAnyHighPercent":{"description":"Percentage of time spent in Any high glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyHighPercentDelta":{"description":"Difference between the timeInAnyHighPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInAnyHighRecords":{"type":"boolean"},"timeInAnyHighRecords":{"description":"Counter of records in Any high glucose range","type":"number","example":10,"x-go-type":"int"},"timeInAnyHighRecordsDelta":{"description":"Difference between the timeInAnyHighRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInLowPercent":{"type":"boolean"},"timeInLowPercent":{"description":"Percentage of time spent in low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInLowPercentDelta":{"description":"Difference between the timeInLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInLowRecords":{"type":"boolean"},"timeInLowRecords":{"description":"Counter of records in low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInLowRecordsDelta":{"description":"Difference between the timeInLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInVeryLowPercent":{"type":"boolean"},"timeInVeryLowPercent":{"description":"Percentage of time spent in very low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInVeryLowPercentDelta":{"description":"Difference between the timeInVeryLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInVeryLowRecords":{"type":"boolean"},"timeInVeryLowRecords":{"description":"Counter of records in very low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInVeryLowRecordsDelta":{"description":"Difference between the timeInVeryLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTimeInAnyLowPercent":{"type":"boolean"},"timeInAnyLowPercent":{"description":"Percentage of time spent in Any low glucose range","type":"number","example":0.35,"x-go-type":"float64"},"timeInAnyLowPercentDelta":{"description":"Difference between the timeInAnyLowPercent in this period and version in the opposite offset","type":"number","example":0.2,"x-go-type":"float64"},"hasTimeInAnyLowRecords":{"type":"boolean"},"timeInAnyLowRecords":{"description":"Counter of records in Any low glucose range","type":"number","example":10,"x-go-type":"int"},"timeInAnyLowRecordsDelta":{"description":"Difference between the timeInAnyLowRecords in this period and version in the opposite offset","type":"number","example":5,"x-go-type":"int"},"hasTotalRecords":{"type":"boolean"},"totalRecords":{"description":"Counter of records","type":"number","example":10,"x-go-type":"int"},"totalRecordsDelta":{"description":"Difference between the totalRecords in this period and version in the opposite offset","type":"number","example":10,"x-go-type":"int"},"hasAverageDailyRecords":{"type":"boolean"},"averageDailyRecords":{"description":"Average daily readings","type":"number","example":3.5,"x-go-type":"float64"},"averageDailyRecordsDelta":{"description":"Difference between the averageDailyRecords in this period and version in the opposite offset","type":"number","example":2.5,"x-go-type":"float64"},"standardDeviation":{"type":"number","example":2.5,"x-go-type":"float64"},"standardDeviationDelta":{"type":"number","example":2.5,"x-go-type":"float64"},"coefficientOfVariation":{"type":"number","example":2.5,"x-go-type":"float64"},"coefficientOfVariationDelta":{"type":"number","example":2.5,"x-go-type":"float64"},"daysWithData":{"type":"number","example":2,"x-go-type":"int"},"daysWithDataDelta":{"type":"number","example":2,"x-go-type":"int"}},"required":["min","minDelta","max","maxDelta","hasAverageGlucoseMmol","hasTimeInTargetPercent","hasTimeInTargetRecords","hasTimeInHighPercent","hasTimeInHighRecords","hasTimeInVeryHighPercent","hasTimeInVeryHighRecords","hasTimeInExtremeHighPercent","hasTimeInExtremeHighRecords","hasTimeInAnyHighPercent","hasTimeInAnyHighRecords","hasTimeInLowPercent","hasTimeInLowRecords","hasTimeInVeryLowPercent","hasTimeInVeryLowRecords","hasTimeInAnyLowPercent","hasTimeInAnyLowRecords","hasTotalRecords","hasAverageDailyRecords","daysWithData","daysWithDataDelta"]}},"components/schemas/bgmPeriods.v1":{"id":"components/schemas/bgmPeriods.v1","kind":"json-schema","title":"bgmperiods.v1","data":{"type":"object","title":"bgmperiods.v1","description":"A map to each supported BGM summary period","x-go-type-skip-optional-pointer":true,"additionalProperties":{"$ref":"#/components/schemas/bgmPeriod.v1"}}},"components/schemas/bgmStats.v1":{"id":"components/schemas/bgmStats.v1","kind":"json-schema","title":"bgmstats.v1","data":{"type":"object","title":"bgmstats.v1","description":"A summary of a users recent BGM glucose values","properties":{"id":{"$ref":"#/components/schemas/summaryId.v1"},"config":{"$ref":"#/components/schemas/summaryConfig.v1"},"dates":{"$ref":"#/components/schemas/summaryDates.v1"},"periods":{"$ref":"#/components/schemas/bgmPeriods.v1"}}}},"components/schemas/patientSummary.v1":{"id":"components/schemas/patientSummary.v1","kind":"json-schema","title":"patientsummary.v1","data":{"type":"object","title":"patientsummary.v1","description":"A summary of a patients recent data","properties":{"cgmStats":{"$ref":"#/components/schemas/cgmStats.v1"},"bgmStats":{"$ref":"#/components/schemas/bgmStats.v1"}}}},"components/schemas/providerId.v1":{"id":"components/schemas/providerId.v1","kind":"json-schema","title":"Third-Party Data Providers","data":{"title":"Third-Party Data Providers","x-stoplight":{"id":"fdmfczqym3ocn"},"type":"string","enum":["dexcom","twiist","abbott"]}},"components/schemas/providerConnectionRequest.v1":{"id":"components/schemas/providerConnectionRequest.v1","kind":"json-schema","title":"Provider Connection Request","data":{"title":"Provider Connection Request","x-stoplight":{"id":"nim4cceb0lu0w"},"type":"object","properties":{"createdTime":{"type":"string","x-stoplight":{"id":"efcvyea5slw36"},"format":"date-time"},"providerName":{"$ref":"#/components/schemas/providerId.v1","x-stoplight":{"id":"ej94kmuykpg1k"}}},"required":["createdTime","providerName"]}},"components/schemas/providerConnectionRequests.v1":{"id":"components/schemas/providerConnectionRequests.v1","kind":"json-schema","title":"providerconnectionrequests.v1","data":{"title":"providerconnectionrequests.v1","x-stoplight":{"id":"c8q7wrz5rtge5"},"type":"object","readOnly":true,"properties":{"twiist":{"type":"array","x-stoplight":{"id":"7ve65jmart7pj"},"items":{"$ref":"#/components/schemas/providerConnectionRequest.v1","x-stoplight":{"id":"47ez7wiccxdut"}}},"dexcom":{"type":"array","x-stoplight":{"id":"7ve65jmart7pj"},"items":{"$ref":"#/components/schemas/providerConnectionRequest.v1","x-stoplight":{"id":"913pgkbkz62eq"}}},"abbott":{"type":"array","x-stoplight":{"id":"u9rfvrr2njlcq"},"items":{"$ref":"#/components/schemas/providerConnectionRequest.v1","x-stoplight":{"id":"47ez7wiccxdut"}}}},"required":["twiist","dexcom","abbott"]}},"components/schemas/glycemicRangesThresholdUpperBound.v1":{"id":"components/schemas/glycemicRangesThresholdUpperBound.v1","kind":"json-schema","title":"glycemicRangesThresholdUpperBound.v1","data":{"type":"object","properties":{"value":{"type":"number","format":"float"},"units":{"type":"string","enum":["mg/dL","mmol/L"]}},"required":["value","units"]}},"components/schemas/glycemicRangesThreshold.v1":{"id":"components/schemas/glycemicRangesThreshold.v1","kind":"json-schema","title":"glycemicRangesThreshold.v1","data":{"type":"object","properties":{"name":{"type":"string","minLength":1},"upperBound":{"$ref":"#/components/schemas/glycemicRangesThresholdUpperBound.v1"},"inclusive":{"type":"boolean","default":false,"x-go-type-skip-optional-pointer":true}},"required":["name","upperBound"]}},"components/schemas/glycemicRangesCustom.v1":{"id":"components/schemas/glycemicRangesCustom.v1","kind":"json-schema","title":"glycemicRangesCustom.v1","data":{"type":"object","properties":{"name":{"type":"string","minLength":1},"thresholds":{"type":"array","items":{"$ref":"#/components/schemas/glycemicRangesThreshold.v1"},"minLength":4,"maxLength":5}},"required":["name","thresholds"],"x-go-type-skip-optional-pointer":true,"x-omitzero":true}},"components/schemas/glycemicRangesPreset.v1":{"id":"components/schemas/glycemicRangesPreset.v1","kind":"json-schema","title":"glycemicRangesPreset.v1","data":{"type":"string","minLength":1,"enum":["adaStandard","adaPregnancyType1","adaPregnancyType2","adaHighRisk"],"x-enum-varnames":["ADAStandard","ADAPregnancyType1","ADAPregnancyType2","ADAHighRisk"],"default":"adaStandard","x-go-type-skip-optional-pointer":true,"x-omitzero":true}},"components/schemas/glycemicRanges.v1":{"id":"components/schemas/glycemicRanges.v1","kind":"json-schema","title":"glycemicRanges.v1","data":{"properties":{"type":{"type":"string","enum":["preset","custom"],"default":"preset"},"custom":{"$ref":"#/components/schemas/glycemicRangesCustom.v1"},"preset":{"$ref":"#/components/schemas/glycemicRangesPreset.v1"}},"required":["type"]}},"components/schemas/diagnosisType.v1":{"id":"components/schemas/diagnosisType.v1","kind":"json-schema","title":"Diagnosis Type","data":{"title":"Diagnosis Type","type":"string","enum":["type1","type2","type3c","gestational","prediabetes","lada","mody","other","notApplicable",""],"example":"type1"}},"components/schemas/patient.v1":{"id":"components/schemas/patient.v1","kind":"json-schema","title":"Patient","data":{"type":"object","title":"Patient","properties":{"id":{"$ref":"#/components/schemas/tidepooluserid"},"email":{"type":"string","x-go-type":"string","format":"email"},"fullName":{"type":"string","description":"The full name of the patient","minLength":1},"birthDate":{"type":"string","format":"date","example":"2012-08-30"},"mrn":{"type":"string","description":"The medical record number of the patient","minLength":1},"tags":{"$ref":"#/components/schemas/patientTagIds.v1"},"targetDevices":{"$ref":"#/components/schemas/targetdevices.v1"},"permissions":{"$ref":"#/components/schemas/patientPermissions.v1"},"createdTime":{"type":"string","format":"date-time","readOnly":true},"updatedTime":{"type":"string","format":"date-time","readOnly":true},"attestationSubmitted":{"type":"boolean"},"dataSources":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/dataSource.v1"}},"lastUploadReminderTime":{"type":"string","format":"date-time","readOnly":true},"summary":{"$ref":"#/components/schemas/patientSummary.v1","readOnly":true},"reviews":{"type":"array","nullable":true,"x-go-type-skip-optional-pointer":true,"items":{"$ref":"#/components/schemas/patientReview.v1"}},"connectionRequests":{"$ref":"#/components/schemas/providerConnectionRequests.v1","x-stoplight":{"id":"502rliv0l2tyy"},"description":"Requests for each provider are listed in reverse chronological order","readOnly":true},"sites":{"type":"array","x-go-type-skip-optional-pointer":true,"x-omitempty":false,"x-omitzero":true,"items":{"$ref":"#/components/schemas/site.v1"}},"glycemicRanges":{"$ref":"#/components/schemas/glycemicRanges.v1"},"diagnosisType":{"$ref":"#/components/schemas/diagnosisType.v1"}},"required":["id","fullName","birthDate","createdTime","updatedTime","connectionRequests"]}},"components/schemas/siteById.v1":{"id":"components/schemas/siteById.v1","kind":"json-schema","title":"SiteById","data":{"type":"object","title":"SiteById","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A clinic's physical or logical location—id only."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/objectid.v1"}},"required":["id"]}},"components/schemas/emailaddress.v1":{"id":"components/schemas/emailaddress.v1","kind":"json-schema","title":"Email Address","data":{"title":"Email Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An email address, as specified by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc5322"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 5322"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"email","minLength":6,"example":"example@tidepool.org","x-go-type":"string"}},"components/schemas/inviteClinician.v1":{"id":"components/schemas/inviteClinician.v1","kind":"json-schema","title":"Invite Clinician","data":{"title":"Invite Clinician","type":"object","description":"","properties":{"email":{"$ref":"#/components/schemas/emailaddress.v1"},"roles":{"$ref":"#/components/schemas/clinicianRoles.v1"}},"required":["email","roles"]}},"components/schemas/key.v1":{"id":"components/schemas/key.v1","kind":"json-schema","title":"Confirmation key that uniquely identifies each confirmation","data":{"title":"Confirmation key that uniquely identifies each confirmation","type":"string","minLength":32,"maxLength":32,"example":"Sds2PHMALZrmt++JyD5mIjLkZruJldiM"}},"components/schemas/confirmation-type.v1":{"id":"components/schemas/confirmation-type.v1","kind":"json-schema","title":"Confirmation Type","data":{"title":"Confirmation Type","type":"string","enum":["password_reset","careteam_invitation","clinician_invitation","signup_confirmation","no_account"]}},"components/schemas/status.v1":{"id":"components/schemas/status.v1","kind":"json-schema","title":"Confirmation Status","data":{"title":"Confirmation Status","type":"string","enum":["pending","completed","canceled","declined"]}},"components/schemas/birthday.v1":{"id":"components/schemas/birthday.v1","kind":"json-schema","title":"Birthday","data":{"title":"Birthday","type":"string","format":"date","example":"2012-08-30","x-go-type":"string"}},"components/schemas/diagnosisdate.v1":{"id":"components/schemas/diagnosisdate.v1","kind":"json-schema","title":"Diagnosis Date","data":{"title":"Diagnosis Date","type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2013-05-09","x-go-type":"string"}},"components/schemas/patientprofile.v1":{"id":"components/schemas/patientprofile.v1","kind":"json-schema","title":"Patient User Profile","data":{"title":"Patient User Profile","type":"object","properties":{"birthday":{"$ref":"#/components/schemas/birthday.v1"},"diagnosisDate":{"$ref":"#/components/schemas/diagnosisdate.v1"},"isOtherPerson":{"type":"boolean","example":false},"fullName":{"type":"string","example":"James Jellyfish"}}}},"components/schemas/creatorprofile.v1":{"id":"components/schemas/creatorprofile.v1","kind":"json-schema","title":"Creator user profile","data":{"title":"Creator user profile","type":"object","properties":{"fullName":{"type":"string"},"patient":{"$ref":"#/components/schemas/patientprofile.v1"}},"required":["fullName","patient"]}},"components/schemas/creator.v1":{"id":"components/schemas/creator.v1","kind":"json-schema","title":"Creator","data":{"title":"Creator","type":"object","properties":{"userid":{"$ref":"#/components/schemas/tidepooluserid"},"profile":{"$ref":"#/components/schemas/creatorprofile.v1"}},"required":["userid","profile"]}},"components/schemas/restrictions.v1":{"id":"components/schemas/restrictions.v1","kind":"json-schema","title":"Acceptance restrictions","data":{"title":"Acceptance restrictions","type":"object","properties":{"canAccept":{"type":"boolean","description":"Whether the invite can be accepted by the current user"},"requiredIdp":{"type":"string","description":"Set if the user must be authenticated against a specific identity provider before they are able to accept the invite"}},"required":["canAccept"]}},"components/schemas/expiresAt.v1":{"id":"components/schemas/expiresAt.v1","kind":"json-schema","title":"Expiration Time","data":{"title":"Expiration Time","type":"string","format":"date-time","description":"If specified, the invitation will expire at the given date and time.","example":"2024-01-30T08:11:00Z"}},"components/schemas/confirmation.v1":{"id":"components/schemas/confirmation.v1","kind":"json-schema","title":"Confirmation","data":{"title":"Confirmation","type":"object","properties":{"key":{"$ref":"#/components/schemas/key.v1"},"type":{"$ref":"#/components/schemas/confirmation-type.v1"},"status":{"$ref":"#/components/schemas/status.v1"},"email":{"$ref":"#/components/schemas/emailaddress.v1"},"creatorId":{"$ref":"#/components/schemas/tidepooluserid"},"created":{"$ref":"#/components/schemas/datetime.v1"},"modified":{"$ref":"#/components/schemas/datetime.v1"},"creator":{"$ref":"#/components/schemas/creator.v1"},"context":{"type":"string"},"restrictions":{"$ref":"#/components/schemas/restrictions.v1"},"expiresAt":{"$ref":"#/components/schemas/expiresAt.v1"}},"required":["key","type","status","email","creatorId","created"]}},"components/schemas/migrationStatus.v1":{"id":"components/schemas/migrationStatus.v1","kind":"json-schema","title":"Migration Status","data":{"type":"string","title":"Migration Status","enum":["PENDING","RUNNING","COMPLETED"],"description":"The current status of the migration"}},"components/schemas/membershipRestriction.v1":{"id":"components/schemas/membershipRestriction.v1","kind":"json-schema","title":"Membership Restriction","data":{"title":"Membership Restriction","type":"object","description":"A user joining a clinic must match all of the defined restrictions","properties":{"emailDomain":{"type":"string","format":"hostname","description":"The restriction applies only if the user has an email address with a matching domain"},"requiredIdp":{"type":"string","description":"If this attribute is set, at the time of joining the clinic the user must be authenticated against this identity provider"}},"required":["emailDomain"]}},"components/schemas/membershipRestrictions.v1":{"id":"components/schemas/membershipRestrictions.v1","kind":"json-schema","title":"Membership Restrictions","data":{"title":"Membership Restrictions","type":"object","description":"A user joining a clinic must match at least one of the specified membership restrictions","properties":{"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/membershipRestriction.v1"}}}}},"components/schemas/ehrDestinations.v1":{"id":"components/schemas/ehrDestinations.v1","kind":"json-schema","title":"Default Redox destination ID and per-model overrides","data":{"title":"Default Redox destination ID and per-model overrides","x-stoplight":{"id":"z6cjrz20e5mvu"},"type":"object","properties":{"flowsheet":{"type":"string","description":"Destination ID override for Flowsheets","minLength":1},"results":{"type":"string","description":"Destination ID override for Results","minLength":1},"notes":{"type":"string","description":"Destination ID override for Notes","minLength":1}},"required":["flowsheet","results","notes"]}},"components/schemas/ehrProcedures.v1":{"id":"components/schemas/ehrProcedures.v1","kind":"json-schema","title":"EHR Procedure Codes Map","data":{"title":"EHR Procedure Codes Map","x-stoplight":{"id":"gy7do1thlm3g5"},"type":"object","properties":{"enableSummaryReports":{"type":"string","minLength":1,"description":"Procedure Code for Summary Statistics and PDF Reports subscription"},"disableSummaryReports":{"type":"string","minLength":1},"createAccount":{"type":"string","minLength":1},"createAccountAndEnableReports":{"type":"string","x-stoplight":{"id":"nb3o2a7kkebar"}}}}},"components/schemas/scheduledReports.v1":{"id":"components/schemas/scheduledReports.v1","kind":"json-schema","title":"scheduledreports.v1","data":{"title":"scheduledreports.v1","x-stoplight":{"id":"or3i2vsiyder8"},"type":"object","description":"Scheduled Report Settings","properties":{"onUploadEnabled":{"type":"boolean","x-stoplight":{"id":"ij8d2vhz49f0u"},"description":"Send a PDF Report and a Flowsheet to Redox after a dataset is uploaded.\n"},"onUploadNoteEventType":{"type":"string","x-stoplight":{"id":"h02b819r2xdy0"},"enum":["New","Replace"],"default":"New"},"cadence":{"type":"string","x-stoplight":{"id":"ibtk59wcgho89"},"enum":["1d","7d","14d","30d","DISABLED"],"description":"The cadence of the scheduled reports. Disabling the scheduled reports does not affect reports which are generated after a dataset is uploaded."}},"required":["onUploadEnabled","cadence"]}},"components/schemas/ehrTagsSettings.v1":{"id":"components/schemas/ehrTagsSettings.v1","kind":"json-schema","title":"EHR Tags Settings","data":{"title":"EHR Tags Settings","x-stoplight":{"id":"w3h05rpqc45iv"},"type":"object","description":"This configuration only applies to integrations using Redox Data Model","properties":{"codes":{"type":"array","x-stoplight":{"id":"fcr5es83pzi6r"},"description":"Codes of the clinical info items used to select the tags to associate with the patient. If defined, all tags of a patient will be replaced every time an enrollment order for the patient is processed.","items":{"x-stoplight":{"id":"h40mu6ujxknzf"},"type":"string"}},"separator":{"type":"string","x-stoplight":{"id":"ic7t703igp2rn"},"description":"If set to a non-empty string, the tag values will be split using this separator","minLength":1}}}},"components/schemas/ehrFlowsheetSettings.v1":{"id":"components/schemas/ehrFlowsheetSettings.v1","kind":"json-schema","title":"Flowsheet Settings","data":{"title":"Flowsheet Settings","type":"object","properties":{"icode":{"type":"boolean","description":"Determine if values should be sent in accorance with ICode2 rounding standards, or if we should send the values at higher precision."}},"required":["icode"]}},"components/schemas/ehrNoteSettings.v1":{"id":"components/schemas/ehrNoteSettings.v1","kind":"json-schema","title":"Note Settings","data":{"title":"Note Settings","type":"object","properties":{"includeGMI":{"type":"boolean","description":"If true, include GMI in the notes.","default":false,"x-go-type-skip-optional-pointer":true,"x-omitempty":false,"x-omitzero":true}}}},"components/schemas/ehrSettings.v1":{"id":"components/schemas/ehrSettings.v1","kind":"json-schema","title":"EHR Settings","data":{"title":"EHR Settings","x-stoplight":{"id":"m0iw4p0mf24nb"},"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable or disable the EHR integration"},"sourceId":{"type":"string"},"destinationIds":{"$ref":"#/components/schemas/ehrDestinations.v1"},"procedureCodes":{"$ref":"#/components/schemas/ehrProcedures.v1"},"mrnIdType":{"type":"string","x-stoplight":{"id":"x74orwp43yu91"},"minLength":1},"provider":{"type":"string","x-stoplight":{"id":"z31vhe9hbaqrn"},"enum":["xealth","redox"]},"scheduledReports":{"$ref":"#/components/schemas/scheduledReports.v1","x-stoplight":{"id":"lgfrpsps4x37a"},"description":"Scheduled Report Settings"},"tags":{"$ref":"#/components/schemas/ehrTagsSettings.v1","x-stoplight":{"id":"hp97ilzsssprv"}},"flowsheets":{"$ref":"#/components/schemas/ehrFlowsheetSettings.v1"},"notes":{"x-go-type-skip-optional-pointer":true,"x-omitempty":false,"x-omitzero":true,"allOf":[{"$ref":"#/components/schemas/ehrNoteSettings.v1"}]}},"required":["enabled","sourceId","procedureCodes","mrnIdType","provider","scheduledReports","tags","flowsheets"]}},"components/schemas/mrnSettings.v1":{"id":"components/schemas/mrnSettings.v1","kind":"json-schema","title":"MRN Settings","data":{"title":"MRN Settings","x-stoplight":{"id":"876c3qkxy3ih9"},"type":"object","properties":{"required":{"type":"boolean","description":"Require MRN when creating or updating patients"},"unique":{"type":"boolean","description":"Enforce MRN uniqueness constraint"}},"required":["required","unique"]}},"components/schemas/patientCountLimit.v1":{"id":"components/schemas/patientCountLimit.v1","kind":"json-schema","title":"Patient Count Limit","data":{"title":"Patient Count Limit","type":"object","properties":{"plan":{"description":"The plan-based patient count limit","type":"integer","minimum":0},"startDate":{"description":"The start date when the patient count limit should be applied","$ref":"#/components/schemas/datetime.v1"},"endDate":{"description":"The end date when the patient count limit should no longer be applied","$ref":"#/components/schemas/datetime.v1"}},"required":["plan"]}},"components/schemas/patientCountSettings.v1":{"id":"components/schemas/patientCountSettings.v1","kind":"json-schema","title":"Patient Count Settings","data":{"title":"Patient Count Settings","type":"object","properties":{"hardLimit":{"description":"The hard limit for the clinic patient count where new patients cannot be created","$ref":"#/components/schemas/patientCountLimit.v1"},"softLimit":{"description":"The soft limit for the clinic patient count where new patients may still be created","$ref":"#/components/schemas/patientCountLimit.v1"}}}},"components/schemas/patientProviderCount.v1":{"id":"components/schemas/patientProviderCount.v1","kind":"json-schema","title":"Patient Provider Count","data":{"title":"Patient Provider Count","description":"The count of patients associated with the clinic for a specific provider. As each patient may be \nassociated with multiple providers, the sum of all provider counts may exceed the total patient count.","type":"object","properties":{"total":{"description":"The count of patients that have a specific provider as a data source.","type":"integer","minimum":0},"states":{"description":"The count of patients for the provider segmented by data source state. The possible\nstates are connected, disconnected, error, pending, and pendingReconnect.","type":"object","additionalProperties":{"type":"integer","minimum":0}}},"required":["total","states"]}},"components/schemas/patientCount.v1":{"id":"components/schemas/patientCount.v1","kind":"json-schema","title":"Patient Count","data":{"title":"Patient Count","type":"object","properties":{"total":{"description":"The count of all patients associated with the clinic, regardless of classification.","type":"integer","minimum":0},"demo":{"description":"The count of patients associated with the clinic that are classified as demo and do not \napply towards the plan-based patient count limit. Currently this is limited to 0 or 1,\nbut allows for future expansion with multiple demo patients if needed.","type":"integer","minimum":0},"plan":{"description":"The count of patients associated with the clinic classified as applying towards the \nplan-based patient count limit. This excludes patients classified as demo as well as any \nother classifications that do not apply towards the plan-based patient count limit \nfor various business reasons.","type":"integer","minimum":0},"providers":{"type":"object","description":"The count of patients associated with the clinic by provider. As each patient may be associated \nwith multiple providers, the sum of all provider counts may exceed the total patient count.","additionalProperties":{"$ref":"#/components/schemas/patientProviderCount.v1"}}},"required":["total","demo","plan"]}},"schema_110":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":10},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"integer","minimum":0},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-f0-9]{24}$"},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","format":"email"},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"string","pattern":"^(1d|7d|14d|30d)$","example":"7d"},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/objectId.v1"},"minItems":1},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"array","x-go-type-skip-optional-pointer":true,"x-omitempty":true,"x-omitzero":true,"items":{"type":"string","enum":["timeInVeryLowPercent","timeInAnyLowPercent","timeInExtremeHighPercent","timeInVeryHighPercent","timeInAnyHighPercent","dropInTimeInTargetPercent","timeInTargetPercent","timeCGMUsePercent","meetingTargets"]}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"boolean","x-go-type-skip-optional-pointer":true,"x-omitempty":true},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"string","pattern":"(?:-|\\+)(?:[a-zA-Z]|_)+"},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","pattern":"^(cgm|bgm)$","example":"cgm"},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"$ref":"#/components/schemas/FloatFilter"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"$ref":"#/components/schemas/IntFilter"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"^[a-f0-9]{24}$"}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"$ref":"#/components/schemas/objectId.v1"},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"string","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","enum":["custodian","view","upload","note"]},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"$ref":"#/components/schemas/tidepooluserid"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"$ref":"#/components/schemas/clinicId.v1"},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/clinicianClinicRelationship.v1"}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"$ref":"#/components/schemas/summaryId.v1"},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"string","enum":["clinicId","ehrSourceId"]},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"$ref":"#/components/schemas/providerId.v1"},"id":"schema_136"}},"exampleStore":{},"securitySchemeStore":{"sessionToken":{"id":"sessionToken","type":"apiKey","description":"A Tidepool session token","in":"header","paramName":"x-tidepool-session-token"}},"servers":[{"url":"/_mock/reference/clinic.v1","isMockServer":true,"description":"Mock server"},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}]},"options":{"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/reference/clinic.v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/clinic.v1.json?download"},{"url":"/_bundle/reference/clinic.v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Clinics API","description":"Web service that stores information about clinics, clinicians and their patients"}},"baseSlug":"/reference/clinic.v1","routesMapping":{}}