API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Mar 18th, 2019
98
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 29.49 KB | None | 0 0
raw download clone embed print report
  1. {
  2. "class": [
  3. "DoctorHome"
  4. ],
  5. "actions": [
  6. {
  7. "name": "patients-search",
  8. "method": "GET",
  9. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli/patients",
  10. "type": "application/x-www-form-urlencoded",
  11. "fields": [
  12. {
  13. "name": "queryText",
  14. "title": "Text to search.",
  15. "type": "TEXT",
  16. "required": false
  17. },
  18. {
  19. "name": "treatmentStatus",
  20. "title": "Status of treatment.",
  21. "type": "RADIO",
  22. "required": false,
  23. "options": [
  24. {
  25. "title": "In progress",
  26. "value": "IN_PROGRESS",
  27. "default": false
  28. },
  29. {
  30. "title": "Action required",
  31. "value": "ACTION_REQUIRED",
  32. "default": false
  33. },
  34. {
  35. "title": "Archived",
  36. "value": "ARCHIVED",
  37. "default": false
  38. }
  39. ]
  40. },
  41. {
  42. "name": "workflow",
  43. "title": "Workflow type",
  44. "type": "RADIO",
  45. "required": false,
  46. "options": [
  47. {
  48. "title": "INVISALIGN",
  49. "value": "INVISALIGN",
  50. "default": false
  51. },
  52. {
  53. "title": "REALINE",
  54. "value": "REALINE",
  55. "default": false
  56. },
  57. {
  58. "title": "SDC",
  59. "value": "SDC",
  60. "default": false
  61. },
  62. {
  63. "title": "ACCESS",
  64. "value": "ACCESS",
  65. "default": false
  66. }
  67. ]
  68. },
  69. {
  70. "name": "sort",
  71. "title": "Sort by",
  72. "type": "RADIO",
  73. "required": false,
  74. "options": [
  75. {
  76. "title": "START_DATE",
  77. "value": "START_DATE",
  78. "default": false
  79. },
  80. {
  81. "title": "CCAA_START_DATE",
  82. "value": "CCAA_START_DATE",
  83. "default": false
  84. },
  85. {
  86. "title": "PATIENT_MODIFIED_DATE",
  87. "value": "PATIENT_MODIFIED_DATE",
  88. "default": false
  89. }
  90. ]
  91. },
  92. {
  93. "name": "sortDirection",
  94. "title": "Sort direction",
  95. "type": "RADIO",
  96. "required": false,
  97. "options": [
  98. {
  99. "title": "ASC",
  100. "value": "ASC",
  101. "default": false
  102. },
  103. {
  104. "title": "DESC",
  105. "value": "DESC",
  106. "default": false
  107. }
  108. ]
  109. },
  110. {
  111. "name": "size",
  112. "title": "Number of entities per page",
  113. "type": "NUMBER",
  114. "value": "30",
  115. "required": false
  116. },
  117. {
  118. "name": "page",
  119. "title": "Page number",
  120. "type": "NUMBER",
  121. "value": "0",
  122. "required": false
  123. }
  124. ]
  125. },
  126. {
  127. "name": "patients-by-pid-search",
  128. "method": "GET",
  129. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli/patients",
  130. "type": "application/x-www-form-urlencoded",
  131. "fields": [
  132. {
  133. "name": "pid",
  134. "title": "PID",
  135. "type": "TEXT",
  136. "required": true
  137. }
  138. ]
  139. },
  140. {
  141. "name": "patient-search",
  142. "method": "GET",
  143. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/patient-search",
  144. "type": "application/x-www-form-urlencoded",
  145. "fields": [
  146. {
  147. "name": "externalSystem",
  148. "title": "External system which patient is linked to",
  149. "type": "RADIO",
  150. "required": true,
  151. "options": [
  152. {
  153. "title": "IOSim",
  154. "value": "IOSIM",
  155. "default": false
  156. }
  157. ]
  158. },
  159. {
  160. "name": "externalId",
  161. "title": "External id",
  162. "type": "TEXT",
  163. "required": true
  164. }
  165. ]
  166. },
  167. {
  168. "name": "treatment-plan-search",
  169. "method": "GET",
  170. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/treatment-plan-search",
  171. "type": "application/x-www-form-urlencoded",
  172. "fields": [
  173. {
  174. "name": "clincheckId",
  175. "title": "Treatment plan id",
  176. "type": "NUMBER",
  177. "required": true
  178. }
  179. ]
  180. },
  181. {
  182. "name": "ajax-treatment-plan-search",
  183. "method": "GET",
  184. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/ajax-treatment-plan-search",
  185. "type": "application/x-www-form-urlencoded",
  186. "fields": [
  187. {
  188. "name": "clincheckId",
  189. "title": "Treatment plan id",
  190. "type": "NUMBER",
  191. "required": true
  192. }
  193. ]
  194. },
  195. {
  196. "name": "create-share",
  197. "method": "POST",
  198. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/treatment-plan-shares",
  199. "title": "Create a share",
  200. "type": "application/json",
  201. "fields": [
  202. {
  203. "name": "shareThrough",
  204. "title": "Treatment viewer type",
  205. "type": "RADIO",
  206. "required": true,
  207. "options": [
  208. {
  209. "title": "PatientTreatmentViewer",
  210. "value": "PATIENT",
  211. "default": false
  212. },
  213. {
  214. "title": "PatientTreatmentViewerAltaGoTreatmentVariant",
  215. "value": "PATIENT_ALTA_GO_VARIANT",
  216. "default": false
  217. },
  218. {
  219. "title": "PatientTreatmentViewerAltaGoClassic",
  220. "value": "PATIENT_ALTA_GO_CLASSIC",
  221. "default": false
  222. },
  223. {
  224. "title": "SimulationViewer",
  225. "value": "SIMULATION",
  226. "default": false
  227. },
  228. {
  229. "title": "SmileDirectClubViewer",
  230. "value": "SMILE_DIRECT_CLUB",
  231. "default": false
  232. },
  233. {
  234. "title": "SmileStoreViewer",
  235. "value": "SMILE_STORE",
  236. "default": false
  237. }
  238. ]
  239. },
  240. {
  241. "name": "sendNotificationEmail",
  242. "title": "Flag that tells if notification email should be sent",
  243. "type": "CHECKBOX",
  244. "value": "true",
  245. "required": false
  246. },
  247. {
  248. "name": "doctorEmail",
  249. "title": "Doctor's email",
  250. "type": "EMAIL",
  251. "required": false
  252. },
  253. {
  254. "name": "patientEmails",
  255. "title": "Comma separated list of patient emails",
  256. "type": "TEXT",
  257. "required": false
  258. },
  259. {
  260. "name": "displayOptions",
  261. "title": "Display parameters",
  262. "type": "TEXT",
  263. "required": true
  264. },
  265. {
  266. "name": "expirationDate",
  267. "title": "Date of treatment plan share expiration",
  268. "type": "DATETIME",
  269. "required": false
  270. }
  271. ]
  272. },
  273. {
  274. "name": "treatment-simulation-share",
  275. "method": "POST",
  276. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli/treatment-simulation-share",
  277. "title": "Create a simulated treatment share",
  278. "type": "application/json",
  279. "fields": [
  280. {
  281. "name": "shareThrough",
  282. "title": "Treatment viewer type",
  283. "type": "RADIO",
  284. "required": false,
  285. "options": [
  286. {
  287. "title": "PatientTreatmentViewer",
  288. "value": "PATIENT",
  289. "default": true
  290. },
  291. {
  292. "title": "PatientTreatmentViewerAltaGoTreatmentVariant",
  293. "value": "PATIENT_ALTA_GO_VARIANT",
  294. "default": false
  295. },
  296. {
  297. "title": "PatientTreatmentViewerAltaGoClassic",
  298. "value": "PATIENT_ALTA_GO_CLASSIC",
  299. "default": false
  300. },
  301. {
  302. "title": "SimulationViewer",
  303. "value": "SIMULATION",
  304. "default": false
  305. },
  306. {
  307. "title": "SmileDirectClubViewer",
  308. "value": "SMILE_DIRECT_CLUB",
  309. "default": false
  310. },
  311. {
  312. "title": "SmileStoreViewer",
  313. "value": "SMILE_STORE",
  314. "default": false
  315. }
  316. ]
  317. },
  318. {
  319. "name": "sendNotificationEmail",
  320. "title": "Flag that tells if notification email should be sent",
  321. "type": "CHECKBOX",
  322. "value": "true",
  323. "required": false
  324. },
  325. {
  326. "name": "doctorEmail",
  327. "title": "Doctor's email",
  328. "type": "EMAIL",
  329. "required": false
  330. },
  331. {
  332. "name": "patientEmails",
  333. "title": "Comma separated list of patient emails",
  334. "type": "TEXT",
  335. "required": false
  336. },
  337. {
  338. "name": "displayOptions",
  339. "title": "Display parameters",
  340. "type": "TEXT",
  341. "required": true
  342. },
  343. {
  344. "name": "expirationDate",
  345. "title": "Date of treatment plan share expiration",
  346. "type": "DATETIME",
  347. "required": false
  348. }
  349. ]
  350. },
  351. {
  352. "name": "create-patient",
  353. "method": "POST",
  354. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli/patients",
  355. "title": "Create patient",
  356. "type": "application/json",
  357. "fields": [
  358. {
  359. "name": "givenName",
  360. "title": "Patient's first name",
  361. "type": "TEXT",
  362. "required": true,
  363. "maxLength": 25
  364. },
  365. {
  366. "name": "middleInitial",
  367. "title": "Patient's middle initial",
  368. "type": "TEXT",
  369. "required": false,
  370. "maxLength": 1
  371. },
  372. {
  373. "name": "familyName",
  374. "title": "Patient's last name",
  375. "type": "TEXT",
  376. "required": true,
  377. "maxLength": 25
  378. },
  379. {
  380. "name": "nativeGivenName",
  381. "title": "Patient native first name (for Japan doctors)",
  382. "type": "TEXT",
  383. "required": false
  384. },
  385. {
  386. "name": "nativeFamilyName",
  387. "title": "Patient native last name (for Japan doctors)",
  388. "type": "TEXT",
  389. "required": false
  390. },
  391. {
  392. "name": "gender",
  393. "title": "Patient's gender",
  394. "type": "RADIO",
  395. "required": true,
  396. "options": [
  397. {
  398. "title": "Male",
  399. "value": "MALE",
  400. "default": false
  401. },
  402. {
  403. "title": "Female",
  404. "value": "FEMALE",
  405. "default": false
  406. }
  407. ]
  408. },
  409. {
  410. "name": "birthDate",
  411. "title": "Patient's Date of Birth (YYYY-MM-DD)",
  412. "type": "DATE",
  413. "required": true
  414. },
  415. {
  416. "name": "email",
  417. "title": "Patient's email",
  418. "type": "EMAIL",
  419. "required": false
  420. },
  421. {
  422. "name": "phone",
  423. "title": "Patient's phone number",
  424. "type": "TEL",
  425. "required": false
  426. },
  427. {
  428. "name": "zipCode",
  429. "title": "Patient's zip code",
  430. "type": "TEXT",
  431. "required": true
  432. },
  433. {
  434. "name": "workflow",
  435. "title": "Workflow type",
  436. "type": "RADIO",
  437. "required": false,
  438. "options": [
  439. {
  440. "title": "INVISALIGN",
  441. "value": "INVISALIGN",
  442. "default": false
  443. },
  444. {
  445. "title": "REALINE",
  446. "value": "REALINE",
  447. "default": false
  448. },
  449. {
  450. "title": "SDC",
  451. "value": "SDC",
  452. "default": false
  453. },
  454. {
  455. "title": "ACCESS",
  456. "value": "ACCESS",
  457. "default": false
  458. }
  459. ]
  460. },
  461. {
  462. "name": "clinicalConditions",
  463. "title": "Patient clinical conditions",
  464. "type": "CHECKBOX",
  465. "required": false,
  466. "options": [
  467. {
  468. "title": "CROWDING",
  469. "value": "CROWDING",
  470. "default": false
  471. },
  472. {
  473. "title": "SPACING",
  474. "value": "SPACING",
  475. "default": false
  476. },
  477. {
  478. "title": "CLASS_1",
  479. "value": "CLASS_1",
  480. "default": false
  481. },
  482. {
  483. "title": "CLASS_2",
  484. "value": "CLASS_2",
  485. "default": false
  486. },
  487. {
  488. "title": "CLASS_3",
  489. "value": "CLASS_3",
  490. "default": false
  491. },
  492. {
  493. "title": "OPEN_BITE",
  494. "value": "OPEN_BITE",
  495. "default": false
  496. },
  497. {
  498. "title": "DEEP_BITE",
  499. "value": "DEEP_BITE",
  500. "default": false
  501. },
  502. {
  503. "title": "ANTERIOR_CROSSBITE",
  504. "value": "ANTERIOR_CROSSBITE",
  505. "default": false
  506. },
  507. {
  508. "title": "POSTERIOR_CROSSBITE",
  509. "value": "POSTERIOR_CROSSBITE",
  510. "default": false
  511. },
  512. {
  513. "title": "NARROW_ARCH",
  514. "value": "NARROW_ARCH",
  515. "default": false
  516. },
  517. {
  518. "title": "FLARED_TEETH",
  519. "value": "FLARED_TEETH",
  520. "default": false
  521. },
  522. {
  523. "title": "OVERJET",
  524. "value": "OVERJET",
  525. "default": false
  526. },
  527. {
  528. "title": "UNEVEN_SMILE",
  529. "value": "UNEVEN_SMILE",
  530. "default": false
  531. },
  532. {
  533. "title": "MISSHAPEN_TEETH",
  534. "value": "MISSHAPEN_TEETH",
  535. "default": false
  536. },
  537. {
  538. "title": "OTHER",
  539. "value": "OTHER",
  540. "default": false
  541. }
  542. ]
  543. },
  544. {
  545. "name": "shipToAddressId",
  546. "title": "Ship to address",
  547. "type": "RADIO",
  548. "required": false,
  549. "options": [
  550. {
  551. "title": "477 N El Camino Real, Suite B207, Encinitas, CA, 92024-1353, US",
  552. "value": "122823",
  553. "default": true
  554. }
  555. ]
  556. },
  557. {
  558. "name": "billToAddressId",
  559. "title": "Bill to address",
  560. "type": "RADIO",
  561. "required": false,
  562. "options": [
  563. {
  564. "title": "477 N El Camino Real, Suite B207, Encinitas, CA, 92024-1353, US",
  565. "value": "122823",
  566. "default": true
  567. }
  568. ]
  569. }
  570. ]
  571. },
  572. {
  573. "name": "link-external",
  574. "method": "PUT",
  575. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/patient-links",
  576. "title": "Link patient to external system (allows to call creation of the same Patient Link multiple times)",
  577. "type": "application/json",
  578. "fields": [
  579. {
  580. "name": "externalSystem",
  581. "title": "External system which patient should be linked to",
  582. "type": "RADIO",
  583. "required": true,
  584. "options": [
  585. {
  586. "title": "3Shape",
  587. "value": "3Shape",
  588. "default": false
  589. },
  590. {
  591. "title": "IOSIM",
  592. "value": "IOSIM",
  593. "default": false
  594. },
  595. {
  596. "title": "iTero",
  597. "value": "iTero",
  598. "default": false
  599. },
  600. {
  601. "title": "Sirona",
  602. "value": "Sirona",
  603. "default": false
  604. }
  605. ]
  606. },
  607. {
  608. "name": "externalId",
  609. "title": "External id",
  610. "type": "TEXT",
  611. "required": true
  612. },
  613. {
  614. "name": "vpi",
  615. "title": "Patient's ID",
  616. "type": "NUMBER",
  617. "required": true
  618. }
  619. ]
  620. },
  621. {
  622. "name": "external-patient-create",
  623. "method": "POST",
  624. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/external-patients",
  625. "title": "Create a non-Invisalign patient",
  626. "type": "application/json",
  627. "fields": [
  628. {
  629. "name": "givenName",
  630. "title": "Given name",
  631. "type": "TEXT",
  632. "required": true
  633. },
  634. {
  635. "name": "middleInitial",
  636. "title": "Middle initial",
  637. "type": "TEXT",
  638. "required": false
  639. },
  640. {
  641. "name": "familyName",
  642. "title": "Family name",
  643. "type": "TEXT",
  644. "required": true
  645. },
  646. {
  647. "name": "nativeGivenName",
  648. "title": "Native given name",
  649. "type": "TEXT",
  650. "required": false
  651. },
  652. {
  653. "name": "nativeFamilyName",
  654. "title": "Native family name",
  655. "type": "TEXT",
  656. "required": false
  657. },
  658. {
  659. "name": "birthDate",
  660. "title": "Birth date",
  661. "type": "DATE",
  662. "required": true
  663. },
  664. {
  665. "name": "gender",
  666. "title": "Patient's gender",
  667. "type": "RADIO",
  668. "required": true,
  669. "options": [
  670. {
  671. "title": "Male",
  672. "value": "MALE",
  673. "default": false
  674. },
  675. {
  676. "title": "Female",
  677. "value": "FEMALE",
  678. "default": false
  679. }
  680. ]
  681. },
  682. {
  683. "name": "email",
  684. "title": "Email",
  685. "type": "EMAIL",
  686. "required": false
  687. },
  688. {
  689. "name": "phone",
  690. "title": "Phone",
  691. "type": "TEL",
  692. "required": false
  693. },
  694. {
  695. "name": "zipCode",
  696. "title": "Zip code",
  697. "type": "TEXT",
  698. "required": false
  699. }
  700. ]
  701. },
  702. {
  703. "name": "external-patients-list",
  704. "method": "GET",
  705. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/external-patients",
  706. "title": "Get a pageable list of non-Invisalign patients for this doctor",
  707. "type": "application/x-www-form-urlencoded",
  708. "fields": [
  709. {
  710. "name": "givenName",
  711. "title": "External patient given name",
  712. "type": "TEXT",
  713. "required": false
  714. },
  715. {
  716. "name": "familyName",
  717. "title": "External patient family name",
  718. "type": "TEXT",
  719. "required": false
  720. },
  721. {
  722. "name": "size",
  723. "title": "Number of entities per page",
  724. "type": "NUMBER",
  725. "value": "30",
  726. "required": false
  727. },
  728. {
  729. "name": "page",
  730. "title": "Page number",
  731. "type": "NUMBER",
  732. "value": "0",
  733. "required": false
  734. }
  735. ]
  736. }
  737. ],
  738. "links": [
  739. {
  740. "rel": [
  741. "self",
  742. "index"
  743. ],
  744. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/home/doctor/mgalli",
  745. "title": "Link to doctor's 'mgalli' home"
  746. },
  747. {
  748. "rel": [
  749. "doctor"
  750. ],
  751. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli",
  752. "title": "Information about doctor 'mgalli'"
  753. },
  754. {
  755. "rel": [
  756. "addresses"
  757. ],
  758. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/doctors/mgalli/addresses",
  759. "title": "List of doctor's shipping and billing addresses"
  760. },
  761. {
  762. "rel": [
  763. "ioscan-api"
  764. ],
  765. "href": "https://alignapi.qas.aligntech.com/ioscan-api/1.0/",
  766. "title": "IOscan endpoint"
  767. },
  768. {
  769. "rel": [
  770. "instrumentation"
  771. ],
  772. "href": "https://vip.qas.invisalign.com/v3/xmlrpc/cci20",
  773. "title": "Instrumentation endpoint"
  774. },
  775. {
  776. "rel": [
  777. "terms-of-service"
  778. ],
  779. "href": "https://alignapi.qas.aligntech.com/ids-api/v2/cs/documents/TERMS_OF_SERVICE?clinid=mgalli",
  780. "title": "Document with terms of service description"
  781. },
  782. {
  783. "rel": [
  784. "wcc-help"
  785. ],
  786. "href": "https://alignapi.qas.aligntech.com/ids-api/v2/cs/documents/WCC_HELP?clinid=mgalli",
  787. "title": "Help document for ClinCheck"
  788. },
  789. {
  790. "rel": [
  791. "userinfo"
  792. ],
  793. "href": "https://alignapi.qas.aligntech.com/clinical-api/1.0/userinfo"
  794. },
  795. {
  796. "rel": [
  797. "contextual-education"
  798. ],
  799. "href": "https://alignapi.qas.aligntech.com/cs-contextual-education/v1/",
  800. "title": "Link to Contextual Education home"
  801. },
  802. {
  803. "rel": [
  804. "tp-data"
  805. ],
  806. "href": "https://alignapi.qas.aligntech.com/tpdata/v1/",
  807. "title": "Link to Treatment Planning Data home"
  808. }
  809. ]
  810. }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!