Guest User

openmrs swagger

a guest
Jul 13th, 2021
40
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. {
  2. swagger: "2.0",
  3. info: {
  4. description: "OpenMRS RESTful API documentation generated by Swagger",
  5. version: "2.4.0",
  6. title: "OpenMRS API Docs",
  7. contact: {
  8. name: "OpenMRS",
  9. url: "http://openmrs.org"
  10. },
  11. license: {
  12. name: "MPL-2.0 w/ HD",
  13. url: "http://openmrs.org/license"
  14. }
  15. },
  16. host: "localhost:8080",
  17. basePath: "/openmrs/ws/rest/v1",
  18. schemes: [
  19. "http"
  20. ],
  21. consumes: [
  22. "application/json"
  23. ],
  24. produces: [
  25. "application/json"
  26. ],
  27. security: [
  28. {
  29. basic_auth: [ ]
  30. },
  31. {
  32. basic_auth: [ ]
  33. },
  34. {
  35. basic_auth: [ ]
  36. }
  37. ],
  38. paths: {
  39. /orderable: {
  40. get: {
  41. tags: [
  42. "orderable"
  43. ],
  44. summary: "Search for orderable",
  45. description: "At least one search parameter must be specified",
  46. operationId: "getAllOrderables",
  47. produces: [
  48. "application/json",
  49. "application/xml"
  50. ],
  51. parameters: [
  52. {
  53. name: "limit",
  54. in: "query",
  55. description: "The number of results to return",
  56. required: false,
  57. type: "integer"
  58. },
  59. {
  60. name: "startIndex",
  61. in: "query",
  62. description: "The offset at which to start",
  63. required: false,
  64. type: "integer"
  65. },
  66. {
  67. name: "v",
  68. in: "query",
  69. description: "The representation to return (ref, default, full or custom)",
  70. required: false,
  71. type: "string",
  72. enum: [
  73. "ref",
  74. "default",
  75. "full",
  76. "custom"
  77. ]
  78. },
  79. {
  80. name: "q",
  81. in: "query",
  82. description: "The search query",
  83. required: true,
  84. type: "string"
  85. }
  86. ],
  87. responses: {
  88. 200: {
  89. description: "orderable response",
  90. schema: {
  91. $ref: "#/definitions/FetchAll"
  92. }
  93. }
  94. }
  95. }
  96. },
  97. /form: {
  98. get: {
  99. tags: [
  100. "form"
  101. ],
  102. summary: "Fetch all non-retired form resources or perform search",
  103. description: "All search parameters are optional",
  104. operationId: "getAllForms",
  105. consumes: [
  106. "application/json"
  107. ],
  108. produces: [
  109. "application/json"
  110. ],
  111. parameters: [
  112. {
  113. name: "limit",
  114. in: "query",
  115. description: "The number of results to return",
  116. required: false,
  117. type: "integer"
  118. },
  119. {
  120. name: "startIndex",
  121. in: "query",
  122. description: "The offset at which to start",
  123. required: false,
  124. type: "integer"
  125. },
  126. {
  127. name: "v",
  128. in: "query",
  129. description: "The representation to return (ref, default, full or custom)",
  130. required: false,
  131. type: "string",
  132. enum: [
  133. "ref",
  134. "default",
  135. "full",
  136. "custom"
  137. ]
  138. },
  139. {
  140. name: "q",
  141. in: "query",
  142. description: "The search query",
  143. required: false,
  144. type: "string"
  145. }
  146. ],
  147. responses: {
  148. 200: {
  149. description: "form response",
  150. schema: {
  151. $ref: "#/definitions/FetchAll"
  152. }
  153. },
  154. 401: {
  155. description: "User not logged in"
  156. }
  157. }
  158. },
  159. post: {
  160. tags: [
  161. "form"
  162. ],
  163. summary: "Create with properties in request",
  164. operationId: "createForm",
  165. consumes: [
  166. "application/json"
  167. ],
  168. produces: [
  169. "application/json"
  170. ],
  171. parameters: [
  172. {
  173. in: "body",
  174. name: "resource",
  175. description: "Resource to create",
  176. required: true,
  177. schema: {
  178. $ref: "#/definitions/FormCreate"
  179. }
  180. }
  181. ],
  182. responses: {
  183. 201: {
  184. description: "form response"
  185. },
  186. 401: {
  187. description: "User not logged in"
  188. }
  189. }
  190. }
  191. },
  192. /form/{uuid}: {
  193. get: {
  194. tags: [
  195. "form"
  196. ],
  197. summary: "Fetch by uuid",
  198. operationId: "getForm",
  199. consumes: [
  200. "application/json"
  201. ],
  202. produces: [
  203. "application/json"
  204. ],
  205. parameters: [
  206. {
  207. name: "v",
  208. in: "query",
  209. description: "The representation to return (ref, default, full or custom)",
  210. required: false,
  211. type: "string",
  212. enum: [
  213. "ref",
  214. "default",
  215. "full",
  216. "custom"
  217. ]
  218. },
  219. {
  220. name: "uuid",
  221. in: "path",
  222. description: "uuid to filter by",
  223. required: true,
  224. type: "string"
  225. }
  226. ],
  227. responses: {
  228. 200: {
  229. description: "form response",
  230. schema: {
  231. $ref: "#/definitions/FormGet"
  232. }
  233. },
  234. 401: {
  235. description: "User not logged in"
  236. },
  237. 404: {
  238. description: "Resource with given uuid doesn't exist"
  239. }
  240. }
  241. },
  242. post: {
  243. tags: [
  244. "form"
  245. ],
  246. summary: "Edit with given uuid, only modifying properties in request",
  247. operationId: "updateForm",
  248. consumes: [
  249. "application/json"
  250. ],
  251. produces: [
  252. "application/json"
  253. ],
  254. parameters: [
  255. {
  256. name: "uuid",
  257. in: "path",
  258. description: "uuid of resource to update",
  259. required: true,
  260. type: "string"
  261. },
  262. {
  263. in: "body",
  264. name: "resource",
  265. description: "Resource properties to update",
  266. required: true,
  267. schema: {
  268. $ref: "#/definitions/FormUpdate"
  269. }
  270. }
  271. ],
  272. responses: {
  273. 201: {
  274. description: "form response"
  275. },
  276. 401: {
  277. description: "User not logged in"
  278. }
  279. }
  280. },
  281. delete: {
  282. tags: [
  283. "form"
  284. ],
  285. summary: "Delete or purge resource by uuid",
  286. description: "The resource will be voided/retired unless purge = 'true'",
  287. operationId: "deleteForm",
  288. consumes: [
  289. "application/json"
  290. ],
  291. produces: [
  292. "application/json"
  293. ],
  294. parameters: [
  295. {
  296. name: "uuid",
  297. in: "path",
  298. description: "uuid to delete",
  299. required: true,
  300. type: "string"
  301. },
  302. {
  303. name: "purge",
  304. in: "query",
  305. required: false,
  306. type: "boolean"
  307. }
  308. ],
  309. responses: {
  310. 204: {
  311. description: "Delete successful"
  312. },
  313. 401: {
  314. description: "User not logged in"
  315. },
  316. 404: {
  317. description: "Resource with given uuid doesn't exist"
  318. }
  319. }
  320. }
  321. },
  322. /condition: {
  323. get: {
  324. tags: [
  325. "condition"
  326. ],
  327. summary: "Search for condition",
  328. description: "At least one search parameter must be specified",
  329. operationId: "getAllConditions",
  330. produces: [
  331. "application/json",
  332. "application/xml"
  333. ],
  334. parameters: [
  335. {
  336. name: "limit",
  337. in: "query",
  338. description: "The number of results to return",
  339. required: false,
  340. type: "integer"
  341. },
  342. {
  343. name: "startIndex",
  344. in: "query",
  345. description: "The offset at which to start",
  346. required: false,
  347. type: "integer"
  348. },
  349. {
  350. name: "v",
  351. in: "query",
  352. description: "The representation to return (ref, default, full or custom)",
  353. required: false,
  354. type: "string",
  355. enum: [
  356. "ref",
  357. "default",
  358. "full",
  359. "custom"
  360. ]
  361. },
  362. {
  363. name: "q",
  364. in: "query",
  365. description: "The search query",
  366. required: true,
  367. type: "string"
  368. }
  369. ],
  370. responses: {
  371. 200: {
  372. description: "condition response",
  373. schema: {
  374. $ref: "#/definitions/FetchAll"
  375. }
  376. }
  377. }
  378. },
  379. post: {
  380. tags: [
  381. "condition"
  382. ],
  383. summary: "Create with properties in request",
  384. operationId: "createCondition",
  385. consumes: [
  386. "application/json"
  387. ],
  388. produces: [
  389. "application/json"
  390. ],
  391. parameters: [
  392. {
  393. in: "body",
  394. name: "resource",
  395. description: "Resource to create",
  396. required: true,
  397. schema: {
  398. $ref: "#/definitions/ConditionCreate"
  399. }
  400. }
  401. ],
  402. responses: {
  403. 201: {
  404. description: "condition response"
  405. },
  406. 401: {
  407. description: "User not logged in"
  408. }
  409. }
  410. }
  411. },
  412. /condition/{uuid}: {
  413. get: {
  414. tags: [
  415. "condition"
  416. ],
  417. summary: "Fetch by uuid",
  418. operationId: "getCondition",
  419. consumes: [
  420. "application/json"
  421. ],
  422. produces: [
  423. "application/json"
  424. ],
  425. parameters: [
  426. {
  427. name: "v",
  428. in: "query",
  429. description: "The representation to return (ref, default, full or custom)",
  430. required: false,
  431. type: "string",
  432. enum: [
  433. "ref",
  434. "default",
  435. "full",
  436. "custom"
  437. ]
  438. },
  439. {
  440. name: "uuid",
  441. in: "path",
  442. description: "uuid to filter by",
  443. required: true,
  444. type: "string"
  445. }
  446. ],
  447. responses: {
  448. 200: {
  449. description: "condition response",
  450. schema: {
  451. $ref: "#/definitions/ConditionGet"
  452. }
  453. },
  454. 401: {
  455. description: "User not logged in"
  456. },
  457. 404: {
  458. description: "Resource with given uuid doesn't exist"
  459. }
  460. }
  461. },
  462. post: {
  463. tags: [
  464. "condition"
  465. ],
  466. summary: "Edit with given uuid, only modifying properties in request",
  467. operationId: "updateCondition",
  468. consumes: [
  469. "application/json"
  470. ],
  471. produces: [
  472. "application/json"
  473. ],
  474. parameters: [
  475. {
  476. name: "uuid",
  477. in: "path",
  478. description: "uuid of resource to update",
  479. required: true,
  480. type: "string"
  481. },
  482. {
  483. in: "body",
  484. name: "resource",
  485. description: "Resource properties to update",
  486. required: true,
  487. schema: {
  488. $ref: "#/definitions/ConditionUpdate"
  489. }
  490. }
  491. ],
  492. responses: {
  493. 201: {
  494. description: "condition response"
  495. },
  496. 401: {
  497. description: "User not logged in"
  498. }
  499. }
  500. },
  501. delete: {
  502. tags: [
  503. "condition"
  504. ],
  505. summary: "Delete or purge resource by uuid",
  506. description: "The resource will be voided/retired unless purge = 'true'",
  507. operationId: "deleteCondition",
  508. consumes: [
  509. "application/json"
  510. ],
  511. produces: [
  512. "application/json"
  513. ],
  514. parameters: [
  515. {
  516. name: "uuid",
  517. in: "path",
  518. description: "uuid to delete",
  519. required: true,
  520. type: "string"
  521. },
  522. {
  523. name: "purge",
  524. in: "query",
  525. required: false,
  526. type: "boolean"
  527. }
  528. ],
  529. responses: {
  530. 204: {
  531. description: "Delete successful"
  532. },
  533. 401: {
  534. description: "User not logged in"
  535. },
  536. 404: {
  537. description: "Resource with given uuid doesn't exist"
  538. }
  539. }
  540. }
  541. },
  542. /privilege: {
  543. get: {
  544. tags: [
  545. "privilege"
  546. ],
  547. summary: "Fetch all non-retired privilege resources or perform search",
  548. description: "All search parameters are optional",
  549. operationId: "getAllPrivileges",
  550. consumes: [
  551. "application/json"
  552. ],
  553. produces: [
  554. "application/json"
  555. ],
  556. parameters: [
  557. {
  558. name: "limit",
  559. in: "query",
  560. description: "The number of results to return",
  561. required: false,
  562. type: "integer"
  563. },
  564. {
  565. name: "startIndex",
  566. in: "query",
  567. description: "The offset at which to start",
  568. required: false,
  569. type: "integer"
  570. },
  571. {
  572. name: "v",
  573. in: "query",
  574. description: "The representation to return (ref, default, full or custom)",
  575. required: false,
  576. type: "string",
  577. enum: [
  578. "ref",
  579. "default",
  580. "full",
  581. "custom"
  582. ]
  583. },
  584. {
  585. name: "q",
  586. in: "query",
  587. description: "The search query",
  588. required: false,
  589. type: "string"
  590. }
  591. ],
  592. responses: {
  593. 200: {
  594. description: "privilege response",
  595. schema: {
  596. $ref: "#/definitions/FetchAll"
  597. }
  598. },
  599. 401: {
  600. description: "User not logged in"
  601. }
  602. }
  603. },
  604. post: {
  605. tags: [
  606. "privilege"
  607. ],
  608. summary: "Create with properties in request",
  609. operationId: "createPrivilege",
  610. consumes: [
  611. "application/json"
  612. ],
  613. produces: [
  614. "application/json"
  615. ],
  616. parameters: [
  617. {
  618. in: "body",
  619. name: "resource",
  620. description: "Resource to create",
  621. required: true,
  622. schema: {
  623. $ref: "#/definitions/PrivilegeCreate"
  624. }
  625. }
  626. ],
  627. responses: {
  628. 201: {
  629. description: "privilege response"
  630. },
  631. 401: {
  632. description: "User not logged in"
  633. }
  634. }
  635. }
  636. },
  637. /privilege/{uuid}: {
  638. get: {
  639. tags: [
  640. "privilege"
  641. ],
  642. summary: "Fetch by uuid",
  643. operationId: "getPrivilege",
  644. consumes: [
  645. "application/json"
  646. ],
  647. produces: [
  648. "application/json"
  649. ],
  650. parameters: [
  651. {
  652. name: "v",
  653. in: "query",
  654. description: "The representation to return (ref, default, full or custom)",
  655. required: false,
  656. type: "string",
  657. enum: [
  658. "ref",
  659. "default",
  660. "full",
  661. "custom"
  662. ]
  663. },
  664. {
  665. name: "uuid",
  666. in: "path",
  667. description: "uuid to filter by",
  668. required: true,
  669. type: "string"
  670. }
  671. ],
  672. responses: {
  673. 200: {
  674. description: "privilege response",
  675. schema: {
  676. $ref: "#/definitions/PrivilegeGet"
  677. }
  678. },
  679. 401: {
  680. description: "User not logged in"
  681. },
  682. 404: {
  683. description: "Resource with given uuid doesn't exist"
  684. }
  685. }
  686. },
  687. post: {
  688. tags: [
  689. "privilege"
  690. ],
  691. summary: "Edit with given uuid, only modifying properties in request",
  692. operationId: "updatePrivilege",
  693. consumes: [
  694. "application/json"
  695. ],
  696. produces: [
  697. "application/json"
  698. ],
  699. parameters: [
  700. {
  701. name: "uuid",
  702. in: "path",
  703. description: "uuid of resource to update",
  704. required: true,
  705. type: "string"
  706. },
  707. {
  708. in: "body",
  709. name: "resource",
  710. description: "Resource properties to update",
  711. required: true,
  712. schema: {
  713. $ref: "#/definitions/PrivilegeUpdate"
  714. }
  715. }
  716. ],
  717. responses: {
  718. 201: {
  719. description: "privilege response"
  720. },
  721. 401: {
  722. description: "User not logged in"
  723. }
  724. }
  725. },
  726. delete: {
  727. tags: [
  728. "privilege"
  729. ],
  730. summary: "Delete or purge resource by uuid",
  731. description: "The resource will be voided/retired unless purge = 'true'",
  732. operationId: "deletePrivilege",
  733. consumes: [
  734. "application/json"
  735. ],
  736. produces: [
  737. "application/json"
  738. ],
  739. parameters: [
  740. {
  741. name: "uuid",
  742. in: "path",
  743. description: "uuid to delete",
  744. required: true,
  745. type: "string"
  746. },
  747. {
  748. name: "purge",
  749. in: "query",
  750. required: false,
  751. type: "boolean"
  752. }
  753. ],
  754. responses: {
  755. 204: {
  756. description: "Delete successful"
  757. },
  758. 401: {
  759. description: "User not logged in"
  760. },
  761. 404: {
  762. description: "Resource with given uuid doesn't exist"
  763. }
  764. }
  765. }
  766. },
  767. /taskaction: {
  768. post: {
  769. tags: [
  770. "taskaction"
  771. ],
  772. summary: "Create with properties in request",
  773. operationId: "createTaskAction",
  774. consumes: [
  775. "application/json"
  776. ],
  777. produces: [
  778. "application/json"
  779. ],
  780. parameters: [
  781. {
  782. in: "body",
  783. name: "resource",
  784. description: "Resource to create",
  785. required: true,
  786. schema: {
  787. $ref: "#/definitions/TaskactionCreate"
  788. }
  789. }
  790. ],
  791. responses: {
  792. 201: {
  793. description: "taskaction response"
  794. },
  795. 401: {
  796. description: "User not logged in"
  797. }
  798. }
  799. }
  800. },
  801. /taskaction/{uuid}: {
  802. get: {
  803. tags: [
  804. "taskaction"
  805. ],
  806. summary: "Fetch by uuid",
  807. operationId: "getTaskAction",
  808. consumes: [
  809. "application/json"
  810. ],
  811. produces: [
  812. "application/json"
  813. ],
  814. parameters: [
  815. {
  816. name: "v",
  817. in: "query",
  818. description: "The representation to return (ref, default, full or custom)",
  819. required: false,
  820. type: "string",
  821. enum: [
  822. "ref",
  823. "default",
  824. "full",
  825. "custom"
  826. ]
  827. },
  828. {
  829. name: "uuid",
  830. in: "path",
  831. description: "uuid to filter by",
  832. required: true,
  833. type: "string"
  834. }
  835. ],
  836. responses: {
  837. 200: {
  838. description: "taskaction response",
  839. schema: {
  840. $ref: "#/definitions/TaskactionGet"
  841. }
  842. },
  843. 401: {
  844. description: "User not logged in"
  845. },
  846. 404: {
  847. description: "Resource with given uuid doesn't exist"
  848. }
  849. }
  850. }
  851. },
  852. /orderfrequency: {
  853. get: {
  854. tags: [
  855. "orderfrequency"
  856. ],
  857. summary: "Fetch all non-retired orderfrequency resources or perform search",
  858. description: "All search parameters are optional",
  859. operationId: "getAllOrderFrequencies",
  860. consumes: [
  861. "application/json"
  862. ],
  863. produces: [
  864. "application/json"
  865. ],
  866. parameters: [
  867. {
  868. name: "limit",
  869. in: "query",
  870. description: "The number of results to return",
  871. required: false,
  872. type: "integer"
  873. },
  874. {
  875. name: "startIndex",
  876. in: "query",
  877. description: "The offset at which to start",
  878. required: false,
  879. type: "integer"
  880. },
  881. {
  882. name: "v",
  883. in: "query",
  884. description: "The representation to return (ref, default, full or custom)",
  885. required: false,
  886. type: "string",
  887. enum: [
  888. "ref",
  889. "default",
  890. "full",
  891. "custom"
  892. ]
  893. },
  894. {
  895. name: "q",
  896. in: "query",
  897. description: "The search query",
  898. required: false,
  899. type: "string"
  900. }
  901. ],
  902. responses: {
  903. 200: {
  904. description: "orderfrequency response",
  905. schema: {
  906. $ref: "#/definitions/FetchAll"
  907. }
  908. },
  909. 401: {
  910. description: "User not logged in"
  911. }
  912. }
  913. },
  914. post: {
  915. tags: [
  916. "orderfrequency"
  917. ],
  918. summary: "Create with properties in request",
  919. operationId: "createOrderFrequency",
  920. consumes: [
  921. "application/json"
  922. ],
  923. produces: [
  924. "application/json"
  925. ],
  926. parameters: [
  927. {
  928. in: "body",
  929. name: "resource",
  930. description: "Resource to create",
  931. required: true,
  932. schema: {
  933. $ref: "#/definitions/OrderfrequencyCreate"
  934. }
  935. }
  936. ],
  937. responses: {
  938. 201: {
  939. description: "orderfrequency response"
  940. },
  941. 401: {
  942. description: "User not logged in"
  943. }
  944. }
  945. }
  946. },
  947. /orderfrequency/{uuid}: {
  948. get: {
  949. tags: [
  950. "orderfrequency"
  951. ],
  952. summary: "Fetch by uuid",
  953. operationId: "getOrderFrequency",
  954. consumes: [
  955. "application/json"
  956. ],
  957. produces: [
  958. "application/json"
  959. ],
  960. parameters: [
  961. {
  962. name: "v",
  963. in: "query",
  964. description: "The representation to return (ref, default, full or custom)",
  965. required: false,
  966. type: "string",
  967. enum: [
  968. "ref",
  969. "default",
  970. "full",
  971. "custom"
  972. ]
  973. },
  974. {
  975. name: "uuid",
  976. in: "path",
  977. description: "uuid to filter by",
  978. required: true,
  979. type: "string"
  980. }
  981. ],
  982. responses: {
  983. 200: {
  984. description: "orderfrequency response",
  985. schema: {
  986. $ref: "#/definitions/OrderfrequencyGet"
  987. }
  988. },
  989. 401: {
  990. description: "User not logged in"
  991. },
  992. 404: {
  993. description: "Resource with given uuid doesn't exist"
  994. }
  995. }
  996. },
  997. post: {
  998. tags: [
  999. "orderfrequency"
  1000. ],
  1001. summary: "Edit with given uuid, only modifying properties in request",
  1002. operationId: "updateOrderFrequency",
  1003. consumes: [
  1004. "application/json"
  1005. ],
  1006. produces: [
  1007. "application/json"
  1008. ],
  1009. parameters: [
  1010. {
  1011. name: "uuid",
  1012. in: "path",
  1013. description: "uuid of resource to update",
  1014. required: true,
  1015. type: "string"
  1016. },
  1017. {
  1018. in: "body",
  1019. name: "resource",
  1020. description: "Resource properties to update",
  1021. required: true,
  1022. schema: {
  1023. $ref: "#/definitions/OrderfrequencyUpdate"
  1024. }
  1025. }
  1026. ],
  1027. responses: {
  1028. 201: {
  1029. description: "orderfrequency response"
  1030. },
  1031. 401: {
  1032. description: "User not logged in"
  1033. }
  1034. }
  1035. },
  1036. delete: {
  1037. tags: [
  1038. "orderfrequency"
  1039. ],
  1040. summary: "Delete or purge resource by uuid",
  1041. description: "The resource will be voided/retired unless purge = 'true'",
  1042. operationId: "deleteOrderFrequency",
  1043. consumes: [
  1044. "application/json"
  1045. ],
  1046. produces: [
  1047. "application/json"
  1048. ],
  1049. parameters: [
  1050. {
  1051. name: "uuid",
  1052. in: "path",
  1053. description: "uuid to delete",
  1054. required: true,
  1055. type: "string"
  1056. },
  1057. {
  1058. name: "purge",
  1059. in: "query",
  1060. required: false,
  1061. type: "boolean"
  1062. }
  1063. ],
  1064. responses: {
  1065. 204: {
  1066. description: "Delete successful"
  1067. },
  1068. 401: {
  1069. description: "User not logged in"
  1070. },
  1071. 404: {
  1072. description: "Resource with given uuid doesn't exist"
  1073. }
  1074. }
  1075. }
  1076. },
  1077. /module: {
  1078. get: {
  1079. tags: [
  1080. "module"
  1081. ],
  1082. summary: "Fetch all non-retired",
  1083. operationId: "getAllModules",
  1084. consumes: [
  1085. "application/json"
  1086. ],
  1087. produces: [
  1088. "application/json"
  1089. ],
  1090. parameters: [
  1091. {
  1092. name: "limit",
  1093. in: "query",
  1094. description: "The number of results to return",
  1095. required: false,
  1096. type: "integer"
  1097. },
  1098. {
  1099. name: "startIndex",
  1100. in: "query",
  1101. description: "The offset at which to start",
  1102. required: false,
  1103. type: "integer"
  1104. },
  1105. {
  1106. name: "v",
  1107. in: "query",
  1108. description: "The representation to return (ref, default, full or custom)",
  1109. required: false,
  1110. type: "string",
  1111. enum: [
  1112. "ref",
  1113. "default",
  1114. "full",
  1115. "custom"
  1116. ]
  1117. }
  1118. ],
  1119. responses: {
  1120. 200: {
  1121. description: "module response",
  1122. schema: {
  1123. $ref: "#/definitions/FetchAll"
  1124. }
  1125. },
  1126. 401: {
  1127. description: "User not logged in"
  1128. }
  1129. }
  1130. }
  1131. },
  1132. /module/{uuid}: {
  1133. get: {
  1134. tags: [
  1135. "module"
  1136. ],
  1137. summary: "Fetch by uuid",
  1138. operationId: "getModule",
  1139. consumes: [
  1140. "application/json"
  1141. ],
  1142. produces: [
  1143. "application/json"
  1144. ],
  1145. parameters: [
  1146. {
  1147. name: "v",
  1148. in: "query",
  1149. description: "The representation to return (ref, default, full or custom)",
  1150. required: false,
  1151. type: "string",
  1152. enum: [
  1153. "ref",
  1154. "default",
  1155. "full",
  1156. "custom"
  1157. ]
  1158. },
  1159. {
  1160. name: "uuid",
  1161. in: "path",
  1162. description: "uuid to filter by",
  1163. required: true,
  1164. type: "string"
  1165. }
  1166. ],
  1167. responses: {
  1168. 200: {
  1169. description: "module response",
  1170. schema: {
  1171. $ref: "#/definitions/ModuleGet"
  1172. }
  1173. },
  1174. 401: {
  1175. description: "User not logged in"
  1176. },
  1177. 404: {
  1178. description: "Resource with given uuid doesn't exist"
  1179. }
  1180. }
  1181. }
  1182. },
  1183. /visitattributetype: {
  1184. get: {
  1185. tags: [
  1186. "visitattributetype"
  1187. ],
  1188. summary: "Fetch all non-retired visitattributetype resources or perform search",
  1189. description: "All search parameters are optional",
  1190. operationId: "getAllVisitAttributeTypes",
  1191. consumes: [
  1192. "application/json"
  1193. ],
  1194. produces: [
  1195. "application/json"
  1196. ],
  1197. parameters: [
  1198. {
  1199. name: "limit",
  1200. in: "query",
  1201. description: "The number of results to return",
  1202. required: false,
  1203. type: "integer"
  1204. },
  1205. {
  1206. name: "startIndex",
  1207. in: "query",
  1208. description: "The offset at which to start",
  1209. required: false,
  1210. type: "integer"
  1211. },
  1212. {
  1213. name: "v",
  1214. in: "query",
  1215. description: "The representation to return (ref, default, full or custom)",
  1216. required: false,
  1217. type: "string",
  1218. enum: [
  1219. "ref",
  1220. "default",
  1221. "full",
  1222. "custom"
  1223. ]
  1224. },
  1225. {
  1226. name: "q",
  1227. in: "query",
  1228. description: "The search query",
  1229. required: false,
  1230. type: "string"
  1231. }
  1232. ],
  1233. responses: {
  1234. 200: {
  1235. description: "visitattributetype response",
  1236. schema: {
  1237. $ref: "#/definitions/FetchAll"
  1238. }
  1239. },
  1240. 401: {
  1241. description: "User not logged in"
  1242. }
  1243. }
  1244. },
  1245. post: {
  1246. tags: [
  1247. "visitattributetype"
  1248. ],
  1249. summary: "Create with properties in request",
  1250. operationId: "createVisitAttributeType",
  1251. consumes: [
  1252. "application/json"
  1253. ],
  1254. produces: [
  1255. "application/json"
  1256. ],
  1257. parameters: [
  1258. {
  1259. in: "body",
  1260. name: "resource",
  1261. description: "Resource to create",
  1262. required: true,
  1263. schema: {
  1264. $ref: "#/definitions/VisitattributetypeCreate"
  1265. }
  1266. }
  1267. ],
  1268. responses: {
  1269. 201: {
  1270. description: "visitattributetype response"
  1271. },
  1272. 401: {
  1273. description: "User not logged in"
  1274. }
  1275. }
  1276. }
  1277. },
  1278. /visitattributetype/{uuid}: {
  1279. get: {
  1280. tags: [
  1281. "visitattributetype"
  1282. ],
  1283. summary: "Fetch by uuid",
  1284. operationId: "getVisitAttributeType",
  1285. consumes: [
  1286. "application/json"
  1287. ],
  1288. produces: [
  1289. "application/json"
  1290. ],
  1291. parameters: [
  1292. {
  1293. name: "v",
  1294. in: "query",
  1295. description: "The representation to return (ref, default, full or custom)",
  1296. required: false,
  1297. type: "string",
  1298. enum: [
  1299. "ref",
  1300. "default",
  1301. "full",
  1302. "custom"
  1303. ]
  1304. },
  1305. {
  1306. name: "uuid",
  1307. in: "path",
  1308. description: "uuid to filter by",
  1309. required: true,
  1310. type: "string"
  1311. }
  1312. ],
  1313. responses: {
  1314. 200: {
  1315. description: "visitattributetype response",
  1316. schema: {
  1317. $ref: "#/definitions/VisitattributetypeGet"
  1318. }
  1319. },
  1320. 401: {
  1321. description: "User not logged in"
  1322. },
  1323. 404: {
  1324. description: "Resource with given uuid doesn't exist"
  1325. }
  1326. }
  1327. },
  1328. post: {
  1329. tags: [
  1330. "visitattributetype"
  1331. ],
  1332. summary: "Edit with given uuid, only modifying properties in request",
  1333. operationId: "updateVisitAttributeType",
  1334. consumes: [
  1335. "application/json"
  1336. ],
  1337. produces: [
  1338. "application/json"
  1339. ],
  1340. parameters: [
  1341. {
  1342. name: "uuid",
  1343. in: "path",
  1344. description: "uuid of resource to update",
  1345. required: true,
  1346. type: "string"
  1347. },
  1348. {
  1349. in: "body",
  1350. name: "resource",
  1351. description: "Resource properties to update",
  1352. required: true,
  1353. schema: {
  1354. $ref: "#/definitions/VisitattributetypeUpdate"
  1355. }
  1356. }
  1357. ],
  1358. responses: {
  1359. 201: {
  1360. description: "visitattributetype response"
  1361. },
  1362. 401: {
  1363. description: "User not logged in"
  1364. }
  1365. }
  1366. },
  1367. delete: {
  1368. tags: [
  1369. "visitattributetype"
  1370. ],
  1371. summary: "Delete or purge resource by uuid",
  1372. description: "The resource will be voided/retired unless purge = 'true'",
  1373. operationId: "deleteVisitAttributeType",
  1374. consumes: [
  1375. "application/json"
  1376. ],
  1377. produces: [
  1378. "application/json"
  1379. ],
  1380. parameters: [
  1381. {
  1382. name: "uuid",
  1383. in: "path",
  1384. description: "uuid to delete",
  1385. required: true,
  1386. type: "string"
  1387. },
  1388. {
  1389. name: "purge",
  1390. in: "query",
  1391. required: false,
  1392. type: "boolean"
  1393. }
  1394. ],
  1395. responses: {
  1396. 204: {
  1397. description: "Delete successful"
  1398. },
  1399. 401: {
  1400. description: "User not logged in"
  1401. },
  1402. 404: {
  1403. description: "Resource with given uuid doesn't exist"
  1404. }
  1405. }
  1406. }
  1407. },
  1408. /ordergroup: {
  1409. get: {
  1410. tags: [
  1411. "ordergroup"
  1412. ],
  1413. summary: "Search for ordergroup",
  1414. description: "At least one search parameter must be specified",
  1415. operationId: "getAllOrderGroups",
  1416. produces: [
  1417. "application/json",
  1418. "application/xml"
  1419. ],
  1420. parameters: [
  1421. {
  1422. name: "limit",
  1423. in: "query",
  1424. description: "The number of results to return",
  1425. required: false,
  1426. type: "integer"
  1427. },
  1428. {
  1429. name: "startIndex",
  1430. in: "query",
  1431. description: "The offset at which to start",
  1432. required: false,
  1433. type: "integer"
  1434. },
  1435. {
  1436. name: "v",
  1437. in: "query",
  1438. description: "The representation to return (ref, default, full or custom)",
  1439. required: false,
  1440. type: "string",
  1441. enum: [
  1442. "ref",
  1443. "default",
  1444. "full",
  1445. "custom"
  1446. ]
  1447. },
  1448. {
  1449. name: "q",
  1450. in: "query",
  1451. description: "The search query",
  1452. required: true,
  1453. type: "string"
  1454. }
  1455. ],
  1456. responses: {
  1457. 200: {
  1458. description: "ordergroup response",
  1459. schema: {
  1460. $ref: "#/definitions/FetchAll"
  1461. }
  1462. }
  1463. }
  1464. },
  1465. post: {
  1466. tags: [
  1467. "ordergroup"
  1468. ],
  1469. summary: "Create with properties in request",
  1470. operationId: "createOrderGroup",
  1471. consumes: [
  1472. "application/json"
  1473. ],
  1474. produces: [
  1475. "application/json"
  1476. ],
  1477. parameters: [
  1478. {
  1479. in: "body",
  1480. name: "resource",
  1481. description: "Resource to create",
  1482. required: true,
  1483. schema: {
  1484. $ref: "#/definitions/OrdergroupCreate"
  1485. }
  1486. }
  1487. ],
  1488. responses: {
  1489. 201: {
  1490. description: "ordergroup response"
  1491. },
  1492. 401: {
  1493. description: "User not logged in"
  1494. }
  1495. }
  1496. }
  1497. },
  1498. /ordergroup/{uuid}: {
  1499. get: {
  1500. tags: [
  1501. "ordergroup"
  1502. ],
  1503. summary: "Fetch by uuid",
  1504. operationId: "getOrderGroup",
  1505. consumes: [
  1506. "application/json"
  1507. ],
  1508. produces: [
  1509. "application/json"
  1510. ],
  1511. parameters: [
  1512. {
  1513. name: "v",
  1514. in: "query",
  1515. description: "The representation to return (ref, default, full or custom)",
  1516. required: false,
  1517. type: "string",
  1518. enum: [
  1519. "ref",
  1520. "default",
  1521. "full",
  1522. "custom"
  1523. ]
  1524. },
  1525. {
  1526. name: "uuid",
  1527. in: "path",
  1528. description: "uuid to filter by",
  1529. required: true,
  1530. type: "string"
  1531. }
  1532. ],
  1533. responses: {
  1534. 200: {
  1535. description: "ordergroup response",
  1536. schema: {
  1537. $ref: "#/definitions/OrdergroupGet"
  1538. }
  1539. },
  1540. 401: {
  1541. description: "User not logged in"
  1542. },
  1543. 404: {
  1544. description: "Resource with given uuid doesn't exist"
  1545. }
  1546. }
  1547. },
  1548. post: {
  1549. tags: [
  1550. "ordergroup"
  1551. ],
  1552. summary: "Edit with given uuid, only modifying properties in request",
  1553. operationId: "updateOrderGroup",
  1554. consumes: [
  1555. "application/json"
  1556. ],
  1557. produces: [
  1558. "application/json"
  1559. ],
  1560. parameters: [
  1561. {
  1562. name: "uuid",
  1563. in: "path",
  1564. description: "uuid of resource to update",
  1565. required: true,
  1566. type: "string"
  1567. },
  1568. {
  1569. in: "body",
  1570. name: "resource",
  1571. description: "Resource properties to update",
  1572. required: true,
  1573. schema: {
  1574. $ref: "#/definitions/OrdergroupUpdate"
  1575. }
  1576. }
  1577. ],
  1578. responses: {
  1579. 201: {
  1580. description: "ordergroup response"
  1581. },
  1582. 401: {
  1583. description: "User not logged in"
  1584. }
  1585. }
  1586. },
  1587. delete: {
  1588. tags: [
  1589. "ordergroup"
  1590. ],
  1591. summary: "Delete or purge resource by uuid",
  1592. description: "The resource will be voided/retired unless purge = 'true'",
  1593. operationId: "deleteOrderGroup",
  1594. consumes: [
  1595. "application/json"
  1596. ],
  1597. produces: [
  1598. "application/json"
  1599. ],
  1600. parameters: [
  1601. {
  1602. name: "uuid",
  1603. in: "path",
  1604. description: "uuid to delete",
  1605. required: true,
  1606. type: "string"
  1607. },
  1608. {
  1609. name: "purge",
  1610. in: "query",
  1611. required: false,
  1612. type: "boolean"
  1613. }
  1614. ],
  1615. responses: {
  1616. 204: {
  1617. description: "Delete successful"
  1618. },
  1619. 401: {
  1620. description: "User not logged in"
  1621. },
  1622. 404: {
  1623. description: "Resource with given uuid doesn't exist"
  1624. }
  1625. }
  1626. }
  1627. },
  1628. /personattributetype: {
  1629. get: {
  1630. tags: [
  1631. "personattributetype"
  1632. ],
  1633. summary: "Fetch all non-retired personattributetype resources or perform search",
  1634. description: "All search parameters are optional",
  1635. operationId: "getAllPersonAttributeTypes",
  1636. consumes: [
  1637. "application/json"
  1638. ],
  1639. produces: [
  1640. "application/json"
  1641. ],
  1642. parameters: [
  1643. {
  1644. name: "limit",
  1645. in: "query",
  1646. description: "The number of results to return",
  1647. required: false,
  1648. type: "integer"
  1649. },
  1650. {
  1651. name: "startIndex",
  1652. in: "query",
  1653. description: "The offset at which to start",
  1654. required: false,
  1655. type: "integer"
  1656. },
  1657. {
  1658. name: "v",
  1659. in: "query",
  1660. description: "The representation to return (ref, default, full or custom)",
  1661. required: false,
  1662. type: "string",
  1663. enum: [
  1664. "ref",
  1665. "default",
  1666. "full",
  1667. "custom"
  1668. ]
  1669. },
  1670. {
  1671. name: "q",
  1672. in: "query",
  1673. description: "The search query",
  1674. required: false,
  1675. type: "string"
  1676. }
  1677. ],
  1678. responses: {
  1679. 200: {
  1680. description: "personattributetype response",
  1681. schema: {
  1682. $ref: "#/definitions/FetchAll"
  1683. }
  1684. },
  1685. 401: {
  1686. description: "User not logged in"
  1687. }
  1688. }
  1689. },
  1690. post: {
  1691. tags: [
  1692. "personattributetype"
  1693. ],
  1694. summary: "Create with properties in request",
  1695. operationId: "createPersonAttributeType",
  1696. consumes: [
  1697. "application/json"
  1698. ],
  1699. produces: [
  1700. "application/json"
  1701. ],
  1702. parameters: [
  1703. {
  1704. in: "body",
  1705. name: "resource",
  1706. description: "Resource to create",
  1707. required: true,
  1708. schema: {
  1709. $ref: "#/definitions/PersonattributetypeCreate"
  1710. }
  1711. }
  1712. ],
  1713. responses: {
  1714. 201: {
  1715. description: "personattributetype response"
  1716. },
  1717. 401: {
  1718. description: "User not logged in"
  1719. }
  1720. }
  1721. }
  1722. },
  1723. /personattributetype/{uuid}: {
  1724. get: {
  1725. tags: [
  1726. "personattributetype"
  1727. ],
  1728. summary: "Fetch by uuid",
  1729. operationId: "getPersonAttributeType",
  1730. consumes: [
  1731. "application/json"
  1732. ],
  1733. produces: [
  1734. "application/json"
  1735. ],
  1736. parameters: [
  1737. {
  1738. name: "v",
  1739. in: "query",
  1740. description: "The representation to return (ref, default, full or custom)",
  1741. required: false,
  1742. type: "string",
  1743. enum: [
  1744. "ref",
  1745. "default",
  1746. "full",
  1747. "custom"
  1748. ]
  1749. },
  1750. {
  1751. name: "uuid",
  1752. in: "path",
  1753. description: "uuid to filter by",
  1754. required: true,
  1755. type: "string"
  1756. }
  1757. ],
  1758. responses: {
  1759. 200: {
  1760. description: "personattributetype response",
  1761. schema: {
  1762. $ref: "#/definitions/PersonattributetypeGet"
  1763. }
  1764. },
  1765. 401: {
  1766. description: "User not logged in"
  1767. },
  1768. 404: {
  1769. description: "Resource with given uuid doesn't exist"
  1770. }
  1771. }
  1772. },
  1773. post: {
  1774. tags: [
  1775. "personattributetype"
  1776. ],
  1777. summary: "Edit with given uuid, only modifying properties in request",
  1778. operationId: "updatePersonAttributeType",
  1779. consumes: [
  1780. "application/json"
  1781. ],
  1782. produces: [
  1783. "application/json"
  1784. ],
  1785. parameters: [
  1786. {
  1787. name: "uuid",
  1788. in: "path",
  1789. description: "uuid of resource to update",
  1790. required: true,
  1791. type: "string"
  1792. },
  1793. {
  1794. in: "body",
  1795. name: "resource",
  1796. description: "Resource properties to update",
  1797. required: true,
  1798. schema: {
  1799. $ref: "#/definitions/PersonattributetypeUpdate"
  1800. }
  1801. }
  1802. ],
  1803. responses: {
  1804. 201: {
  1805. description: "personattributetype response"
  1806. },
  1807. 401: {
  1808. description: "User not logged in"
  1809. }
  1810. }
  1811. },
  1812. delete: {
  1813. tags: [
  1814. "personattributetype"
  1815. ],
  1816. summary: "Delete or purge resource by uuid",
  1817. description: "The resource will be voided/retired unless purge = 'true'",
  1818. operationId: "deletePersonAttributeType",
  1819. consumes: [
  1820. "application/json"
  1821. ],
  1822. produces: [
  1823. "application/json"
  1824. ],
  1825. parameters: [
  1826. {
  1827. name: "uuid",
  1828. in: "path",
  1829. description: "uuid to delete",
  1830. required: true,
  1831. type: "string"
  1832. },
  1833. {
  1834. name: "purge",
  1835. in: "query",
  1836. required: false,
  1837. type: "boolean"
  1838. }
  1839. ],
  1840. responses: {
  1841. 204: {
  1842. description: "Delete successful"
  1843. },
  1844. 401: {
  1845. description: "User not logged in"
  1846. },
  1847. 404: {
  1848. description: "Resource with given uuid doesn't exist"
  1849. }
  1850. }
  1851. }
  1852. },
  1853. /conceptmaptype: {
  1854. get: {
  1855. tags: [
  1856. "conceptmaptype"
  1857. ],
  1858. summary: "Fetch all non-retired conceptmaptype resources or perform search",
  1859. description: "All search parameters are optional",
  1860. operationId: "getAllConceptMapTypes",
  1861. consumes: [
  1862. "application/json"
  1863. ],
  1864. produces: [
  1865. "application/json"
  1866. ],
  1867. parameters: [
  1868. {
  1869. name: "limit",
  1870. in: "query",
  1871. description: "The number of results to return",
  1872. required: false,
  1873. type: "integer"
  1874. },
  1875. {
  1876. name: "startIndex",
  1877. in: "query",
  1878. description: "The offset at which to start",
  1879. required: false,
  1880. type: "integer"
  1881. },
  1882. {
  1883. name: "v",
  1884. in: "query",
  1885. description: "The representation to return (ref, default, full or custom)",
  1886. required: false,
  1887. type: "string",
  1888. enum: [
  1889. "ref",
  1890. "default",
  1891. "full",
  1892. "custom"
  1893. ]
  1894. },
  1895. {
  1896. name: "q",
  1897. in: "query",
  1898. description: "The search query",
  1899. required: false,
  1900. type: "string"
  1901. }
  1902. ],
  1903. responses: {
  1904. 200: {
  1905. description: "conceptmaptype response",
  1906. schema: {
  1907. $ref: "#/definitions/FetchAll"
  1908. }
  1909. },
  1910. 401: {
  1911. description: "User not logged in"
  1912. }
  1913. }
  1914. },
  1915. post: {
  1916. tags: [
  1917. "conceptmaptype"
  1918. ],
  1919. summary: "Create with properties in request",
  1920. operationId: "createConceptMapType",
  1921. consumes: [
  1922. "application/json"
  1923. ],
  1924. produces: [
  1925. "application/json"
  1926. ],
  1927. parameters: [
  1928. {
  1929. in: "body",
  1930. name: "resource",
  1931. description: "Resource to create",
  1932. required: true,
  1933. schema: {
  1934. $ref: "#/definitions/ConceptmaptypeCreate"
  1935. }
  1936. }
  1937. ],
  1938. responses: {
  1939. 201: {
  1940. description: "conceptmaptype response"
  1941. },
  1942. 401: {
  1943. description: "User not logged in"
  1944. }
  1945. }
  1946. }
  1947. },
  1948. /conceptmaptype/{uuid}: {
  1949. get: {
  1950. tags: [
  1951. "conceptmaptype"
  1952. ],
  1953. summary: "Fetch by uuid",
  1954. operationId: "getConceptMapType",
  1955. consumes: [
  1956. "application/json"
  1957. ],
  1958. produces: [
  1959. "application/json"
  1960. ],
  1961. parameters: [
  1962. {
  1963. name: "v",
  1964. in: "query",
  1965. description: "The representation to return (ref, default, full or custom)",
  1966. required: false,
  1967. type: "string",
  1968. enum: [
  1969. "ref",
  1970. "default",
  1971. "full",
  1972. "custom"
  1973. ]
  1974. },
  1975. {
  1976. name: "uuid",
  1977. in: "path",
  1978. description: "uuid to filter by",
  1979. required: true,
  1980. type: "string"
  1981. }
  1982. ],
  1983. responses: {
  1984. 200: {
  1985. description: "conceptmaptype response",
  1986. schema: {
  1987. $ref: "#/definitions/ConceptmaptypeGet"
  1988. }
  1989. },
  1990. 401: {
  1991. description: "User not logged in"
  1992. },
  1993. 404: {
  1994. description: "Resource with given uuid doesn't exist"
  1995. }
  1996. }
  1997. },
  1998. post: {
  1999. tags: [
  2000. "conceptmaptype"
  2001. ],
  2002. summary: "Edit with given uuid, only modifying properties in request",
  2003. operationId: "updateConceptMapType",
  2004. consumes: [
  2005. "application/json"
  2006. ],
  2007. produces: [
  2008. "application/json"
  2009. ],
  2010. parameters: [
  2011. {
  2012. name: "uuid",
  2013. in: "path",
  2014. description: "uuid of resource to update",
  2015. required: true,
  2016. type: "string"
  2017. },
  2018. {
  2019. in: "body",
  2020. name: "resource",
  2021. description: "Resource properties to update",
  2022. required: true,
  2023. schema: {
  2024. $ref: "#/definitions/ConceptmaptypeUpdate"
  2025. }
  2026. }
  2027. ],
  2028. responses: {
  2029. 201: {
  2030. description: "conceptmaptype response"
  2031. },
  2032. 401: {
  2033. description: "User not logged in"
  2034. }
  2035. }
  2036. },
  2037. delete: {
  2038. tags: [
  2039. "conceptmaptype"
  2040. ],
  2041. summary: "Delete or purge resource by uuid",
  2042. description: "The resource will be voided/retired unless purge = 'true'",
  2043. operationId: "deleteConceptMapType",
  2044. consumes: [
  2045. "application/json"
  2046. ],
  2047. produces: [
  2048. "application/json"
  2049. ],
  2050. parameters: [
  2051. {
  2052. name: "uuid",
  2053. in: "path",
  2054. description: "uuid to delete",
  2055. required: true,
  2056. type: "string"
  2057. },
  2058. {
  2059. name: "purge",
  2060. in: "query",
  2061. required: false,
  2062. type: "boolean"
  2063. }
  2064. ],
  2065. responses: {
  2066. 204: {
  2067. description: "Delete successful"
  2068. },
  2069. 401: {
  2070. description: "User not logged in"
  2071. },
  2072. 404: {
  2073. description: "Resource with given uuid doesn't exist"
  2074. }
  2075. }
  2076. }
  2077. },
  2078. /cohort: {
  2079. get: {
  2080. tags: [
  2081. "cohort"
  2082. ],
  2083. summary: "Fetch all non-retired cohort resources or perform search",
  2084. description: "All search parameters are optional",
  2085. operationId: "getAllCohorts",
  2086. consumes: [
  2087. "application/json"
  2088. ],
  2089. produces: [
  2090. "application/json"
  2091. ],
  2092. parameters: [
  2093. {
  2094. name: "limit",
  2095. in: "query",
  2096. description: "The number of results to return",
  2097. required: false,
  2098. type: "integer"
  2099. },
  2100. {
  2101. name: "startIndex",
  2102. in: "query",
  2103. description: "The offset at which to start",
  2104. required: false,
  2105. type: "integer"
  2106. },
  2107. {
  2108. name: "v",
  2109. in: "query",
  2110. description: "The representation to return (ref, default, full or custom)",
  2111. required: false,
  2112. type: "string",
  2113. enum: [
  2114. "ref",
  2115. "default",
  2116. "full",
  2117. "custom"
  2118. ]
  2119. },
  2120. {
  2121. name: "q",
  2122. in: "query",
  2123. description: "The search query",
  2124. required: false,
  2125. type: "string"
  2126. }
  2127. ],
  2128. responses: {
  2129. 200: {
  2130. description: "cohort response",
  2131. schema: {
  2132. $ref: "#/definitions/FetchAll"
  2133. }
  2134. },
  2135. 401: {
  2136. description: "User not logged in"
  2137. }
  2138. }
  2139. },
  2140. post: {
  2141. tags: [
  2142. "cohort"
  2143. ],
  2144. summary: "Create with properties in request",
  2145. operationId: "createCohort",
  2146. consumes: [
  2147. "application/json"
  2148. ],
  2149. produces: [
  2150. "application/json"
  2151. ],
  2152. parameters: [
  2153. {
  2154. in: "body",
  2155. name: "resource",
  2156. description: "Resource to create",
  2157. required: true,
  2158. schema: {
  2159. $ref: "#/definitions/CohortCreate"
  2160. }
  2161. }
  2162. ],
  2163. responses: {
  2164. 201: {
  2165. description: "cohort response"
  2166. },
  2167. 401: {
  2168. description: "User not logged in"
  2169. }
  2170. }
  2171. }
  2172. },
  2173. /cohort/{uuid}: {
  2174. get: {
  2175. tags: [
  2176. "cohort"
  2177. ],
  2178. summary: "Fetch by uuid",
  2179. operationId: "getCohort",
  2180. consumes: [
  2181. "application/json"
  2182. ],
  2183. produces: [
  2184. "application/json"
  2185. ],
  2186. parameters: [
  2187. {
  2188. name: "v",
  2189. in: "query",
  2190. description: "The representation to return (ref, default, full or custom)",
  2191. required: false,
  2192. type: "string",
  2193. enum: [
  2194. "ref",
  2195. "default",
  2196. "full",
  2197. "custom"
  2198. ]
  2199. },
  2200. {
  2201. name: "uuid",
  2202. in: "path",
  2203. description: "uuid to filter by",
  2204. required: true,
  2205. type: "string"
  2206. }
  2207. ],
  2208. responses: {
  2209. 200: {
  2210. description: "cohort response",
  2211. schema: {
  2212. $ref: "#/definitions/CohortGet"
  2213. }
  2214. },
  2215. 401: {
  2216. description: "User not logged in"
  2217. },
  2218. 404: {
  2219. description: "Resource with given uuid doesn't exist"
  2220. }
  2221. }
  2222. },
  2223. post: {
  2224. tags: [
  2225. "cohort"
  2226. ],
  2227. summary: "Edit with given uuid, only modifying properties in request",
  2228. operationId: "updateCohort",
  2229. consumes: [
  2230. "application/json"
  2231. ],
  2232. produces: [
  2233. "application/json"
  2234. ],
  2235. parameters: [
  2236. {
  2237. name: "uuid",
  2238. in: "path",
  2239. description: "uuid of resource to update",
  2240. required: true,
  2241. type: "string"
  2242. },
  2243. {
  2244. in: "body",
  2245. name: "resource",
  2246. description: "Resource properties to update",
  2247. required: true,
  2248. schema: {
  2249. $ref: "#/definitions/CohortUpdate"
  2250. }
  2251. }
  2252. ],
  2253. responses: {
  2254. 201: {
  2255. description: "cohort response"
  2256. },
  2257. 401: {
  2258. description: "User not logged in"
  2259. }
  2260. }
  2261. },
  2262. delete: {
  2263. tags: [
  2264. "cohort"
  2265. ],
  2266. summary: "Delete or purge resource by uuid",
  2267. description: "The resource will be voided/retired unless purge = 'true'",
  2268. operationId: "deleteCohort",
  2269. consumes: [
  2270. "application/json"
  2271. ],
  2272. produces: [
  2273. "application/json"
  2274. ],
  2275. parameters: [
  2276. {
  2277. name: "uuid",
  2278. in: "path",
  2279. description: "uuid to delete",
  2280. required: true,
  2281. type: "string"
  2282. },
  2283. {
  2284. name: "purge",
  2285. in: "query",
  2286. required: false,
  2287. type: "boolean"
  2288. }
  2289. ],
  2290. responses: {
  2291. 204: {
  2292. description: "Delete successful"
  2293. },
  2294. 401: {
  2295. description: "User not logged in"
  2296. },
  2297. 404: {
  2298. description: "Resource with given uuid doesn't exist"
  2299. }
  2300. }
  2301. }
  2302. },
  2303. /conceptclass: {
  2304. get: {
  2305. tags: [
  2306. "conceptclass"
  2307. ],
  2308. summary: "Fetch all non-retired conceptclass resources or perform search",
  2309. description: "All search parameters are optional",
  2310. operationId: "getAllConceptClasses",
  2311. consumes: [
  2312. "application/json"
  2313. ],
  2314. produces: [
  2315. "application/json"
  2316. ],
  2317. parameters: [
  2318. {
  2319. name: "limit",
  2320. in: "query",
  2321. description: "The number of results to return",
  2322. required: false,
  2323. type: "integer"
  2324. },
  2325. {
  2326. name: "startIndex",
  2327. in: "query",
  2328. description: "The offset at which to start",
  2329. required: false,
  2330. type: "integer"
  2331. },
  2332. {
  2333. name: "v",
  2334. in: "query",
  2335. description: "The representation to return (ref, default, full or custom)",
  2336. required: false,
  2337. type: "string",
  2338. enum: [
  2339. "ref",
  2340. "default",
  2341. "full",
  2342. "custom"
  2343. ]
  2344. },
  2345. {
  2346. name: "q",
  2347. in: "query",
  2348. description: "The search query",
  2349. required: false,
  2350. type: "string"
  2351. }
  2352. ],
  2353. responses: {
  2354. 200: {
  2355. description: "conceptclass response",
  2356. schema: {
  2357. $ref: "#/definitions/FetchAll"
  2358. }
  2359. },
  2360. 401: {
  2361. description: "User not logged in"
  2362. }
  2363. }
  2364. },
  2365. post: {
  2366. tags: [
  2367. "conceptclass"
  2368. ],
  2369. summary: "Create with properties in request",
  2370. operationId: "createConceptClass",
  2371. consumes: [
  2372. "application/json"
  2373. ],
  2374. produces: [
  2375. "application/json"
  2376. ],
  2377. parameters: [
  2378. {
  2379. in: "body",
  2380. name: "resource",
  2381. description: "Resource to create",
  2382. required: true,
  2383. schema: {
  2384. $ref: "#/definitions/ConceptclassCreate"
  2385. }
  2386. }
  2387. ],
  2388. responses: {
  2389. 201: {
  2390. description: "conceptclass response"
  2391. },
  2392. 401: {
  2393. description: "User not logged in"
  2394. }
  2395. }
  2396. }
  2397. },
  2398. /conceptclass/{uuid}: {
  2399. get: {
  2400. tags: [
  2401. "conceptclass"
  2402. ],
  2403. summary: "Fetch by uuid",
  2404. operationId: "getConceptClass",
  2405. consumes: [
  2406. "application/json"
  2407. ],
  2408. produces: [
  2409. "application/json"
  2410. ],
  2411. parameters: [
  2412. {
  2413. name: "v",
  2414. in: "query",
  2415. description: "The representation to return (ref, default, full or custom)",
  2416. required: false,
  2417. type: "string",
  2418. enum: [
  2419. "ref",
  2420. "default",
  2421. "full",
  2422. "custom"
  2423. ]
  2424. },
  2425. {
  2426. name: "uuid",
  2427. in: "path",
  2428. description: "uuid to filter by",
  2429. required: true,
  2430. type: "string"
  2431. }
  2432. ],
  2433. responses: {
  2434. 200: {
  2435. description: "conceptclass response",
  2436. schema: {
  2437. $ref: "#/definitions/ConceptclassGet"
  2438. }
  2439. },
  2440. 401: {
  2441. description: "User not logged in"
  2442. },
  2443. 404: {
  2444. description: "Resource with given uuid doesn't exist"
  2445. }
  2446. }
  2447. },
  2448. post: {
  2449. tags: [
  2450. "conceptclass"
  2451. ],
  2452. summary: "Edit with given uuid, only modifying properties in request",
  2453. operationId: "updateConceptClass",
  2454. consumes: [
  2455. "application/json"
  2456. ],
  2457. produces: [
  2458. "application/json"
  2459. ],
  2460. parameters: [
  2461. {
  2462. name: "uuid",
  2463. in: "path",
  2464. description: "uuid of resource to update",
  2465. required: true,
  2466. type: "string"
  2467. },
  2468. {
  2469. in: "body",
  2470. name: "resource",
  2471. description: "Resource properties to update",
  2472. required: true,
  2473. schema: {
  2474. $ref: "#/definitions/ConceptclassUpdate"
  2475. }
  2476. }
  2477. ],
  2478. responses: {
  2479. 201: {
  2480. description: "conceptclass response"
  2481. },
  2482. 401: {
  2483. description: "User not logged in"
  2484. }
  2485. }
  2486. },
  2487. delete: {
  2488. tags: [
  2489. "conceptclass"
  2490. ],
  2491. summary: "Delete or purge resource by uuid",
  2492. description: "The resource will be voided/retired unless purge = 'true'",
  2493. operationId: "deleteConceptClass",
  2494. consumes: [
  2495. "application/json"
  2496. ],
  2497. produces: [
  2498. "application/json"
  2499. ],
  2500. parameters: [
  2501. {
  2502. name: "uuid",
  2503. in: "path",
  2504. description: "uuid to delete",
  2505. required: true,
  2506. type: "string"
  2507. },
  2508. {
  2509. name: "purge",
  2510. in: "query",
  2511. required: false,
  2512. type: "boolean"
  2513. }
  2514. ],
  2515. responses: {
  2516. 204: {
  2517. description: "Delete successful"
  2518. },
  2519. 401: {
  2520. description: "User not logged in"
  2521. },
  2522. 404: {
  2523. description: "Resource with given uuid doesn't exist"
  2524. }
  2525. }
  2526. }
  2527. },
  2528. /conceptattributetype: {
  2529. get: {
  2530. tags: [
  2531. "conceptattributetype"
  2532. ],
  2533. summary: "Fetch all non-retired conceptattributetype resources or perform search",
  2534. description: "All search parameters are optional",
  2535. operationId: "getAllConceptAttributeTypes",
  2536. consumes: [
  2537. "application/json"
  2538. ],
  2539. produces: [
  2540. "application/json"
  2541. ],
  2542. parameters: [
  2543. {
  2544. name: "limit",
  2545. in: "query",
  2546. description: "The number of results to return",
  2547. required: false,
  2548. type: "integer"
  2549. },
  2550. {
  2551. name: "startIndex",
  2552. in: "query",
  2553. description: "The offset at which to start",
  2554. required: false,
  2555. type: "integer"
  2556. },
  2557. {
  2558. name: "v",
  2559. in: "query",
  2560. description: "The representation to return (ref, default, full or custom)",
  2561. required: false,
  2562. type: "string",
  2563. enum: [
  2564. "ref",
  2565. "default",
  2566. "full",
  2567. "custom"
  2568. ]
  2569. },
  2570. {
  2571. name: "q",
  2572. in: "query",
  2573. description: "The search query",
  2574. required: false,
  2575. type: "string"
  2576. }
  2577. ],
  2578. responses: {
  2579. 200: {
  2580. description: "conceptattributetype response",
  2581. schema: {
  2582. $ref: "#/definitions/FetchAll"
  2583. }
  2584. },
  2585. 401: {
  2586. description: "User not logged in"
  2587. }
  2588. }
  2589. },
  2590. post: {
  2591. tags: [
  2592. "conceptattributetype"
  2593. ],
  2594. summary: "Create with properties in request",
  2595. operationId: "createConceptAttributeType",
  2596. consumes: [
  2597. "application/json"
  2598. ],
  2599. produces: [
  2600. "application/json"
  2601. ],
  2602. parameters: [
  2603. {
  2604. in: "body",
  2605. name: "resource",
  2606. description: "Resource to create",
  2607. required: true,
  2608. schema: {
  2609. $ref: "#/definitions/ConceptattributetypeCreate"
  2610. }
  2611. }
  2612. ],
  2613. responses: {
  2614. 201: {
  2615. description: "conceptattributetype response"
  2616. },
  2617. 401: {
  2618. description: "User not logged in"
  2619. }
  2620. }
  2621. }
  2622. },
  2623. /conceptattributetype/{uuid}: {
  2624. get: {
  2625. tags: [
  2626. "conceptattributetype"
  2627. ],
  2628. summary: "Fetch by uuid",
  2629. operationId: "getConceptAttributeType",
  2630. consumes: [
  2631. "application/json"
  2632. ],
  2633. produces: [
  2634. "application/json"
  2635. ],
  2636. parameters: [
  2637. {
  2638. name: "v",
  2639. in: "query",
  2640. description: "The representation to return (ref, default, full or custom)",
  2641. required: false,
  2642. type: "string",
  2643. enum: [
  2644. "ref",
  2645. "default",
  2646. "full",
  2647. "custom"
  2648. ]
  2649. },
  2650. {
  2651. name: "uuid",
  2652. in: "path",
  2653. description: "uuid to filter by",
  2654. required: true,
  2655. type: "string"
  2656. }
  2657. ],
  2658. responses: {
  2659. 200: {
  2660. description: "conceptattributetype response",
  2661. schema: {
  2662. $ref: "#/definitions/ConceptattributetypeGet"
  2663. }
  2664. },
  2665. 401: {
  2666. description: "User not logged in"
  2667. },
  2668. 404: {
  2669. description: "Resource with given uuid doesn't exist"
  2670. }
  2671. }
  2672. },
  2673. post: {
  2674. tags: [
  2675. "conceptattributetype"
  2676. ],
  2677. summary: "Edit with given uuid, only modifying properties in request",
  2678. operationId: "updateConceptAttributeType",
  2679. consumes: [
  2680. "application/json"
  2681. ],
  2682. produces: [
  2683. "application/json"
  2684. ],
  2685. parameters: [
  2686. {
  2687. name: "uuid",
  2688. in: "path",
  2689. description: "uuid of resource to update",
  2690. required: true,
  2691. type: "string"
  2692. },
  2693. {
  2694. in: "body",
  2695. name: "resource",
  2696. description: "Resource properties to update",
  2697. required: true,
  2698. schema: {
  2699. $ref: "#/definitions/ConceptattributetypeUpdate"
  2700. }
  2701. }
  2702. ],
  2703. responses: {
  2704. 201: {
  2705. description: "conceptattributetype response"
  2706. },
  2707. 401: {
  2708. description: "User not logged in"
  2709. }
  2710. }
  2711. },
  2712. delete: {
  2713. tags: [
  2714. "conceptattributetype"
  2715. ],
  2716. summary: "Delete or purge resource by uuid",
  2717. description: "The resource will be voided/retired unless purge = 'true'",
  2718. operationId: "deleteConceptAttributeType",
  2719. consumes: [
  2720. "application/json"
  2721. ],
  2722. produces: [
  2723. "application/json"
  2724. ],
  2725. parameters: [
  2726. {
  2727. name: "uuid",
  2728. in: "path",
  2729. description: "uuid to delete",
  2730. required: true,
  2731. type: "string"
  2732. },
  2733. {
  2734. name: "purge",
  2735. in: "query",
  2736. required: false,
  2737. type: "boolean"
  2738. }
  2739. ],
  2740. responses: {
  2741. 204: {
  2742. description: "Delete successful"
  2743. },
  2744. 401: {
  2745. description: "User not logged in"
  2746. },
  2747. 404: {
  2748. description: "Resource with given uuid doesn't exist"
  2749. }
  2750. }
  2751. }
  2752. },
  2753. /person: {
  2754. get: {
  2755. tags: [
  2756. "person"
  2757. ],
  2758. summary: "Search for person",
  2759. description: "At least one search parameter must be specified",
  2760. operationId: "getAllPersons",
  2761. produces: [
  2762. "application/json",
  2763. "application/xml"
  2764. ],
  2765. parameters: [
  2766. {
  2767. name: "limit",
  2768. in: "query",
  2769. description: "The number of results to return",
  2770. required: false,
  2771. type: "integer"
  2772. },
  2773. {
  2774. name: "startIndex",
  2775. in: "query",
  2776. description: "The offset at which to start",
  2777. required: false,
  2778. type: "integer"
  2779. },
  2780. {
  2781. name: "v",
  2782. in: "query",
  2783. description: "The representation to return (ref, default, full or custom)",
  2784. required: false,
  2785. type: "string",
  2786. enum: [
  2787. "ref",
  2788. "default",
  2789. "full",
  2790. "custom"
  2791. ]
  2792. },
  2793. {
  2794. name: "q",
  2795. in: "query",
  2796. description: "The search query",
  2797. required: true,
  2798. type: "string"
  2799. }
  2800. ],
  2801. responses: {
  2802. 200: {
  2803. description: "person response",
  2804. schema: {
  2805. $ref: "#/definitions/FetchAll"
  2806. }
  2807. }
  2808. }
  2809. },
  2810. post: {
  2811. tags: [
  2812. "person"
  2813. ],
  2814. summary: "Create with properties in request",
  2815. operationId: "createPerson",
  2816. consumes: [
  2817. "application/json"
  2818. ],
  2819. produces: [
  2820. "application/json"
  2821. ],
  2822. parameters: [
  2823. {
  2824. in: "body",
  2825. name: "resource",
  2826. description: "Resource to create",
  2827. required: true,
  2828. schema: {
  2829. $ref: "#/definitions/PersonCreate"
  2830. }
  2831. }
  2832. ],
  2833. responses: {
  2834. 201: {
  2835. description: "person response"
  2836. },
  2837. 401: {
  2838. description: "User not logged in"
  2839. }
  2840. }
  2841. }
  2842. },
  2843. /person/{uuid}: {
  2844. get: {
  2845. tags: [
  2846. "person"
  2847. ],
  2848. summary: "Fetch by uuid",
  2849. operationId: "getPerson",
  2850. consumes: [
  2851. "application/json"
  2852. ],
  2853. produces: [
  2854. "application/json"
  2855. ],
  2856. parameters: [
  2857. {
  2858. name: "v",
  2859. in: "query",
  2860. description: "The representation to return (ref, default, full or custom)",
  2861. required: false,
  2862. type: "string",
  2863. enum: [
  2864. "ref",
  2865. "default",
  2866. "full",
  2867. "custom"
  2868. ]
  2869. },
  2870. {
  2871. name: "uuid",
  2872. in: "path",
  2873. description: "uuid to filter by",
  2874. required: true,
  2875. type: "string"
  2876. }
  2877. ],
  2878. responses: {
  2879. 200: {
  2880. description: "person response",
  2881. schema: {
  2882. $ref: "#/definitions/PersonGet"
  2883. }
  2884. },
  2885. 401: {
  2886. description: "User not logged in"
  2887. },
  2888. 404: {
  2889. description: "Resource with given uuid doesn't exist"
  2890. }
  2891. }
  2892. },
  2893. post: {
  2894. tags: [
  2895. "person"
  2896. ],
  2897. summary: "Edit with given uuid, only modifying properties in request",
  2898. operationId: "updatePerson",
  2899. consumes: [
  2900. "application/json"
  2901. ],
  2902. produces: [
  2903. "application/json"
  2904. ],
  2905. parameters: [
  2906. {
  2907. name: "uuid",
  2908. in: "path",
  2909. description: "uuid of resource to update",
  2910. required: true,
  2911. type: "string"
  2912. },
  2913. {
  2914. in: "body",
  2915. name: "resource",
  2916. description: "Resource properties to update",
  2917. required: true,
  2918. schema: {
  2919. $ref: "#/definitions/PersonUpdate"
  2920. }
  2921. }
  2922. ],
  2923. responses: {
  2924. 201: {
  2925. description: "person response"
  2926. },
  2927. 401: {
  2928. description: "User not logged in"
  2929. }
  2930. }
  2931. },
  2932. delete: {
  2933. tags: [
  2934. "person"
  2935. ],
  2936. summary: "Delete or purge resource by uuid",
  2937. description: "The resource will be voided/retired unless purge = 'true'",
  2938. operationId: "deletePerson",
  2939. consumes: [
  2940. "application/json"
  2941. ],
  2942. produces: [
  2943. "application/json"
  2944. ],
  2945. parameters: [
  2946. {
  2947. name: "uuid",
  2948. in: "path",
  2949. description: "uuid to delete",
  2950. required: true,
  2951. type: "string"
  2952. },
  2953. {
  2954. name: "purge",
  2955. in: "query",
  2956. required: false,
  2957. type: "boolean"
  2958. }
  2959. ],
  2960. responses: {
  2961. 204: {
  2962. description: "Delete successful"
  2963. },
  2964. 401: {
  2965. description: "User not logged in"
  2966. },
  2967. 404: {
  2968. description: "Resource with given uuid doesn't exist"
  2969. }
  2970. }
  2971. }
  2972. },
  2973. /taskdefinition: {
  2974. get: {
  2975. tags: [
  2976. "taskdefinition"
  2977. ],
  2978. summary: "Fetch all non-retired taskdefinition resources or perform search",
  2979. description: "All search parameters are optional",
  2980. operationId: "getAllTaskDefinitions",
  2981. consumes: [
  2982. "application/json"
  2983. ],
  2984. produces: [
  2985. "application/json"
  2986. ],
  2987. parameters: [
  2988. {
  2989. name: "limit",
  2990. in: "query",
  2991. description: "The number of results to return",
  2992. required: false,
  2993. type: "integer"
  2994. },
  2995. {
  2996. name: "startIndex",
  2997. in: "query",
  2998. description: "The offset at which to start",
  2999. required: false,
  3000. type: "integer"
  3001. },
  3002. {
  3003. name: "v",
  3004. in: "query",
  3005. description: "The representation to return (ref, default, full or custom)",
  3006. required: false,
  3007. type: "string",
  3008. enum: [
  3009. "ref",
  3010. "default",
  3011. "full",
  3012. "custom"
  3013. ]
  3014. },
  3015. {
  3016. name: "q",
  3017. in: "query",
  3018. description: "The search query",
  3019. required: false,
  3020. type: "string"
  3021. }
  3022. ],
  3023. responses: {
  3024. 200: {
  3025. description: "taskdefinition response",
  3026. schema: {
  3027. $ref: "#/definitions/FetchAll"
  3028. }
  3029. },
  3030. 401: {
  3031. description: "User not logged in"
  3032. }
  3033. }
  3034. },
  3035. post: {
  3036. tags: [
  3037. "taskdefinition"
  3038. ],
  3039. summary: "Create with properties in request",
  3040. operationId: "createTaskDefinition",
  3041. consumes: [
  3042. "application/json"
  3043. ],
  3044. produces: [
  3045. "application/json"
  3046. ],
  3047. parameters: [
  3048. {
  3049. in: "body",
  3050. name: "resource",
  3051. description: "Resource to create",
  3052. required: true,
  3053. schema: {
  3054. $ref: "#/definitions/TaskdefinitionCreate"
  3055. }
  3056. }
  3057. ],
  3058. responses: {
  3059. 201: {
  3060. description: "taskdefinition response"
  3061. },
  3062. 401: {
  3063. description: "User not logged in"
  3064. }
  3065. }
  3066. }
  3067. },
  3068. /taskdefinition/{uuid}: {
  3069. get: {
  3070. tags: [
  3071. "taskdefinition"
  3072. ],
  3073. summary: "Fetch by uuid",
  3074. operationId: "getTaskDefinition",
  3075. consumes: [
  3076. "application/json"
  3077. ],
  3078. produces: [
  3079. "application/json"
  3080. ],
  3081. parameters: [
  3082. {
  3083. name: "v",
  3084. in: "query",
  3085. description: "The representation to return (ref, default, full or custom)",
  3086. required: false,
  3087. type: "string",
  3088. enum: [
  3089. "ref",
  3090. "default",
  3091. "full",
  3092. "custom"
  3093. ]
  3094. },
  3095. {
  3096. name: "uuid",
  3097. in: "path",
  3098. description: "uuid to filter by",
  3099. required: true,
  3100. type: "string"
  3101. }
  3102. ],
  3103. responses: {
  3104. 200: {
  3105. description: "taskdefinition response",
  3106. schema: {
  3107. $ref: "#/definitions/TaskdefinitionGet"
  3108. }
  3109. },
  3110. 401: {
  3111. description: "User not logged in"
  3112. },
  3113. 404: {
  3114. description: "Resource with given uuid doesn't exist"
  3115. }
  3116. }
  3117. },
  3118. post: {
  3119. tags: [
  3120. "taskdefinition"
  3121. ],
  3122. summary: "Edit with given uuid, only modifying properties in request",
  3123. operationId: "updateTaskDefinition",
  3124. consumes: [
  3125. "application/json"
  3126. ],
  3127. produces: [
  3128. "application/json"
  3129. ],
  3130. parameters: [
  3131. {
  3132. name: "uuid",
  3133. in: "path",
  3134. description: "uuid of resource to update",
  3135. required: true,
  3136. type: "string"
  3137. },
  3138. {
  3139. in: "body",
  3140. name: "resource",
  3141. description: "Resource properties to update",
  3142. required: true,
  3143. schema: {
  3144. $ref: "#/definitions/TaskdefinitionUpdate"
  3145. }
  3146. }
  3147. ],
  3148. responses: {
  3149. 201: {
  3150. description: "taskdefinition response"
  3151. },
  3152. 401: {
  3153. description: "User not logged in"
  3154. }
  3155. }
  3156. },
  3157. delete: {
  3158. tags: [
  3159. "taskdefinition"
  3160. ],
  3161. summary: "Delete or purge resource by uuid",
  3162. description: "The resource will be voided/retired unless purge = 'true'",
  3163. operationId: "deleteTaskDefinition",
  3164. consumes: [
  3165. "application/json"
  3166. ],
  3167. produces: [
  3168. "application/json"
  3169. ],
  3170. parameters: [
  3171. {
  3172. name: "uuid",
  3173. in: "path",
  3174. description: "uuid to delete",
  3175. required: true,
  3176. type: "string"
  3177. },
  3178. {
  3179. name: "purge",
  3180. in: "query",
  3181. required: false,
  3182. type: "boolean"
  3183. }
  3184. ],
  3185. responses: {
  3186. 204: {
  3187. description: "Delete successful"
  3188. },
  3189. 401: {
  3190. description: "User not logged in"
  3191. },
  3192. 404: {
  3193. description: "Resource with given uuid doesn't exist"
  3194. }
  3195. }
  3196. }
  3197. },
  3198. /role: {
  3199. get: {
  3200. tags: [
  3201. "role"
  3202. ],
  3203. summary: "Fetch all non-retired role resources or perform search",
  3204. description: "All search parameters are optional",
  3205. operationId: "getAllRoles",
  3206. consumes: [
  3207. "application/json"
  3208. ],
  3209. produces: [
  3210. "application/json"
  3211. ],
  3212. parameters: [
  3213. {
  3214. name: "limit",
  3215. in: "query",
  3216. description: "The number of results to return",
  3217. required: false,
  3218. type: "integer"
  3219. },
  3220. {
  3221. name: "startIndex",
  3222. in: "query",
  3223. description: "The offset at which to start",
  3224. required: false,
  3225. type: "integer"
  3226. },
  3227. {
  3228. name: "v",
  3229. in: "query",
  3230. description: "The representation to return (ref, default, full or custom)",
  3231. required: false,
  3232. type: "string",
  3233. enum: [
  3234. "ref",
  3235. "default",
  3236. "full",
  3237. "custom"
  3238. ]
  3239. },
  3240. {
  3241. name: "q",
  3242. in: "query",
  3243. description: "The search query",
  3244. required: false,
  3245. type: "string"
  3246. }
  3247. ],
  3248. responses: {
  3249. 200: {
  3250. description: "role response",
  3251. schema: {
  3252. $ref: "#/definitions/FetchAll"
  3253. }
  3254. },
  3255. 401: {
  3256. description: "User not logged in"
  3257. }
  3258. }
  3259. },
  3260. post: {
  3261. tags: [
  3262. "role"
  3263. ],
  3264. summary: "Create with properties in request",
  3265. operationId: "createRole",
  3266. consumes: [
  3267. "application/json"
  3268. ],
  3269. produces: [
  3270. "application/json"
  3271. ],
  3272. parameters: [
  3273. {
  3274. in: "body",
  3275. name: "resource",
  3276. description: "Resource to create",
  3277. required: true,
  3278. schema: {
  3279. $ref: "#/definitions/RoleCreate"
  3280. }
  3281. }
  3282. ],
  3283. responses: {
  3284. 201: {
  3285. description: "role response"
  3286. },
  3287. 401: {
  3288. description: "User not logged in"
  3289. }
  3290. }
  3291. }
  3292. },
  3293. /role/{uuid}: {
  3294. get: {
  3295. tags: [
  3296. "role"
  3297. ],
  3298. summary: "Fetch by uuid",
  3299. operationId: "getRole",
  3300. consumes: [
  3301. "application/json"
  3302. ],
  3303. produces: [
  3304. "application/json"
  3305. ],
  3306. parameters: [
  3307. {
  3308. name: "v",
  3309. in: "query",
  3310. description: "The representation to return (ref, default, full or custom)",
  3311. required: false,
  3312. type: "string",
  3313. enum: [
  3314. "ref",
  3315. "default",
  3316. "full",
  3317. "custom"
  3318. ]
  3319. },
  3320. {
  3321. name: "uuid",
  3322. in: "path",
  3323. description: "uuid to filter by",
  3324. required: true,
  3325. type: "string"
  3326. }
  3327. ],
  3328. responses: {
  3329. 200: {
  3330. description: "role response",
  3331. schema: {
  3332. $ref: "#/definitions/RoleGet"
  3333. }
  3334. },
  3335. 401: {
  3336. description: "User not logged in"
  3337. },
  3338. 404: {
  3339. description: "Resource with given uuid doesn't exist"
  3340. }
  3341. }
  3342. },
  3343. post: {
  3344. tags: [
  3345. "role"
  3346. ],
  3347. summary: "Edit with given uuid, only modifying properties in request",
  3348. operationId: "updateRole",
  3349. consumes: [
  3350. "application/json"
  3351. ],
  3352. produces: [
  3353. "application/json"
  3354. ],
  3355. parameters: [
  3356. {
  3357. name: "uuid",
  3358. in: "path",
  3359. description: "uuid of resource to update",
  3360. required: true,
  3361. type: "string"
  3362. },
  3363. {
  3364. in: "body",
  3365. name: "resource",
  3366. description: "Resource properties to update",
  3367. required: true,
  3368. schema: {
  3369. $ref: "#/definitions/RoleUpdate"
  3370. }
  3371. }
  3372. ],
  3373. responses: {
  3374. 201: {
  3375. description: "role response"
  3376. },
  3377. 401: {
  3378. description: "User not logged in"
  3379. }
  3380. }
  3381. },
  3382. delete: {
  3383. tags: [
  3384. "role"
  3385. ],
  3386. summary: "Delete or purge resource by uuid",
  3387. description: "The resource will be voided/retired unless purge = 'true'",
  3388. operationId: "deleteRole",
  3389. consumes: [
  3390. "application/json"
  3391. ],
  3392. produces: [
  3393. "application/json"
  3394. ],
  3395. parameters: [
  3396. {
  3397. name: "uuid",
  3398. in: "path",
  3399. description: "uuid to delete",
  3400. required: true,
  3401. type: "string"
  3402. },
  3403. {
  3404. name: "purge",
  3405. in: "query",
  3406. required: false,
  3407. type: "boolean"
  3408. }
  3409. ],
  3410. responses: {
  3411. 204: {
  3412. description: "Delete successful"
  3413. },
  3414. 401: {
  3415. description: "User not logged in"
  3416. },
  3417. 404: {
  3418. description: "Resource with given uuid doesn't exist"
  3419. }
  3420. }
  3421. }
  3422. },
  3423. /obs: {
  3424. get: {
  3425. tags: [
  3426. "obs"
  3427. ],
  3428. summary: "Search for obs",
  3429. description: "At least one search parameter must be specified",
  3430. operationId: "getAllObses",
  3431. produces: [
  3432. "application/json",
  3433. "application/xml"
  3434. ],
  3435. parameters: [
  3436. {
  3437. name: "limit",
  3438. in: "query",
  3439. description: "The number of results to return",
  3440. required: false,
  3441. type: "integer"
  3442. },
  3443. {
  3444. name: "startIndex",
  3445. in: "query",
  3446. description: "The offset at which to start",
  3447. required: false,
  3448. type: "integer"
  3449. },
  3450. {
  3451. name: "v",
  3452. in: "query",
  3453. description: "The representation to return (ref, default, full or custom)",
  3454. required: false,
  3455. type: "string",
  3456. enum: [
  3457. "ref",
  3458. "default",
  3459. "full",
  3460. "custom"
  3461. ]
  3462. },
  3463. {
  3464. name: "q",
  3465. in: "query",
  3466. description: "The search query",
  3467. required: false,
  3468. type: "string"
  3469. },
  3470. {
  3471. name: "concepts",
  3472. in: "query",
  3473. description: "Must be used with patient",
  3474. required: false,
  3475. type: "string"
  3476. },
  3477. {
  3478. name: "patient",
  3479. in: "query",
  3480. required: false,
  3481. type: "string"
  3482. },
  3483. {
  3484. name: "concept",
  3485. in: "query",
  3486. description: "Must be used with patient",
  3487. required: false,
  3488. type: "string"
  3489. },
  3490. {
  3491. name: "groupingConcepts",
  3492. in: "query",
  3493. description: "Must be used with patient",
  3494. required: false,
  3495. type: "string"
  3496. },
  3497. {
  3498. name: "answers",
  3499. in: "query",
  3500. description: "Must be used with patient",
  3501. required: false,
  3502. type: "string"
  3503. }
  3504. ],
  3505. responses: {
  3506. 200: {
  3507. description: "obs response",
  3508. schema: {
  3509. $ref: "#/definitions/FetchAll"
  3510. }
  3511. }
  3512. }
  3513. },
  3514. post: {
  3515. tags: [
  3516. "obs"
  3517. ],
  3518. summary: "Create with properties in request",
  3519. operationId: "createObs",
  3520. consumes: [
  3521. "application/json"
  3522. ],
  3523. produces: [
  3524. "application/json"
  3525. ],
  3526. parameters: [
  3527. {
  3528. in: "body",
  3529. name: "resource",
  3530. description: "Resource to create",
  3531. required: true,
  3532. schema: {
  3533. $ref: "#/definitions/ObsCreate"
  3534. }
  3535. }
  3536. ],
  3537. responses: {
  3538. 201: {
  3539. description: "obs response"
  3540. },
  3541. 401: {
  3542. description: "User not logged in"
  3543. }
  3544. }
  3545. }
  3546. },
  3547. /obs/{uuid}: {
  3548. get: {
  3549. tags: [
  3550. "obs"
  3551. ],
  3552. summary: "Fetch by uuid",
  3553. operationId: "getObs",
  3554. consumes: [
  3555. "application/json"
  3556. ],
  3557. produces: [
  3558. "application/json"
  3559. ],
  3560. parameters: [
  3561. {
  3562. name: "v",
  3563. in: "query",
  3564. description: "The representation to return (ref, default, full or custom)",
  3565. required: false,
  3566. type: "string",
  3567. enum: [
  3568. "ref",
  3569. "default",
  3570. "full",
  3571. "custom"
  3572. ]
  3573. },
  3574. {
  3575. name: "uuid",
  3576. in: "path",
  3577. description: "uuid to filter by",
  3578. required: true,
  3579. type: "string"
  3580. }
  3581. ],
  3582. responses: {
  3583. 200: {
  3584. description: "obs response",
  3585. schema: {
  3586. $ref: "#/definitions/ObsGet"
  3587. }
  3588. },
  3589. 401: {
  3590. description: "User not logged in"
  3591. },
  3592. 404: {
  3593. description: "Resource with given uuid doesn't exist"
  3594. }
  3595. }
  3596. },
  3597. post: {
  3598. tags: [
  3599. "obs"
  3600. ],
  3601. summary: "Edit with given uuid, only modifying properties in request",
  3602. operationId: "updateObs",
  3603. consumes: [
  3604. "application/json"
  3605. ],
  3606. produces: [
  3607. "application/json"
  3608. ],
  3609. parameters: [
  3610. {
  3611. name: "uuid",
  3612. in: "path",
  3613. description: "uuid of resource to update",
  3614. required: true,
  3615. type: "string"
  3616. },
  3617. {
  3618. in: "body",
  3619. name: "resource",
  3620. description: "Resource properties to update",
  3621. required: true,
  3622. schema: {
  3623. $ref: "#/definitions/ObsUpdate"
  3624. }
  3625. }
  3626. ],
  3627. responses: {
  3628. 201: {
  3629. description: "obs response"
  3630. },
  3631. 401: {
  3632. description: "User not logged in"
  3633. }
  3634. }
  3635. },
  3636. delete: {
  3637. tags: [
  3638. "obs"
  3639. ],
  3640. summary: "Delete or purge resource by uuid",
  3641. description: "The resource will be voided/retired unless purge = 'true'",
  3642. operationId: "deleteObs",
  3643. consumes: [
  3644. "application/json"
  3645. ],
  3646. produces: [
  3647. "application/json"
  3648. ],
  3649. parameters: [
  3650. {
  3651. name: "uuid",
  3652. in: "path",
  3653. description: "uuid to delete",
  3654. required: true,
  3655. type: "string"
  3656. },
  3657. {
  3658. name: "purge",
  3659. in: "query",
  3660. required: false,
  3661. type: "boolean"
  3662. }
  3663. ],
  3664. responses: {
  3665. 204: {
  3666. description: "Delete successful"
  3667. },
  3668. 401: {
  3669. description: "User not logged in"
  3670. },
  3671. 404: {
  3672. description: "Resource with given uuid doesn't exist"
  3673. }
  3674. }
  3675. }
  3676. },
  3677. /programattributetype: {
  3678. get: {
  3679. tags: [
  3680. "programattributetype"
  3681. ],
  3682. summary: "Fetch all non-retired programattributetype resources or perform search",
  3683. description: "All search parameters are optional",
  3684. operationId: "getAllProgramAttributeTypes",
  3685. consumes: [
  3686. "application/json"
  3687. ],
  3688. produces: [
  3689. "application/json"
  3690. ],
  3691. parameters: [
  3692. {
  3693. name: "limit",
  3694. in: "query",
  3695. description: "The number of results to return",
  3696. required: false,
  3697. type: "integer"
  3698. },
  3699. {
  3700. name: "startIndex",
  3701. in: "query",
  3702. description: "The offset at which to start",
  3703. required: false,
  3704. type: "integer"
  3705. },
  3706. {
  3707. name: "v",
  3708. in: "query",
  3709. description: "The representation to return (ref, default, full or custom)",
  3710. required: false,
  3711. type: "string",
  3712. enum: [
  3713. "ref",
  3714. "default",
  3715. "full",
  3716. "custom"
  3717. ]
  3718. },
  3719. {
  3720. name: "q",
  3721. in: "query",
  3722. description: "The search query",
  3723. required: false,
  3724. type: "string"
  3725. }
  3726. ],
  3727. responses: {
  3728. 200: {
  3729. description: "programattributetype response",
  3730. schema: {
  3731. $ref: "#/definitions/FetchAll"
  3732. }
  3733. },
  3734. 401: {
  3735. description: "User not logged in"
  3736. }
  3737. }
  3738. },
  3739. post: {
  3740. tags: [
  3741. "programattributetype"
  3742. ],
  3743. summary: "Create with properties in request",
  3744. operationId: "createProgramAttributeType",
  3745. consumes: [
  3746. "application/json"
  3747. ],
  3748. produces: [
  3749. "application/json"
  3750. ],
  3751. parameters: [
  3752. {
  3753. in: "body",
  3754. name: "resource",
  3755. description: "Resource to create",
  3756. required: true,
  3757. schema: {
  3758. $ref: "#/definitions/ProgramattributetypeCreate"
  3759. }
  3760. }
  3761. ],
  3762. responses: {
  3763. 201: {
  3764. description: "programattributetype response"
  3765. },
  3766. 401: {
  3767. description: "User not logged in"
  3768. }
  3769. }
  3770. }
  3771. },
  3772. /programattributetype/{uuid}: {
  3773. get: {
  3774. tags: [
  3775. "programattributetype"
  3776. ],
  3777. summary: "Fetch by uuid",
  3778. operationId: "getProgramAttributeType",
  3779. consumes: [
  3780. "application/json"
  3781. ],
  3782. produces: [
  3783. "application/json"
  3784. ],
  3785. parameters: [
  3786. {
  3787. name: "v",
  3788. in: "query",
  3789. description: "The representation to return (ref, default, full or custom)",
  3790. required: false,
  3791. type: "string",
  3792. enum: [
  3793. "ref",
  3794. "default",
  3795. "full",
  3796. "custom"
  3797. ]
  3798. },
  3799. {
  3800. name: "uuid",
  3801. in: "path",
  3802. description: "uuid to filter by",
  3803. required: true,
  3804. type: "string"
  3805. }
  3806. ],
  3807. responses: {
  3808. 200: {
  3809. description: "programattributetype response",
  3810. schema: {
  3811. $ref: "#/definitions/ProgramattributetypeGet"
  3812. }
  3813. },
  3814. 401: {
  3815. description: "User not logged in"
  3816. },
  3817. 404: {
  3818. description: "Resource with given uuid doesn't exist"
  3819. }
  3820. }
  3821. },
  3822. post: {
  3823. tags: [
  3824. "programattributetype"
  3825. ],
  3826. summary: "Edit with given uuid, only modifying properties in request",
  3827. operationId: "updateProgramAttributeType",
  3828. consumes: [
  3829. "application/json"
  3830. ],
  3831. produces: [
  3832. "application/json"
  3833. ],
  3834. parameters: [
  3835. {
  3836. name: "uuid",
  3837. in: "path",
  3838. description: "uuid of resource to update",
  3839. required: true,
  3840. type: "string"
  3841. },
  3842. {
  3843. in: "body",
  3844. name: "resource",
  3845. description: "Resource properties to update",
  3846. required: true,
  3847. schema: {
  3848. $ref: "#/definitions/ProgramattributetypeUpdate"
  3849. }
  3850. }
  3851. ],
  3852. responses: {
  3853. 201: {
  3854. description: "programattributetype response"
  3855. },
  3856. 401: {
  3857. description: "User not logged in"
  3858. }
  3859. }
  3860. },
  3861. delete: {
  3862. tags: [
  3863. "programattributetype"
  3864. ],
  3865. summary: "Delete or purge resource by uuid",
  3866. description: "The resource will be voided/retired unless purge = 'true'",
  3867. operationId: "deleteProgramAttributeType",
  3868. consumes: [
  3869. "application/json"
  3870. ],
  3871. produces: [
  3872. "application/json"
  3873. ],
  3874. parameters: [
  3875. {
  3876. name: "uuid",
  3877. in: "path",
  3878. description: "uuid to delete",
  3879. required: true,
  3880. type: "string"
  3881. },
  3882. {
  3883. name: "purge",
  3884. in: "query",
  3885. required: false,
  3886. type: "boolean"
  3887. }
  3888. ],
  3889. responses: {
  3890. 204: {
  3891. description: "Delete successful"
  3892. },
  3893. 401: {
  3894. description: "User not logged in"
  3895. },
  3896. 404: {
  3897. description: "Resource with given uuid doesn't exist"
  3898. }
  3899. }
  3900. }
  3901. },
  3902. /patientdiagnoses: {
  3903. get: {
  3904. tags: [
  3905. "patientdiagnoses"
  3906. ],
  3907. summary: "Search for patientdiagnoses",
  3908. description: "At least one search parameter must be specified",
  3909. operationId: "getAllDiagnoses",
  3910. produces: [
  3911. "application/json",
  3912. "application/xml"
  3913. ],
  3914. parameters: [
  3915. {
  3916. name: "limit",
  3917. in: "query",
  3918. description: "The number of results to return",
  3919. required: false,
  3920. type: "integer"
  3921. },
  3922. {
  3923. name: "startIndex",
  3924. in: "query",
  3925. description: "The offset at which to start",
  3926. required: false,
  3927. type: "integer"
  3928. },
  3929. {
  3930. name: "v",
  3931. in: "query",
  3932. description: "The representation to return (ref, default, full or custom)",
  3933. required: false,
  3934. type: "string",
  3935. enum: [
  3936. "ref",
  3937. "default",
  3938. "full",
  3939. "custom"
  3940. ]
  3941. },
  3942. {
  3943. name: "q",
  3944. in: "query",
  3945. description: "The search query",
  3946. required: true,
  3947. type: "string"
  3948. }
  3949. ],
  3950. responses: {
  3951. 200: {
  3952. description: "patientdiagnoses response",
  3953. schema: {
  3954. $ref: "#/definitions/FetchAll"
  3955. }
  3956. }
  3957. }
  3958. },
  3959. post: {
  3960. tags: [
  3961. "patientdiagnoses"
  3962. ],
  3963. summary: "Create with properties in request",
  3964. operationId: "createDiagnosis",
  3965. consumes: [
  3966. "application/json"
  3967. ],
  3968. produces: [
  3969. "application/json"
  3970. ],
  3971. parameters: [
  3972. {
  3973. in: "body",
  3974. name: "resource",
  3975. description: "Resource to create",
  3976. required: true,
  3977. schema: {
  3978. $ref: "#/definitions/PatientdiagnosesCreate"
  3979. }
  3980. }
  3981. ],
  3982. responses: {
  3983. 201: {
  3984. description: "patientdiagnoses response"
  3985. },
  3986. 401: {
  3987. description: "User not logged in"
  3988. }
  3989. }
  3990. }
  3991. },
  3992. /patientdiagnoses/{uuid}: {
  3993. get: {
  3994. tags: [
  3995. "patientdiagnoses"
  3996. ],
  3997. summary: "Fetch by uuid",
  3998. operationId: "getDiagnosis",
  3999. consumes: [
  4000. "application/json"
  4001. ],
  4002. produces: [
  4003. "application/json"
  4004. ],
  4005. parameters: [
  4006. {
  4007. name: "v",
  4008. in: "query",
  4009. description: "The representation to return (ref, default, full or custom)",
  4010. required: false,
  4011. type: "string",
  4012. enum: [
  4013. "ref",
  4014. "default",
  4015. "full",
  4016. "custom"
  4017. ]
  4018. },
  4019. {
  4020. name: "uuid",
  4021. in: "path",
  4022. description: "uuid to filter by",
  4023. required: true,
  4024. type: "string"
  4025. }
  4026. ],
  4027. responses: {
  4028. 200: {
  4029. description: "patientdiagnoses response",
  4030. schema: {
  4031. $ref: "#/definitions/PatientdiagnosesGet"
  4032. }
  4033. },
  4034. 401: {
  4035. description: "User not logged in"
  4036. },
  4037. 404: {
  4038. description: "Resource with given uuid doesn't exist"
  4039. }
  4040. }
  4041. },
  4042. post: {
  4043. tags: [
  4044. "patientdiagnoses"
  4045. ],
  4046. summary: "Edit with given uuid, only modifying properties in request",
  4047. operationId: "updateDiagnosis",
  4048. consumes: [
  4049. "application/json"
  4050. ],
  4051. produces: [
  4052. "application/json"
  4053. ],
  4054. parameters: [
  4055. {
  4056. name: "uuid",
  4057. in: "path",
  4058. description: "uuid of resource to update",
  4059. required: true,
  4060. type: "string"
  4061. },
  4062. {
  4063. in: "body",
  4064. name: "resource",
  4065. description: "Resource properties to update",
  4066. required: true,
  4067. schema: {
  4068. $ref: "#/definitions/PatientdiagnosesUpdate"
  4069. }
  4070. }
  4071. ],
  4072. responses: {
  4073. 201: {
  4074. description: "patientdiagnoses response"
  4075. },
  4076. 401: {
  4077. description: "User not logged in"
  4078. }
  4079. }
  4080. },
  4081. delete: {
  4082. tags: [
  4083. "patientdiagnoses"
  4084. ],
  4085. summary: "Delete or purge resource by uuid",
  4086. description: "The resource will be voided/retired unless purge = 'true'",
  4087. operationId: "deleteDiagnosis",
  4088. consumes: [
  4089. "application/json"
  4090. ],
  4091. produces: [
  4092. "application/json"
  4093. ],
  4094. parameters: [
  4095. {
  4096. name: "uuid",
  4097. in: "path",
  4098. description: "uuid to delete",
  4099. required: true,
  4100. type: "string"
  4101. },
  4102. {
  4103. name: "purge",
  4104. in: "query",
  4105. required: false,
  4106. type: "boolean"
  4107. }
  4108. ],
  4109. responses: {
  4110. 204: {
  4111. description: "Delete successful"
  4112. },
  4113. 401: {
  4114. description: "User not logged in"
  4115. },
  4116. 404: {
  4117. description: "Resource with given uuid doesn't exist"
  4118. }
  4119. }
  4120. }
  4121. },
  4122. /patient: {
  4123. get: {
  4124. tags: [
  4125. "patient"
  4126. ],
  4127. summary: "Search for patient",
  4128. description: "At least one search parameter must be specified",
  4129. operationId: "getAllPatients",
  4130. produces: [
  4131. "application/json",
  4132. "application/xml"
  4133. ],
  4134. parameters: [
  4135. {
  4136. name: "limit",
  4137. in: "query",
  4138. description: "The number of results to return",
  4139. required: false,
  4140. type: "integer"
  4141. },
  4142. {
  4143. name: "startIndex",
  4144. in: "query",
  4145. description: "The offset at which to start",
  4146. required: false,
  4147. type: "integer"
  4148. },
  4149. {
  4150. name: "v",
  4151. in: "query",
  4152. description: "The representation to return (ref, default, full or custom)",
  4153. required: false,
  4154. type: "string",
  4155. enum: [
  4156. "ref",
  4157. "default",
  4158. "full",
  4159. "custom"
  4160. ]
  4161. },
  4162. {
  4163. name: "q",
  4164. in: "query",
  4165. description: "The search query",
  4166. required: false,
  4167. type: "string"
  4168. },
  4169. {
  4170. name: "matchSimilar",
  4171. in: "query",
  4172. required: false,
  4173. type: "string"
  4174. },
  4175. {
  4176. name: "country",
  4177. in: "query",
  4178. description: "Must be used with matchSimilar",
  4179. required: false,
  4180. type: "string"
  4181. },
  4182. {
  4183. name: "identifier",
  4184. in: "query",
  4185. required: false,
  4186. type: "string"
  4187. },
  4188. {
  4189. name: "birthdate",
  4190. in: "query",
  4191. description: "Must be used with matchSimilar",
  4192. required: false,
  4193. type: "string"
  4194. },
  4195. {
  4196. name: "gender",
  4197. in: "query",
  4198. description: "Must be used with matchSimilar",
  4199. required: false,
  4200. type: "string"
  4201. },
  4202. {
  4203. name: "city",
  4204. in: "query",
  4205. description: "Must be used with matchSimilar",
  4206. required: false,
  4207. type: "string"
  4208. },
  4209. {
  4210. name: "address2",
  4211. in: "query",
  4212. description: "Must be used with matchSimilar",
  4213. required: false,
  4214. type: "string"
  4215. },
  4216. {
  4217. name: "searchType",
  4218. in: "query",
  4219. description: "Must be used with identifier",
  4220. required: false,
  4221. type: "string"
  4222. },
  4223. {
  4224. name: "address1",
  4225. in: "query",
  4226. description: "Must be used with matchSimilar",
  4227. required: false,
  4228. type: "string"
  4229. },
  4230. {
  4231. name: "familyname",
  4232. in: "query",
  4233. description: "Must be used with matchSimilar",
  4234. required: false,
  4235. type: "string"
  4236. },
  4237. {
  4238. name: "middlename",
  4239. in: "query",
  4240. description: "Must be used with matchSimilar",
  4241. required: false,
  4242. type: "string"
  4243. },
  4244. {
  4245. name: "q",
  4246. in: "query",
  4247. required: false,
  4248. type: "string"
  4249. },
  4250. {
  4251. name: "includeDead",
  4252. in: "query",
  4253. description: "Must be used with q",
  4254. required: false,
  4255. type: "string"
  4256. },
  4257. {
  4258. name: "postalcode",
  4259. in: "query",
  4260. description: "Must be used with matchSimilar",
  4261. required: false,
  4262. type: "string"
  4263. },
  4264. {
  4265. name: "givenname",
  4266. in: "query",
  4267. description: "Must be used with matchSimilar",
  4268. required: false,
  4269. type: "string"
  4270. },
  4271. {
  4272. name: "state",
  4273. in: "query",
  4274. description: "Must be used with matchSimilar",
  4275. required: false,
  4276. type: "string"
  4277. }
  4278. ],
  4279. responses: {
  4280. 200: {
  4281. description: "patient response",
  4282. schema: {
  4283. $ref: "#/definitions/FetchAll"
  4284. }
  4285. }
  4286. }
  4287. },
  4288. post: {
  4289. tags: [
  4290. "patient"
  4291. ],
  4292. summary: "Create with properties in request",
  4293. operationId: "createPatient",
  4294. consumes: [
  4295. "application/json"
  4296. ],
  4297. produces: [
  4298. "application/json"
  4299. ],
  4300. parameters: [
  4301. {
  4302. in: "body",
  4303. name: "resource",
  4304. description: "Resource to create",
  4305. required: true,
  4306. schema: {
  4307. $ref: "#/definitions/PatientCreate"
  4308. }
  4309. }
  4310. ],
  4311. responses: {
  4312. 201: {
  4313. description: "patient response"
  4314. },
  4315. 401: {
  4316. description: "User not logged in"
  4317. }
  4318. }
  4319. }
  4320. },
  4321. /patient/{uuid}: {
  4322. get: {
  4323. tags: [
  4324. "patient"
  4325. ],
  4326. summary: "Fetch by uuid",
  4327. operationId: "getPatient",
  4328. consumes: [
  4329. "application/json"
  4330. ],
  4331. produces: [
  4332. "application/json"
  4333. ],
  4334. parameters: [
  4335. {
  4336. name: "v",
  4337. in: "query",
  4338. description: "The representation to return (ref, default, full or custom)",
  4339. required: false,
  4340. type: "string",
  4341. enum: [
  4342. "ref",
  4343. "default",
  4344. "full",
  4345. "custom"
  4346. ]
  4347. },
  4348. {
  4349. name: "uuid",
  4350. in: "path",
  4351. description: "uuid to filter by",
  4352. required: true,
  4353. type: "string"
  4354. }
  4355. ],
  4356. responses: {
  4357. 200: {
  4358. description: "patient response",
  4359. schema: {
  4360. $ref: "#/definitions/PatientGet"
  4361. }
  4362. },
  4363. 401: {
  4364. description: "User not logged in"
  4365. },
  4366. 404: {
  4367. description: "Resource with given uuid doesn't exist"
  4368. }
  4369. }
  4370. },
  4371. post: {
  4372. tags: [
  4373. "patient"
  4374. ],
  4375. summary: "Edit with given uuid, only modifying properties in request",
  4376. operationId: "updatePatient",
  4377. consumes: [
  4378. "application/json"
  4379. ],
  4380. produces: [
  4381. "application/json"
  4382. ],
  4383. parameters: [
  4384. {
  4385. name: "uuid",
  4386. in: "path",
  4387. description: "uuid of resource to update",
  4388. required: true,
  4389. type: "string"
  4390. },
  4391. {
  4392. in: "body",
  4393. name: "resource",
  4394. description: "Resource properties to update",
  4395. required: true,
  4396. schema: {
  4397. $ref: "#/definitions/PatientUpdate"
  4398. }
  4399. }
  4400. ],
  4401. responses: {
  4402. 201: {
  4403. description: "patient response"
  4404. },
  4405. 401: {
  4406. description: "User not logged in"
  4407. }
  4408. }
  4409. },
  4410. delete: {
  4411. tags: [
  4412. "patient"
  4413. ],
  4414. summary: "Delete or purge resource by uuid",
  4415. description: "The resource will be voided/retired unless purge = 'true'",
  4416. operationId: "deletePatient",
  4417. consumes: [
  4418. "application/json"
  4419. ],
  4420. produces: [
  4421. "application/json"
  4422. ],
  4423. parameters: [
  4424. {
  4425. name: "uuid",
  4426. in: "path",
  4427. description: "uuid to delete",
  4428. required: true,
  4429. type: "string"
  4430. },
  4431. {
  4432. name: "purge",
  4433. in: "query",
  4434. required: false,
  4435. type: "boolean"
  4436. }
  4437. ],
  4438. responses: {
  4439. 204: {
  4440. description: "Delete successful"
  4441. },
  4442. 401: {
  4443. description: "User not logged in"
  4444. },
  4445. 404: {
  4446. description: "Resource with given uuid doesn't exist"
  4447. }
  4448. }
  4449. }
  4450. },
  4451. /customdatatype: {
  4452. get: {
  4453. tags: [
  4454. "customdatatype"
  4455. ],
  4456. summary: "Fetch all non-retired customdatatype resources or perform search",
  4457. description: "All search parameters are optional",
  4458. operationId: "getAllCustomDatatypes",
  4459. consumes: [
  4460. "application/json"
  4461. ],
  4462. produces: [
  4463. "application/json"
  4464. ],
  4465. parameters: [
  4466. {
  4467. name: "limit",
  4468. in: "query",
  4469. description: "The number of results to return",
  4470. required: false,
  4471. type: "integer"
  4472. },
  4473. {
  4474. name: "startIndex",
  4475. in: "query",
  4476. description: "The offset at which to start",
  4477. required: false,
  4478. type: "integer"
  4479. },
  4480. {
  4481. name: "v",
  4482. in: "query",
  4483. description: "The representation to return (ref, default, full or custom)",
  4484. required: false,
  4485. type: "string",
  4486. enum: [
  4487. "ref",
  4488. "default",
  4489. "full",
  4490. "custom"
  4491. ]
  4492. },
  4493. {
  4494. name: "q",
  4495. in: "query",
  4496. description: "The search query",
  4497. required: false,
  4498. type: "string"
  4499. }
  4500. ],
  4501. responses: {
  4502. 200: {
  4503. description: "customdatatype response",
  4504. schema: {
  4505. $ref: "#/definitions/FetchAll"
  4506. }
  4507. },
  4508. 401: {
  4509. description: "User not logged in"
  4510. }
  4511. }
  4512. }
  4513. },
  4514. /customdatatype/{uuid}: {
  4515. get: {
  4516. tags: [
  4517. "customdatatype"
  4518. ],
  4519. summary: "Fetch by uuid",
  4520. operationId: "getCustomDatatype",
  4521. consumes: [
  4522. "application/json"
  4523. ],
  4524. produces: [
  4525. "application/json"
  4526. ],
  4527. parameters: [
  4528. {
  4529. name: "v",
  4530. in: "query",
  4531. description: "The representation to return (ref, default, full or custom)",
  4532. required: false,
  4533. type: "string",
  4534. enum: [
  4535. "ref",
  4536. "default",
  4537. "full",
  4538. "custom"
  4539. ]
  4540. },
  4541. {
  4542. name: "uuid",
  4543. in: "path",
  4544. description: "uuid to filter by",
  4545. required: true,
  4546. type: "string"
  4547. }
  4548. ],
  4549. responses: {
  4550. 200: {
  4551. description: "customdatatype response",
  4552. schema: {
  4553. $ref: "#/definitions/CustomdatatypeGet"
  4554. }
  4555. },
  4556. 401: {
  4557. description: "User not logged in"
  4558. },
  4559. 404: {
  4560. description: "Resource with given uuid doesn't exist"
  4561. }
  4562. }
  4563. },
  4564. delete: {
  4565. tags: [
  4566. "customdatatype"
  4567. ],
  4568. summary: "Delete or purge resource by uuid",
  4569. description: "The resource will be voided/retired unless purge = 'true'",
  4570. operationId: "deleteCustomDatatype",
  4571. consumes: [
  4572. "application/json"
  4573. ],
  4574. produces: [
  4575. "application/json"
  4576. ],
  4577. parameters: [
  4578. {
  4579. name: "uuid",
  4580. in: "path",
  4581. description: "uuid to delete",
  4582. required: true,
  4583. type: "string"
  4584. },
  4585. {
  4586. name: "purge",
  4587. in: "query",
  4588. required: false,
  4589. type: "boolean"
  4590. }
  4591. ],
  4592. responses: {
  4593. 204: {
  4594. description: "Delete successful"
  4595. },
  4596. 401: {
  4597. description: "User not logged in"
  4598. },
  4599. 404: {
  4600. description: "Resource with given uuid doesn't exist"
  4601. }
  4602. }
  4603. }
  4604. },
  4605. /concept: {
  4606. get: {
  4607. tags: [
  4608. "concept"
  4609. ],
  4610. summary: "Fetch all non-retired concept resources or perform search",
  4611. description: "All search parameters are optional",
  4612. operationId: "getAllConcepts",
  4613. consumes: [
  4614. "application/json"
  4615. ],
  4616. produces: [
  4617. "application/json"
  4618. ],
  4619. parameters: [
  4620. {
  4621. name: "limit",
  4622. in: "query",
  4623. description: "The number of results to return",
  4624. required: false,
  4625. type: "integer"
  4626. },
  4627. {
  4628. name: "startIndex",
  4629. in: "query",
  4630. description: "The offset at which to start",
  4631. required: false,
  4632. type: "integer"
  4633. },
  4634. {
  4635. name: "v",
  4636. in: "query",
  4637. description: "The representation to return (ref, default, full or custom)",
  4638. required: false,
  4639. type: "string",
  4640. enum: [
  4641. "ref",
  4642. "default",
  4643. "full",
  4644. "custom"
  4645. ]
  4646. },
  4647. {
  4648. name: "q",
  4649. in: "query",
  4650. description: "The search query",
  4651. required: false,
  4652. type: "string"
  4653. },
  4654. {
  4655. name: "code",
  4656. in: "query",
  4657. description: "Must be used with source",
  4658. required: false,
  4659. type: "string"
  4660. },
  4661. {
  4662. name: "searchType",
  4663. in: "query",
  4664. description: "Must be used with name",
  4665. required: false,
  4666. type: "string"
  4667. },
  4668. {
  4669. name: "name",
  4670. in: "query",
  4671. required: false,
  4672. type: "string"
  4673. },
  4674. {
  4675. name: "term",
  4676. in: "query",
  4677. required: false,
  4678. type: "string"
  4679. },
  4680. {
  4681. name: "source",
  4682. in: "query",
  4683. required: false,
  4684. type: "string"
  4685. },
  4686. {
  4687. name: "class",
  4688. in: "query",
  4689. description: "Must be used with name",
  4690. required: false,
  4691. type: "string"
  4692. }
  4693. ],
  4694. responses: {
  4695. 200: {
  4696. description: "concept response",
  4697. schema: {
  4698. $ref: "#/definitions/FetchAll"
  4699. }
  4700. },
  4701. 401: {
  4702. description: "User not logged in"
  4703. }
  4704. }
  4705. },
  4706. post: {
  4707. tags: [
  4708. "concept"
  4709. ],
  4710. summary: "Create with properties in request",
  4711. operationId: "createConcept",
  4712. consumes: [
  4713. "application/json"
  4714. ],
  4715. produces: [
  4716. "application/json"
  4717. ],
  4718. parameters: [
  4719. {
  4720. in: "body",
  4721. name: "resource",
  4722. description: "Resource to create",
  4723. required: true,
  4724. schema: {
  4725. $ref: "#/definitions/ConceptCreate"
  4726. }
  4727. }
  4728. ],
  4729. responses: {
  4730. 201: {
  4731. description: "concept response"
  4732. },
  4733. 401: {
  4734. description: "User not logged in"
  4735. }
  4736. }
  4737. }
  4738. },
  4739. /concept/{uuid}: {
  4740. get: {
  4741. tags: [
  4742. "concept"
  4743. ],
  4744. summary: "Fetch by uuid",
  4745. operationId: "getConcept",
  4746. consumes: [
  4747. "application/json"
  4748. ],
  4749. produces: [
  4750. "application/json"
  4751. ],
  4752. parameters: [
  4753. {
  4754. name: "v",
  4755. in: "query",
  4756. description: "The representation to return (ref, default, full or custom)",
  4757. required: false,
  4758. type: "string",
  4759. enum: [
  4760. "ref",
  4761. "default",
  4762. "full",
  4763. "custom"
  4764. ]
  4765. },
  4766. {
  4767. name: "uuid",
  4768. in: "path",
  4769. description: "uuid to filter by",
  4770. required: true,
  4771. type: "string"
  4772. }
  4773. ],
  4774. responses: {
  4775. 200: {
  4776. description: "concept response",
  4777. schema: {
  4778. $ref: "#/definitions/ConceptGet"
  4779. }
  4780. },
  4781. 401: {
  4782. description: "User not logged in"
  4783. },
  4784. 404: {
  4785. description: "Resource with given uuid doesn't exist"
  4786. }
  4787. }
  4788. },
  4789. post: {
  4790. tags: [
  4791. "concept"
  4792. ],
  4793. summary: "Edit with given uuid, only modifying properties in request",
  4794. operationId: "updateConcept",
  4795. consumes: [
  4796. "application/json"
  4797. ],
  4798. produces: [
  4799. "application/json"
  4800. ],
  4801. parameters: [
  4802. {
  4803. name: "uuid",
  4804. in: "path",
  4805. description: "uuid of resource to update",
  4806. required: true,
  4807. type: "string"
  4808. },
  4809. {
  4810. in: "body",
  4811. name: "resource",
  4812. description: "Resource properties to update",
  4813. required: true,
  4814. schema: {
  4815. $ref: "#/definitions/ConceptUpdate"
  4816. }
  4817. }
  4818. ],
  4819. responses: {
  4820. 201: {
  4821. description: "concept response"
  4822. },
  4823. 401: {
  4824. description: "User not logged in"
  4825. }
  4826. }
  4827. },
  4828. delete: {
  4829. tags: [
  4830. "concept"
  4831. ],
  4832. summary: "Delete or purge resource by uuid",
  4833. description: "The resource will be voided/retired unless purge = 'true'",
  4834. operationId: "deleteConcept",
  4835. consumes: [
  4836. "application/json"
  4837. ],
  4838. produces: [
  4839. "application/json"
  4840. ],
  4841. parameters: [
  4842. {
  4843. name: "uuid",
  4844. in: "path",
  4845. description: "uuid to delete",
  4846. required: true,
  4847. type: "string"
  4848. },
  4849. {
  4850. name: "purge",
  4851. in: "query",
  4852. required: false,
  4853. type: "boolean"
  4854. }
  4855. ],
  4856. responses: {
  4857. 204: {
  4858. description: "Delete successful"
  4859. },
  4860. 401: {
  4861. description: "User not logged in"
  4862. },
  4863. 404: {
  4864. description: "Resource with given uuid doesn't exist"
  4865. }
  4866. }
  4867. }
  4868. },
  4869. /systemsetting: {
  4870. get: {
  4871. tags: [
  4872. "systemsetting"
  4873. ],
  4874. summary: "Fetch all non-retired systemsetting resources or perform search",
  4875. description: "All search parameters are optional",
  4876. operationId: "getAllSystemSettings",
  4877. consumes: [
  4878. "application/json"
  4879. ],
  4880. produces: [
  4881. "application/json"
  4882. ],
  4883. parameters: [
  4884. {
  4885. name: "limit",
  4886. in: "query",
  4887. description: "The number of results to return",
  4888. required: false,
  4889. type: "integer"
  4890. },
  4891. {
  4892. name: "startIndex",
  4893. in: "query",
  4894. description: "The offset at which to start",
  4895. required: false,
  4896. type: "integer"
  4897. },
  4898. {
  4899. name: "v",
  4900. in: "query",
  4901. description: "The representation to return (ref, default, full or custom)",
  4902. required: false,
  4903. type: "string",
  4904. enum: [
  4905. "ref",
  4906. "default",
  4907. "full",
  4908. "custom"
  4909. ]
  4910. },
  4911. {
  4912. name: "q",
  4913. in: "query",
  4914. description: "The search query",
  4915. required: false,
  4916. type: "string"
  4917. }
  4918. ],
  4919. responses: {
  4920. 200: {
  4921. description: "systemsetting response",
  4922. schema: {
  4923. $ref: "#/definitions/FetchAll"
  4924. }
  4925. },
  4926. 401: {
  4927. description: "User not logged in"
  4928. }
  4929. }
  4930. },
  4931. post: {
  4932. tags: [
  4933. "systemsetting"
  4934. ],
  4935. summary: "Create with properties in request",
  4936. operationId: "createSystemSetting",
  4937. consumes: [
  4938. "application/json"
  4939. ],
  4940. produces: [
  4941. "application/json"
  4942. ],
  4943. parameters: [
  4944. {
  4945. in: "body",
  4946. name: "resource",
  4947. description: "Resource to create",
  4948. required: true,
  4949. schema: {
  4950. $ref: "#/definitions/SystemsettingCreate"
  4951. }
  4952. }
  4953. ],
  4954. responses: {
  4955. 201: {
  4956. description: "systemsetting response"
  4957. },
  4958. 401: {
  4959. description: "User not logged in"
  4960. }
  4961. }
  4962. }
  4963. },
  4964. /systemsetting/{uuid}: {
  4965. get: {
  4966. tags: [
  4967. "systemsetting"
  4968. ],
  4969. summary: "Fetch by uuid",
  4970. operationId: "getSystemSetting",
  4971. consumes: [
  4972. "application/json"
  4973. ],
  4974. produces: [
  4975. "application/json"
  4976. ],
  4977. parameters: [
  4978. {
  4979. name: "v",
  4980. in: "query",
  4981. description: "The representation to return (ref, default, full or custom)",
  4982. required: false,
  4983. type: "string",
  4984. enum: [
  4985. "ref",
  4986. "default",
  4987. "full",
  4988. "custom"
  4989. ]
  4990. },
  4991. {
  4992. name: "uuid",
  4993. in: "path",
  4994. description: "uuid to filter by",
  4995. required: true,
  4996. type: "string"
  4997. }
  4998. ],
  4999. responses: {
  5000. 200: {
  5001. description: "systemsetting response",
  5002. schema: {
  5003. $ref: "#/definitions/SystemsettingGet"
  5004. }
  5005. },
  5006. 401: {
  5007. description: "User not logged in"
  5008. },
  5009. 404: {
  5010. description: "Resource with given uuid doesn't exist"
  5011. }
  5012. }
  5013. },
  5014. post: {
  5015. tags: [
  5016. "systemsetting"
  5017. ],
  5018. summary: "Edit with given uuid, only modifying properties in request",
  5019. operationId: "updateSystemSetting",
  5020. consumes: [
  5021. "application/json"
  5022. ],
  5023. produces: [
  5024. "application/json"
  5025. ],
  5026. parameters: [
  5027. {
  5028. name: "uuid",
  5029. in: "path",
  5030. description: "uuid of resource to update",
  5031. required: true,
  5032. type: "string"
  5033. },
  5034. {
  5035. in: "body",
  5036. name: "resource",
  5037. description: "Resource properties to update",
  5038. required: true,
  5039. schema: {
  5040. $ref: "#/definitions/SystemsettingUpdate"
  5041. }
  5042. }
  5043. ],
  5044. responses: {
  5045. 201: {
  5046. description: "systemsetting response"
  5047. },
  5048. 401: {
  5049. description: "User not logged in"
  5050. }
  5051. }
  5052. },
  5053. delete: {
  5054. tags: [
  5055. "systemsetting"
  5056. ],
  5057. summary: "Delete or purge resource by uuid",
  5058. description: "The resource will be voided/retired unless purge = 'true'",
  5059. operationId: "deleteSystemSetting",
  5060. consumes: [
  5061. "application/json"
  5062. ],
  5063. produces: [
  5064. "application/json"
  5065. ],
  5066. parameters: [
  5067. {
  5068. name: "uuid",
  5069. in: "path",
  5070. description: "uuid to delete",
  5071. required: true,
  5072. type: "string"
  5073. },
  5074. {
  5075. name: "purge",
  5076. in: "query",
  5077. required: false,
  5078. type: "boolean"
  5079. }
  5080. ],
  5081. responses: {
  5082. 204: {
  5083. description: "Delete successful"
  5084. },
  5085. 401: {
  5086. description: "User not logged in"
  5087. },
  5088. 404: {
  5089. description: "Resource with given uuid doesn't exist"
  5090. }
  5091. }
  5092. }
  5093. },
  5094. /conceptdatatype: {
  5095. get: {
  5096. tags: [
  5097. "conceptdatatype"
  5098. ],
  5099. summary: "Fetch all non-retired conceptdatatype resources or perform search",
  5100. description: "All search parameters are optional",
  5101. operationId: "getAllConceptDatatypes",
  5102. consumes: [
  5103. "application/json"
  5104. ],
  5105. produces: [
  5106. "application/json"
  5107. ],
  5108. parameters: [
  5109. {
  5110. name: "limit",
  5111. in: "query",
  5112. description: "The number of results to return",
  5113. required: false,
  5114. type: "integer"
  5115. },
  5116. {
  5117. name: "startIndex",
  5118. in: "query",
  5119. description: "The offset at which to start",
  5120. required: false,
  5121. type: "integer"
  5122. },
  5123. {
  5124. name: "v",
  5125. in: "query",
  5126. description: "The representation to return (ref, default, full or custom)",
  5127. required: false,
  5128. type: "string",
  5129. enum: [
  5130. "ref",
  5131. "default",
  5132. "full",
  5133. "custom"
  5134. ]
  5135. },
  5136. {
  5137. name: "q",
  5138. in: "query",
  5139. description: "The search query",
  5140. required: false,
  5141. type: "string"
  5142. }
  5143. ],
  5144. responses: {
  5145. 200: {
  5146. description: "conceptdatatype response",
  5147. schema: {
  5148. $ref: "#/definitions/FetchAll"
  5149. }
  5150. },
  5151. 401: {
  5152. description: "User not logged in"
  5153. }
  5154. }
  5155. }
  5156. },
  5157. /conceptdatatype/{uuid}: {
  5158. get: {
  5159. tags: [
  5160. "conceptdatatype"
  5161. ],
  5162. summary: "Fetch by uuid",
  5163. operationId: "getConceptDatatype",
  5164. consumes: [
  5165. "application/json"
  5166. ],
  5167. produces: [
  5168. "application/json"
  5169. ],
  5170. parameters: [
  5171. {
  5172. name: "v",
  5173. in: "query",
  5174. description: "The representation to return (ref, default, full or custom)",
  5175. required: false,
  5176. type: "string",
  5177. enum: [
  5178. "ref",
  5179. "default",
  5180. "full",
  5181. "custom"
  5182. ]
  5183. },
  5184. {
  5185. name: "uuid",
  5186. in: "path",
  5187. description: "uuid to filter by",
  5188. required: true,
  5189. type: "string"
  5190. }
  5191. ],
  5192. responses: {
  5193. 200: {
  5194. description: "conceptdatatype response",
  5195. schema: {
  5196. $ref: "#/definitions/ConceptdatatypeGet"
  5197. }
  5198. },
  5199. 401: {
  5200. description: "User not logged in"
  5201. },
  5202. 404: {
  5203. description: "Resource with given uuid doesn't exist"
  5204. }
  5205. }
  5206. },
  5207. delete: {
  5208. tags: [
  5209. "conceptdatatype"
  5210. ],
  5211. summary: "Delete or purge resource by uuid",
  5212. description: "The resource will be voided/retired unless purge = 'true'",
  5213. operationId: "deleteConceptDatatype",
  5214. consumes: [
  5215. "application/json"
  5216. ],
  5217. produces: [
  5218. "application/json"
  5219. ],
  5220. parameters: [
  5221. {
  5222. name: "uuid",
  5223. in: "path",
  5224. description: "uuid to delete",
  5225. required: true,
  5226. type: "string"
  5227. },
  5228. {
  5229. name: "purge",
  5230. in: "query",
  5231. required: false,
  5232. type: "boolean"
  5233. }
  5234. ],
  5235. responses: {
  5236. 204: {
  5237. description: "Delete successful"
  5238. },
  5239. 401: {
  5240. description: "User not logged in"
  5241. },
  5242. 404: {
  5243. description: "Resource with given uuid doesn't exist"
  5244. }
  5245. }
  5246. }
  5247. },
  5248. /hl7source: {
  5249. get: {
  5250. tags: [
  5251. "hl7source"
  5252. ],
  5253. summary: "Search for hl7source",
  5254. description: "At least one search parameter must be specified",
  5255. operationId: "getAllHL7Sources",
  5256. produces: [
  5257. "application/json",
  5258. "application/xml"
  5259. ],
  5260. parameters: [
  5261. {
  5262. name: "limit",
  5263. in: "query",
  5264. description: "The number of results to return",
  5265. required: false,
  5266. type: "integer"
  5267. },
  5268. {
  5269. name: "startIndex",
  5270. in: "query",
  5271. description: "The offset at which to start",
  5272. required: false,
  5273. type: "integer"
  5274. },
  5275. {
  5276. name: "v",
  5277. in: "query",
  5278. description: "The representation to return (ref, default, full or custom)",
  5279. required: false,
  5280. type: "string",
  5281. enum: [
  5282. "ref",
  5283. "default",
  5284. "full",
  5285. "custom"
  5286. ]
  5287. },
  5288. {
  5289. name: "q",
  5290. in: "query",
  5291. description: "The search query",
  5292. required: true,
  5293. type: "string"
  5294. }
  5295. ],
  5296. responses: {
  5297. 200: {
  5298. description: "hl7source response",
  5299. schema: {
  5300. $ref: "#/definitions/FetchAll"
  5301. }
  5302. }
  5303. }
  5304. },
  5305. post: {
  5306. tags: [
  5307. "hl7source"
  5308. ],
  5309. summary: "Create with properties in request",
  5310. operationId: "createHL7Source",
  5311. consumes: [
  5312. "application/json"
  5313. ],
  5314. produces: [
  5315. "application/json"
  5316. ],
  5317. parameters: [
  5318. {
  5319. in: "body",
  5320. name: "resource",
  5321. description: "Resource to create",
  5322. required: true,
  5323. schema: {
  5324. $ref: "#/definitions/Hl7sourceCreate"
  5325. }
  5326. }
  5327. ],
  5328. responses: {
  5329. 201: {
  5330. description: "hl7source response"
  5331. },
  5332. 401: {
  5333. description: "User not logged in"
  5334. }
  5335. }
  5336. }
  5337. },
  5338. /hl7source/{uuid}: {
  5339. get: {
  5340. tags: [
  5341. "hl7source"
  5342. ],
  5343. summary: "Fetch by uuid",
  5344. operationId: "getHL7Source",
  5345. consumes: [
  5346. "application/json"
  5347. ],
  5348. produces: [
  5349. "application/json"
  5350. ],
  5351. parameters: [
  5352. {
  5353. name: "v",
  5354. in: "query",
  5355. description: "The representation to return (ref, default, full or custom)",
  5356. required: false,
  5357. type: "string",
  5358. enum: [
  5359. "ref",
  5360. "default",
  5361. "full",
  5362. "custom"
  5363. ]
  5364. },
  5365. {
  5366. name: "uuid",
  5367. in: "path",
  5368. description: "uuid to filter by",
  5369. required: true,
  5370. type: "string"
  5371. }
  5372. ],
  5373. responses: {
  5374. 200: {
  5375. description: "hl7source response",
  5376. schema: {
  5377. $ref: "#/definitions/Hl7sourceGet"
  5378. }
  5379. },
  5380. 401: {
  5381. description: "User not logged in"
  5382. },
  5383. 404: {
  5384. description: "Resource with given uuid doesn't exist"
  5385. }
  5386. }
  5387. },
  5388. post: {
  5389. tags: [
  5390. "hl7source"
  5391. ],
  5392. summary: "Edit with given uuid, only modifying properties in request",
  5393. operationId: "updateHL7Source",
  5394. consumes: [
  5395. "application/json"
  5396. ],
  5397. produces: [
  5398. "application/json"
  5399. ],
  5400. parameters: [
  5401. {
  5402. name: "uuid",
  5403. in: "path",
  5404. description: "uuid of resource to update",
  5405. required: true,
  5406. type: "string"
  5407. },
  5408. {
  5409. in: "body",
  5410. name: "resource",
  5411. description: "Resource properties to update",
  5412. required: true,
  5413. schema: {
  5414. $ref: "#/definitions/Hl7sourceUpdate"
  5415. }
  5416. }
  5417. ],
  5418. responses: {
  5419. 201: {
  5420. description: "hl7source response"
  5421. },
  5422. 401: {
  5423. description: "User not logged in"
  5424. }
  5425. }
  5426. },
  5427. delete: {
  5428. tags: [
  5429. "hl7source"
  5430. ],
  5431. summary: "Delete or purge resource by uuid",
  5432. description: "The resource will be voided/retired unless purge = 'true'",
  5433. operationId: "deleteHL7Source",
  5434. consumes: [
  5435. "application/json"
  5436. ],
  5437. produces: [
  5438. "application/json"
  5439. ],
  5440. parameters: [
  5441. {
  5442. name: "uuid",
  5443. in: "path",
  5444. description: "uuid to delete",
  5445. required: true,
  5446. type: "string"
  5447. },
  5448. {
  5449. name: "purge",
  5450. in: "query",
  5451. required: false,
  5452. type: "boolean"
  5453. }
  5454. ],
  5455. responses: {
  5456. 204: {
  5457. description: "Delete successful"
  5458. },
  5459. 401: {
  5460. description: "User not logged in"
  5461. },
  5462. 404: {
  5463. description: "Resource with given uuid doesn't exist"
  5464. }
  5465. }
  5466. }
  5467. },
  5468. /workflow: {
  5469. get: {
  5470. tags: [
  5471. "workflow"
  5472. ],
  5473. summary: "Search for workflow",
  5474. description: "At least one search parameter must be specified",
  5475. operationId: "getAllProgramWorkflows",
  5476. produces: [
  5477. "application/json",
  5478. "application/xml"
  5479. ],
  5480. parameters: [
  5481. {
  5482. name: "limit",
  5483. in: "query",
  5484. description: "The number of results to return",
  5485. required: false,
  5486. type: "integer"
  5487. },
  5488. {
  5489. name: "startIndex",
  5490. in: "query",
  5491. description: "The offset at which to start",
  5492. required: false,
  5493. type: "integer"
  5494. },
  5495. {
  5496. name: "v",
  5497. in: "query",
  5498. description: "The representation to return (ref, default, full or custom)",
  5499. required: false,
  5500. type: "string",
  5501. enum: [
  5502. "ref",
  5503. "default",
  5504. "full",
  5505. "custom"
  5506. ]
  5507. },
  5508. {
  5509. name: "q",
  5510. in: "query",
  5511. description: "The search query",
  5512. required: true,
  5513. type: "string"
  5514. }
  5515. ],
  5516. responses: {
  5517. 200: {
  5518. description: "workflow response",
  5519. schema: {
  5520. $ref: "#/definitions/FetchAll"
  5521. }
  5522. }
  5523. }
  5524. },
  5525. post: {
  5526. tags: [
  5527. "workflow"
  5528. ],
  5529. summary: "Create with properties in request",
  5530. operationId: "createProgramWorkflow",
  5531. consumes: [
  5532. "application/json"
  5533. ],
  5534. produces: [
  5535. "application/json"
  5536. ],
  5537. parameters: [
  5538. {
  5539. in: "body",
  5540. name: "resource",
  5541. description: "Resource to create",
  5542. required: true,
  5543. schema: {
  5544. $ref: "#/definitions/WorkflowCreate"
  5545. }
  5546. }
  5547. ],
  5548. responses: {
  5549. 201: {
  5550. description: "workflow response"
  5551. },
  5552. 401: {
  5553. description: "User not logged in"
  5554. }
  5555. }
  5556. }
  5557. },
  5558. /workflow/{uuid}: {
  5559. get: {
  5560. tags: [
  5561. "workflow"
  5562. ],
  5563. summary: "Fetch by uuid",
  5564. operationId: "getProgramWorkflow",
  5565. consumes: [
  5566. "application/json"
  5567. ],
  5568. produces: [
  5569. "application/json"
  5570. ],
  5571. parameters: [
  5572. {
  5573. name: "v",
  5574. in: "query",
  5575. description: "The representation to return (ref, default, full or custom)",
  5576. required: false,
  5577. type: "string",
  5578. enum: [
  5579. "ref",
  5580. "default",
  5581. "full",
  5582. "custom"
  5583. ]
  5584. },
  5585. {
  5586. name: "uuid",
  5587. in: "path",
  5588. description: "uuid to filter by",
  5589. required: true,
  5590. type: "string"
  5591. }
  5592. ],
  5593. responses: {
  5594. 200: {
  5595. description: "workflow response",
  5596. schema: {
  5597. $ref: "#/definitions/WorkflowGet"
  5598. }
  5599. },
  5600. 401: {
  5601. description: "User not logged in"
  5602. },
  5603. 404: {
  5604. description: "Resource with given uuid doesn't exist"
  5605. }
  5606. }
  5607. },
  5608. post: {
  5609. tags: [
  5610. "workflow"
  5611. ],
  5612. summary: "Edit with given uuid, only modifying properties in request",
  5613. operationId: "updateProgramWorkflow",
  5614. consumes: [
  5615. "application/json"
  5616. ],
  5617. produces: [
  5618. "application/json"
  5619. ],
  5620. parameters: [
  5621. {
  5622. name: "uuid",
  5623. in: "path",
  5624. description: "uuid of resource to update",
  5625. required: true,
  5626. type: "string"
  5627. },
  5628. {
  5629. in: "body",
  5630. name: "resource",
  5631. description: "Resource properties to update",
  5632. required: true,
  5633. schema: {
  5634. $ref: "#/definitions/WorkflowUpdate"
  5635. }
  5636. }
  5637. ],
  5638. responses: {
  5639. 201: {
  5640. description: "workflow response"
  5641. },
  5642. 401: {
  5643. description: "User not logged in"
  5644. }
  5645. }
  5646. },
  5647. delete: {
  5648. tags: [
  5649. "workflow"
  5650. ],
  5651. summary: "Delete or purge resource by uuid",
  5652. description: "The resource will be voided/retired unless purge = 'true'",
  5653. operationId: "deleteProgramWorkflow",
  5654. consumes: [
  5655. "application/json"
  5656. ],
  5657. produces: [
  5658. "application/json"
  5659. ],
  5660. parameters: [
  5661. {
  5662. name: "uuid",
  5663. in: "path",
  5664. description: "uuid to delete",
  5665. required: true,
  5666. type: "string"
  5667. },
  5668. {
  5669. name: "purge",
  5670. in: "query",
  5671. required: false,
  5672. type: "boolean"
  5673. }
  5674. ],
  5675. responses: {
  5676. 204: {
  5677. description: "Delete successful"
  5678. },
  5679. 401: {
  5680. description: "User not logged in"
  5681. },
  5682. 404: {
  5683. description: "Resource with given uuid doesn't exist"
  5684. }
  5685. }
  5686. }
  5687. },
  5688. /orderset: {
  5689. get: {
  5690. tags: [
  5691. "orderset"
  5692. ],
  5693. summary: "Fetch all non-retired orderset resources or perform search",
  5694. description: "All search parameters are optional",
  5695. operationId: "getAllOrderSets",
  5696. consumes: [
  5697. "application/json"
  5698. ],
  5699. produces: [
  5700. "application/json"
  5701. ],
  5702. parameters: [
  5703. {
  5704. name: "limit",
  5705. in: "query",
  5706. description: "The number of results to return",
  5707. required: false,
  5708. type: "integer"
  5709. },
  5710. {
  5711. name: "startIndex",
  5712. in: "query",
  5713. description: "The offset at which to start",
  5714. required: false,
  5715. type: "integer"
  5716. },
  5717. {
  5718. name: "v",
  5719. in: "query",
  5720. description: "The representation to return (ref, default, full or custom)",
  5721. required: false,
  5722. type: "string",
  5723. enum: [
  5724. "ref",
  5725. "default",
  5726. "full",
  5727. "custom"
  5728. ]
  5729. },
  5730. {
  5731. name: "q",
  5732. in: "query",
  5733. description: "The search query",
  5734. required: false,
  5735. type: "string"
  5736. }
  5737. ],
  5738. responses: {
  5739. 200: {
  5740. description: "orderset response",
  5741. schema: {
  5742. $ref: "#/definitions/FetchAll"
  5743. }
  5744. },
  5745. 401: {
  5746. description: "User not logged in"
  5747. }
  5748. }
  5749. },
  5750. post: {
  5751. tags: [
  5752. "orderset"
  5753. ],
  5754. summary: "Create with properties in request",
  5755. operationId: "createOrderSet",
  5756. consumes: [
  5757. "application/json"
  5758. ],
  5759. produces: [
  5760. "application/json"
  5761. ],
  5762. parameters: [
  5763. {
  5764. in: "body",
  5765. name: "resource",
  5766. description: "Resource to create",
  5767. required: true,
  5768. schema: {
  5769. $ref: "#/definitions/OrdersetCreate"
  5770. }
  5771. }
  5772. ],
  5773. responses: {
  5774. 201: {
  5775. description: "orderset response"
  5776. },
  5777. 401: {
  5778. description: "User not logged in"
  5779. }
  5780. }
  5781. }
  5782. },
  5783. /orderset/{uuid}: {
  5784. get: {
  5785. tags: [
  5786. "orderset"
  5787. ],
  5788. summary: "Fetch by uuid",
  5789. operationId: "getOrderSet",
  5790. consumes: [
  5791. "application/json"
  5792. ],
  5793. produces: [
  5794. "application/json"
  5795. ],
  5796. parameters: [
  5797. {
  5798. name: "v",
  5799. in: "query",
  5800. description: "The representation to return (ref, default, full or custom)",
  5801. required: false,
  5802. type: "string",
  5803. enum: [
  5804. "ref",
  5805. "default",
  5806. "full",
  5807. "custom"
  5808. ]
  5809. },
  5810. {
  5811. name: "uuid",
  5812. in: "path",
  5813. description: "uuid to filter by",
  5814. required: true,
  5815. type: "string"
  5816. }
  5817. ],
  5818. responses: {
  5819. 200: {
  5820. description: "orderset response",
  5821. schema: {
  5822. $ref: "#/definitions/OrdersetGet"
  5823. }
  5824. },
  5825. 401: {
  5826. description: "User not logged in"
  5827. },
  5828. 404: {
  5829. description: "Resource with given uuid doesn't exist"
  5830. }
  5831. }
  5832. },
  5833. post: {
  5834. tags: [
  5835. "orderset"
  5836. ],
  5837. summary: "Edit with given uuid, only modifying properties in request",
  5838. operationId: "updateOrderSet",
  5839. consumes: [
  5840. "application/json"
  5841. ],
  5842. produces: [
  5843. "application/json"
  5844. ],
  5845. parameters: [
  5846. {
  5847. name: "uuid",
  5848. in: "path",
  5849. description: "uuid of resource to update",
  5850. required: true,
  5851. type: "string"
  5852. },
  5853. {
  5854. in: "body",
  5855. name: "resource",
  5856. description: "Resource properties to update",
  5857. required: true,
  5858. schema: {
  5859. $ref: "#/definitions/OrdersetUpdate"
  5860. }
  5861. }
  5862. ],
  5863. responses: {
  5864. 201: {
  5865. description: "orderset response"
  5866. },
  5867. 401: {
  5868. description: "User not logged in"
  5869. }
  5870. }
  5871. },
  5872. delete: {
  5873. tags: [
  5874. "orderset"
  5875. ],
  5876. summary: "Delete or purge resource by uuid",
  5877. description: "The resource will be voided/retired unless purge = 'true'",
  5878. operationId: "deleteOrderSet",
  5879. consumes: [
  5880. "application/json"
  5881. ],
  5882. produces: [
  5883. "application/json"
  5884. ],
  5885. parameters: [
  5886. {
  5887. name: "uuid",
  5888. in: "path",
  5889. description: "uuid to delete",
  5890. required: true,
  5891. type: "string"
  5892. },
  5893. {
  5894. name: "purge",
  5895. in: "query",
  5896. required: false,
  5897. type: "boolean"
  5898. }
  5899. ],
  5900. responses: {
  5901. 204: {
  5902. description: "Delete successful"
  5903. },
  5904. 401: {
  5905. description: "User not logged in"
  5906. },
  5907. 404: {
  5908. description: "Resource with given uuid doesn't exist"
  5909. }
  5910. }
  5911. }
  5912. },
  5913. /location: {
  5914. get: {
  5915. tags: [
  5916. "location"
  5917. ],
  5918. summary: "Fetch all non-retired location resources or perform search",
  5919. description: "All search parameters are optional",
  5920. operationId: "getAllLocations",
  5921. consumes: [
  5922. "application/json"
  5923. ],
  5924. produces: [
  5925. "application/json"
  5926. ],
  5927. parameters: [
  5928. {
  5929. name: "limit",
  5930. in: "query",
  5931. description: "The number of results to return",
  5932. required: false,
  5933. type: "integer"
  5934. },
  5935. {
  5936. name: "startIndex",
  5937. in: "query",
  5938. description: "The offset at which to start",
  5939. required: false,
  5940. type: "integer"
  5941. },
  5942. {
  5943. name: "v",
  5944. in: "query",
  5945. description: "The representation to return (ref, default, full or custom)",
  5946. required: false,
  5947. type: "string",
  5948. enum: [
  5949. "ref",
  5950. "default",
  5951. "full",
  5952. "custom"
  5953. ]
  5954. },
  5955. {
  5956. name: "q",
  5957. in: "query",
  5958. description: "The search query",
  5959. required: false,
  5960. type: "string"
  5961. },
  5962. {
  5963. name: "tag",
  5964. in: "query",
  5965. required: false,
  5966. type: "string"
  5967. }
  5968. ],
  5969. responses: {
  5970. 200: {
  5971. description: "location response",
  5972. schema: {
  5973. $ref: "#/definitions/FetchAll"
  5974. }
  5975. },
  5976. 401: {
  5977. description: "User not logged in"
  5978. }
  5979. }
  5980. },
  5981. post: {
  5982. tags: [
  5983. "location"
  5984. ],
  5985. summary: "Create with properties in request",
  5986. operationId: "createLocation",
  5987. consumes: [
  5988. "application/json"
  5989. ],
  5990. produces: [
  5991. "application/json"
  5992. ],
  5993. parameters: [
  5994. {
  5995. in: "body",
  5996. name: "resource",
  5997. description: "Resource to create",
  5998. required: true,
  5999. schema: {
  6000. $ref: "#/definitions/LocationCreate"
  6001. }
  6002. }
  6003. ],
  6004. responses: {
  6005. 201: {
  6006. description: "location response"
  6007. },
  6008. 401: {
  6009. description: "User not logged in"
  6010. }
  6011. }
  6012. }
  6013. },
  6014. /location/{uuid}: {
  6015. get: {
  6016. tags: [
  6017. "location"
  6018. ],
  6019. summary: "Fetch by uuid",
  6020. operationId: "getLocation",
  6021. consumes: [
  6022. "application/json"
  6023. ],
  6024. produces: [
  6025. "application/json"
  6026. ],
  6027. parameters: [
  6028. {
  6029. name: "v",
  6030. in: "query",
  6031. description: "The representation to return (ref, default, full or custom)",
  6032. required: false,
  6033. type: "string",
  6034. enum: [
  6035. "ref",
  6036. "default",
  6037. "full",
  6038. "custom"
  6039. ]
  6040. },
  6041. {
  6042. name: "uuid",
  6043. in: "path",
  6044. description: "uuid to filter by",
  6045. required: true,
  6046. type: "string"
  6047. }
  6048. ],
  6049. responses: {
  6050. 200: {
  6051. description: "location response",
  6052. schema: {
  6053. $ref: "#/definitions/LocationGet"
  6054. }
  6055. },
  6056. 401: {
  6057. description: "User not logged in"
  6058. },
  6059. 404: {
  6060. description: "Resource with given uuid doesn't exist"
  6061. }
  6062. }
  6063. },
  6064. post: {
  6065. tags: [
  6066. "location"
  6067. ],
  6068. summary: "Edit with given uuid, only modifying properties in request",
  6069. operationId: "updateLocation",
  6070. consumes: [
  6071. "application/json"
  6072. ],
  6073. produces: [
  6074. "application/json"
  6075. ],
  6076. parameters: [
  6077. {
  6078. name: "uuid",
  6079. in: "path",
  6080. description: "uuid of resource to update",
  6081. required: true,
  6082. type: "string"
  6083. },
  6084. {
  6085. in: "body",
  6086. name: "resource",
  6087. description: "Resource properties to update",
  6088. required: true,
  6089. schema: {
  6090. $ref: "#/definitions/LocationUpdate"
  6091. }
  6092. }
  6093. ],
  6094. responses: {
  6095. 201: {
  6096. description: "location response"
  6097. },
  6098. 401: {
  6099. description: "User not logged in"
  6100. }
  6101. }
  6102. },
  6103. delete: {
  6104. tags: [
  6105. "location"
  6106. ],
  6107. summary: "Delete or purge resource by uuid",
  6108. description: "The resource will be voided/retired unless purge = 'true'",
  6109. operationId: "deleteLocation",
  6110. consumes: [
  6111. "application/json"
  6112. ],
  6113. produces: [
  6114. "application/json"
  6115. ],
  6116. parameters: [
  6117. {
  6118. name: "uuid",
  6119. in: "path",
  6120. description: "uuid to delete",
  6121. required: true,
  6122. type: "string"
  6123. },
  6124. {
  6125. name: "purge",
  6126. in: "query",
  6127. required: false,
  6128. type: "boolean"
  6129. }
  6130. ],
  6131. responses: {
  6132. 204: {
  6133. description: "Delete successful"
  6134. },
  6135. 401: {
  6136. description: "User not logged in"
  6137. },
  6138. 404: {
  6139. description: "Resource with given uuid doesn't exist"
  6140. }
  6141. }
  6142. }
  6143. },
  6144. /providerattributetype: {
  6145. get: {
  6146. tags: [
  6147. "providerattributetype"
  6148. ],
  6149. summary: "Fetch all non-retired providerattributetype resources or perform search",
  6150. description: "All search parameters are optional",
  6151. operationId: "getAllProviderAttributeTypes",
  6152. consumes: [
  6153. "application/json"
  6154. ],
  6155. produces: [
  6156. "application/json"
  6157. ],
  6158. parameters: [
  6159. {
  6160. name: "limit",
  6161. in: "query",
  6162. description: "The number of results to return",
  6163. required: false,
  6164. type: "integer"
  6165. },
  6166. {
  6167. name: "startIndex",
  6168. in: "query",
  6169. description: "The offset at which to start",
  6170. required: false,
  6171. type: "integer"
  6172. },
  6173. {
  6174. name: "v",
  6175. in: "query",
  6176. description: "The representation to return (ref, default, full or custom)",
  6177. required: false,
  6178. type: "string",
  6179. enum: [
  6180. "ref",
  6181. "default",
  6182. "full",
  6183. "custom"
  6184. ]
  6185. },
  6186. {
  6187. name: "q",
  6188. in: "query",
  6189. description: "The search query",
  6190. required: false,
  6191. type: "string"
  6192. }
  6193. ],
  6194. responses: {
  6195. 200: {
  6196. description: "providerattributetype response",
  6197. schema: {
  6198. $ref: "#/definitions/FetchAll"
  6199. }
  6200. },
  6201. 401: {
  6202. description: "User not logged in"
  6203. }
  6204. }
  6205. },
  6206. post: {
  6207. tags: [
  6208. "providerattributetype"
  6209. ],
  6210. summary: "Create with properties in request",
  6211. operationId: "createProviderAttributeType",
  6212. consumes: [
  6213. "application/json"
  6214. ],
  6215. produces: [
  6216. "application/json"
  6217. ],
  6218. parameters: [
  6219. {
  6220. in: "body",
  6221. name: "resource",
  6222. description: "Resource to create",
  6223. required: true,
  6224. schema: {
  6225. $ref: "#/definitions/ProviderattributetypeCreate"
  6226. }
  6227. }
  6228. ],
  6229. responses: {
  6230. 201: {
  6231. description: "providerattributetype response"
  6232. },
  6233. 401: {
  6234. description: "User not logged in"
  6235. }
  6236. }
  6237. }
  6238. },
  6239. /providerattributetype/{uuid}: {
  6240. get: {
  6241. tags: [
  6242. "providerattributetype"
  6243. ],
  6244. summary: "Fetch by uuid",
  6245. operationId: "getProviderAttributeType",
  6246. consumes: [
  6247. "application/json"
  6248. ],
  6249. produces: [
  6250. "application/json"
  6251. ],
  6252. parameters: [
  6253. {
  6254. name: "v",
  6255. in: "query",
  6256. description: "The representation to return (ref, default, full or custom)",
  6257. required: false,
  6258. type: "string",
  6259. enum: [
  6260. "ref",
  6261. "default",
  6262. "full",
  6263. "custom"
  6264. ]
  6265. },
  6266. {
  6267. name: "uuid",
  6268. in: "path",
  6269. description: "uuid to filter by",
  6270. required: true,
  6271. type: "string"
  6272. }
  6273. ],
  6274. responses: {
  6275. 200: {
  6276. description: "providerattributetype response",
  6277. schema: {
  6278. $ref: "#/definitions/ProviderattributetypeGet"
  6279. }
  6280. },
  6281. 401: {
  6282. description: "User not logged in"
  6283. },
  6284. 404: {
  6285. description: "Resource with given uuid doesn't exist"
  6286. }
  6287. }
  6288. },
  6289. post: {
  6290. tags: [
  6291. "providerattributetype"
  6292. ],
  6293. summary: "Edit with given uuid, only modifying properties in request",
  6294. operationId: "updateProviderAttributeType",
  6295. consumes: [
  6296. "application/json"
  6297. ],
  6298. produces: [
  6299. "application/json"
  6300. ],
  6301. parameters: [
  6302. {
  6303. name: "uuid",
  6304. in: "path",
  6305. description: "uuid of resource to update",
  6306. required: true,
  6307. type: "string"
  6308. },
  6309. {
  6310. in: "body",
  6311. name: "resource",
  6312. description: "Resource properties to update",
  6313. required: true,
  6314. schema: {
  6315. $ref: "#/definitions/ProviderattributetypeUpdate"
  6316. }
  6317. }
  6318. ],
  6319. responses: {
  6320. 201: {
  6321. description: "providerattributetype response"
  6322. },
  6323. 401: {
  6324. description: "User not logged in"
  6325. }
  6326. }
  6327. },
  6328. delete: {
  6329. tags: [
  6330. "providerattributetype"
  6331. ],
  6332. summary: "Delete or purge resource by uuid",
  6333. description: "The resource will be voided/retired unless purge = 'true'",
  6334. operationId: "deleteProviderAttributeType",
  6335. consumes: [
  6336. "application/json"
  6337. ],
  6338. produces: [
  6339. "application/json"
  6340. ],
  6341. parameters: [
  6342. {
  6343. name: "uuid",
  6344. in: "path",
  6345. description: "uuid to delete",
  6346. required: true,
  6347. type: "string"
  6348. },
  6349. {
  6350. name: "purge",
  6351. in: "query",
  6352. required: false,
  6353. type: "boolean"
  6354. }
  6355. ],
  6356. responses: {
  6357. 204: {
  6358. description: "Delete successful"
  6359. },
  6360. 401: {
  6361. description: "User not logged in"
  6362. },
  6363. 404: {
  6364. description: "Resource with given uuid doesn't exist"
  6365. }
  6366. }
  6367. }
  6368. },
  6369. /programenrollment: {
  6370. get: {
  6371. tags: [
  6372. "programenrollment"
  6373. ],
  6374. summary: "Search for programenrollment",
  6375. description: "At least one search parameter must be specified",
  6376. operationId: "getAllProgramEnrollments",
  6377. produces: [
  6378. "application/json",
  6379. "application/xml"
  6380. ],
  6381. parameters: [
  6382. {
  6383. name: "limit",
  6384. in: "query",
  6385. description: "The number of results to return",
  6386. required: false,
  6387. type: "integer"
  6388. },
  6389. {
  6390. name: "startIndex",
  6391. in: "query",
  6392. description: "The offset at which to start",
  6393. required: false,
  6394. type: "integer"
  6395. },
  6396. {
  6397. name: "v",
  6398. in: "query",
  6399. description: "The representation to return (ref, default, full or custom)",
  6400. required: false,
  6401. type: "string",
  6402. enum: [
  6403. "ref",
  6404. "default",
  6405. "full",
  6406. "custom"
  6407. ]
  6408. },
  6409. {
  6410. name: "q",
  6411. in: "query",
  6412. description: "The search query",
  6413. required: true,
  6414. type: "string"
  6415. }
  6416. ],
  6417. responses: {
  6418. 200: {
  6419. description: "programenrollment response",
  6420. schema: {
  6421. $ref: "#/definitions/FetchAll"
  6422. }
  6423. }
  6424. }
  6425. },
  6426. post: {
  6427. tags: [
  6428. "programenrollment"
  6429. ],
  6430. summary: "Create with properties in request",
  6431. operationId: "createProgramEnrollment",
  6432. consumes: [
  6433. "application/json"
  6434. ],
  6435. produces: [
  6436. "application/json"
  6437. ],
  6438. parameters: [
  6439. {
  6440. in: "body",
  6441. name: "resource",
  6442. description: "Resource to create",
  6443. required: true,
  6444. schema: {
  6445. $ref: "#/definitions/ProgramenrollmentCreate"
  6446. }
  6447. }
  6448. ],
  6449. responses: {
  6450. 201: {
  6451. description: "programenrollment response"
  6452. },
  6453. 401: {
  6454. description: "User not logged in"
  6455. }
  6456. }
  6457. }
  6458. },
  6459. /programenrollment/{uuid}: {
  6460. get: {
  6461. tags: [
  6462. "programenrollment"
  6463. ],
  6464. summary: "Fetch by uuid",
  6465. operationId: "getProgramEnrollment",
  6466. consumes: [
  6467. "application/json"
  6468. ],
  6469. produces: [
  6470. "application/json"
  6471. ],
  6472. parameters: [
  6473. {
  6474. name: "v",
  6475. in: "query",
  6476. description: "The representation to return (ref, default, full or custom)",
  6477. required: false,
  6478. type: "string",
  6479. enum: [
  6480. "ref",
  6481. "default",
  6482. "full",
  6483. "custom"
  6484. ]
  6485. },
  6486. {
  6487. name: "uuid",
  6488. in: "path",
  6489. description: "uuid to filter by",
  6490. required: true,
  6491. type: "string"
  6492. }
  6493. ],
  6494. responses: {
  6495. 200: {
  6496. description: "programenrollment response",
  6497. schema: {
  6498. $ref: "#/definitions/ProgramenrollmentGet"
  6499. }
  6500. },
  6501. 401: {
  6502. description: "User not logged in"
  6503. },
  6504. 404: {
  6505. description: "Resource with given uuid doesn't exist"
  6506. }
  6507. }
  6508. },
  6509. post: {
  6510. tags: [
  6511. "programenrollment"
  6512. ],
  6513. summary: "Edit with given uuid, only modifying properties in request",
  6514. operationId: "updateProgramEnrollment",
  6515. consumes: [
  6516. "application/json"
  6517. ],
  6518. produces: [
  6519. "application/json"
  6520. ],
  6521. parameters: [
  6522. {
  6523. name: "uuid",
  6524. in: "path",
  6525. description: "uuid of resource to update",
  6526. required: true,
  6527. type: "string"
  6528. },
  6529. {
  6530. in: "body",
  6531. name: "resource",
  6532. description: "Resource properties to update",
  6533. required: true,
  6534. schema: {
  6535. $ref: "#/definitions/ProgramenrollmentUpdate"
  6536. }
  6537. }
  6538. ],
  6539. responses: {
  6540. 201: {
  6541. description: "programenrollment response"
  6542. },
  6543. 401: {
  6544. description: "User not logged in"
  6545. }
  6546. }
  6547. },
  6548. delete: {
  6549. tags: [
  6550. "programenrollment"
  6551. ],
  6552. summary: "Delete or purge resource by uuid",
  6553. description: "The resource will be voided/retired unless purge = 'true'",
  6554. operationId: "deleteProgramEnrollment",
  6555. consumes: [
  6556. "application/json"
  6557. ],
  6558. produces: [
  6559. "application/json"
  6560. ],
  6561. parameters: [
  6562. {
  6563. name: "uuid",
  6564. in: "path",
  6565. description: "uuid to delete",
  6566. required: true,
  6567. type: "string"
  6568. },
  6569. {
  6570. name: "purge",
  6571. in: "query",
  6572. required: false,
  6573. type: "boolean"
  6574. }
  6575. ],
  6576. responses: {
  6577. 204: {
  6578. description: "Delete successful"
  6579. },
  6580. 401: {
  6581. description: "User not logged in"
  6582. },
  6583. 404: {
  6584. description: "Resource with given uuid doesn't exist"
  6585. }
  6586. }
  6587. }
  6588. },
  6589. /encounterrole: {
  6590. get: {
  6591. tags: [
  6592. "encounterrole"
  6593. ],
  6594. summary: "Fetch all non-retired encounterrole resources or perform search",
  6595. description: "All search parameters are optional",
  6596. operationId: "getAllEncounterRoles",
  6597. consumes: [
  6598. "application/json"
  6599. ],
  6600. produces: [
  6601. "application/json"
  6602. ],
  6603. parameters: [
  6604. {
  6605. name: "limit",
  6606. in: "query",
  6607. description: "The number of results to return",
  6608. required: false,
  6609. type: "integer"
  6610. },
  6611. {
  6612. name: "startIndex",
  6613. in: "query",
  6614. description: "The offset at which to start",
  6615. required: false,
  6616. type: "integer"
  6617. },
  6618. {
  6619. name: "v",
  6620. in: "query",
  6621. description: "The representation to return (ref, default, full or custom)",
  6622. required: false,
  6623. type: "string",
  6624. enum: [
  6625. "ref",
  6626. "default",
  6627. "full",
  6628. "custom"
  6629. ]
  6630. },
  6631. {
  6632. name: "q",
  6633. in: "query",
  6634. description: "The search query",
  6635. required: false,
  6636. type: "string"
  6637. }
  6638. ],
  6639. responses: {
  6640. 200: {
  6641. description: "encounterrole response",
  6642. schema: {
  6643. $ref: "#/definitions/FetchAll"
  6644. }
  6645. },
  6646. 401: {
  6647. description: "User not logged in"
  6648. }
  6649. }
  6650. },
  6651. post: {
  6652. tags: [
  6653. "encounterrole"
  6654. ],
  6655. summary: "Create with properties in request",
  6656. operationId: "createEncounterRole",
  6657. consumes: [
  6658. "application/json"
  6659. ],
  6660. produces: [
  6661. "application/json"
  6662. ],
  6663. parameters: [
  6664. {
  6665. in: "body",
  6666. name: "resource",
  6667. description: "Resource to create",
  6668. required: true,
  6669. schema: {
  6670. $ref: "#/definitions/EncounterroleCreate"
  6671. }
  6672. }
  6673. ],
  6674. responses: {
  6675. 201: {
  6676. description: "encounterrole response"
  6677. },
  6678. 401: {
  6679. description: "User not logged in"
  6680. }
  6681. }
  6682. }
  6683. },
  6684. /encounterrole/{uuid}: {
  6685. get: {
  6686. tags: [
  6687. "encounterrole"
  6688. ],
  6689. summary: "Fetch by uuid",
  6690. operationId: "getEncounterRole",
  6691. consumes: [
  6692. "application/json"
  6693. ],
  6694. produces: [
  6695. "application/json"
  6696. ],
  6697. parameters: [
  6698. {
  6699. name: "v",
  6700. in: "query",
  6701. description: "The representation to return (ref, default, full or custom)",
  6702. required: false,
  6703. type: "string",
  6704. enum: [
  6705. "ref",
  6706. "default",
  6707. "full",
  6708. "custom"
  6709. ]
  6710. },
  6711. {
  6712. name: "uuid",
  6713. in: "path",
  6714. description: "uuid to filter by",
  6715. required: true,
  6716. type: "string"
  6717. }
  6718. ],
  6719. responses: {
  6720. 200: {
  6721. description: "encounterrole response",
  6722. schema: {
  6723. $ref: "#/definitions/EncounterroleGet"
  6724. }
  6725. },
  6726. 401: {
  6727. description: "User not logged in"
  6728. },
  6729. 404: {
  6730. description: "Resource with given uuid doesn't exist"
  6731. }
  6732. }
  6733. },
  6734. post: {
  6735. tags: [
  6736. "encounterrole"
  6737. ],
  6738. summary: "Edit with given uuid, only modifying properties in request",
  6739. operationId: "updateEncounterRole",
  6740. consumes: [
  6741. "application/json"
  6742. ],
  6743. produces: [
  6744. "application/json"
  6745. ],
  6746. parameters: [
  6747. {
  6748. name: "uuid",
  6749. in: "path",
  6750. description: "uuid of resource to update",
  6751. required: true,
  6752. type: "string"
  6753. },
  6754. {
  6755. in: "body",
  6756. name: "resource",
  6757. description: "Resource properties to update",
  6758. required: true,
  6759. schema: {
  6760. $ref: "#/definitions/EncounterroleUpdate"
  6761. }
  6762. }
  6763. ],
  6764. responses: {
  6765. 201: {
  6766. description: "encounterrole response"
  6767. },
  6768. 401: {
  6769. description: "User not logged in"
  6770. }
  6771. }
  6772. },
  6773. delete: {
  6774. tags: [
  6775. "encounterrole"
  6776. ],
  6777. summary: "Delete or purge resource by uuid",
  6778. description: "The resource will be voided/retired unless purge = 'true'",
  6779. operationId: "deleteEncounterRole",
  6780. consumes: [
  6781. "application/json"
  6782. ],
  6783. produces: [
  6784. "application/json"
  6785. ],
  6786. parameters: [
  6787. {
  6788. name: "uuid",
  6789. in: "path",
  6790. description: "uuid to delete",
  6791. required: true,
  6792. type: "string"
  6793. },
  6794. {
  6795. name: "purge",
  6796. in: "query",
  6797. required: false,
  6798. type: "boolean"
  6799. }
  6800. ],
  6801. responses: {
  6802. 204: {
  6803. description: "Delete successful"
  6804. },
  6805. 401: {
  6806. description: "User not logged in"
  6807. },
  6808. 404: {
  6809. description: "Resource with given uuid doesn't exist"
  6810. }
  6811. }
  6812. }
  6813. },
  6814. /visit: {
  6815. get: {
  6816. tags: [
  6817. "visit"
  6818. ],
  6819. summary: "Fetch all non-retired visit resources or perform search",
  6820. description: "All search parameters are optional",
  6821. operationId: "getAllVisits",
  6822. consumes: [
  6823. "application/json"
  6824. ],
  6825. produces: [
  6826. "application/json"
  6827. ],
  6828. parameters: [
  6829. {
  6830. name: "limit",
  6831. in: "query",
  6832. description: "The number of results to return",
  6833. required: false,
  6834. type: "integer"
  6835. },
  6836. {
  6837. name: "startIndex",
  6838. in: "query",
  6839. description: "The offset at which to start",
  6840. required: false,
  6841. type: "integer"
  6842. },
  6843. {
  6844. name: "v",
  6845. in: "query",
  6846. description: "The representation to return (ref, default, full or custom)",
  6847. required: false,
  6848. type: "string",
  6849. enum: [
  6850. "ref",
  6851. "default",
  6852. "full",
  6853. "custom"
  6854. ]
  6855. },
  6856. {
  6857. name: "q",
  6858. in: "query",
  6859. description: "The search query",
  6860. required: false,
  6861. type: "string"
  6862. }
  6863. ],
  6864. responses: {
  6865. 200: {
  6866. description: "visit response",
  6867. schema: {
  6868. $ref: "#/definitions/FetchAll"
  6869. }
  6870. },
  6871. 401: {
  6872. description: "User not logged in"
  6873. }
  6874. }
  6875. },
  6876. post: {
  6877. tags: [
  6878. "visit"
  6879. ],
  6880. summary: "Create with properties in request",
  6881. operationId: "createVisit",
  6882. consumes: [
  6883. "application/json"
  6884. ],
  6885. produces: [
  6886. "application/json"
  6887. ],
  6888. parameters: [
  6889. {
  6890. in: "body",
  6891. name: "resource",
  6892. description: "Resource to create",
  6893. required: true,
  6894. schema: {
  6895. $ref: "#/definitions/VisitCreate"
  6896. }
  6897. }
  6898. ],
  6899. responses: {
  6900. 201: {
  6901. description: "visit response"
  6902. },
  6903. 401: {
  6904. description: "User not logged in"
  6905. }
  6906. }
  6907. }
  6908. },
  6909. /visit/{uuid}: {
  6910. get: {
  6911. tags: [
  6912. "visit"
  6913. ],
  6914. summary: "Fetch by uuid",
  6915. operationId: "getVisit",
  6916. consumes: [
  6917. "application/json"
  6918. ],
  6919. produces: [
  6920. "application/json"
  6921. ],
  6922. parameters: [
  6923. {
  6924. name: "v",
  6925. in: "query",
  6926. description: "The representation to return (ref, default, full or custom)",
  6927. required: false,
  6928. type: "string",
  6929. enum: [
  6930. "ref",
  6931. "default",
  6932. "full",
  6933. "custom"
  6934. ]
  6935. },
  6936. {
  6937. name: "uuid",
  6938. in: "path",
  6939. description: "uuid to filter by",
  6940. required: true,
  6941. type: "string"
  6942. }
  6943. ],
  6944. responses: {
  6945. 200: {
  6946. description: "visit response",
  6947. schema: {
  6948. $ref: "#/definitions/VisitGet"
  6949. }
  6950. },
  6951. 401: {
  6952. description: "User not logged in"
  6953. },
  6954. 404: {
  6955. description: "Resource with given uuid doesn't exist"
  6956. }
  6957. }
  6958. },
  6959. post: {
  6960. tags: [
  6961. "visit"
  6962. ],
  6963. summary: "Edit with given uuid, only modifying properties in request",
  6964. operationId: "updateVisit",
  6965. consumes: [
  6966. "application/json"
  6967. ],
  6968. produces: [
  6969. "application/json"
  6970. ],
  6971. parameters: [
  6972. {
  6973. name: "uuid",
  6974. in: "path",
  6975. description: "uuid of resource to update",
  6976. required: true,
  6977. type: "string"
  6978. },
  6979. {
  6980. in: "body",
  6981. name: "resource",
  6982. description: "Resource properties to update",
  6983. required: true,
  6984. schema: {
  6985. $ref: "#/definitions/VisitUpdate"
  6986. }
  6987. }
  6988. ],
  6989. responses: {
  6990. 201: {
  6991. description: "visit response"
  6992. },
  6993. 401: {
  6994. description: "User not logged in"
  6995. }
  6996. }
  6997. },
  6998. delete: {
  6999. tags: [
  7000. "visit"
  7001. ],
  7002. summary: "Delete or purge resource by uuid",
  7003. description: "The resource will be voided/retired unless purge = 'true'",
  7004. operationId: "deleteVisit",
  7005. consumes: [
  7006. "application/json"
  7007. ],
  7008. produces: [
  7009. "application/json"
  7010. ],
  7011. parameters: [
  7012. {
  7013. name: "uuid",
  7014. in: "path",
  7015. description: "uuid to delete",
  7016. required: true,
  7017. type: "string"
  7018. },
  7019. {
  7020. name: "purge",
  7021. in: "query",
  7022. required: false,
  7023. type: "boolean"
  7024. }
  7025. ],
  7026. responses: {
  7027. 204: {
  7028. description: "Delete successful"
  7029. },
  7030. 401: {
  7031. description: "User not logged in"
  7032. },
  7033. 404: {
  7034. description: "Resource with given uuid doesn't exist"
  7035. }
  7036. }
  7037. }
  7038. },
  7039. /user: {
  7040. get: {
  7041. tags: [
  7042. "user"
  7043. ],
  7044. summary: "Fetch all non-retired user resources or perform search",
  7045. description: "All search parameters are optional",
  7046. operationId: "getAllUsers",
  7047. consumes: [
  7048. "application/json"
  7049. ],
  7050. produces: [
  7051. "application/json"
  7052. ],
  7053. parameters: [
  7054. {
  7055. name: "limit",
  7056. in: "query",
  7057. description: "The number of results to return",
  7058. required: false,
  7059. type: "integer"
  7060. },
  7061. {
  7062. name: "startIndex",
  7063. in: "query",
  7064. description: "The offset at which to start",
  7065. required: false,
  7066. type: "integer"
  7067. },
  7068. {
  7069. name: "v",
  7070. in: "query",
  7071. description: "The representation to return (ref, default, full or custom)",
  7072. required: false,
  7073. type: "string",
  7074. enum: [
  7075. "ref",
  7076. "default",
  7077. "full",
  7078. "custom"
  7079. ]
  7080. },
  7081. {
  7082. name: "q",
  7083. in: "query",
  7084. description: "The search query",
  7085. required: false,
  7086. type: "string"
  7087. },
  7088. {
  7089. name: "username",
  7090. in: "query",
  7091. required: false,
  7092. type: "string"
  7093. }
  7094. ],
  7095. responses: {
  7096. 200: {
  7097. description: "user response",
  7098. schema: {
  7099. $ref: "#/definitions/FetchAll"
  7100. }
  7101. },
  7102. 401: {
  7103. description: "User not logged in"
  7104. }
  7105. }
  7106. },
  7107. post: {
  7108. tags: [
  7109. "user"
  7110. ],
  7111. summary: "Create with properties in request",
  7112. operationId: "createUser",
  7113. consumes: [
  7114. "application/json"
  7115. ],
  7116. produces: [
  7117. "application/json"
  7118. ],
  7119. parameters: [
  7120. {
  7121. in: "body",
  7122. name: "resource",
  7123. description: "Resource to create",
  7124. required: true,
  7125. schema: {
  7126. $ref: "#/definitions/UserCreate"
  7127. }
  7128. }
  7129. ],
  7130. responses: {
  7131. 201: {
  7132. description: "user response"
  7133. },
  7134. 401: {
  7135. description: "User not logged in"
  7136. }
  7137. }
  7138. }
  7139. },
  7140. /user/{uuid}: {
  7141. get: {
  7142. tags: [
  7143. "user"
  7144. ],
  7145. summary: "Fetch by uuid",
  7146. operationId: "getUser",
  7147. consumes: [
  7148. "application/json"
  7149. ],
  7150. produces: [
  7151. "application/json"
  7152. ],
  7153. parameters: [
  7154. {
  7155. name: "v",
  7156. in: "query",
  7157. description: "The representation to return (ref, default, full or custom)",
  7158. required: false,
  7159. type: "string",
  7160. enum: [
  7161. "ref",
  7162. "default",
  7163. "full",
  7164. "custom"
  7165. ]
  7166. },
  7167. {
  7168. name: "uuid",
  7169. in: "path",
  7170. description: "uuid to filter by",
  7171. required: true,
  7172. type: "string"
  7173. }
  7174. ],
  7175. responses: {
  7176. 200: {
  7177. description: "user response",
  7178. schema: {
  7179. $ref: "#/definitions/UserGet"
  7180. }
  7181. },
  7182. 401: {
  7183. description: "User not logged in"
  7184. },
  7185. 404: {
  7186. description: "Resource with given uuid doesn't exist"
  7187. }
  7188. }
  7189. },
  7190. post: {
  7191. tags: [
  7192. "user"
  7193. ],
  7194. summary: "Edit with given uuid, only modifying properties in request",
  7195. operationId: "updateUser",
  7196. consumes: [
  7197. "application/json"
  7198. ],
  7199. produces: [
  7200. "application/json"
  7201. ],
  7202. parameters: [
  7203. {
  7204. name: "uuid",
  7205. in: "path",
  7206. description: "uuid of resource to update",
  7207. required: true,
  7208. type: "string"
  7209. },
  7210. {
  7211. in: "body",
  7212. name: "resource",
  7213. description: "Resource properties to update",
  7214. required: true,
  7215. schema: {
  7216. $ref: "#/definitions/UserUpdate"
  7217. }
  7218. }
  7219. ],
  7220. responses: {
  7221. 201: {
  7222. description: "user response"
  7223. },
  7224. 401: {
  7225. description: "User not logged in"
  7226. }
  7227. }
  7228. },
  7229. delete: {
  7230. tags: [
  7231. "user"
  7232. ],
  7233. summary: "Delete or purge resource by uuid",
  7234. description: "The resource will be voided/retired unless purge = 'true'",
  7235. operationId: "deleteUser",
  7236. consumes: [
  7237. "application/json"
  7238. ],
  7239. produces: [
  7240. "application/json"
  7241. ],
  7242. parameters: [
  7243. {
  7244. name: "uuid",
  7245. in: "path",
  7246. description: "uuid to delete",
  7247. required: true,
  7248. type: "string"
  7249. },
  7250. {
  7251. name: "purge",
  7252. in: "query",
  7253. required: false,
  7254. type: "boolean"
  7255. }
  7256. ],
  7257. responses: {
  7258. 204: {
  7259. description: "Delete successful"
  7260. },
  7261. 401: {
  7262. description: "User not logged in"
  7263. },
  7264. 404: {
  7265. description: "Resource with given uuid doesn't exist"
  7266. }
  7267. }
  7268. }
  7269. },
  7270. /caresetting: {
  7271. get: {
  7272. tags: [
  7273. "caresetting"
  7274. ],
  7275. summary: "Fetch all non-retired caresetting resources or perform search",
  7276. description: "All search parameters are optional",
  7277. operationId: "getAllCareSettings",
  7278. consumes: [
  7279. "application/json"
  7280. ],
  7281. produces: [
  7282. "application/json"
  7283. ],
  7284. parameters: [
  7285. {
  7286. name: "limit",
  7287. in: "query",
  7288. description: "The number of results to return",
  7289. required: false,
  7290. type: "integer"
  7291. },
  7292. {
  7293. name: "startIndex",
  7294. in: "query",
  7295. description: "The offset at which to start",
  7296. required: false,
  7297. type: "integer"
  7298. },
  7299. {
  7300. name: "v",
  7301. in: "query",
  7302. description: "The representation to return (ref, default, full or custom)",
  7303. required: false,
  7304. type: "string",
  7305. enum: [
  7306. "ref",
  7307. "default",
  7308. "full",
  7309. "custom"
  7310. ]
  7311. },
  7312. {
  7313. name: "q",
  7314. in: "query",
  7315. description: "The search query",
  7316. required: false,
  7317. type: "string"
  7318. }
  7319. ],
  7320. responses: {
  7321. 200: {
  7322. description: "caresetting response",
  7323. schema: {
  7324. $ref: "#/definitions/FetchAll"
  7325. }
  7326. },
  7327. 401: {
  7328. description: "User not logged in"
  7329. }
  7330. }
  7331. }
  7332. },
  7333. /caresetting/{uuid}: {
  7334. get: {
  7335. tags: [
  7336. "caresetting"
  7337. ],
  7338. summary: "Fetch by uuid",
  7339. operationId: "getCareSetting",
  7340. consumes: [
  7341. "application/json"
  7342. ],
  7343. produces: [
  7344. "application/json"
  7345. ],
  7346. parameters: [
  7347. {
  7348. name: "v",
  7349. in: "query",
  7350. description: "The representation to return (ref, default, full or custom)",
  7351. required: false,
  7352. type: "string",
  7353. enum: [
  7354. "ref",
  7355. "default",
  7356. "full",
  7357. "custom"
  7358. ]
  7359. },
  7360. {
  7361. name: "uuid",
  7362. in: "path",
  7363. description: "uuid to filter by",
  7364. required: true,
  7365. type: "string"
  7366. }
  7367. ],
  7368. responses: {
  7369. 200: {
  7370. description: "caresetting response",
  7371. schema: {
  7372. $ref: "#/definitions/CaresettingGet"
  7373. }
  7374. },
  7375. 401: {
  7376. description: "User not logged in"
  7377. },
  7378. 404: {
  7379. description: "Resource with given uuid doesn't exist"
  7380. }
  7381. }
  7382. },
  7383. delete: {
  7384. tags: [
  7385. "caresetting"
  7386. ],
  7387. summary: "Delete or purge resource by uuid",
  7388. description: "The resource will be voided/retired unless purge = 'true'",
  7389. operationId: "deleteCareSetting",
  7390. consumes: [
  7391. "application/json"
  7392. ],
  7393. produces: [
  7394. "application/json"
  7395. ],
  7396. parameters: [
  7397. {
  7398. name: "uuid",
  7399. in: "path",
  7400. description: "uuid to delete",
  7401. required: true,
  7402. type: "string"
  7403. },
  7404. {
  7405. name: "purge",
  7406. in: "query",
  7407. required: false,
  7408. type: "boolean"
  7409. }
  7410. ],
  7411. responses: {
  7412. 204: {
  7413. description: "Delete successful"
  7414. },
  7415. 401: {
  7416. description: "User not logged in"
  7417. },
  7418. 404: {
  7419. description: "Resource with given uuid doesn't exist"
  7420. }
  7421. }
  7422. }
  7423. },
  7424. /moduleaction: {
  7425. post: {
  7426. tags: [
  7427. "moduleaction"
  7428. ],
  7429. summary: "Create with properties in request",
  7430. operationId: "createModuleAction",
  7431. consumes: [
  7432. "application/json"
  7433. ],
  7434. produces: [
  7435. "application/json"
  7436. ],
  7437. parameters: [
  7438. {
  7439. in: "body",
  7440. name: "resource",
  7441. description: "Resource to create",
  7442. required: true,
  7443. schema: {
  7444. $ref: "#/definitions/ModuleactionCreate"
  7445. }
  7446. }
  7447. ],
  7448. responses: {
  7449. 201: {
  7450. description: "moduleaction response"
  7451. },
  7452. 401: {
  7453. description: "User not logged in"
  7454. }
  7455. }
  7456. }
  7457. },
  7458. /relationshiptype: {
  7459. get: {
  7460. tags: [
  7461. "relationshiptype"
  7462. ],
  7463. summary: "Fetch all non-retired relationshiptype resources or perform search",
  7464. description: "All search parameters are optional",
  7465. operationId: "getAllRelationShipTypes",
  7466. consumes: [
  7467. "application/json"
  7468. ],
  7469. produces: [
  7470. "application/json"
  7471. ],
  7472. parameters: [
  7473. {
  7474. name: "limit",
  7475. in: "query",
  7476. description: "The number of results to return",
  7477. required: false,
  7478. type: "integer"
  7479. },
  7480. {
  7481. name: "startIndex",
  7482. in: "query",
  7483. description: "The offset at which to start",
  7484. required: false,
  7485. type: "integer"
  7486. },
  7487. {
  7488. name: "v",
  7489. in: "query",
  7490. description: "The representation to return (ref, default, full or custom)",
  7491. required: false,
  7492. type: "string",
  7493. enum: [
  7494. "ref",
  7495. "default",
  7496. "full",
  7497. "custom"
  7498. ]
  7499. },
  7500. {
  7501. name: "q",
  7502. in: "query",
  7503. description: "The search query",
  7504. required: false,
  7505. type: "string"
  7506. }
  7507. ],
  7508. responses: {
  7509. 200: {
  7510. description: "relationshiptype response",
  7511. schema: {
  7512. $ref: "#/definitions/FetchAll"
  7513. }
  7514. },
  7515. 401: {
  7516. description: "User not logged in"
  7517. }
  7518. }
  7519. },
  7520. post: {
  7521. tags: [
  7522. "relationshiptype"
  7523. ],
  7524. summary: "Create with properties in request",
  7525. operationId: "createRelationShipType",
  7526. consumes: [
  7527. "application/json"
  7528. ],
  7529. produces: [
  7530. "application/json"
  7531. ],
  7532. parameters: [
  7533. {
  7534. in: "body",
  7535. name: "resource",
  7536. description: "Resource to create",
  7537. required: true,
  7538. schema: {
  7539. $ref: "#/definitions/RelationshiptypeCreate"
  7540. }
  7541. }
  7542. ],
  7543. responses: {
  7544. 201: {
  7545. description: "relationshiptype response"
  7546. },
  7547. 401: {
  7548. description: "User not logged in"
  7549. }
  7550. }
  7551. }
  7552. },
  7553. /relationshiptype/{uuid}: {
  7554. get: {
  7555. tags: [
  7556. "relationshiptype"
  7557. ],
  7558. summary: "Fetch by uuid",
  7559. operationId: "getRelationShipType",
  7560. consumes: [
  7561. "application/json"
  7562. ],
  7563. produces: [
  7564. "application/json"
  7565. ],
  7566. parameters: [
  7567. {
  7568. name: "v",
  7569. in: "query",
  7570. description: "The representation to return (ref, default, full or custom)",
  7571. required: false,
  7572. type: "string",
  7573. enum: [
  7574. "ref",
  7575. "default",
  7576. "full",
  7577. "custom"
  7578. ]
  7579. },
  7580. {
  7581. name: "uuid",
  7582. in: "path",
  7583. description: "uuid to filter by",
  7584. required: true,
  7585. type: "string"
  7586. }
  7587. ],
  7588. responses: {
  7589. 200: {
  7590. description: "relationshiptype response",
  7591. schema: {
  7592. $ref: "#/definitions/RelationshiptypeGet"
  7593. }
  7594. },
  7595. 401: {
  7596. description: "User not logged in"
  7597. },
  7598. 404: {
  7599. description: "Resource with given uuid doesn't exist"
  7600. }
  7601. }
  7602. },
  7603. post: {
  7604. tags: [
  7605. "relationshiptype"
  7606. ],
  7607. summary: "Edit with given uuid, only modifying properties in request",
  7608. operationId: "updateRelationShipType",
  7609. consumes: [
  7610. "application/json"
  7611. ],
  7612. produces: [
  7613. "application/json"
  7614. ],
  7615. parameters: [
  7616. {
  7617. name: "uuid",
  7618. in: "path",
  7619. description: "uuid of resource to update",
  7620. required: true,
  7621. type: "string"
  7622. },
  7623. {
  7624. in: "body",
  7625. name: "resource",
  7626. description: "Resource properties to update",
  7627. required: true,
  7628. schema: {
  7629. $ref: "#/definitions/RelationshiptypeUpdate"
  7630. }
  7631. }
  7632. ],
  7633. responses: {
  7634. 201: {
  7635. description: "relationshiptype response"
  7636. },
  7637. 401: {
  7638. description: "User not logged in"
  7639. }
  7640. }
  7641. },
  7642. delete: {
  7643. tags: [
  7644. "relationshiptype"
  7645. ],
  7646. summary: "Delete or purge resource by uuid",
  7647. description: "The resource will be voided/retired unless purge = 'true'",
  7648. operationId: "deleteRelationShipType",
  7649. consumes: [
  7650. "application/json"
  7651. ],
  7652. produces: [
  7653. "application/json"
  7654. ],
  7655. parameters: [
  7656. {
  7657. name: "uuid",
  7658. in: "path",
  7659. description: "uuid to delete",
  7660. required: true,
  7661. type: "string"
  7662. },
  7663. {
  7664. name: "purge",
  7665. in: "query",
  7666. required: false,
  7667. type: "boolean"
  7668. }
  7669. ],
  7670. responses: {
  7671. 204: {
  7672. description: "Delete successful"
  7673. },
  7674. 401: {
  7675. description: "User not logged in"
  7676. },
  7677. 404: {
  7678. description: "Resource with given uuid doesn't exist"
  7679. }
  7680. }
  7681. }
  7682. },
  7683. /ordertype: {
  7684. get: {
  7685. tags: [
  7686. "ordertype"
  7687. ],
  7688. summary: "Fetch all non-retired ordertype resources or perform search",
  7689. description: "All search parameters are optional",
  7690. operationId: "getAllOrderTypes",
  7691. consumes: [
  7692. "application/json"
  7693. ],
  7694. produces: [
  7695. "application/json"
  7696. ],
  7697. parameters: [
  7698. {
  7699. name: "limit",
  7700. in: "query",
  7701. description: "The number of results to return",
  7702. required: false,
  7703. type: "integer"
  7704. },
  7705. {
  7706. name: "startIndex",
  7707. in: "query",
  7708. description: "The offset at which to start",
  7709. required: false,
  7710. type: "integer"
  7711. },
  7712. {
  7713. name: "v",
  7714. in: "query",
  7715. description: "The representation to return (ref, default, full or custom)",
  7716. required: false,
  7717. type: "string",
  7718. enum: [
  7719. "ref",
  7720. "default",
  7721. "full",
  7722. "custom"
  7723. ]
  7724. },
  7725. {
  7726. name: "q",
  7727. in: "query",
  7728. description: "The search query",
  7729. required: false,
  7730. type: "string"
  7731. }
  7732. ],
  7733. responses: {
  7734. 200: {
  7735. description: "ordertype response",
  7736. schema: {
  7737. $ref: "#/definitions/FetchAll"
  7738. }
  7739. },
  7740. 401: {
  7741. description: "User not logged in"
  7742. }
  7743. }
  7744. },
  7745. post: {
  7746. tags: [
  7747. "ordertype"
  7748. ],
  7749. summary: "Create with properties in request",
  7750. operationId: "createOrderType",
  7751. consumes: [
  7752. "application/json"
  7753. ],
  7754. produces: [
  7755. "application/json"
  7756. ],
  7757. parameters: [
  7758. {
  7759. in: "body",
  7760. name: "resource",
  7761. description: "Resource to create",
  7762. required: true,
  7763. schema: {
  7764. $ref: "#/definitions/OrdertypeCreate"
  7765. }
  7766. }
  7767. ],
  7768. responses: {
  7769. 201: {
  7770. description: "ordertype response"
  7771. },
  7772. 401: {
  7773. description: "User not logged in"
  7774. }
  7775. }
  7776. }
  7777. },
  7778. /ordertype/{uuid}: {
  7779. get: {
  7780. tags: [
  7781. "ordertype"
  7782. ],
  7783. summary: "Fetch by uuid",
  7784. operationId: "getOrderType",
  7785. consumes: [
  7786. "application/json"
  7787. ],
  7788. produces: [
  7789. "application/json"
  7790. ],
  7791. parameters: [
  7792. {
  7793. name: "v",
  7794. in: "query",
  7795. description: "The representation to return (ref, default, full or custom)",
  7796. required: false,
  7797. type: "string",
  7798. enum: [
  7799. "ref",
  7800. "default",
  7801. "full",
  7802. "custom"
  7803. ]
  7804. },
  7805. {
  7806. name: "uuid",
  7807. in: "path",
  7808. description: "uuid to filter by",
  7809. required: true,
  7810. type: "string"
  7811. }
  7812. ],
  7813. responses: {
  7814. 200: {
  7815. description: "ordertype response",
  7816. schema: {
  7817. $ref: "#/definitions/OrdertypeGet"
  7818. }
  7819. },
  7820. 401: {
  7821. description: "User not logged in"
  7822. },
  7823. 404: {
  7824. description: "Resource with given uuid doesn't exist"
  7825. }
  7826. }
  7827. },
  7828. post: {
  7829. tags: [
  7830. "ordertype"
  7831. ],
  7832. summary: "Edit with given uuid, only modifying properties in request",
  7833. operationId: "updateOrderType",
  7834. consumes: [
  7835. "application/json"
  7836. ],
  7837. produces: [
  7838. "application/json"
  7839. ],
  7840. parameters: [
  7841. {
  7842. name: "uuid",
  7843. in: "path",
  7844. description: "uuid of resource to update",
  7845. required: true,
  7846. type: "string"
  7847. },
  7848. {
  7849. in: "body",
  7850. name: "resource",
  7851. description: "Resource properties to update",
  7852. required: true,
  7853. schema: {
  7854. $ref: "#/definitions/OrdertypeUpdate"
  7855. }
  7856. }
  7857. ],
  7858. responses: {
  7859. 201: {
  7860. description: "ordertype response"
  7861. },
  7862. 401: {
  7863. description: "User not logged in"
  7864. }
  7865. }
  7866. },
  7867. delete: {
  7868. tags: [
  7869. "ordertype"
  7870. ],
  7871. summary: "Delete or purge resource by uuid",
  7872. description: "The resource will be voided/retired unless purge = 'true'",
  7873. operationId: "deleteOrderType",
  7874. consumes: [
  7875. "application/json"
  7876. ],
  7877. produces: [
  7878. "application/json"
  7879. ],
  7880. parameters: [
  7881. {
  7882. name: "uuid",
  7883. in: "path",
  7884. description: "uuid to delete",
  7885. required: true,
  7886. type: "string"
  7887. },
  7888. {
  7889. name: "purge",
  7890. in: "query",
  7891. required: false,
  7892. type: "boolean"
  7893. }
  7894. ],
  7895. responses: {
  7896. 204: {
  7897. description: "Delete successful"
  7898. },
  7899. 401: {
  7900. description: "User not logged in"
  7901. },
  7902. 404: {
  7903. description: "Resource with given uuid doesn't exist"
  7904. }
  7905. }
  7906. }
  7907. },
  7908. /conceptstopword: {
  7909. get: {
  7910. tags: [
  7911. "conceptstopword"
  7912. ],
  7913. summary: "Fetch all non-retired conceptstopword resources or perform search",
  7914. description: "All search parameters are optional",
  7915. operationId: "getAllConceptStopwords",
  7916. consumes: [
  7917. "application/json"
  7918. ],
  7919. produces: [
  7920. "application/json"
  7921. ],
  7922. parameters: [
  7923. {
  7924. name: "limit",
  7925. in: "query",
  7926. description: "The number of results to return",
  7927. required: false,
  7928. type: "integer"
  7929. },
  7930. {
  7931. name: "startIndex",
  7932. in: "query",
  7933. description: "The offset at which to start",
  7934. required: false,
  7935. type: "integer"
  7936. },
  7937. {
  7938. name: "v",
  7939. in: "query",
  7940. description: "The representation to return (ref, default, full or custom)",
  7941. required: false,
  7942. type: "string",
  7943. enum: [
  7944. "ref",
  7945. "default",
  7946. "full",
  7947. "custom"
  7948. ]
  7949. },
  7950. {
  7951. name: "q",
  7952. in: "query",
  7953. description: "The search query",
  7954. required: false,
  7955. type: "string"
  7956. }
  7957. ],
  7958. responses: {
  7959. 200: {
  7960. description: "conceptstopword response",
  7961. schema: {
  7962. $ref: "#/definitions/FetchAll"
  7963. }
  7964. },
  7965. 401: {
  7966. description: "User not logged in"
  7967. }
  7968. }
  7969. },
  7970. post: {
  7971. tags: [
  7972. "conceptstopword"
  7973. ],
  7974. summary: "Create with properties in request",
  7975. operationId: "createConceptStopword",
  7976. consumes: [
  7977. "application/json"
  7978. ],
  7979. produces: [
  7980. "application/json"
  7981. ],
  7982. parameters: [
  7983. {
  7984. in: "body",
  7985. name: "resource",
  7986. description: "Resource to create",
  7987. required: true,
  7988. schema: {
  7989. $ref: "#/definitions/ConceptstopwordCreate"
  7990. }
  7991. }
  7992. ],
  7993. responses: {
  7994. 201: {
  7995. description: "conceptstopword response"
  7996. },
  7997. 401: {
  7998. description: "User not logged in"
  7999. }
  8000. }
  8001. }
  8002. },
  8003. /conceptstopword/{uuid}: {
  8004. get: {
  8005. tags: [
  8006. "conceptstopword"
  8007. ],
  8008. summary: "Fetch by uuid",
  8009. operationId: "getConceptStopword",
  8010. consumes: [
  8011. "application/json"
  8012. ],
  8013. produces: [
  8014. "application/json"
  8015. ],
  8016. parameters: [
  8017. {
  8018. name: "v",
  8019. in: "query",
  8020. description: "The representation to return (ref, default, full or custom)",
  8021. required: false,
  8022. type: "string",
  8023. enum: [
  8024. "ref",
  8025. "default",
  8026. "full",
  8027. "custom"
  8028. ]
  8029. },
  8030. {
  8031. name: "uuid",
  8032. in: "path",
  8033. description: "uuid to filter by",
  8034. required: true,
  8035. type: "string"
  8036. }
  8037. ],
  8038. responses: {
  8039. 200: {
  8040. description: "conceptstopword response",
  8041. schema: {
  8042. $ref: "#/definitions/ConceptstopwordGet"
  8043. }
  8044. },
  8045. 401: {
  8046. description: "User not logged in"
  8047. },
  8048. 404: {
  8049. description: "Resource with given uuid doesn't exist"
  8050. }
  8051. }
  8052. },
  8053. post: {
  8054. tags: [
  8055. "conceptstopword"
  8056. ],
  8057. summary: "Edit with given uuid, only modifying properties in request",
  8058. operationId: "updateConceptStopword",
  8059. consumes: [
  8060. "application/json"
  8061. ],
  8062. produces: [
  8063. "application/json"
  8064. ],
  8065. parameters: [
  8066. {
  8067. name: "uuid",
  8068. in: "path",
  8069. description: "uuid of resource to update",
  8070. required: true,
  8071. type: "string"
  8072. },
  8073. {
  8074. in: "body",
  8075. name: "resource",
  8076. description: "Resource properties to update",
  8077. required: true,
  8078. schema: {
  8079. $ref: "#/definitions/ConceptstopwordUpdate"
  8080. }
  8081. }
  8082. ],
  8083. responses: {
  8084. 201: {
  8085. description: "conceptstopword response"
  8086. },
  8087. 401: {
  8088. description: "User not logged in"
  8089. }
  8090. }
  8091. },
  8092. delete: {
  8093. tags: [
  8094. "conceptstopword"
  8095. ],
  8096. summary: "Delete or purge resource by uuid",
  8097. description: "The resource will be voided/retired unless purge = 'true'",
  8098. operationId: "deleteConceptStopword",
  8099. consumes: [
  8100. "application/json"
  8101. ],
  8102. produces: [
  8103. "application/json"
  8104. ],
  8105. parameters: [
  8106. {
  8107. name: "uuid",
  8108. in: "path",
  8109. description: "uuid to delete",
  8110. required: true,
  8111. type: "string"
  8112. },
  8113. {
  8114. name: "purge",
  8115. in: "query",
  8116. required: false,
  8117. type: "boolean"
  8118. }
  8119. ],
  8120. responses: {
  8121. 204: {
  8122. description: "Delete successful"
  8123. },
  8124. 401: {
  8125. description: "User not logged in"
  8126. },
  8127. 404: {
  8128. description: "Resource with given uuid doesn't exist"
  8129. }
  8130. }
  8131. }
  8132. },
  8133. /fieldtype: {
  8134. get: {
  8135. tags: [
  8136. "fieldtype"
  8137. ],
  8138. summary: "Fetch all non-retired fieldtype resources or perform search",
  8139. description: "All search parameters are optional",
  8140. operationId: "getAllFieldTypes",
  8141. consumes: [
  8142. "application/json"
  8143. ],
  8144. produces: [
  8145. "application/json"
  8146. ],
  8147. parameters: [
  8148. {
  8149. name: "limit",
  8150. in: "query",
  8151. description: "The number of results to return",
  8152. required: false,
  8153. type: "integer"
  8154. },
  8155. {
  8156. name: "startIndex",
  8157. in: "query",
  8158. description: "The offset at which to start",
  8159. required: false,
  8160. type: "integer"
  8161. },
  8162. {
  8163. name: "v",
  8164. in: "query",
  8165. description: "The representation to return (ref, default, full or custom)",
  8166. required: false,
  8167. type: "string",
  8168. enum: [
  8169. "ref",
  8170. "default",
  8171. "full",
  8172. "custom"
  8173. ]
  8174. },
  8175. {
  8176. name: "q",
  8177. in: "query",
  8178. description: "The search query",
  8179. required: false,
  8180. type: "string"
  8181. }
  8182. ],
  8183. responses: {
  8184. 200: {
  8185. description: "fieldtype response",
  8186. schema: {
  8187. $ref: "#/definitions/FetchAll"
  8188. }
  8189. },
  8190. 401: {
  8191. description: "User not logged in"
  8192. }
  8193. }
  8194. },
  8195. post: {
  8196. tags: [
  8197. "fieldtype"
  8198. ],
  8199. summary: "Create with properties in request",
  8200. operationId: "createFieldType",
  8201. consumes: [
  8202. "application/json"
  8203. ],
  8204. produces: [
  8205. "application/json"
  8206. ],
  8207. parameters: [
  8208. {
  8209. in: "body",
  8210. name: "resource",
  8211. description: "Resource to create",
  8212. required: true,
  8213. schema: {
  8214. $ref: "#/definitions/FieldtypeCreate"
  8215. }
  8216. }
  8217. ],
  8218. responses: {
  8219. 201: {
  8220. description: "fieldtype response"
  8221. },
  8222. 401: {
  8223. description: "User not logged in"
  8224. }
  8225. }
  8226. }
  8227. },
  8228. /fieldtype/{uuid}: {
  8229. get: {
  8230. tags: [
  8231. "fieldtype"
  8232. ],
  8233. summary: "Fetch by uuid",
  8234. operationId: "getFieldType",
  8235. consumes: [
  8236. "application/json"
  8237. ],
  8238. produces: [
  8239. "application/json"
  8240. ],
  8241. parameters: [
  8242. {
  8243. name: "v",
  8244. in: "query",
  8245. description: "The representation to return (ref, default, full or custom)",
  8246. required: false,
  8247. type: "string",
  8248. enum: [
  8249. "ref",
  8250. "default",
  8251. "full",
  8252. "custom"
  8253. ]
  8254. },
  8255. {
  8256. name: "uuid",
  8257. in: "path",
  8258. description: "uuid to filter by",
  8259. required: true,
  8260. type: "string"
  8261. }
  8262. ],
  8263. responses: {
  8264. 200: {
  8265. description: "fieldtype response",
  8266. schema: {
  8267. $ref: "#/definitions/FieldtypeGet"
  8268. }
  8269. },
  8270. 401: {
  8271. description: "User not logged in"
  8272. },
  8273. 404: {
  8274. description: "Resource with given uuid doesn't exist"
  8275. }
  8276. }
  8277. },
  8278. post: {
  8279. tags: [
  8280. "fieldtype"
  8281. ],
  8282. summary: "Edit with given uuid, only modifying properties in request",
  8283. operationId: "updateFieldType",
  8284. consumes: [
  8285. "application/json"
  8286. ],
  8287. produces: [
  8288. "application/json"
  8289. ],
  8290. parameters: [
  8291. {
  8292. name: "uuid",
  8293. in: "path",
  8294. description: "uuid of resource to update",
  8295. required: true,
  8296. type: "string"
  8297. },
  8298. {
  8299. in: "body",
  8300. name: "resource",
  8301. description: "Resource properties to update",
  8302. required: true,
  8303. schema: {
  8304. $ref: "#/definitions/FieldtypeUpdate"
  8305. }
  8306. }
  8307. ],
  8308. responses: {
  8309. 201: {
  8310. description: "fieldtype response"
  8311. },
  8312. 401: {
  8313. description: "User not logged in"
  8314. }
  8315. }
  8316. },
  8317. delete: {
  8318. tags: [
  8319. "fieldtype"
  8320. ],
  8321. summary: "Delete or purge resource by uuid",
  8322. description: "The resource will be voided/retired unless purge = 'true'",
  8323. operationId: "deleteFieldType",
  8324. consumes: [
  8325. "application/json"
  8326. ],
  8327. produces: [
  8328. "application/json"
  8329. ],
  8330. parameters: [
  8331. {
  8332. name: "uuid",
  8333. in: "path",
  8334. description: "uuid to delete",
  8335. required: true,
  8336. type: "string"
  8337. },
  8338. {
  8339. name: "purge",
  8340. in: "query",
  8341. required: false,
  8342. type: "boolean"
  8343. }
  8344. ],
  8345. responses: {
  8346. 204: {
  8347. description: "Delete successful"
  8348. },
  8349. 401: {
  8350. description: "User not logged in"
  8351. },
  8352. 404: {
  8353. description: "Resource with given uuid doesn't exist"
  8354. }
  8355. }
  8356. }
  8357. },
  8358. /locationattributetype: {
  8359. get: {
  8360. tags: [
  8361. "locationattributetype"
  8362. ],
  8363. summary: "Fetch all non-retired locationattributetype resources or perform search",
  8364. description: "All search parameters are optional",
  8365. operationId: "getAllLocationAttributeTypes",
  8366. consumes: [
  8367. "application/json"
  8368. ],
  8369. produces: [
  8370. "application/json"
  8371. ],
  8372. parameters: [
  8373. {
  8374. name: "limit",
  8375. in: "query",
  8376. description: "The number of results to return",
  8377. required: false,
  8378. type: "integer"
  8379. },
  8380. {
  8381. name: "startIndex",
  8382. in: "query",
  8383. description: "The offset at which to start",
  8384. required: false,
  8385. type: "integer"
  8386. },
  8387. {
  8388. name: "v",
  8389. in: "query",
  8390. description: "The representation to return (ref, default, full or custom)",
  8391. required: false,
  8392. type: "string",
  8393. enum: [
  8394. "ref",
  8395. "default",
  8396. "full",
  8397. "custom"
  8398. ]
  8399. },
  8400. {
  8401. name: "q",
  8402. in: "query",
  8403. description: "The search query",
  8404. required: false,
  8405. type: "string"
  8406. }
  8407. ],
  8408. responses: {
  8409. 200: {
  8410. description: "locationattributetype response",
  8411. schema: {
  8412. $ref: "#/definitions/FetchAll"
  8413. }
  8414. },
  8415. 401: {
  8416. description: "User not logged in"
  8417. }
  8418. }
  8419. },
  8420. post: {
  8421. tags: [
  8422. "locationattributetype"
  8423. ],
  8424. summary: "Create with properties in request",
  8425. operationId: "createLocationAttributeType",
  8426. consumes: [
  8427. "application/json"
  8428. ],
  8429. produces: [
  8430. "application/json"
  8431. ],
  8432. parameters: [
  8433. {
  8434. in: "body",
  8435. name: "resource",
  8436. description: "Resource to create",
  8437. required: true,
  8438. schema: {
  8439. $ref: "#/definitions/LocationattributetypeCreate"
  8440. }
  8441. }
  8442. ],
  8443. responses: {
  8444. 201: {
  8445. description: "locationattributetype response"
  8446. },
  8447. 401: {
  8448. description: "User not logged in"
  8449. }
  8450. }
  8451. }
  8452. },
  8453. /locationattributetype/{uuid}: {
  8454. get: {
  8455. tags: [
  8456. "locationattributetype"
  8457. ],
  8458. summary: "Fetch by uuid",
  8459. operationId: "getLocationAttributeType",
  8460. consumes: [
  8461. "application/json"
  8462. ],
  8463. produces: [
  8464. "application/json"
  8465. ],
  8466. parameters: [
  8467. {
  8468. name: "v",
  8469. in: "query",
  8470. description: "The representation to return (ref, default, full or custom)",
  8471. required: false,
  8472. type: "string",
  8473. enum: [
  8474. "ref",
  8475. "default",
  8476. "full",
  8477. "custom"
  8478. ]
  8479. },
  8480. {
  8481. name: "uuid",
  8482. in: "path",
  8483. description: "uuid to filter by",
  8484. required: true,
  8485. type: "string"
  8486. }
  8487. ],
  8488. responses: {
  8489. 200: {
  8490. description: "locationattributetype response",
  8491. schema: {
  8492. $ref: "#/definitions/LocationattributetypeGet"
  8493. }
  8494. },
  8495. 401: {
  8496. description: "User not logged in"
  8497. },
  8498. 404: {
  8499. description: "Resource with given uuid doesn't exist"
  8500. }
  8501. }
  8502. },
  8503. post: {
  8504. tags: [
  8505. "locationattributetype"
  8506. ],
  8507. summary: "Edit with given uuid, only modifying properties in request",
  8508. operationId: "updateLocationAttributeType",
  8509. consumes: [
  8510. "application/json"
  8511. ],
  8512. produces: [
  8513. "application/json"
  8514. ],
  8515. parameters: [
  8516. {
  8517. name: "uuid",
  8518. in: "path",
  8519. description: "uuid of resource to update",
  8520. required: true,
  8521. type: "string"
  8522. },
  8523. {
  8524. in: "body",
  8525. name: "resource",
  8526. description: "Resource properties to update",
  8527. required: true,
  8528. schema: {
  8529. $ref: "#/definitions/LocationattributetypeUpdate"
  8530. }
  8531. }
  8532. ],
  8533. responses: {
  8534. 201: {
  8535. description: "locationattributetype response"
  8536. },
  8537. 401: {
  8538. description: "User not logged in"
  8539. }
  8540. }
  8541. },
  8542. delete: {
  8543. tags: [
  8544. "locationattributetype"
  8545. ],
  8546. summary: "Delete or purge resource by uuid",
  8547. description: "The resource will be voided/retired unless purge = 'true'",
  8548. operationId: "deleteLocationAttributeType",
  8549. consumes: [
  8550. "application/json"
  8551. ],
  8552. produces: [
  8553. "application/json"
  8554. ],
  8555. parameters: [
  8556. {
  8557. name: "uuid",
  8558. in: "path",
  8559. description: "uuid to delete",
  8560. required: true,
  8561. type: "string"
  8562. },
  8563. {
  8564. name: "purge",
  8565. in: "query",
  8566. required: false,
  8567. type: "boolean"
  8568. }
  8569. ],
  8570. responses: {
  8571. 204: {
  8572. description: "Delete successful"
  8573. },
  8574. 401: {
  8575. description: "User not logged in"
  8576. },
  8577. 404: {
  8578. description: "Resource with given uuid doesn't exist"
  8579. }
  8580. }
  8581. }
  8582. },
  8583. /relationship: {
  8584. get: {
  8585. tags: [
  8586. "relationship"
  8587. ],
  8588. summary: "Fetch all non-retired relationship resources or perform search",
  8589. description: "All search parameters are optional",
  8590. operationId: "getAllRelationships",
  8591. consumes: [
  8592. "application/json"
  8593. ],
  8594. produces: [
  8595. "application/json"
  8596. ],
  8597. parameters: [
  8598. {
  8599. name: "limit",
  8600. in: "query",
  8601. description: "The number of results to return",
  8602. required: false,
  8603. type: "integer"
  8604. },
  8605. {
  8606. name: "startIndex",
  8607. in: "query",
  8608. description: "The offset at which to start",
  8609. required: false,
  8610. type: "integer"
  8611. },
  8612. {
  8613. name: "v",
  8614. in: "query",
  8615. description: "The representation to return (ref, default, full or custom)",
  8616. required: false,
  8617. type: "string",
  8618. enum: [
  8619. "ref",
  8620. "default",
  8621. "full",
  8622. "custom"
  8623. ]
  8624. },
  8625. {
  8626. name: "q",
  8627. in: "query",
  8628. description: "The search query",
  8629. required: false,
  8630. type: "string"
  8631. },
  8632. {
  8633. name: "personB",
  8634. in: "query",
  8635. required: false,
  8636. type: "string"
  8637. },
  8638. {
  8639. name: "personA",
  8640. in: "query",
  8641. required: false,
  8642. type: "string"
  8643. },
  8644. {
  8645. name: "person",
  8646. in: "query",
  8647. required: false,
  8648. type: "string"
  8649. },
  8650. {
  8651. name: "relation",
  8652. in: "query",
  8653. required: false,
  8654. type: "string"
  8655. },
  8656. {
  8657. name: "relatedPerson",
  8658. in: "query",
  8659. required: false,
  8660. type: "string"
  8661. }
  8662. ],
  8663. responses: {
  8664. 200: {
  8665. description: "relationship response",
  8666. schema: {
  8667. $ref: "#/definitions/FetchAll"
  8668. }
  8669. },
  8670. 401: {
  8671. description: "User not logged in"
  8672. }
  8673. }
  8674. },
  8675. post: {
  8676. tags: [
  8677. "relationship"
  8678. ],
  8679. summary: "Create with properties in request",
  8680. operationId: "createRelationship",
  8681. consumes: [
  8682. "application/json"
  8683. ],
  8684. produces: [
  8685. "application/json"
  8686. ],
  8687. parameters: [
  8688. {
  8689. in: "body",
  8690. name: "resource",
  8691. description: "Resource to create",
  8692. required: true,
  8693. schema: {
  8694. $ref: "#/definitions/RelationshipCreate"
  8695. }
  8696. }
  8697. ],
  8698. responses: {
  8699. 201: {
  8700. description: "relationship response"
  8701. },
  8702. 401: {
  8703. description: "User not logged in"
  8704. }
  8705. }
  8706. }
  8707. },
  8708. /relationship/{uuid}: {
  8709. get: {
  8710. tags: [
  8711. "relationship"
  8712. ],
  8713. summary: "Fetch by uuid",
  8714. operationId: "getRelationship",
  8715. consumes: [
  8716. "application/json"
  8717. ],
  8718. produces: [
  8719. "application/json"
  8720. ],
  8721. parameters: [
  8722. {
  8723. name: "v",
  8724. in: "query",
  8725. description: "The representation to return (ref, default, full or custom)",
  8726. required: false,
  8727. type: "string",
  8728. enum: [
  8729. "ref",
  8730. "default",
  8731. "full",
  8732. "custom"
  8733. ]
  8734. },
  8735. {
  8736. name: "uuid",
  8737. in: "path",
  8738. description: "uuid to filter by",
  8739. required: true,
  8740. type: "string"
  8741. }
  8742. ],
  8743. responses: {
  8744. 200: {
  8745. description: "relationship response",
  8746. schema: {
  8747. $ref: "#/definitions/RelationshipGet"
  8748. }
  8749. },
  8750. 401: {
  8751. description: "User not logged in"
  8752. },
  8753. 404: {
  8754. description: "Resource with given uuid doesn't exist"
  8755. }
  8756. }
  8757. },
  8758. post: {
  8759. tags: [
  8760. "relationship"
  8761. ],
  8762. summary: "Edit with given uuid, only modifying properties in request",
  8763. operationId: "updateRelationship",
  8764. consumes: [
  8765. "application/json"
  8766. ],
  8767. produces: [
  8768. "application/json"
  8769. ],
  8770. parameters: [
  8771. {
  8772. name: "uuid",
  8773. in: "path",
  8774. description: "uuid of resource to update",
  8775. required: true,
  8776. type: "string"
  8777. },
  8778. {
  8779. in: "body",
  8780. name: "resource",
  8781. description: "Resource properties to update",
  8782. required: true,
  8783. schema: {
  8784. $ref: "#/definitions/RelationshipUpdate"
  8785. }
  8786. }
  8787. ],
  8788. responses: {
  8789. 201: {
  8790. description: "relationship response"
  8791. },
  8792. 401: {
  8793. description: "User not logged in"
  8794. }
  8795. }
  8796. },
  8797. delete: {
  8798. tags: [
  8799. "relationship"
  8800. ],
  8801. summary: "Delete or purge resource by uuid",
  8802. description: "The resource will be voided/retired unless purge = 'true'",
  8803. operationId: "deleteRelationship",
  8804. consumes: [
  8805. "application/json"
  8806. ],
  8807. produces: [
  8808. "application/json"
  8809. ],
  8810. parameters: [
  8811. {
  8812. name: "uuid",
  8813. in: "path",
  8814. description: "uuid to delete",
  8815. required: true,
  8816. type: "string"
  8817. },
  8818. {
  8819. name: "purge",
  8820. in: "query",
  8821. required: false,
  8822. type: "boolean"
  8823. }
  8824. ],
  8825. responses: {
  8826. 204: {
  8827. description: "Delete successful"
  8828. },
  8829. 401: {
  8830. description: "User not logged in"
  8831. },
  8832. 404: {
  8833. description: "Resource with given uuid doesn't exist"
  8834. }
  8835. }
  8836. }
  8837. },
  8838. /visittype: {
  8839. get: {
  8840. tags: [
  8841. "visittype"
  8842. ],
  8843. summary: "Fetch all non-retired visittype resources or perform search",
  8844. description: "All search parameters are optional",
  8845. operationId: "getAllVisitTypes",
  8846. consumes: [
  8847. "application/json"
  8848. ],
  8849. produces: [
  8850. "application/json"
  8851. ],
  8852. parameters: [
  8853. {
  8854. name: "limit",
  8855. in: "query",
  8856. description: "The number of results to return",
  8857. required: false,
  8858. type: "integer"
  8859. },
  8860. {
  8861. name: "startIndex",
  8862. in: "query",
  8863. description: "The offset at which to start",
  8864. required: false,
  8865. type: "integer"
  8866. },
  8867. {
  8868. name: "v",
  8869. in: "query",
  8870. description: "The representation to return (ref, default, full or custom)",
  8871. required: false,
  8872. type: "string",
  8873. enum: [
  8874. "ref",
  8875. "default",
  8876. "full",
  8877. "custom"
  8878. ]
  8879. },
  8880. {
  8881. name: "q",
  8882. in: "query",
  8883. description: "The search query",
  8884. required: false,
  8885. type: "string"
  8886. }
  8887. ],
  8888. responses: {
  8889. 200: {
  8890. description: "visittype response",
  8891. schema: {
  8892. $ref: "#/definitions/FetchAll"
  8893. }
  8894. },
  8895. 401: {
  8896. description: "User not logged in"
  8897. }
  8898. }
  8899. },
  8900. post: {
  8901. tags: [
  8902. "visittype"
  8903. ],
  8904. summary: "Create with properties in request",
  8905. operationId: "createVisitType",
  8906. consumes: [
  8907. "application/json"
  8908. ],
  8909. produces: [
  8910. "application/json"
  8911. ],
  8912. parameters: [
  8913. {
  8914. in: "body",
  8915. name: "resource",
  8916. description: "Resource to create",
  8917. required: true,
  8918. schema: {
  8919. $ref: "#/definitions/VisittypeCreate"
  8920. }
  8921. }
  8922. ],
  8923. responses: {
  8924. 201: {
  8925. description: "visittype response"
  8926. },
  8927. 401: {
  8928. description: "User not logged in"
  8929. }
  8930. }
  8931. }
  8932. },
  8933. /visittype/{uuid}: {
  8934. get: {
  8935. tags: [
  8936. "visittype"
  8937. ],
  8938. summary: "Fetch by uuid",
  8939. operationId: "getVisitType",
  8940. consumes: [
  8941. "application/json"
  8942. ],
  8943. produces: [
  8944. "application/json"
  8945. ],
  8946. parameters: [
  8947. {
  8948. name: "v",
  8949. in: "query",
  8950. description: "The representation to return (ref, default, full or custom)",
  8951. required: false,
  8952. type: "string",
  8953. enum: [
  8954. "ref",
  8955. "default",
  8956. "full",
  8957. "custom"
  8958. ]
  8959. },
  8960. {
  8961. name: "uuid",
  8962. in: "path",
  8963. description: "uuid to filter by",
  8964. required: true,
  8965. type: "string"
  8966. }
  8967. ],
  8968. responses: {
  8969. 200: {
  8970. description: "visittype response",
  8971. schema: {
  8972. $ref: "#/definitions/VisittypeGet"
  8973. }
  8974. },
  8975. 401: {
  8976. description: "User not logged in"
  8977. },
  8978. 404: {
  8979. description: "Resource with given uuid doesn't exist"
  8980. }
  8981. }
  8982. },
  8983. post: {
  8984. tags: [
  8985. "visittype"
  8986. ],
  8987. summary: "Edit with given uuid, only modifying properties in request",
  8988. operationId: "updateVisitType",
  8989. consumes: [
  8990. "application/json"
  8991. ],
  8992. produces: [
  8993. "application/json"
  8994. ],
  8995. parameters: [
  8996. {
  8997. name: "uuid",
  8998. in: "path",
  8999. description: "uuid of resource to update",
  9000. required: true,
  9001. type: "string"
  9002. },
  9003. {
  9004. in: "body",
  9005. name: "resource",
  9006. description: "Resource properties to update",
  9007. required: true,
  9008. schema: {
  9009. $ref: "#/definitions/VisittypeUpdate"
  9010. }
  9011. }
  9012. ],
  9013. responses: {
  9014. 201: {
  9015. description: "visittype response"
  9016. },
  9017. 401: {
  9018. description: "User not logged in"
  9019. }
  9020. }
  9021. },
  9022. delete: {
  9023. tags: [
  9024. "visittype"
  9025. ],
  9026. summary: "Delete or purge resource by uuid",
  9027. description: "The resource will be voided/retired unless purge = 'true'",
  9028. operationId: "deleteVisitType",
  9029. consumes: [
  9030. "application/json"
  9031. ],
  9032. produces: [
  9033. "application/json"
  9034. ],
  9035. parameters: [
  9036. {
  9037. name: "uuid",
  9038. in: "path",
  9039. description: "uuid to delete",
  9040. required: true,
  9041. type: "string"
  9042. },
  9043. {
  9044. name: "purge",
  9045. in: "query",
  9046. required: false,
  9047. type: "boolean"
  9048. }
  9049. ],
  9050. responses: {
  9051. 204: {
  9052. description: "Delete successful"
  9053. },
  9054. 401: {
  9055. description: "User not logged in"
  9056. },
  9057. 404: {
  9058. description: "Resource with given uuid doesn't exist"
  9059. }
  9060. }
  9061. }
  9062. },
  9063. /order: {
  9064. get: {
  9065. tags: [
  9066. "order"
  9067. ],
  9068. summary: "Search for order",
  9069. description: "At least one search parameter must be specified",
  9070. operationId: "getAllOrders",
  9071. produces: [
  9072. "application/json",
  9073. "application/xml"
  9074. ],
  9075. parameters: [
  9076. {
  9077. name: "limit",
  9078. in: "query",
  9079. description: "The number of results to return",
  9080. required: false,
  9081. type: "integer"
  9082. },
  9083. {
  9084. name: "startIndex",
  9085. in: "query",
  9086. description: "The offset at which to start",
  9087. required: false,
  9088. type: "integer"
  9089. },
  9090. {
  9091. name: "v",
  9092. in: "query",
  9093. description: "The representation to return (ref, default, full or custom)",
  9094. required: false,
  9095. type: "string",
  9096. enum: [
  9097. "ref",
  9098. "default",
  9099. "full",
  9100. "custom"
  9101. ]
  9102. },
  9103. {
  9104. name: "q",
  9105. in: "query",
  9106. description: "The search query",
  9107. required: false,
  9108. type: "string"
  9109. },
  9110. {
  9111. name: "t",
  9112. in: "query",
  9113. description: "The type of Subclass Resource to return",
  9114. required: false,
  9115. type: "string"
  9116. },
  9117. {
  9118. name: "careSetting",
  9119. in: "query",
  9120. description: "Must be used with ",
  9121. required: false,
  9122. type: "string"
  9123. },
  9124. {
  9125. name: "includeVoided",
  9126. in: "query",
  9127. description: "Must be used with ",
  9128. required: false,
  9129. type: "string"
  9130. },
  9131. {
  9132. name: "concepts",
  9133. in: "query",
  9134. description: "Must be used with ",
  9135. required: false,
  9136. type: "string"
  9137. },
  9138. {
  9139. name: "patient",
  9140. in: "query",
  9141. description: "Must be used with ",
  9142. required: false,
  9143. type: "string"
  9144. },
  9145. {
  9146. name: "orderTypes",
  9147. in: "query",
  9148. description: "Must be used with ",
  9149. required: false,
  9150. type: "string"
  9151. },
  9152. {
  9153. name: "activatedOnOrBeforeDate",
  9154. in: "query",
  9155. description: "Must be used with ",
  9156. required: false,
  9157. type: "string"
  9158. },
  9159. {
  9160. name: "activatedOnOrAfterDate",
  9161. in: "query",
  9162. description: "Must be used with ",
  9163. required: false,
  9164. type: "string"
  9165. }
  9166. ],
  9167. responses: {
  9168. 200: {
  9169. description: "order response",
  9170. schema: {
  9171. $ref: "#/definitions/FetchAll"
  9172. }
  9173. }
  9174. }
  9175. },
  9176. post: {
  9177. tags: [
  9178. "order"
  9179. ],
  9180. summary: "Create with properties in request",
  9181. operationId: "createOrder",
  9182. consumes: [
  9183. "application/json"
  9184. ],
  9185. produces: [
  9186. "application/json"
  9187. ],
  9188. parameters: [
  9189. {
  9190. in: "body",
  9191. name: "resource",
  9192. description: "Resource to create",
  9193. required: true,
  9194. schema: {
  9195. $ref: "#/definitions/OrderCreate"
  9196. }
  9197. }
  9198. ],
  9199. responses: {
  9200. 201: {
  9201. description: "order response"
  9202. },
  9203. 401: {
  9204. description: "User not logged in"
  9205. }
  9206. }
  9207. }
  9208. },
  9209. /order/{uuid}: {
  9210. get: {
  9211. tags: [
  9212. "order"
  9213. ],
  9214. summary: "Fetch by uuid",
  9215. operationId: "getOrder",
  9216. consumes: [
  9217. "application/json"
  9218. ],
  9219. produces: [
  9220. "application/json"
  9221. ],
  9222. parameters: [
  9223. {
  9224. name: "v",
  9225. in: "query",
  9226. description: "The representation to return (ref, default, full or custom)",
  9227. required: false,
  9228. type: "string",
  9229. enum: [
  9230. "ref",
  9231. "default",
  9232. "full",
  9233. "custom"
  9234. ]
  9235. },
  9236. {
  9237. name: "uuid",
  9238. in: "path",
  9239. description: "uuid to filter by",
  9240. required: true,
  9241. type: "string"
  9242. }
  9243. ],
  9244. responses: {
  9245. 200: {
  9246. description: "order response",
  9247. schema: {
  9248. $ref: "#/definitions/OrderGet"
  9249. }
  9250. },
  9251. 401: {
  9252. description: "User not logged in"
  9253. },
  9254. 404: {
  9255. description: "Resource with given uuid doesn't exist"
  9256. }
  9257. }
  9258. },
  9259. delete: {
  9260. tags: [
  9261. "order"
  9262. ],
  9263. summary: "Delete or purge resource by uuid",
  9264. description: "The resource will be voided/retired unless purge = 'true'",
  9265. operationId: "deleteOrder",
  9266. consumes: [
  9267. "application/json"
  9268. ],
  9269. produces: [
  9270. "application/json"
  9271. ],
  9272. parameters: [
  9273. {
  9274. name: "uuid",
  9275. in: "path",
  9276. description: "uuid to delete",
  9277. required: true,
  9278. type: "string"
  9279. },
  9280. {
  9281. name: "purge",
  9282. in: "query",
  9283. required: false,
  9284. type: "boolean"
  9285. }
  9286. ],
  9287. responses: {
  9288. 204: {
  9289. description: "Delete successful"
  9290. },
  9291. 401: {
  9292. description: "User not logged in"
  9293. },
  9294. 404: {
  9295. description: "Resource with given uuid doesn't exist"
  9296. }
  9297. }
  9298. }
  9299. },
  9300. /drug: {
  9301. get: {
  9302. tags: [
  9303. "drug"
  9304. ],
  9305. summary: "Fetch all non-retired drug resources or perform search",
  9306. description: "All search parameters are optional",
  9307. operationId: "getAllDrugs",
  9308. consumes: [
  9309. "application/json"
  9310. ],
  9311. produces: [
  9312. "application/json"
  9313. ],
  9314. parameters: [
  9315. {
  9316. name: "limit",
  9317. in: "query",
  9318. description: "The number of results to return",
  9319. required: false,
  9320. type: "integer"
  9321. },
  9322. {
  9323. name: "startIndex",
  9324. in: "query",
  9325. description: "The offset at which to start",
  9326. required: false,
  9327. type: "integer"
  9328. },
  9329. {
  9330. name: "v",
  9331. in: "query",
  9332. description: "The representation to return (ref, default, full or custom)",
  9333. required: false,
  9334. type: "string",
  9335. enum: [
  9336. "ref",
  9337. "default",
  9338. "full",
  9339. "custom"
  9340. ]
  9341. },
  9342. {
  9343. name: "q",
  9344. in: "query",
  9345. description: "The search query",
  9346. required: false,
  9347. type: "string"
  9348. },
  9349. {
  9350. name: "q",
  9351. in: "query",
  9352. required: false,
  9353. type: "string"
  9354. },
  9355. {
  9356. name: "code",
  9357. in: "query",
  9358. description: "Must be used with source",
  9359. required: false,
  9360. type: "string"
  9361. },
  9362. {
  9363. name: "preferredMapTypes",
  9364. in: "query",
  9365. description: "Must be used with source",
  9366. required: false,
  9367. type: "string"
  9368. },
  9369. {
  9370. name: "source",
  9371. in: "query",
  9372. required: false,
  9373. type: "string"
  9374. },
  9375. {
  9376. name: "locale",
  9377. in: "query",
  9378. description: "Must be used with q",
  9379. required: false,
  9380. type: "string"
  9381. },
  9382. {
  9383. name: "exactLocale",
  9384. in: "query",
  9385. description: "Must be used with q",
  9386. required: false,
  9387. type: "string"
  9388. }
  9389. ],
  9390. responses: {
  9391. 200: {
  9392. description: "drug response",
  9393. schema: {
  9394. $ref: "#/definitions/FetchAll"
  9395. }
  9396. },
  9397. 401: {
  9398. description: "User not logged in"
  9399. }
  9400. }
  9401. },
  9402. post: {
  9403. tags: [
  9404. "drug"
  9405. ],
  9406. summary: "Create with properties in request",
  9407. operationId: "createDrug",
  9408. consumes: [
  9409. "application/json"
  9410. ],
  9411. produces: [
  9412. "application/json"
  9413. ],
  9414. parameters: [
  9415. {
  9416. in: "body",
  9417. name: "resource",
  9418. description: "Resource to create",
  9419. required: true,
  9420. schema: {
  9421. $ref: "#/definitions/DrugCreate"
  9422. }
  9423. }
  9424. ],
  9425. responses: {
  9426. 201: {
  9427. description: "drug response"
  9428. },
  9429. 401: {
  9430. description: "User not logged in"
  9431. }
  9432. }
  9433. }
  9434. },
  9435. /drug/{uuid}: {
  9436. get: {
  9437. tags: [
  9438. "drug"
  9439. ],
  9440. summary: "Fetch by uuid",
  9441. operationId: "getDrug",
  9442. consumes: [
  9443. "application/json"
  9444. ],
  9445. produces: [
  9446. "application/json"
  9447. ],
  9448. parameters: [
  9449. {
  9450. name: "v",
  9451. in: "query",
  9452. description: "The representation to return (ref, default, full or custom)",
  9453. required: false,
  9454. type: "string",
  9455. enum: [
  9456. "ref",
  9457. "default",
  9458. "full",
  9459. "custom"
  9460. ]
  9461. },
  9462. {
  9463. name: "uuid",
  9464. in: "path",
  9465. description: "uuid to filter by",
  9466. required: true,
  9467. type: "string"
  9468. }
  9469. ],
  9470. responses: {
  9471. 200: {
  9472. description: "drug response",
  9473. schema: {
  9474. $ref: "#/definitions/DrugGet"
  9475. }
  9476. },
  9477. 401: {
  9478. description: "User not logged in"
  9479. },
  9480. 404: {
  9481. description: "Resource with given uuid doesn't exist"
  9482. }
  9483. }
  9484. },
  9485. post: {
  9486. tags: [
  9487. "drug"
  9488. ],
  9489. summary: "Edit with given uuid, only modifying properties in request",
  9490. operationId: "updateDrug",
  9491. consumes: [
  9492. "application/json"
  9493. ],
  9494. produces: [
  9495. "application/json"
  9496. ],
  9497. parameters: [
  9498. {
  9499. name: "uuid",
  9500. in: "path",
  9501. description: "uuid of resource to update",
  9502. required: true,
  9503. type: "string"
  9504. },
  9505. {
  9506. in: "body",
  9507. name: "resource",
  9508. description: "Resource properties to update",
  9509. required: true,
  9510. schema: {
  9511. $ref: "#/definitions/DrugUpdate"
  9512. }
  9513. }
  9514. ],
  9515. responses: {
  9516. 201: {
  9517. description: "drug response"
  9518. },
  9519. 401: {
  9520. description: "User not logged in"
  9521. }
  9522. }
  9523. },
  9524. delete: {
  9525. tags: [
  9526. "drug"
  9527. ],
  9528. summary: "Delete or purge resource by uuid",
  9529. description: "The resource will be voided/retired unless purge = 'true'",
  9530. operationId: "deleteDrug",
  9531. consumes: [
  9532. "application/json"
  9533. ],
  9534. produces: [
  9535. "application/json"
  9536. ],
  9537. parameters: [
  9538. {
  9539. name: "uuid",
  9540. in: "path",
  9541. description: "uuid to delete",
  9542. required: true,
  9543. type: "string"
  9544. },
  9545. {
  9546. name: "purge",
  9547. in: "query",
  9548. required: false,
  9549. type: "boolean"
  9550. }
  9551. ],
  9552. responses: {
  9553. 204: {
  9554. description: "Delete successful"
  9555. },
  9556. 401: {
  9557. description: "User not logged in"
  9558. },
  9559. 404: {
  9560. description: "Resource with given uuid doesn't exist"
  9561. }
  9562. }
  9563. }
  9564. },
  9565. /field: {
  9566. get: {
  9567. tags: [
  9568. "field"
  9569. ],
  9570. summary: "Fetch all non-retired field resources or perform search",
  9571. description: "All search parameters are optional",
  9572. operationId: "getAllFields",
  9573. consumes: [
  9574. "application/json"
  9575. ],
  9576. produces: [
  9577. "application/json"
  9578. ],
  9579. parameters: [
  9580. {
  9581. name: "limit",
  9582. in: "query",
  9583. description: "The number of results to return",
  9584. required: false,
  9585. type: "integer"
  9586. },
  9587. {
  9588. name: "startIndex",
  9589. in: "query",
  9590. description: "The offset at which to start",
  9591. required: false,
  9592. type: "integer"
  9593. },
  9594. {
  9595. name: "v",
  9596. in: "query",
  9597. description: "The representation to return (ref, default, full or custom)",
  9598. required: false,
  9599. type: "string",
  9600. enum: [
  9601. "ref",
  9602. "default",
  9603. "full",
  9604. "custom"
  9605. ]
  9606. },
  9607. {
  9608. name: "q",
  9609. in: "query",
  9610. description: "The search query",
  9611. required: false,
  9612. type: "string"
  9613. }
  9614. ],
  9615. responses: {
  9616. 200: {
  9617. description: "field response",
  9618. schema: {
  9619. $ref: "#/definitions/FetchAll"
  9620. }
  9621. },
  9622. 401: {
  9623. description: "User not logged in"
  9624. }
  9625. }
  9626. },
  9627. post: {
  9628. tags: [
  9629. "field"
  9630. ],
  9631. summary: "Create with properties in request",
  9632. operationId: "createField",
  9633. consumes: [
  9634. "application/json"
  9635. ],
  9636. produces: [
  9637. "application/json"
  9638. ],
  9639. parameters: [
  9640. {
  9641. in: "body",
  9642. name: "resource",
  9643. description: "Resource to create",
  9644. required: true,
  9645. schema: {
  9646. $ref: "#/definitions/FieldCreate"
  9647. }
  9648. }
  9649. ],
  9650. responses: {
  9651. 201: {
  9652. description: "field response"
  9653. },
  9654. 401: {
  9655. description: "User not logged in"
  9656. }
  9657. }
  9658. }
  9659. },
  9660. /field/{uuid}: {
  9661. get: {
  9662. tags: [
  9663. "field"
  9664. ],
  9665. summary: "Fetch by uuid",
  9666. operationId: "getField",
  9667. consumes: [
  9668. "application/json"
  9669. ],
  9670. produces: [
  9671. "application/json"
  9672. ],
  9673. parameters: [
  9674. {
  9675. name: "v",
  9676. in: "query",
  9677. description: "The representation to return (ref, default, full or custom)",
  9678. required: false,
  9679. type: "string",
  9680. enum: [
  9681. "ref",
  9682. "default",
  9683. "full",
  9684. "custom"
  9685. ]
  9686. },
  9687. {
  9688. name: "uuid",
  9689. in: "path",
  9690. description: "uuid to filter by",
  9691. required: true,
  9692. type: "string"
  9693. }
  9694. ],
  9695. responses: {
  9696. 200: {
  9697. description: "field response",
  9698. schema: {
  9699. $ref: "#/definitions/FieldGet"
  9700. }
  9701. },
  9702. 401: {
  9703. description: "User not logged in"
  9704. },
  9705. 404: {
  9706. description: "Resource with given uuid doesn't exist"
  9707. }
  9708. }
  9709. },
  9710. post: {
  9711. tags: [
  9712. "field"
  9713. ],
  9714. summary: "Edit with given uuid, only modifying properties in request",
  9715. operationId: "updateField",
  9716. consumes: [
  9717. "application/json"
  9718. ],
  9719. produces: [
  9720. "application/json"
  9721. ],
  9722. parameters: [
  9723. {
  9724. name: "uuid",
  9725. in: "path",
  9726. description: "uuid of resource to update",
  9727. required: true,
  9728. type: "string"
  9729. },
  9730. {
  9731. in: "body",
  9732. name: "resource",
  9733. description: "Resource properties to update",
  9734. required: true,
  9735. schema: {
  9736. $ref: "#/definitions/FieldUpdate"
  9737. }
  9738. }
  9739. ],
  9740. responses: {
  9741. 201: {
  9742. description: "field response"
  9743. },
  9744. 401: {
  9745. description: "User not logged in"
  9746. }
  9747. }
  9748. },
  9749. delete: {
  9750. tags: [
  9751. "field"
  9752. ],
  9753. summary: "Delete or purge resource by uuid",
  9754. description: "The resource will be voided/retired unless purge = 'true'",
  9755. operationId: "deleteField",
  9756. consumes: [
  9757. "application/json"
  9758. ],
  9759. produces: [
  9760. "application/json"
  9761. ],
  9762. parameters: [
  9763. {
  9764. name: "uuid",
  9765. in: "path",
  9766. description: "uuid to delete",
  9767. required: true,
  9768. type: "string"
  9769. },
  9770. {
  9771. name: "purge",
  9772. in: "query",
  9773. required: false,
  9774. type: "boolean"
  9775. }
  9776. ],
  9777. responses: {
  9778. 204: {
  9779. description: "Delete successful"
  9780. },
  9781. 401: {
  9782. description: "User not logged in"
  9783. },
  9784. 404: {
  9785. description: "Resource with given uuid doesn't exist"
  9786. }
  9787. }
  9788. }
  9789. },
  9790. /encountertype: {
  9791. get: {
  9792. tags: [
  9793. "encountertype"
  9794. ],
  9795. summary: "Fetch all non-retired encountertype resources or perform search",
  9796. description: "All search parameters are optional",
  9797. operationId: "getAllEncounterTypes",
  9798. consumes: [
  9799. "application/json"
  9800. ],
  9801. produces: [
  9802. "application/json"
  9803. ],
  9804. parameters: [
  9805. {
  9806. name: "limit",
  9807. in: "query",
  9808. description: "The number of results to return",
  9809. required: false,
  9810. type: "integer"
  9811. },
  9812. {
  9813. name: "startIndex",
  9814. in: "query",
  9815. description: "The offset at which to start",
  9816. required: false,
  9817. type: "integer"
  9818. },
  9819. {
  9820. name: "v",
  9821. in: "query",
  9822. description: "The representation to return (ref, default, full or custom)",
  9823. required: false,
  9824. type: "string",
  9825. enum: [
  9826. "ref",
  9827. "default",
  9828. "full",
  9829. "custom"
  9830. ]
  9831. },
  9832. {
  9833. name: "q",
  9834. in: "query",
  9835. description: "The search query",
  9836. required: false,
  9837. type: "string"
  9838. }
  9839. ],
  9840. responses: {
  9841. 200: {
  9842. description: "encountertype response",
  9843. schema: {
  9844. $ref: "#/definitions/FetchAll"
  9845. }
  9846. },
  9847. 401: {
  9848. description: "User not logged in"
  9849. }
  9850. }
  9851. },
  9852. post: {
  9853. tags: [
  9854. "encountertype"
  9855. ],
  9856. summary: "Create with properties in request",
  9857. operationId: "createEncounterType",
  9858. consumes: [
  9859. "application/json"
  9860. ],
  9861. produces: [
  9862. "application/json"
  9863. ],
  9864. parameters: [
  9865. {
  9866. in: "body",
  9867. name: "resource",
  9868. description: "Resource to create",
  9869. required: true,
  9870. schema: {
  9871. $ref: "#/definitions/EncountertypeCreate"
  9872. }
  9873. }
  9874. ],
  9875. responses: {
  9876. 201: {
  9877. description: "encountertype response"
  9878. },
  9879. 401: {
  9880. description: "User not logged in"
  9881. }
  9882. }
  9883. }
  9884. },
  9885. /encountertype/{uuid}: {
  9886. get: {
  9887. tags: [
  9888. "encountertype"
  9889. ],
  9890. summary: "Fetch by uuid",
  9891. operationId: "getEncounterType",
  9892. consumes: [
  9893. "application/json"
  9894. ],
  9895. produces: [
  9896. "application/json"
  9897. ],
  9898. parameters: [
  9899. {
  9900. name: "v",
  9901. in: "query",
  9902. description: "The representation to return (ref, default, full or custom)",
  9903. required: false,
  9904. type: "string",
  9905. enum: [
  9906. "ref",
  9907. "default",
  9908. "full",
  9909. "custom"
  9910. ]
  9911. },
  9912. {
  9913. name: "uuid",
  9914. in: "path",
  9915. description: "uuid to filter by",
  9916. required: true,
  9917. type: "string"
  9918. }
  9919. ],
  9920. responses: {
  9921. 200: {
  9922. description: "encountertype response",
  9923. schema: {
  9924. $ref: "#/definitions/EncountertypeGet"
  9925. }
  9926. },
  9927. 401: {
  9928. description: "User not logged in"
  9929. },
  9930. 404: {
  9931. description: "Resource with given uuid doesn't exist"
  9932. }
  9933. }
  9934. },
  9935. post: {
  9936. tags: [
  9937. "encountertype"
  9938. ],
  9939. summary: "Edit with given uuid, only modifying properties in request",
  9940. operationId: "updateEncounterType",
  9941. consumes: [
  9942. "application/json"
  9943. ],
  9944. produces: [
  9945. "application/json"
  9946. ],
  9947. parameters: [
  9948. {
  9949. name: "uuid",
  9950. in: "path",
  9951. description: "uuid of resource to update",
  9952. required: true,
  9953. type: "string"
  9954. },
  9955. {
  9956. in: "body",
  9957. name: "resource",
  9958. description: "Resource properties to update",
  9959. required: true,
  9960. schema: {
  9961. $ref: "#/definitions/EncountertypeUpdate"
  9962. }
  9963. }
  9964. ],
  9965. responses: {
  9966. 201: {
  9967. description: "encountertype response"
  9968. },
  9969. 401: {
  9970. description: "User not logged in"
  9971. }
  9972. }
  9973. },
  9974. delete: {
  9975. tags: [
  9976. "encountertype"
  9977. ],
  9978. summary: "Delete or purge resource by uuid",
  9979. description: "The resource will be voided/retired unless purge = 'true'",
  9980. operationId: "deleteEncounterType",
  9981. consumes: [
  9982. "application/json"
  9983. ],
  9984. produces: [
  9985. "application/json"
  9986. ],
  9987. parameters: [
  9988. {
  9989. name: "uuid",
  9990. in: "path",
  9991. description: "uuid to delete",
  9992. required: true,
  9993. type: "string"
  9994. },
  9995. {
  9996. name: "purge",
  9997. in: "query",
  9998. required: false,
  9999. type: "boolean"
  10000. }
  10001. ],
  10002. responses: {
  10003. 204: {
  10004. description: "Delete successful"
  10005. },
  10006. 401: {
  10007. description: "User not logged in"
  10008. },
  10009. 404: {
  10010. description: "Resource with given uuid doesn't exist"
  10011. }
  10012. }
  10013. }
  10014. },
  10015. /conceptreferencetermmap: {
  10016. get: {
  10017. tags: [
  10018. "conceptreferencetermmap"
  10019. ],
  10020. summary: "Search for conceptreferencetermmap",
  10021. description: "At least one search parameter must be specified",
  10022. operationId: "getAllConceptReferenceTermMaps",
  10023. produces: [
  10024. "application/json",
  10025. "application/xml"
  10026. ],
  10027. parameters: [
  10028. {
  10029. name: "limit",
  10030. in: "query",
  10031. description: "The number of results to return",
  10032. required: false,
  10033. type: "integer"
  10034. },
  10035. {
  10036. name: "startIndex",
  10037. in: "query",
  10038. description: "The offset at which to start",
  10039. required: false,
  10040. type: "integer"
  10041. },
  10042. {
  10043. name: "v",
  10044. in: "query",
  10045. description: "The representation to return (ref, default, full or custom)",
  10046. required: false,
  10047. type: "string",
  10048. enum: [
  10049. "ref",
  10050. "default",
  10051. "full",
  10052. "custom"
  10053. ]
  10054. },
  10055. {
  10056. name: "q",
  10057. in: "query",
  10058. description: "The search query",
  10059. required: false,
  10060. type: "string"
  10061. },
  10062. {
  10063. name: "maps",
  10064. in: "query",
  10065. required: false,
  10066. type: "string"
  10067. },
  10068. {
  10069. name: "termB",
  10070. in: "query",
  10071. required: false,
  10072. type: "string"
  10073. },
  10074. {
  10075. name: "termA",
  10076. in: "query",
  10077. required: false,
  10078. type: "string"
  10079. },
  10080. {
  10081. name: "maptype",
  10082. in: "query",
  10083. description: "Must be used with maps",
  10084. required: false,
  10085. type: "string"
  10086. },
  10087. {
  10088. name: "to",
  10089. in: "query",
  10090. required: false,
  10091. type: "string"
  10092. }
  10093. ],
  10094. responses: {
  10095. 200: {
  10096. description: "conceptreferencetermmap response",
  10097. schema: {
  10098. $ref: "#/definitions/FetchAll"
  10099. }
  10100. }
  10101. }
  10102. },
  10103. post: {
  10104. tags: [
  10105. "conceptreferencetermmap"
  10106. ],
  10107. summary: "Create with properties in request",
  10108. operationId: "createConceptReferenceTermMap",
  10109. consumes: [
  10110. "application/json"
  10111. ],
  10112. produces: [
  10113. "application/json"
  10114. ],
  10115. parameters: [
  10116. {
  10117. in: "body",
  10118. name: "resource",
  10119. description: "Resource to create",
  10120. required: true,
  10121. schema: {
  10122. $ref: "#/definitions/ConceptreferencetermmapCreate"
  10123. }
  10124. }
  10125. ],
  10126. responses: {
  10127. 201: {
  10128. description: "conceptreferencetermmap response"
  10129. },
  10130. 401: {
  10131. description: "User not logged in"
  10132. }
  10133. }
  10134. }
  10135. },
  10136. /conceptreferencetermmap/{uuid}: {
  10137. get: {
  10138. tags: [
  10139. "conceptreferencetermmap"
  10140. ],
  10141. summary: "Fetch by uuid",
  10142. operationId: "getConceptReferenceTermMap",
  10143. consumes: [
  10144. "application/json"
  10145. ],
  10146. produces: [
  10147. "application/json"
  10148. ],
  10149. parameters: [
  10150. {
  10151. name: "v",
  10152. in: "query",
  10153. description: "The representation to return (ref, default, full or custom)",
  10154. required: false,
  10155. type: "string",
  10156. enum: [
  10157. "ref",
  10158. "default",
  10159. "full",
  10160. "custom"
  10161. ]
  10162. },
  10163. {
  10164. name: "uuid",
  10165. in: "path",
  10166. description: "uuid to filter by",
  10167. required: true,
  10168. type: "string"
  10169. }
  10170. ],
  10171. responses: {
  10172. 200: {
  10173. description: "conceptreferencetermmap response",
  10174. schema: {
  10175. $ref: "#/definitions/ConceptreferencetermmapGet"
  10176. }
  10177. },
  10178. 401: {
  10179. description: "User not logged in"
  10180. },
  10181. 404: {
  10182. description: "Resource with given uuid doesn't exist"
  10183. }
  10184. }
  10185. },
  10186. post: {
  10187. tags: [
  10188. "conceptreferencetermmap"
  10189. ],
  10190. summary: "Edit with given uuid, only modifying properties in request",
  10191. operationId: "updateConceptReferenceTermMap",
  10192. consumes: [
  10193. "application/json"
  10194. ],
  10195. produces: [
  10196. "application/json"
  10197. ],
  10198. parameters: [
  10199. {
  10200. name: "uuid",
  10201. in: "path",
  10202. description: "uuid of resource to update",
  10203. required: true,
  10204. type: "string"
  10205. },
  10206. {
  10207. in: "body",
  10208. name: "resource",
  10209. description: "Resource properties to update",
  10210. required: true,
  10211. schema: {
  10212. $ref: "#/definitions/ConceptreferencetermmapUpdate"
  10213. }
  10214. }
  10215. ],
  10216. responses: {
  10217. 201: {
  10218. description: "conceptreferencetermmap response"
  10219. },
  10220. 401: {
  10221. description: "User not logged in"
  10222. }
  10223. }
  10224. },
  10225. delete: {
  10226. tags: [
  10227. "conceptreferencetermmap"
  10228. ],
  10229. summary: "Delete or purge resource by uuid",
  10230. description: "The resource will be voided/retired unless purge = 'true'",
  10231. operationId: "deleteConceptReferenceTermMap",
  10232. consumes: [
  10233. "application/json"
  10234. ],
  10235. produces: [
  10236. "application/json"
  10237. ],
  10238. parameters: [
  10239. {
  10240. name: "uuid",
  10241. in: "path",
  10242. description: "uuid to delete",
  10243. required: true,
  10244. type: "string"
  10245. },
  10246. {
  10247. name: "purge",
  10248. in: "query",
  10249. required: false,
  10250. type: "boolean"
  10251. }
  10252. ],
  10253. responses: {
  10254. 204: {
  10255. description: "Delete successful"
  10256. },
  10257. 401: {
  10258. description: "User not logged in"
  10259. },
  10260. 404: {
  10261. description: "Resource with given uuid doesn't exist"
  10262. }
  10263. }
  10264. }
  10265. },
  10266. /encounter: {
  10267. get: {
  10268. tags: [
  10269. "encounter"
  10270. ],
  10271. summary: "Search for encounter",
  10272. description: "At least one search parameter must be specified",
  10273. operationId: "getAllEncounters",
  10274. produces: [
  10275. "application/json",
  10276. "application/xml"
  10277. ],
  10278. parameters: [
  10279. {
  10280. name: "limit",
  10281. in: "query",
  10282. description: "The number of results to return",
  10283. required: false,
  10284. type: "integer"
  10285. },
  10286. {
  10287. name: "startIndex",
  10288. in: "query",
  10289. description: "The offset at which to start",
  10290. required: false,
  10291. type: "integer"
  10292. },
  10293. {
  10294. name: "v",
  10295. in: "query",
  10296. description: "The representation to return (ref, default, full or custom)",
  10297. required: false,
  10298. type: "string",
  10299. enum: [
  10300. "ref",
  10301. "default",
  10302. "full",
  10303. "custom"
  10304. ]
  10305. },
  10306. {
  10307. name: "q",
  10308. in: "query",
  10309. description: "The search query",
  10310. required: false,
  10311. type: "string"
  10312. },
  10313. {
  10314. name: "obsConcept",
  10315. in: "query",
  10316. required: false,
  10317. type: "string"
  10318. },
  10319. {
  10320. name: "obsValues",
  10321. in: "query",
  10322. description: "Must be used with patient and obsConcept",
  10323. required: false,
  10324. type: "string"
  10325. },
  10326. {
  10327. name: "todate",
  10328. in: "query",
  10329. description: "Must be used with patient",
  10330. required: false,
  10331. type: "string"
  10332. },
  10333. {
  10334. name: "patient",
  10335. in: "query",
  10336. required: false,
  10337. type: "string"
  10338. },
  10339. {
  10340. name: "encounterType",
  10341. in: "query",
  10342. description: "Must be used with patient",
  10343. required: false,
  10344. type: "string"
  10345. },
  10346. {
  10347. name: "fromdate",
  10348. in: "query",
  10349. description: "Must be used with patient",
  10350. required: false,
  10351. type: "string"
  10352. },
  10353. {
  10354. name: "order",
  10355. in: "query",
  10356. description: "Must be used with patient",
  10357. required: false,
  10358. type: "string"
  10359. }
  10360. ],
  10361. responses: {
  10362. 200: {
  10363. description: "encounter response",
  10364. schema: {
  10365. $ref: "#/definitions/FetchAll"
  10366. }
  10367. }
  10368. }
  10369. },
  10370. post: {
  10371. tags: [
  10372. "encounter"
  10373. ],
  10374. summary: "Create with properties in request",
  10375. operationId: "createEncounter",
  10376. consumes: [
  10377. "application/json"
  10378. ],
  10379. produces: [
  10380. "application/json"
  10381. ],
  10382. parameters: [
  10383. {
  10384. in: "body",
  10385. name: "resource",
  10386. description: "Resource to create",
  10387. required: true,
  10388. schema: {
  10389. $ref: "#/definitions/EncounterCreate"
  10390. }
  10391. }
  10392. ],
  10393. responses: {
  10394. 201: {
  10395. description: "encounter response"
  10396. },
  10397. 401: {
  10398. description: "User not logged in"
  10399. }
  10400. }
  10401. }
  10402. },
  10403. /encounter/{uuid}: {
  10404. get: {
  10405. tags: [
  10406. "encounter"
  10407. ],
  10408. summary: "Fetch by uuid",
  10409. operationId: "getEncounter",
  10410. consumes: [
  10411. "application/json"
  10412. ],
  10413. produces: [
  10414. "application/json"
  10415. ],
  10416. parameters: [
  10417. {
  10418. name: "v",
  10419. in: "query",
  10420. description: "The representation to return (ref, default, full or custom)",
  10421. required: false,
  10422. type: "string",
  10423. enum: [
  10424. "ref",
  10425. "default",
  10426. "full",
  10427. "custom"
  10428. ]
  10429. },
  10430. {
  10431. name: "uuid",
  10432. in: "path",
  10433. description: "uuid to filter by",
  10434. required: true,
  10435. type: "string"
  10436. }
  10437. ],
  10438. responses: {
  10439. 200: {
  10440. description: "encounter response",
  10441. schema: {
  10442. $ref: "#/definitions/EncounterGet"
  10443. }
  10444. },
  10445. 401: {
  10446. description: "User not logged in"
  10447. },
  10448. 404: {
  10449. description: "Resource with given uuid doesn't exist"
  10450. }
  10451. }
  10452. },
  10453. post: {
  10454. tags: [
  10455. "encounter"
  10456. ],
  10457. summary: "Edit with given uuid, only modifying properties in request",
  10458. operationId: "updateEncounter",
  10459. consumes: [
  10460. "application/json"
  10461. ],
  10462. produces: [
  10463. "application/json"
  10464. ],
  10465. parameters: [
  10466. {
  10467. name: "uuid",
  10468. in: "path",
  10469. description: "uuid of resource to update",
  10470. required: true,
  10471. type: "string"
  10472. },
  10473. {
  10474. in: "body",
  10475. name: "resource",
  10476. description: "Resource properties to update",
  10477. required: true,
  10478. schema: {
  10479. $ref: "#/definitions/EncounterUpdate"
  10480. }
  10481. }
  10482. ],
  10483. responses: {
  10484. 201: {
  10485. description: "encounter response"
  10486. },
  10487. 401: {
  10488. description: "User not logged in"
  10489. }
  10490. }
  10491. },
  10492. delete: {
  10493. tags: [
  10494. "encounter"
  10495. ],
  10496. summary: "Delete or purge resource by uuid",
  10497. description: "The resource will be voided/retired unless purge = 'true'",
  10498. operationId: "deleteEncounter",
  10499. consumes: [
  10500. "application/json"
  10501. ],
  10502. produces: [
  10503. "application/json"
  10504. ],
  10505. parameters: [
  10506. {
  10507. name: "uuid",
  10508. in: "path",
  10509. description: "uuid to delete",
  10510. required: true,
  10511. type: "string"
  10512. },
  10513. {
  10514. name: "purge",
  10515. in: "query",
  10516. required: false,
  10517. type: "boolean"
  10518. }
  10519. ],
  10520. responses: {
  10521. 204: {
  10522. description: "Delete successful"
  10523. },
  10524. 401: {
  10525. description: "User not logged in"
  10526. },
  10527. 404: {
  10528. description: "Resource with given uuid doesn't exist"
  10529. }
  10530. }
  10531. }
  10532. },
  10533. /serverlog: {
  10534. get: {
  10535. tags: [
  10536. "serverlog"
  10537. ],
  10538. summary: "Fetch all non-retired",
  10539. operationId: "getAllServerLogs",
  10540. consumes: [
  10541. "application/json"
  10542. ],
  10543. produces: [
  10544. "application/json"
  10545. ],
  10546. parameters: [
  10547. {
  10548. name: "limit",
  10549. in: "query",
  10550. description: "The number of results to return",
  10551. required: false,
  10552. type: "integer"
  10553. },
  10554. {
  10555. name: "startIndex",
  10556. in: "query",
  10557. description: "The offset at which to start",
  10558. required: false,
  10559. type: "integer"
  10560. },
  10561. {
  10562. name: "v",
  10563. in: "query",
  10564. description: "The representation to return (ref, default, full or custom)",
  10565. required: false,
  10566. type: "string",
  10567. enum: [
  10568. "ref",
  10569. "default",
  10570. "full",
  10571. "custom"
  10572. ]
  10573. }
  10574. ],
  10575. responses: {
  10576. 200: {
  10577. description: "serverlog response",
  10578. schema: {
  10579. $ref: "#/definitions/FetchAll"
  10580. }
  10581. },
  10582. 401: {
  10583. description: "User not logged in"
  10584. }
  10585. }
  10586. }
  10587. },
  10588. /serverlog/{uuid}: {
  10589. get: {
  10590. tags: [
  10591. "serverlog"
  10592. ],
  10593. summary: "Fetch by uuid",
  10594. operationId: "getServerLog",
  10595. consumes: [
  10596. "application/json"
  10597. ],
  10598. produces: [
  10599. "application/json"
  10600. ],
  10601. parameters: [
  10602. {
  10603. name: "v",
  10604. in: "query",
  10605. description: "The representation to return (ref, default, full or custom)",
  10606. required: false,
  10607. type: "string",
  10608. enum: [
  10609. "ref",
  10610. "default",
  10611. "full",
  10612. "custom"
  10613. ]
  10614. },
  10615. {
  10616. name: "uuid",
  10617. in: "path",
  10618. description: "uuid to filter by",
  10619. required: true,
  10620. type: "string"
  10621. }
  10622. ],
  10623. responses: {
  10624. 200: {
  10625. description: "serverlog response",
  10626. schema: {
  10627. $ref: "#/definitions/ServerlogGet"
  10628. }
  10629. },
  10630. 401: {
  10631. description: "User not logged in"
  10632. },
  10633. 404: {
  10634. description: "Resource with given uuid doesn't exist"
  10635. }
  10636. }
  10637. }
  10638. },
  10639. /hl7: {
  10640. get: {
  10641. tags: [
  10642. "hl7"
  10643. ],
  10644. summary: "Search for hl7",
  10645. description: "At least one search parameter must be specified",
  10646. operationId: "getAllHL7Messages",
  10647. produces: [
  10648. "application/json",
  10649. "application/xml"
  10650. ],
  10651. parameters: [
  10652. {
  10653. name: "limit",
  10654. in: "query",
  10655. description: "The number of results to return",
  10656. required: false,
  10657. type: "integer"
  10658. },
  10659. {
  10660. name: "startIndex",
  10661. in: "query",
  10662. description: "The offset at which to start",
  10663. required: false,
  10664. type: "integer"
  10665. },
  10666. {
  10667. name: "v",
  10668. in: "query",
  10669. description: "The representation to return (ref, default, full or custom)",
  10670. required: false,
  10671. type: "string",
  10672. enum: [
  10673. "ref",
  10674. "default",
  10675. "full",
  10676. "custom"
  10677. ]
  10678. },
  10679. {
  10680. name: "q",
  10681. in: "query",
  10682. description: "The search query",
  10683. required: true,
  10684. type: "string"
  10685. }
  10686. ],
  10687. responses: {
  10688. 200: {
  10689. description: "hl7 response",
  10690. schema: {
  10691. $ref: "#/definitions/FetchAll"
  10692. }
  10693. }
  10694. }
  10695. },
  10696. post: {
  10697. tags: [
  10698. "hl7"
  10699. ],
  10700. summary: "Create with properties in request",
  10701. operationId: "createHL7Message",
  10702. consumes: [
  10703. "application/json"
  10704. ],
  10705. produces: [
  10706. "application/json"
  10707. ],
  10708. parameters: [
  10709. {
  10710. in: "body",
  10711. name: "resource",
  10712. description: "Resource to create",
  10713. required: true,
  10714. schema: {
  10715. $ref: "#/definitions/Hl7Create"
  10716. }
  10717. }
  10718. ],
  10719. responses: {
  10720. 201: {
  10721. description: "hl7 response"
  10722. },
  10723. 401: {
  10724. description: "User not logged in"
  10725. }
  10726. }
  10727. }
  10728. },
  10729. /conceptsource: {
  10730. get: {
  10731. tags: [
  10732. "conceptsource"
  10733. ],
  10734. summary: "Fetch all non-retired conceptsource resources or perform search",
  10735. description: "All search parameters are optional",
  10736. operationId: "getAllConceptSources",
  10737. consumes: [
  10738. "application/json"
  10739. ],
  10740. produces: [
  10741. "application/json"
  10742. ],
  10743. parameters: [
  10744. {
  10745. name: "limit",
  10746. in: "query",
  10747. description: "The number of results to return",
  10748. required: false,
  10749. type: "integer"
  10750. },
  10751. {
  10752. name: "startIndex",
  10753. in: "query",
  10754. description: "The offset at which to start",
  10755. required: false,
  10756. type: "integer"
  10757. },
  10758. {
  10759. name: "v",
  10760. in: "query",
  10761. description: "The representation to return (ref, default, full or custom)",
  10762. required: false,
  10763. type: "string",
  10764. enum: [
  10765. "ref",
  10766. "default",
  10767. "full",
  10768. "custom"
  10769. ]
  10770. },
  10771. {
  10772. name: "q",
  10773. in: "query",
  10774. description: "The search query",
  10775. required: false,
  10776. type: "string"
  10777. }
  10778. ],
  10779. responses: {
  10780. 200: {
  10781. description: "conceptsource response",
  10782. schema: {
  10783. $ref: "#/definitions/FetchAll"
  10784. }
  10785. },
  10786. 401: {
  10787. description: "User not logged in"
  10788. }
  10789. }
  10790. },
  10791. post: {
  10792. tags: [
  10793. "conceptsource"
  10794. ],
  10795. summary: "Create with properties in request",
  10796. operationId: "createConceptSource",
  10797. consumes: [
  10798. "application/json"
  10799. ],
  10800. produces: [
  10801. "application/json"
  10802. ],
  10803. parameters: [
  10804. {
  10805. in: "body",
  10806. name: "resource",
  10807. description: "Resource to create",
  10808. required: true,
  10809. schema: {
  10810. $ref: "#/definitions/ConceptsourceCreate"
  10811. }
  10812. }
  10813. ],
  10814. responses: {
  10815. 201: {
  10816. description: "conceptsource response"
  10817. },
  10818. 401: {
  10819. description: "User not logged in"
  10820. }
  10821. }
  10822. }
  10823. },
  10824. /conceptsource/{uuid}: {
  10825. get: {
  10826. tags: [
  10827. "conceptsource"
  10828. ],
  10829. summary: "Fetch by uuid",
  10830. operationId: "getConceptSource",
  10831. consumes: [
  10832. "application/json"
  10833. ],
  10834. produces: [
  10835. "application/json"
  10836. ],
  10837. parameters: [
  10838. {
  10839. name: "v",
  10840. in: "query",
  10841. description: "The representation to return (ref, default, full or custom)",
  10842. required: false,
  10843. type: "string",
  10844. enum: [
  10845. "ref",
  10846. "default",
  10847. "full",
  10848. "custom"
  10849. ]
  10850. },
  10851. {
  10852. name: "uuid",
  10853. in: "path",
  10854. description: "uuid to filter by",
  10855. required: true,
  10856. type: "string"
  10857. }
  10858. ],
  10859. responses: {
  10860. 200: {
  10861. description: "conceptsource response",
  10862. schema: {
  10863. $ref: "#/definitions/ConceptsourceGet"
  10864. }
  10865. },
  10866. 401: {
  10867. description: "User not logged in"
  10868. },
  10869. 404: {
  10870. description: "Resource with given uuid doesn't exist"
  10871. }
  10872. }
  10873. },
  10874. post: {
  10875. tags: [
  10876. "conceptsource"
  10877. ],
  10878. summary: "Edit with given uuid, only modifying properties in request",
  10879. operationId: "updateConceptSource",
  10880. consumes: [
  10881. "application/json"
  10882. ],
  10883. produces: [
  10884. "application/json"
  10885. ],
  10886. parameters: [
  10887. {
  10888. name: "uuid",
  10889. in: "path",
  10890. description: "uuid of resource to update",
  10891. required: true,
  10892. type: "string"
  10893. },
  10894. {
  10895. in: "body",
  10896. name: "resource",
  10897. description: "Resource properties to update",
  10898. required: true,
  10899. schema: {
  10900. $ref: "#/definitions/ConceptsourceUpdate"
  10901. }
  10902. }
  10903. ],
  10904. responses: {
  10905. 201: {
  10906. description: "conceptsource response"
  10907. },
  10908. 401: {
  10909. description: "User not logged in"
  10910. }
  10911. }
  10912. },
  10913. delete: {
  10914. tags: [
  10915. "conceptsource"
  10916. ],
  10917. summary: "Delete or purge resource by uuid",
  10918. description: "The resource will be voided/retired unless purge = 'true'",
  10919. operationId: "deleteConceptSource",
  10920. consumes: [
  10921. "application/json"
  10922. ],
  10923. produces: [
  10924. "application/json"
  10925. ],
  10926. parameters: [
  10927. {
  10928. name: "uuid",
  10929. in: "path",
  10930. description: "uuid to delete",
  10931. required: true,
  10932. type: "string"
  10933. },
  10934. {
  10935. name: "purge",
  10936. in: "query",
  10937. required: false,
  10938. type: "boolean"
  10939. }
  10940. ],
  10941. responses: {
  10942. 204: {
  10943. description: "Delete successful"
  10944. },
  10945. 401: {
  10946. description: "User not logged in"
  10947. },
  10948. 404: {
  10949. description: "Resource with given uuid doesn't exist"
  10950. }
  10951. }
  10952. }
  10953. },
  10954. /provider: {
  10955. get: {
  10956. tags: [
  10957. "provider"
  10958. ],
  10959. summary: "Fetch all non-retired provider resources or perform search",
  10960. description: "All search parameters are optional",
  10961. operationId: "getAllProviders",
  10962. consumes: [
  10963. "application/json"
  10964. ],
  10965. produces: [
  10966. "application/json"
  10967. ],
  10968. parameters: [
  10969. {
  10970. name: "limit",
  10971. in: "query",
  10972. description: "The number of results to return",
  10973. required: false,
  10974. type: "integer"
  10975. },
  10976. {
  10977. name: "startIndex",
  10978. in: "query",
  10979. description: "The offset at which to start",
  10980. required: false,
  10981. type: "integer"
  10982. },
  10983. {
  10984. name: "v",
  10985. in: "query",
  10986. description: "The representation to return (ref, default, full or custom)",
  10987. required: false,
  10988. type: "string",
  10989. enum: [
  10990. "ref",
  10991. "default",
  10992. "full",
  10993. "custom"
  10994. ]
  10995. },
  10996. {
  10997. name: "q",
  10998. in: "query",
  10999. description: "The search query",
  11000. required: false,
  11001. type: "string"
  11002. },
  11003. {
  11004. name: "user",
  11005. in: "query",
  11006. required: false,
  11007. type: "string"
  11008. }
  11009. ],
  11010. responses: {
  11011. 200: {
  11012. description: "provider response",
  11013. schema: {
  11014. $ref: "#/definitions/FetchAll"
  11015. }
  11016. },
  11017. 401: {
  11018. description: "User not logged in"
  11019. }
  11020. }
  11021. },
  11022. post: {
  11023. tags: [
  11024. "provider"
  11025. ],
  11026. summary: "Create with properties in request",
  11027. operationId: "createProvider",
  11028. consumes: [
  11029. "application/json"
  11030. ],
  11031. produces: [
  11032. "application/json"
  11033. ],
  11034. parameters: [
  11035. {
  11036. in: "body",
  11037. name: "resource",
  11038. description: "Resource to create",
  11039. required: true,
  11040. schema: {
  11041. $ref: "#/definitions/ProviderCreate"
  11042. }
  11043. }
  11044. ],
  11045. responses: {
  11046. 201: {
  11047. description: "provider response"
  11048. },
  11049. 401: {
  11050. description: "User not logged in"
  11051. }
  11052. }
  11053. }
  11054. },
  11055. /provider/{uuid}: {
  11056. get: {
  11057. tags: [
  11058. "provider"
  11059. ],
  11060. summary: "Fetch by uuid",
  11061. operationId: "getProvider",
  11062. consumes: [
  11063. "application/json"
  11064. ],
  11065. produces: [
  11066. "application/json"
  11067. ],
  11068. parameters: [
  11069. {
  11070. name: "v",
  11071. in: "query",
  11072. description: "The representation to return (ref, default, full or custom)",
  11073. required: false,
  11074. type: "string",
  11075. enum: [
  11076. "ref",
  11077. "default",
  11078. "full",
  11079. "custom"
  11080. ]
  11081. },
  11082. {
  11083. name: "uuid",
  11084. in: "path",
  11085. description: "uuid to filter by",
  11086. required: true,
  11087. type: "string"
  11088. }
  11089. ],
  11090. responses: {
  11091. 200: {
  11092. description: "provider response",
  11093. schema: {
  11094. $ref: "#/definitions/ProviderGet"
  11095. }
  11096. },
  11097. 401: {
  11098. description: "User not logged in"
  11099. },
  11100. 404: {
  11101. description: "Resource with given uuid doesn't exist"
  11102. }
  11103. }
  11104. },
  11105. post: {
  11106. tags: [
  11107. "provider"
  11108. ],
  11109. summary: "Edit with given uuid, only modifying properties in request",
  11110. operationId: "updateProvider",
  11111. consumes: [
  11112. "application/json"
  11113. ],
  11114. produces: [
  11115. "application/json"
  11116. ],
  11117. parameters: [
  11118. {
  11119. name: "uuid",
  11120. in: "path",
  11121. description: "uuid of resource to update",
  11122. required: true,
  11123. type: "string"
  11124. },
  11125. {
  11126. in: "body",
  11127. name: "resource",
  11128. description: "Resource properties to update",
  11129. required: true,
  11130. schema: {
  11131. $ref: "#/definitions/ProviderUpdate"
  11132. }
  11133. }
  11134. ],
  11135. responses: {
  11136. 201: {
  11137. description: "provider response"
  11138. },
  11139. 401: {
  11140. description: "User not logged in"
  11141. }
  11142. }
  11143. },
  11144. delete: {
  11145. tags: [
  11146. "provider"
  11147. ],
  11148. summary: "Delete or purge resource by uuid",
  11149. description: "The resource will be voided/retired unless purge = 'true'",
  11150. operationId: "deleteProvider",
  11151. consumes: [
  11152. "application/json"
  11153. ],
  11154. produces: [
  11155. "application/json"
  11156. ],
  11157. parameters: [
  11158. {
  11159. name: "uuid",
  11160. in: "path",
  11161. description: "uuid to delete",
  11162. required: true,
  11163. type: "string"
  11164. },
  11165. {
  11166. name: "purge",
  11167. in: "query",
  11168. required: false,
  11169. type: "boolean"
  11170. }
  11171. ],
  11172. responses: {
  11173. 204: {
  11174. description: "Delete successful"
  11175. },
  11176. 401: {
  11177. description: "User not logged in"
  11178. },
  11179. 404: {
  11180. description: "Resource with given uuid doesn't exist"
  11181. }
  11182. }
  11183. }
  11184. },
  11185. /locationtag: {
  11186. get: {
  11187. tags: [
  11188. "locationtag"
  11189. ],
  11190. summary: "Fetch all non-retired locationtag resources or perform search",
  11191. description: "All search parameters are optional",
  11192. operationId: "getAllLocationTags",
  11193. consumes: [
  11194. "application/json"
  11195. ],
  11196. produces: [
  11197. "application/json"
  11198. ],
  11199. parameters: [
  11200. {
  11201. name: "limit",
  11202. in: "query",
  11203. description: "The number of results to return",
  11204. required: false,
  11205. type: "integer"
  11206. },
  11207. {
  11208. name: "startIndex",
  11209. in: "query",
  11210. description: "The offset at which to start",
  11211. required: false,
  11212. type: "integer"
  11213. },
  11214. {
  11215. name: "v",
  11216. in: "query",
  11217. description: "The representation to return (ref, default, full or custom)",
  11218. required: false,
  11219. type: "string",
  11220. enum: [
  11221. "ref",
  11222. "default",
  11223. "full",
  11224. "custom"
  11225. ]
  11226. },
  11227. {
  11228. name: "q",
  11229. in: "query",
  11230. description: "The search query",
  11231. required: false,
  11232. type: "string"
  11233. }
  11234. ],
  11235. responses: {
  11236. 200: {
  11237. description: "locationtag response",
  11238. schema: {
  11239. $ref: "#/definitions/FetchAll"
  11240. }
  11241. },
  11242. 401: {
  11243. description: "User not logged in"
  11244. }
  11245. }
  11246. },
  11247. post: {
  11248. tags: [
  11249. "locationtag"
  11250. ],
  11251. summary: "Create with properties in request",
  11252. operationId: "createLocationTag",
  11253. consumes: [
  11254. "application/json"
  11255. ],
  11256. produces: [
  11257. "application/json"
  11258. ],
  11259. parameters: [
  11260. {
  11261. in: "body",
  11262. name: "resource",
  11263. description: "Resource to create",
  11264. required: true,
  11265. schema: {
  11266. $ref: "#/definitions/LocationtagCreate"
  11267. }
  11268. }
  11269. ],
  11270. responses: {
  11271. 201: {
  11272. description: "locationtag response"
  11273. },
  11274. 401: {
  11275. description: "User not logged in"
  11276. }
  11277. }
  11278. }
  11279. },
  11280. /locationtag/{uuid}: {
  11281. get: {
  11282. tags: [
  11283. "locationtag"
  11284. ],
  11285. summary: "Fetch by uuid",
  11286. operationId: "getLocationTag",
  11287. consumes: [
  11288. "application/json"
  11289. ],
  11290. produces: [
  11291. "application/json"
  11292. ],
  11293. parameters: [
  11294. {
  11295. name: "v",
  11296. in: "query",
  11297. description: "The representation to return (ref, default, full or custom)",
  11298. required: false,
  11299. type: "string",
  11300. enum: [
  11301. "ref",
  11302. "default",
  11303. "full",
  11304. "custom"
  11305. ]
  11306. },
  11307. {
  11308. name: "uuid",
  11309. in: "path",
  11310. description: "uuid to filter by",
  11311. required: true,
  11312. type: "string"
  11313. }
  11314. ],
  11315. responses: {
  11316. 200: {
  11317. description: "locationtag response",
  11318. schema: {
  11319. $ref: "#/definitions/LocationtagGet"
  11320. }
  11321. },
  11322. 401: {
  11323. description: "User not logged in"
  11324. },
  11325. 404: {
  11326. description: "Resource with given uuid doesn't exist"
  11327. }
  11328. }
  11329. },
  11330. post: {
  11331. tags: [
  11332. "locationtag"
  11333. ],
  11334. summary: "Edit with given uuid, only modifying properties in request",
  11335. operationId: "updateLocationTag",
  11336. consumes: [
  11337. "application/json"
  11338. ],
  11339. produces: [
  11340. "application/json"
  11341. ],
  11342. parameters: [
  11343. {
  11344. name: "uuid",
  11345. in: "path",
  11346. description: "uuid of resource to update",
  11347. required: true,
  11348. type: "string"
  11349. },
  11350. {
  11351. in: "body",
  11352. name: "resource",
  11353. description: "Resource properties to update",
  11354. required: true,
  11355. schema: {
  11356. $ref: "#/definitions/LocationtagUpdate"
  11357. }
  11358. }
  11359. ],
  11360. responses: {
  11361. 201: {
  11362. description: "locationtag response"
  11363. },
  11364. 401: {
  11365. description: "User not logged in"
  11366. }
  11367. }
  11368. },
  11369. delete: {
  11370. tags: [
  11371. "locationtag"
  11372. ],
  11373. summary: "Delete or purge resource by uuid",
  11374. description: "The resource will be voided/retired unless purge = 'true'",
  11375. operationId: "deleteLocationTag",
  11376. consumes: [
  11377. "application/json"
  11378. ],
  11379. produces: [
  11380. "application/json"
  11381. ],
  11382. parameters: [
  11383. {
  11384. name: "uuid",
  11385. in: "path",
  11386. description: "uuid to delete",
  11387. required: true,
  11388. type: "string"
  11389. },
  11390. {
  11391. name: "purge",
  11392. in: "query",
  11393. required: false,
  11394. type: "boolean"
  11395. }
  11396. ],
  11397. responses: {
  11398. 204: {
  11399. description: "Delete successful"
  11400. },
  11401. 401: {
  11402. description: "User not logged in"
  11403. },
  11404. 404: {
  11405. description: "Resource with given uuid doesn't exist"
  11406. }
  11407. }
  11408. }
  11409. },
  11410. /patientidentifiertype: {
  11411. get: {
  11412. tags: [
  11413. "patientidentifiertype"
  11414. ],
  11415. summary: "Fetch all non-retired patientidentifiertype resources or perform search",
  11416. description: "All search parameters are optional",
  11417. operationId: "getAllPatientIdentifierTypes",
  11418. consumes: [
  11419. "application/json"
  11420. ],
  11421. produces: [
  11422. "application/json"
  11423. ],
  11424. parameters: [
  11425. {
  11426. name: "limit",
  11427. in: "query",
  11428. description: "The number of results to return",
  11429. required: false,
  11430. type: "integer"
  11431. },
  11432. {
  11433. name: "startIndex",
  11434. in: "query",
  11435. description: "The offset at which to start",
  11436. required: false,
  11437. type: "integer"
  11438. },
  11439. {
  11440. name: "v",
  11441. in: "query",
  11442. description: "The representation to return (ref, default, full or custom)",
  11443. required: false,
  11444. type: "string",
  11445. enum: [
  11446. "ref",
  11447. "default",
  11448. "full",
  11449. "custom"
  11450. ]
  11451. },
  11452. {
  11453. name: "q",
  11454. in: "query",
  11455. description: "The search query",
  11456. required: false,
  11457. type: "string"
  11458. }
  11459. ],
  11460. responses: {
  11461. 200: {
  11462. description: "patientidentifiertype response",
  11463. schema: {
  11464. $ref: "#/definitions/FetchAll"
  11465. }
  11466. },
  11467. 401: {
  11468. description: "User not logged in"
  11469. }
  11470. }
  11471. },
  11472. post: {
  11473. tags: [
  11474. "patientidentifiertype"
  11475. ],
  11476. summary: "Create with properties in request",
  11477. operationId: "createPatientIdentifierType",
  11478. consumes: [
  11479. "application/json"
  11480. ],
  11481. produces: [
  11482. "application/json"
  11483. ],
  11484. parameters: [
  11485. {
  11486. in: "body",
  11487. name: "resource",
  11488. description: "Resource to create",
  11489. required: true,
  11490. schema: {
  11491. $ref: "#/definitions/PatientidentifiertypeCreate"
  11492. }
  11493. }
  11494. ],
  11495. responses: {
  11496. 201: {
  11497. description: "patientidentifiertype response"
  11498. },
  11499. 401: {
  11500. description: "User not logged in"
  11501. }
  11502. }
  11503. }
  11504. },
  11505. /patientidentifiertype/{uuid}: {
  11506. get: {
  11507. tags: [
  11508. "patientidentifiertype"
  11509. ],
  11510. summary: "Fetch by uuid",
  11511. operationId: "getPatientIdentifierType",
  11512. consumes: [
  11513. "application/json"
  11514. ],
  11515. produces: [
  11516. "application/json"
  11517. ],
  11518. parameters: [
  11519. {
  11520. name: "v",
  11521. in: "query",
  11522. description: "The representation to return (ref, default, full or custom)",
  11523. required: false,
  11524. type: "string",
  11525. enum: [
  11526. "ref",
  11527. "default",
  11528. "full",
  11529. "custom"
  11530. ]
  11531. },
  11532. {
  11533. name: "uuid",
  11534. in: "path",
  11535. description: "uuid to filter by",
  11536. required: true,
  11537. type: "string"
  11538. }
  11539. ],
  11540. responses: {
  11541. 200: {
  11542. description: "patientidentifiertype response",
  11543. schema: {
  11544. $ref: "#/definitions/PatientidentifiertypeGet"
  11545. }
  11546. },
  11547. 401: {
  11548. description: "User not logged in"
  11549. },
  11550. 404: {
  11551. description: "Resource with given uuid doesn't exist"
  11552. }
  11553. }
  11554. },
  11555. post: {
  11556. tags: [
  11557. "patientidentifiertype"
  11558. ],
  11559. summary: "Edit with given uuid, only modifying properties in request",
  11560. operationId: "updatePatientIdentifierType",
  11561. consumes: [
  11562. "application/json"
  11563. ],
  11564. produces: [
  11565. "application/json"
  11566. ],
  11567. parameters: [
  11568. {
  11569. name: "uuid",
  11570. in: "path",
  11571. description: "uuid of resource to update",
  11572. required: true,
  11573. type: "string"
  11574. },
  11575. {
  11576. in: "body",
  11577. name: "resource",
  11578. description: "Resource properties to update",
  11579. required: true,
  11580. schema: {
  11581. $ref: "#/definitions/PatientidentifiertypeUpdate"
  11582. }
  11583. }
  11584. ],
  11585. responses: {
  11586. 201: {
  11587. description: "patientidentifiertype response"
  11588. },
  11589. 401: {
  11590. description: "User not logged in"
  11591. }
  11592. }
  11593. },
  11594. delete: {
  11595. tags: [
  11596. "patientidentifiertype"
  11597. ],
  11598. summary: "Delete or purge resource by uuid",
  11599. description: "The resource will be voided/retired unless purge = 'true'",
  11600. operationId: "deletePatientIdentifierType",
  11601. consumes: [
  11602. "application/json"
  11603. ],
  11604. produces: [
  11605. "application/json"
  11606. ],
  11607. parameters: [
  11608. {
  11609. name: "uuid",
  11610. in: "path",
  11611. description: "uuid to delete",
  11612. required: true,
  11613. type: "string"
  11614. },
  11615. {
  11616. name: "purge",
  11617. in: "query",
  11618. required: false,
  11619. type: "boolean"
  11620. }
  11621. ],
  11622. responses: {
  11623. 204: {
  11624. description: "Delete successful"
  11625. },
  11626. 401: {
  11627. description: "User not logged in"
  11628. },
  11629. 404: {
  11630. description: "Resource with given uuid doesn't exist"
  11631. }
  11632. }
  11633. }
  11634. },
  11635. /conceptreferenceterm: {
  11636. get: {
  11637. tags: [
  11638. "conceptreferenceterm"
  11639. ],
  11640. summary: "Fetch all non-retired conceptreferenceterm resources or perform search",
  11641. description: "All search parameters are optional",
  11642. operationId: "getAllConceptReferenceTerms",
  11643. consumes: [
  11644. "application/json"
  11645. ],
  11646. produces: [
  11647. "application/json"
  11648. ],
  11649. parameters: [
  11650. {
  11651. name: "limit",
  11652. in: "query",
  11653. description: "The number of results to return",
  11654. required: false,
  11655. type: "integer"
  11656. },
  11657. {
  11658. name: "startIndex",
  11659. in: "query",
  11660. description: "The offset at which to start",
  11661. required: false,
  11662. type: "integer"
  11663. },
  11664. {
  11665. name: "v",
  11666. in: "query",
  11667. description: "The representation to return (ref, default, full or custom)",
  11668. required: false,
  11669. type: "string",
  11670. enum: [
  11671. "ref",
  11672. "default",
  11673. "full",
  11674. "custom"
  11675. ]
  11676. },
  11677. {
  11678. name: "q",
  11679. in: "query",
  11680. description: "The search query",
  11681. required: false,
  11682. type: "string"
  11683. },
  11684. {
  11685. name: "codeOrName",
  11686. in: "query",
  11687. description: "Must be used with ",
  11688. required: false,
  11689. type: "string"
  11690. },
  11691. {
  11692. name: "searchType",
  11693. in: "query",
  11694. description: "Must be used with ",
  11695. required: false,
  11696. type: "string"
  11697. },
  11698. {
  11699. name: "source",
  11700. in: "query",
  11701. description: "Must be used with ",
  11702. required: false,
  11703. type: "string"
  11704. }
  11705. ],
  11706. responses: {
  11707. 200: {
  11708. description: "conceptreferenceterm response",
  11709. schema: {
  11710. $ref: "#/definitions/FetchAll"
  11711. }
  11712. },
  11713. 401: {
  11714. description: "User not logged in"
  11715. }
  11716. }
  11717. },
  11718. post: {
  11719. tags: [
  11720. "conceptreferenceterm"
  11721. ],
  11722. summary: "Create with properties in request",
  11723. operationId: "createConceptReferenceTerm",
  11724. consumes: [
  11725. "application/json"
  11726. ],
  11727. produces: [
  11728. "application/json"
  11729. ],
  11730. parameters: [
  11731. {
  11732. in: "body",
  11733. name: "resource",
  11734. description: "Resource to create",
  11735. required: true,
  11736. schema: {
  11737. $ref: "#/definitions/ConceptreferencetermCreate"
  11738. }
  11739. }
  11740. ],
  11741. responses: {
  11742. 201: {
  11743. description: "conceptreferenceterm response"
  11744. },
  11745. 401: {
  11746. description: "User not logged in"
  11747. }
  11748. }
  11749. }
  11750. },
  11751. /conceptreferenceterm/{uuid}: {
  11752. get: {
  11753. tags: [
  11754. "conceptreferenceterm"
  11755. ],
  11756. summary: "Fetch by uuid",
  11757. operationId: "getConceptReferenceTerm",
  11758. consumes: [
  11759. "application/json"
  11760. ],
  11761. produces: [
  11762. "application/json"
  11763. ],
  11764. parameters: [
  11765. {
  11766. name: "v",
  11767. in: "query",
  11768. description: "The representation to return (ref, default, full or custom)",
  11769. required: false,
  11770. type: "string",
  11771. enum: [
  11772. "ref",
  11773. "default",
  11774. "full",
  11775. "custom"
  11776. ]
  11777. },
  11778. {
  11779. name: "uuid",
  11780. in: "path",
  11781. description: "uuid to filter by",
  11782. required: true,
  11783. type: "string"
  11784. }
  11785. ],
  11786. responses: {
  11787. 200: {
  11788. description: "conceptreferenceterm response",
  11789. schema: {
  11790. $ref: "#/definitions/ConceptreferencetermGet"
  11791. }
  11792. },
  11793. 401: {
  11794. description: "User not logged in"
  11795. },
  11796. 404: {
  11797. description: "Resource with given uuid doesn't exist"
  11798. }
  11799. }
  11800. },
  11801. post: {
  11802. tags: [
  11803. "conceptreferenceterm"
  11804. ],
  11805. summary: "Edit with given uuid, only modifying properties in request",
  11806. operationId: "updateConceptReferenceTerm",
  11807. consumes: [
  11808. "application/json"
  11809. ],
  11810. produces: [
  11811. "application/json"
  11812. ],
  11813. parameters: [
  11814. {
  11815. name: "uuid",
  11816. in: "path",
  11817. description: "uuid of resource to update",
  11818. required: true,
  11819. type: "string"
  11820. },
  11821. {
  11822. in: "body",
  11823. name: "resource",
  11824. description: "Resource properties to update",
  11825. required: true,
  11826. schema: {
  11827. $ref: "#/definitions/ConceptreferencetermUpdate"
  11828. }
  11829. }
  11830. ],
  11831. responses: {
  11832. 201: {
  11833. description: "conceptreferenceterm response"
  11834. },
  11835. 401: {
  11836. description: "User not logged in"
  11837. }
  11838. }
  11839. },
  11840. delete: {
  11841. tags: [
  11842. "conceptreferenceterm"
  11843. ],
  11844. summary: "Delete or purge resource by uuid",
  11845. description: "The resource will be voided/retired unless purge = 'true'",
  11846. operationId: "deleteConceptReferenceTerm",
  11847. consumes: [
  11848. "application/json"
  11849. ],
  11850. produces: [
  11851. "application/json"
  11852. ],
  11853. parameters: [
  11854. {
  11855. name: "uuid",
  11856. in: "path",
  11857. description: "uuid to delete",
  11858. required: true,
  11859. type: "string"
  11860. },
  11861. {
  11862. name: "purge",
  11863. in: "query",
  11864. required: false,
  11865. type: "boolean"
  11866. }
  11867. ],
  11868. responses: {
  11869. 204: {
  11870. description: "Delete successful"
  11871. },
  11872. 401: {
  11873. description: "User not logged in"
  11874. },
  11875. 404: {
  11876. description: "Resource with given uuid doesn't exist"
  11877. }
  11878. }
  11879. }
  11880. },
  11881. /program: {
  11882. get: {
  11883. tags: [
  11884. "program"
  11885. ],
  11886. summary: "Fetch all non-retired program resources or perform search",
  11887. description: "All search parameters are optional",
  11888. operationId: "getAllPrograms",
  11889. consumes: [
  11890. "application/json"
  11891. ],
  11892. produces: [
  11893. "application/json"
  11894. ],
  11895. parameters: [
  11896. {
  11897. name: "limit",
  11898. in: "query",
  11899. description: "The number of results to return",
  11900. required: false,
  11901. type: "integer"
  11902. },
  11903. {
  11904. name: "startIndex",
  11905. in: "query",
  11906. description: "The offset at which to start",
  11907. required: false,
  11908. type: "integer"
  11909. },
  11910. {
  11911. name: "v",
  11912. in: "query",
  11913. description: "The representation to return (ref, default, full or custom)",
  11914. required: false,
  11915. type: "string",
  11916. enum: [
  11917. "ref",
  11918. "default",
  11919. "full",
  11920. "custom"
  11921. ]
  11922. },
  11923. {
  11924. name: "q",
  11925. in: "query",
  11926. description: "The search query",
  11927. required: false,
  11928. type: "string"
  11929. }
  11930. ],
  11931. responses: {
  11932. 200: {
  11933. description: "program response",
  11934. schema: {
  11935. $ref: "#/definitions/FetchAll"
  11936. }
  11937. },
  11938. 401: {
  11939. description: "User not logged in"
  11940. }
  11941. }
  11942. },
  11943. post: {
  11944. tags: [
  11945. "program"
  11946. ],
  11947. summary: "Create with properties in request",
  11948. operationId: "createProgram",
  11949. consumes: [
  11950. "application/json"
  11951. ],
  11952. produces: [
  11953. "application/json"
  11954. ],
  11955. parameters: [
  11956. {
  11957. in: "body",
  11958. name: "resource",
  11959. description: "Resource to create",
  11960. required: true,
  11961. schema: {
  11962. $ref: "#/definitions/ProgramCreate"
  11963. }
  11964. }
  11965. ],
  11966. responses: {
  11967. 201: {
  11968. description: "program response"
  11969. },
  11970. 401: {
  11971. description: "User not logged in"
  11972. }
  11973. }
  11974. }
  11975. },
  11976. /program/{uuid}: {
  11977. get: {
  11978. tags: [
  11979. "program"
  11980. ],
  11981. summary: "Fetch by uuid",
  11982. operationId: "getProgram",
  11983. consumes: [
  11984. "application/json"
  11985. ],
  11986. produces: [
  11987. "application/json"
  11988. ],
  11989. parameters: [
  11990. {
  11991. name: "v",
  11992. in: "query",
  11993. description: "The representation to return (ref, default, full or custom)",
  11994. required: false,
  11995. type: "string",
  11996. enum: [
  11997. "ref",
  11998. "default",
  11999. "full",
  12000. "custom"
  12001. ]
  12002. },
  12003. {
  12004. name: "uuid",
  12005. in: "path",
  12006. description: "uuid to filter by",
  12007. required: true,
  12008. type: "string"
  12009. }
  12010. ],
  12011. responses: {
  12012. 200: {
  12013. description: "program response",
  12014. schema: {
  12015. $ref: "#/definitions/ProgramGet"
  12016. }
  12017. },
  12018. 401: {
  12019. description: "User not logged in"
  12020. },
  12021. 404: {
  12022. description: "Resource with given uuid doesn't exist"
  12023. }
  12024. }
  12025. },
  12026. post: {
  12027. tags: [
  12028. "program"
  12029. ],
  12030. summary: "Edit with given uuid, only modifying properties in request",
  12031. operationId: "updateProgram",
  12032. consumes: [
  12033. "application/json"
  12034. ],
  12035. produces: [
  12036. "application/json"
  12037. ],
  12038. parameters: [
  12039. {
  12040. name: "uuid",
  12041. in: "path",
  12042. description: "uuid of resource to update",
  12043. required: true,
  12044. type: "string"
  12045. },
  12046. {
  12047. in: "body",
  12048. name: "resource",
  12049. description: "Resource properties to update",
  12050. required: true,
  12051. schema: {
  12052. $ref: "#/definitions/ProgramUpdate"
  12053. }
  12054. }
  12055. ],
  12056. responses: {
  12057. 201: {
  12058. description: "program response"
  12059. },
  12060. 401: {
  12061. description: "User not logged in"
  12062. }
  12063. }
  12064. },
  12065. delete: {
  12066. tags: [
  12067. "program"
  12068. ],
  12069. summary: "Delete or purge resource by uuid",
  12070. description: "The resource will be voided/retired unless purge = 'true'",
  12071. operationId: "deleteProgram",
  12072. consumes: [
  12073. "application/json"
  12074. ],
  12075. produces: [
  12076. "application/json"
  12077. ],
  12078. parameters: [
  12079. {
  12080. name: "uuid",
  12081. in: "path",
  12082. description: "uuid to delete",
  12083. required: true,
  12084. type: "string"
  12085. },
  12086. {
  12087. name: "purge",
  12088. in: "query",
  12089. required: false,
  12090. type: "boolean"
  12091. }
  12092. ],
  12093. responses: {
  12094. 204: {
  12095. description: "Delete successful"
  12096. },
  12097. 401: {
  12098. description: "User not logged in"
  12099. },
  12100. 404: {
  12101. description: "Resource with given uuid doesn't exist"
  12102. }
  12103. }
  12104. }
  12105. },
  12106. /drugreferencemap: {
  12107. get: {
  12108. tags: [
  12109. "drugreferencemap"
  12110. ],
  12111. summary: "Search for drugreferencemap",
  12112. description: "At least one search parameter must be specified",
  12113. operationId: "getAllDrugReferenceMaps",
  12114. produces: [
  12115. "application/json",
  12116. "application/xml"
  12117. ],
  12118. parameters: [
  12119. {
  12120. name: "limit",
  12121. in: "query",
  12122. description: "The number of results to return",
  12123. required: false,
  12124. type: "integer"
  12125. },
  12126. {
  12127. name: "startIndex",
  12128. in: "query",
  12129. description: "The offset at which to start",
  12130. required: false,
  12131. type: "integer"
  12132. },
  12133. {
  12134. name: "v",
  12135. in: "query",
  12136. description: "The representation to return (ref, default, full or custom)",
  12137. required: false,
  12138. type: "string",
  12139. enum: [
  12140. "ref",
  12141. "default",
  12142. "full",
  12143. "custom"
  12144. ]
  12145. },
  12146. {
  12147. name: "q",
  12148. in: "query",
  12149. description: "The search query",
  12150. required: true,
  12151. type: "string"
  12152. }
  12153. ],
  12154. responses: {
  12155. 200: {
  12156. description: "drugreferencemap response",
  12157. schema: {
  12158. $ref: "#/definitions/FetchAll"
  12159. }
  12160. }
  12161. }
  12162. },
  12163. post: {
  12164. tags: [
  12165. "drugreferencemap"
  12166. ],
  12167. summary: "Create with properties in request",
  12168. operationId: "createDrugReferenceMap",
  12169. consumes: [
  12170. "application/json"
  12171. ],
  12172. produces: [
  12173. "application/json"
  12174. ],
  12175. parameters: [
  12176. {
  12177. in: "body",
  12178. name: "resource",
  12179. description: "Resource to create",
  12180. required: true,
  12181. schema: {
  12182. $ref: "#/definitions/DrugreferencemapCreate"
  12183. }
  12184. }
  12185. ],
  12186. responses: {
  12187. 201: {
  12188. description: "drugreferencemap response"
  12189. },
  12190. 401: {
  12191. description: "User not logged in"
  12192. }
  12193. }
  12194. }
  12195. },
  12196. /drugreferencemap/{uuid}: {
  12197. get: {
  12198. tags: [
  12199. "drugreferencemap"
  12200. ],
  12201. summary: "Fetch by uuid",
  12202. operationId: "getDrugReferenceMap",
  12203. consumes: [
  12204. "application/json"
  12205. ],
  12206. produces: [
  12207. "application/json"
  12208. ],
  12209. parameters: [
  12210. {
  12211. name: "v",
  12212. in: "query",
  12213. description: "The representation to return (ref, default, full or custom)",
  12214. required: false,
  12215. type: "string",
  12216. enum: [
  12217. "ref",
  12218. "default",
  12219. "full",
  12220. "custom"
  12221. ]
  12222. },
  12223. {
  12224. name: "uuid",
  12225. in: "path",
  12226. description: "uuid to filter by",
  12227. required: true,
  12228. type: "string"
  12229. }
  12230. ],
  12231. responses: {
  12232. 200: {
  12233. description: "drugreferencemap response",
  12234. schema: {
  12235. $ref: "#/definitions/DrugreferencemapGet"
  12236. }
  12237. },
  12238. 401: {
  12239. description: "User not logged in"
  12240. },
  12241. 404: {
  12242. description: "Resource with given uuid doesn't exist"
  12243. }
  12244. }
  12245. },
  12246. post: {
  12247. tags: [
  12248. "drugreferencemap"
  12249. ],
  12250. summary: "Edit with given uuid, only modifying properties in request",
  12251. operationId: "updateDrugReferenceMap",
  12252. consumes: [
  12253. "application/json"
  12254. ],
  12255. produces: [
  12256. "application/json"
  12257. ],
  12258. parameters: [
  12259. {
  12260. name: "uuid",
  12261. in: "path",
  12262. description: "uuid of resource to update",
  12263. required: true,
  12264. type: "string"
  12265. },
  12266. {
  12267. in: "body",
  12268. name: "resource",
  12269. description: "Resource properties to update",
  12270. required: true,
  12271. schema: {
  12272. $ref: "#/definitions/DrugreferencemapUpdate"
  12273. }
  12274. }
  12275. ],
  12276. responses: {
  12277. 201: {
  12278. description: "drugreferencemap response"
  12279. },
  12280. 401: {
  12281. description: "User not logged in"
  12282. }
  12283. }
  12284. },
  12285. delete: {
  12286. tags: [
  12287. "drugreferencemap"
  12288. ],
  12289. summary: "Delete or purge resource by uuid",
  12290. description: "The resource will be voided/retired unless purge = 'true'",
  12291. operationId: "deleteDrugReferenceMap",
  12292. consumes: [
  12293. "application/json"
  12294. ],
  12295. produces: [
  12296. "application/json"
  12297. ],
  12298. parameters: [
  12299. {
  12300. name: "uuid",
  12301. in: "path",
  12302. description: "uuid to delete",
  12303. required: true,
  12304. type: "string"
  12305. },
  12306. {
  12307. name: "purge",
  12308. in: "query",
  12309. required: false,
  12310. type: "boolean"
  12311. }
  12312. ],
  12313. responses: {
  12314. 204: {
  12315. description: "Delete successful"
  12316. },
  12317. 401: {
  12318. description: "User not logged in"
  12319. },
  12320. 404: {
  12321. description: "Resource with given uuid doesn't exist"
  12322. }
  12323. }
  12324. }
  12325. },
  12326. /patient/{parent-uuid}/allergy: {
  12327. post: {
  12328. tags: [
  12329. "patient"
  12330. ],
  12331. summary: "Create allergy subresource with properties in request",
  12332. operationId: "createPatientAllergy",
  12333. consumes: [
  12334. "application/json"
  12335. ],
  12336. produces: [
  12337. "application/json"
  12338. ],
  12339. parameters: [
  12340. {
  12341. name: "parent-uuid",
  12342. in: "path",
  12343. description: "parent resource uuid",
  12344. required: true,
  12345. type: "string"
  12346. },
  12347. {
  12348. in: "body",
  12349. name: "resource",
  12350. description: "Resource to create",
  12351. required: true,
  12352. schema: {
  12353. $ref: "#/definitions/PatientAllergyCreate"
  12354. }
  12355. }
  12356. ],
  12357. responses: {
  12358. 201: {
  12359. description: "allergy response"
  12360. },
  12361. 401: {
  12362. description: "User not logged in"
  12363. }
  12364. }
  12365. }
  12366. },
  12367. /patient/{parent-uuid}/allergy/{uuid}: {
  12368. get: {
  12369. tags: [
  12370. "patient"
  12371. ],
  12372. summary: "Fetch allergy subresources by uuid",
  12373. operationId: "getPatientAllergy",
  12374. consumes: [
  12375. "application/json"
  12376. ],
  12377. produces: [
  12378. "application/json"
  12379. ],
  12380. parameters: [
  12381. {
  12382. name: "parent-uuid",
  12383. in: "path",
  12384. description: "parent resource uuid",
  12385. required: true,
  12386. type: "string"
  12387. },
  12388. {
  12389. name: "uuid",
  12390. in: "path",
  12391. description: "uuid to filter by",
  12392. required: true,
  12393. type: "string"
  12394. },
  12395. {
  12396. name: "v",
  12397. in: "query",
  12398. description: "The representation to return (ref, default, full or custom)",
  12399. required: false,
  12400. type: "string",
  12401. enum: [
  12402. "ref",
  12403. "default",
  12404. "full",
  12405. "custom"
  12406. ]
  12407. }
  12408. ],
  12409. responses: {
  12410. 200: {
  12411. description: "allergy response",
  12412. schema: {
  12413. $ref: "#/definitions/PatientAllergyGet"
  12414. }
  12415. },
  12416. 401: {
  12417. description: "User not logged in"
  12418. },
  12419. 404: {
  12420. description: "Resource with given uuid doesn't exist"
  12421. }
  12422. }
  12423. },
  12424. post: {
  12425. tags: [
  12426. "patient"
  12427. ],
  12428. summary: "edit allergy subresource with given uuid, only modifying properties in request",
  12429. operationId: "updatePatientAllergy",
  12430. consumes: [
  12431. "application/json"
  12432. ],
  12433. produces: [
  12434. "application/json"
  12435. ],
  12436. parameters: [
  12437. {
  12438. name: "parent-uuid",
  12439. in: "path",
  12440. description: "parent resource uuid",
  12441. required: true,
  12442. type: "string"
  12443. },
  12444. {
  12445. name: "uuid",
  12446. in: "path",
  12447. description: "uuid of resource to update",
  12448. required: true,
  12449. type: "string"
  12450. },
  12451. {
  12452. in: "body",
  12453. name: "resource",
  12454. description: "Resource properties to update",
  12455. required: true,
  12456. schema: {
  12457. $ref: "#/definitions/PatientAllergyUpdate"
  12458. }
  12459. }
  12460. ],
  12461. responses: {
  12462. 201: {
  12463. description: "allergy response"
  12464. },
  12465. 401: {
  12466. description: "User not logged in"
  12467. }
  12468. }
  12469. },
  12470. delete: {
  12471. tags: [
  12472. "patient"
  12473. ],
  12474. summary: "Delete or purge resource by uuid",
  12475. description: "The resource will be voided/retired unless purge = 'true'",
  12476. operationId: "deletePatientAllergy",
  12477. consumes: [
  12478. "application/json"
  12479. ],
  12480. produces: [
  12481. "application/json"
  12482. ],
  12483. parameters: [
  12484. {
  12485. name: "parent-uuid",
  12486. in: "path",
  12487. description: "parent resource uuid",
  12488. required: true,
  12489. type: "string"
  12490. },
  12491. {
  12492. name: "uuid",
  12493. in: "path",
  12494. description: "uuid to delete",
  12495. required: true,
  12496. type: "string"
  12497. },
  12498. {
  12499. name: "purge",
  12500. in: "query",
  12501. required: false,
  12502. type: "boolean"
  12503. }
  12504. ],
  12505. responses: {
  12506. 204: {
  12507. description: "Delete successful"
  12508. },
  12509. 401: {
  12510. description: "User not logged in"
  12511. },
  12512. 404: {
  12513. description: "Resource with given uuid doesn't exist"
  12514. }
  12515. }
  12516. }
  12517. },
  12518. /concept/{parent-uuid}/mapping: {
  12519. get: {
  12520. tags: [
  12521. "concept"
  12522. ],
  12523. summary: "Fetch all non-retired mapping subresources",
  12524. operationId: "getAllConceptMaps",
  12525. consumes: [
  12526. "application/json"
  12527. ],
  12528. produces: [
  12529. "application/json"
  12530. ],
  12531. parameters: [
  12532. {
  12533. name: "limit",
  12534. in: "query",
  12535. description: "The number of results to return",
  12536. required: false,
  12537. type: "integer"
  12538. },
  12539. {
  12540. name: "startIndex",
  12541. in: "query",
  12542. description: "The offset at which to start",
  12543. required: false,
  12544. type: "integer"
  12545. },
  12546. {
  12547. name: "parent-uuid",
  12548. in: "path",
  12549. description: "parent resource uuid",
  12550. required: true,
  12551. type: "string"
  12552. },
  12553. {
  12554. name: "v",
  12555. in: "query",
  12556. description: "The representation to return (ref, default, full or custom)",
  12557. required: false,
  12558. type: "string",
  12559. enum: [
  12560. "ref",
  12561. "default",
  12562. "full",
  12563. "custom"
  12564. ]
  12565. }
  12566. ],
  12567. responses: {
  12568. 200: {
  12569. description: "mapping response",
  12570. schema: {
  12571. type: "object",
  12572. properties: {
  12573. results: {
  12574. type: "array",
  12575. items: {
  12576. $ref: "#/definitions/ConceptMappingGet"
  12577. }
  12578. }
  12579. }
  12580. }
  12581. },
  12582. 401: {
  12583. description: "User not logged in"
  12584. }
  12585. }
  12586. },
  12587. post: {
  12588. tags: [
  12589. "concept"
  12590. ],
  12591. summary: "Create mapping subresource with properties in request",
  12592. operationId: "createConceptMap",
  12593. consumes: [
  12594. "application/json"
  12595. ],
  12596. produces: [
  12597. "application/json"
  12598. ],
  12599. parameters: [
  12600. {
  12601. name: "parent-uuid",
  12602. in: "path",
  12603. description: "parent resource uuid",
  12604. required: true,
  12605. type: "string"
  12606. },
  12607. {
  12608. in: "body",
  12609. name: "resource",
  12610. description: "Resource to create",
  12611. required: true,
  12612. schema: {
  12613. $ref: "#/definitions/ConceptMappingCreate"
  12614. }
  12615. }
  12616. ],
  12617. responses: {
  12618. 201: {
  12619. description: "mapping response"
  12620. },
  12621. 401: {
  12622. description: "User not logged in"
  12623. }
  12624. }
  12625. }
  12626. },
  12627. /concept/{parent-uuid}/mapping/{uuid}: {
  12628. get: {
  12629. tags: [
  12630. "concept"
  12631. ],
  12632. summary: "Fetch mapping subresources by uuid",
  12633. operationId: "getConceptMap",
  12634. consumes: [
  12635. "application/json"
  12636. ],
  12637. produces: [
  12638. "application/json"
  12639. ],
  12640. parameters: [
  12641. {
  12642. name: "parent-uuid",
  12643. in: "path",
  12644. description: "parent resource uuid",
  12645. required: true,
  12646. type: "string"
  12647. },
  12648. {
  12649. name: "uuid",
  12650. in: "path",
  12651. description: "uuid to filter by",
  12652. required: true,
  12653. type: "string"
  12654. },
  12655. {
  12656. name: "v",
  12657. in: "query",
  12658. description: "The representation to return (ref, default, full or custom)",
  12659. required: false,
  12660. type: "string",
  12661. enum: [
  12662. "ref",
  12663. "default",
  12664. "full",
  12665. "custom"
  12666. ]
  12667. }
  12668. ],
  12669. responses: {
  12670. 200: {
  12671. description: "mapping response",
  12672. schema: {
  12673. $ref: "#/definitions/ConceptMappingGet"
  12674. }
  12675. },
  12676. 401: {
  12677. description: "User not logged in"
  12678. },
  12679. 404: {
  12680. description: "Resource with given uuid doesn't exist"
  12681. }
  12682. }
  12683. },
  12684. post: {
  12685. tags: [
  12686. "concept"
  12687. ],
  12688. summary: "edit mapping subresource with given uuid, only modifying properties in request",
  12689. operationId: "updateConceptMap",
  12690. consumes: [
  12691. "application/json"
  12692. ],
  12693. produces: [
  12694. "application/json"
  12695. ],
  12696. parameters: [
  12697. {
  12698. name: "parent-uuid",
  12699. in: "path",
  12700. description: "parent resource uuid",
  12701. required: true,
  12702. type: "string"
  12703. },
  12704. {
  12705. name: "uuid",
  12706. in: "path",
  12707. description: "uuid of resource to update",
  12708. required: true,
  12709. type: "string"
  12710. },
  12711. {
  12712. in: "body",
  12713. name: "resource",
  12714. description: "Resource properties to update",
  12715. required: true,
  12716. schema: {
  12717. $ref: "#/definitions/ConceptMappingUpdate"
  12718. }
  12719. }
  12720. ],
  12721. responses: {
  12722. 201: {
  12723. description: "mapping response"
  12724. },
  12725. 401: {
  12726. description: "User not logged in"
  12727. }
  12728. }
  12729. },
  12730. delete: {
  12731. tags: [
  12732. "concept"
  12733. ],
  12734. summary: "Delete or purge resource by uuid",
  12735. description: "The resource will be voided/retired unless purge = 'true'",
  12736. operationId: "deleteConceptMap",
  12737. consumes: [
  12738. "application/json"
  12739. ],
  12740. produces: [
  12741. "application/json"
  12742. ],
  12743. parameters: [
  12744. {
  12745. name: "parent-uuid",
  12746. in: "path",
  12747. description: "parent resource uuid",
  12748. required: true,
  12749. type: "string"
  12750. },
  12751. {
  12752. name: "uuid",
  12753. in: "path",
  12754. description: "uuid to delete",
  12755. required: true,
  12756. type: "string"
  12757. },
  12758. {
  12759. name: "purge",
  12760. in: "query",
  12761. required: false,
  12762. type: "boolean"
  12763. }
  12764. ],
  12765. responses: {
  12766. 204: {
  12767. description: "Delete successful"
  12768. },
  12769. 401: {
  12770. description: "User not logged in"
  12771. },
  12772. 404: {
  12773. description: "Resource with given uuid doesn't exist"
  12774. }
  12775. }
  12776. }
  12777. },
  12778. /drug/{parent-uuid}/ingredient: {
  12779. get: {
  12780. tags: [
  12781. "drug"
  12782. ],
  12783. summary: "Fetch all non-retired ingredient subresources",
  12784. operationId: "getAllDrugIngredients",
  12785. consumes: [
  12786. "application/json"
  12787. ],
  12788. produces: [
  12789. "application/json"
  12790. ],
  12791. parameters: [
  12792. {
  12793. name: "limit",
  12794. in: "query",
  12795. description: "The number of results to return",
  12796. required: false,
  12797. type: "integer"
  12798. },
  12799. {
  12800. name: "startIndex",
  12801. in: "query",
  12802. description: "The offset at which to start",
  12803. required: false,
  12804. type: "integer"
  12805. },
  12806. {
  12807. name: "parent-uuid",
  12808. in: "path",
  12809. description: "parent resource uuid",
  12810. required: true,
  12811. type: "string"
  12812. },
  12813. {
  12814. name: "v",
  12815. in: "query",
  12816. description: "The representation to return (ref, default, full or custom)",
  12817. required: false,
  12818. type: "string",
  12819. enum: [
  12820. "ref",
  12821. "default",
  12822. "full",
  12823. "custom"
  12824. ]
  12825. }
  12826. ],
  12827. responses: {
  12828. 200: {
  12829. description: "ingredient response",
  12830. schema: {
  12831. type: "object",
  12832. properties: {
  12833. results: {
  12834. type: "array",
  12835. items: {
  12836. $ref: "#/definitions/DrugIngredientGet"
  12837. }
  12838. }
  12839. }
  12840. }
  12841. },
  12842. 401: {
  12843. description: "User not logged in"
  12844. }
  12845. }
  12846. },
  12847. post: {
  12848. tags: [
  12849. "drug"
  12850. ],
  12851. summary: "Create ingredient subresource with properties in request",
  12852. operationId: "createDrugIngredient",
  12853. consumes: [
  12854. "application/json"
  12855. ],
  12856. produces: [
  12857. "application/json"
  12858. ],
  12859. parameters: [
  12860. {
  12861. name: "parent-uuid",
  12862. in: "path",
  12863. description: "parent resource uuid",
  12864. required: true,
  12865. type: "string"
  12866. },
  12867. {
  12868. in: "body",
  12869. name: "resource",
  12870. description: "Resource to create",
  12871. required: true,
  12872. schema: {
  12873. $ref: "#/definitions/DrugIngredientCreate"
  12874. }
  12875. }
  12876. ],
  12877. responses: {
  12878. 201: {
  12879. description: "ingredient response"
  12880. },
  12881. 401: {
  12882. description: "User not logged in"
  12883. }
  12884. }
  12885. }
  12886. },
  12887. /drug/{parent-uuid}/ingredient/{uuid}: {
  12888. get: {
  12889. tags: [
  12890. "drug"
  12891. ],
  12892. summary: "Fetch ingredient subresources by uuid",
  12893. operationId: "getDrugIngredient",
  12894. consumes: [
  12895. "application/json"
  12896. ],
  12897. produces: [
  12898. "application/json"
  12899. ],
  12900. parameters: [
  12901. {
  12902. name: "parent-uuid",
  12903. in: "path",
  12904. description: "parent resource uuid",
  12905. required: true,
  12906. type: "string"
  12907. },
  12908. {
  12909. name: "uuid",
  12910. in: "path",
  12911. description: "uuid to filter by",
  12912. required: true,
  12913. type: "string"
  12914. },
  12915. {
  12916. name: "v",
  12917. in: "query",
  12918. description: "The representation to return (ref, default, full or custom)",
  12919. required: false,
  12920. type: "string",
  12921. enum: [
  12922. "ref",
  12923. "default",
  12924. "full",
  12925. "custom"
  12926. ]
  12927. }
  12928. ],
  12929. responses: {
  12930. 200: {
  12931. description: "ingredient response",
  12932. schema: {
  12933. $ref: "#/definitions/DrugIngredientGet"
  12934. }
  12935. },
  12936. 401: {
  12937. description: "User not logged in"
  12938. },
  12939. 404: {
  12940. description: "Resource with given uuid doesn't exist"
  12941. }
  12942. }
  12943. },
  12944. post: {
  12945. tags: [
  12946. "drug"
  12947. ],
  12948. summary: "edit ingredient subresource with given uuid, only modifying properties in request",
  12949. operationId: "updateDrugIngredient",
  12950. consumes: [
  12951. "application/json"
  12952. ],
  12953. produces: [
  12954. "application/json"
  12955. ],
  12956. parameters: [
  12957. {
  12958. name: "parent-uuid",
  12959. in: "path",
  12960. description: "parent resource uuid",
  12961. required: true,
  12962. type: "string"
  12963. },
  12964. {
  12965. name: "uuid",
  12966. in: "path",
  12967. description: "uuid of resource to update",
  12968. required: true,
  12969. type: "string"
  12970. },
  12971. {
  12972. in: "body",
  12973. name: "resource",
  12974. description: "Resource properties to update",
  12975. required: true,
  12976. schema: {
  12977. $ref: "#/definitions/DrugIngredientUpdate"
  12978. }
  12979. }
  12980. ],
  12981. responses: {
  12982. 201: {
  12983. description: "ingredient response"
  12984. },
  12985. 401: {
  12986. description: "User not logged in"
  12987. }
  12988. }
  12989. },
  12990. delete: {
  12991. tags: [
  12992. "drug"
  12993. ],
  12994. summary: "Delete or purge resource by uuid",
  12995. description: "The resource will be voided/retired unless purge = 'true'",
  12996. operationId: "deleteDrugIngredient",
  12997. consumes: [
  12998. "application/json"
  12999. ],
  13000. produces: [
  13001. "application/json"
  13002. ],
  13003. parameters: [
  13004. {
  13005. name: "parent-uuid",
  13006. in: "path",
  13007. description: "parent resource uuid",
  13008. required: true,
  13009. type: "string"
  13010. },
  13011. {
  13012. name: "uuid",
  13013. in: "path",
  13014. description: "uuid to delete",
  13015. required: true,
  13016. type: "string"
  13017. },
  13018. {
  13019. name: "purge",
  13020. in: "query",
  13021. required: false,
  13022. type: "boolean"
  13023. }
  13024. ],
  13025. responses: {
  13026. 204: {
  13027. description: "Delete successful"
  13028. },
  13029. 401: {
  13030. description: "User not logged in"
  13031. },
  13032. 404: {
  13033. description: "Resource with given uuid doesn't exist"
  13034. }
  13035. }
  13036. }
  13037. },
  13038. /visit/{parent-uuid}/attribute: {
  13039. get: {
  13040. tags: [
  13041. "visit"
  13042. ],
  13043. summary: "Fetch all non-retired attribute subresources",
  13044. operationId: "getAllVisitAttributes",
  13045. consumes: [
  13046. "application/json"
  13047. ],
  13048. produces: [
  13049. "application/json"
  13050. ],
  13051. parameters: [
  13052. {
  13053. name: "limit",
  13054. in: "query",
  13055. description: "The number of results to return",
  13056. required: false,
  13057. type: "integer"
  13058. },
  13059. {
  13060. name: "startIndex",
  13061. in: "query",
  13062. description: "The offset at which to start",
  13063. required: false,
  13064. type: "integer"
  13065. },
  13066. {
  13067. name: "parent-uuid",
  13068. in: "path",
  13069. description: "parent resource uuid",
  13070. required: true,
  13071. type: "string"
  13072. },
  13073. {
  13074. name: "v",
  13075. in: "query",
  13076. description: "The representation to return (ref, default, full or custom)",
  13077. required: false,
  13078. type: "string",
  13079. enum: [
  13080. "ref",
  13081. "default",
  13082. "full",
  13083. "custom"
  13084. ]
  13085. }
  13086. ],
  13087. responses: {
  13088. 200: {
  13089. description: "attribute response",
  13090. schema: {
  13091. type: "object",
  13092. properties: {
  13093. results: {
  13094. type: "array",
  13095. items: {
  13096. $ref: "#/definitions/VisitAttributeGet"
  13097. }
  13098. }
  13099. }
  13100. }
  13101. },
  13102. 401: {
  13103. description: "User not logged in"
  13104. }
  13105. }
  13106. },
  13107. post: {
  13108. tags: [
  13109. "visit"
  13110. ],
  13111. summary: "Create attribute subresource with properties in request",
  13112. operationId: "createVisitAttribute",
  13113. consumes: [
  13114. "application/json"
  13115. ],
  13116. produces: [
  13117. "application/json"
  13118. ],
  13119. parameters: [
  13120. {
  13121. name: "parent-uuid",
  13122. in: "path",
  13123. description: "parent resource uuid",
  13124. required: true,
  13125. type: "string"
  13126. },
  13127. {
  13128. in: "body",
  13129. name: "resource",
  13130. description: "Resource to create",
  13131. required: true,
  13132. schema: {
  13133. $ref: "#/definitions/VisitAttributeCreate"
  13134. }
  13135. }
  13136. ],
  13137. responses: {
  13138. 201: {
  13139. description: "attribute response"
  13140. },
  13141. 401: {
  13142. description: "User not logged in"
  13143. }
  13144. }
  13145. }
  13146. },
  13147. /visit/{parent-uuid}/attribute/{uuid}: {
  13148. get: {
  13149. tags: [
  13150. "visit"
  13151. ],
  13152. summary: "Fetch attribute subresources by uuid",
  13153. operationId: "getVisitAttribute",
  13154. consumes: [
  13155. "application/json"
  13156. ],
  13157. produces: [
  13158. "application/json"
  13159. ],
  13160. parameters: [
  13161. {
  13162. name: "parent-uuid",
  13163. in: "path",
  13164. description: "parent resource uuid",
  13165. required: true,
  13166. type: "string"
  13167. },
  13168. {
  13169. name: "uuid",
  13170. in: "path",
  13171. description: "uuid to filter by",
  13172. required: true,
  13173. type: "string"
  13174. },
  13175. {
  13176. name: "v",
  13177. in: "query",
  13178. description: "The representation to return (ref, default, full or custom)",
  13179. required: false,
  13180. type: "string",
  13181. enum: [
  13182. "ref",
  13183. "default",
  13184. "full",
  13185. "custom"
  13186. ]
  13187. }
  13188. ],
  13189. responses: {
  13190. 200: {
  13191. description: "attribute response",
  13192. schema: {
  13193. $ref: "#/definitions/VisitAttributeGet"
  13194. }
  13195. },
  13196. 401: {
  13197. description: "User not logged in"
  13198. },
  13199. 404: {
  13200. description: "Resource with given uuid doesn't exist"
  13201. }
  13202. }
  13203. },
  13204. post: {
  13205. tags: [
  13206. "visit"
  13207. ],
  13208. summary: "edit attribute subresource with given uuid, only modifying properties in request",
  13209. operationId: "updateVisitAttribute",
  13210. consumes: [
  13211. "application/json"
  13212. ],
  13213. produces: [
  13214. "application/json"
  13215. ],
  13216. parameters: [
  13217. {
  13218. name: "parent-uuid",
  13219. in: "path",
  13220. description: "parent resource uuid",
  13221. required: true,
  13222. type: "string"
  13223. },
  13224. {
  13225. name: "uuid",
  13226. in: "path",
  13227. description: "uuid of resource to update",
  13228. required: true,
  13229. type: "string"
  13230. },
  13231. {
  13232. in: "body",
  13233. name: "resource",
  13234. description: "Resource properties to update",
  13235. required: true,
  13236. schema: {
  13237. $ref: "#/definitions/VisitAttributeUpdate"
  13238. }
  13239. }
  13240. ],
  13241. responses: {
  13242. 201: {
  13243. description: "attribute response"
  13244. },
  13245. 401: {
  13246. description: "User not logged in"
  13247. }
  13248. }
  13249. },
  13250. delete: {
  13251. tags: [
  13252. "visit"
  13253. ],
  13254. summary: "Delete or purge resource by uuid",
  13255. description: "The resource will be voided/retired unless purge = 'true'",
  13256. operationId: "deleteVisitAttribute",
  13257. consumes: [
  13258. "application/json"
  13259. ],
  13260. produces: [
  13261. "application/json"
  13262. ],
  13263. parameters: [
  13264. {
  13265. name: "parent-uuid",
  13266. in: "path",
  13267. description: "parent resource uuid",
  13268. required: true,
  13269. type: "string"
  13270. },
  13271. {
  13272. name: "uuid",
  13273. in: "path",
  13274. description: "uuid to delete",
  13275. required: true,
  13276. type: "string"
  13277. },
  13278. {
  13279. name: "purge",
  13280. in: "query",
  13281. required: false,
  13282. type: "boolean"
  13283. }
  13284. ],
  13285. responses: {
  13286. 204: {
  13287. description: "Delete successful"
  13288. },
  13289. 401: {
  13290. description: "User not logged in"
  13291. },
  13292. 404: {
  13293. description: "Resource with given uuid doesn't exist"
  13294. }
  13295. }
  13296. }
  13297. },
  13298. /provider/{parent-uuid}/attribute: {
  13299. get: {
  13300. tags: [
  13301. "provider"
  13302. ],
  13303. summary: "Fetch all non-retired attribute subresources",
  13304. operationId: "getAllProviderAttributes",
  13305. consumes: [
  13306. "application/json"
  13307. ],
  13308. produces: [
  13309. "application/json"
  13310. ],
  13311. parameters: [
  13312. {
  13313. name: "limit",
  13314. in: "query",
  13315. description: "The number of results to return",
  13316. required: false,
  13317. type: "integer"
  13318. },
  13319. {
  13320. name: "startIndex",
  13321. in: "query",
  13322. description: "The offset at which to start",
  13323. required: false,
  13324. type: "integer"
  13325. },
  13326. {
  13327. name: "parent-uuid",
  13328. in: "path",
  13329. description: "parent resource uuid",
  13330. required: true,
  13331. type: "string"
  13332. },
  13333. {
  13334. name: "v",
  13335. in: "query",
  13336. description: "The representation to return (ref, default, full or custom)",
  13337. required: false,
  13338. type: "string",
  13339. enum: [
  13340. "ref",
  13341. "default",
  13342. "full",
  13343. "custom"
  13344. ]
  13345. }
  13346. ],
  13347. responses: {
  13348. 200: {
  13349. description: "attribute response",
  13350. schema: {
  13351. type: "object",
  13352. properties: {
  13353. results: {
  13354. type: "array",
  13355. items: {
  13356. $ref: "#/definitions/ProviderAttributeGet"
  13357. }
  13358. }
  13359. }
  13360. }
  13361. },
  13362. 401: {
  13363. description: "User not logged in"
  13364. }
  13365. }
  13366. },
  13367. post: {
  13368. tags: [
  13369. "provider"
  13370. ],
  13371. summary: "Create attribute subresource with properties in request",
  13372. operationId: "createProviderAttribute",
  13373. consumes: [
  13374. "application/json"
  13375. ],
  13376. produces: [
  13377. "application/json"
  13378. ],
  13379. parameters: [
  13380. {
  13381. name: "parent-uuid",
  13382. in: "path",
  13383. description: "parent resource uuid",
  13384. required: true,
  13385. type: "string"
  13386. },
  13387. {
  13388. in: "body",
  13389. name: "resource",
  13390. description: "Resource to create",
  13391. required: true,
  13392. schema: {
  13393. $ref: "#/definitions/ProviderAttributeCreate"
  13394. }
  13395. }
  13396. ],
  13397. responses: {
  13398. 201: {
  13399. description: "attribute response"
  13400. },
  13401. 401: {
  13402. description: "User not logged in"
  13403. }
  13404. }
  13405. }
  13406. },
  13407. /provider/{parent-uuid}/attribute/{uuid}: {
  13408. get: {
  13409. tags: [
  13410. "provider"
  13411. ],
  13412. summary: "Fetch attribute subresources by uuid",
  13413. operationId: "getProviderAttribute",
  13414. consumes: [
  13415. "application/json"
  13416. ],
  13417. produces: [
  13418. "application/json"
  13419. ],
  13420. parameters: [
  13421. {
  13422. name: "parent-uuid",
  13423. in: "path",
  13424. description: "parent resource uuid",
  13425. required: true,
  13426. type: "string"
  13427. },
  13428. {
  13429. name: "uuid",
  13430. in: "path",
  13431. description: "uuid to filter by",
  13432. required: true,
  13433. type: "string"
  13434. },
  13435. {
  13436. name: "v",
  13437. in: "query",
  13438. description: "The representation to return (ref, default, full or custom)",
  13439. required: false,
  13440. type: "string",
  13441. enum: [
  13442. "ref",
  13443. "default",
  13444. "full",
  13445. "custom"
  13446. ]
  13447. }
  13448. ],
  13449. responses: {
  13450. 200: {
  13451. description: "attribute response",
  13452. schema: {
  13453. $ref: "#/definitions/ProviderAttributeGet"
  13454. }
  13455. },
  13456. 401: {
  13457. description: "User not logged in"
  13458. },
  13459. 404: {
  13460. description: "Resource with given uuid doesn't exist"
  13461. }
  13462. }
  13463. },
  13464. post: {
  13465. tags: [
  13466. "provider"
  13467. ],
  13468. summary: "edit attribute subresource with given uuid, only modifying properties in request",
  13469. operationId: "updateProviderAttribute",
  13470. consumes: [
  13471. "application/json"
  13472. ],
  13473. produces: [
  13474. "application/json"
  13475. ],
  13476. parameters: [
  13477. {
  13478. name: "parent-uuid",
  13479. in: "path",
  13480. description: "parent resource uuid",
  13481. required: true,
  13482. type: "string"
  13483. },
  13484. {
  13485. name: "uuid",
  13486. in: "path",
  13487. description: "uuid of resource to update",
  13488. required: true,
  13489. type: "string"
  13490. },
  13491. {
  13492. in: "body",
  13493. name: "resource",
  13494. description: "Resource properties to update",
  13495. required: true,
  13496. schema: {
  13497. $ref: "#/definitions/ProviderAttributeUpdate"
  13498. }
  13499. }
  13500. ],
  13501. responses: {
  13502. 201: {
  13503. description: "attribute response"
  13504. },
  13505. 401: {
  13506. description: "User not logged in"
  13507. }
  13508. }
  13509. },
  13510. delete: {
  13511. tags: [
  13512. "provider"
  13513. ],
  13514. summary: "Delete or purge resource by uuid",
  13515. description: "The resource will be voided/retired unless purge = 'true'",
  13516. operationId: "deleteProviderAttribute",
  13517. consumes: [
  13518. "application/json"
  13519. ],
  13520. produces: [
  13521. "application/json"
  13522. ],
  13523. parameters: [
  13524. {
  13525. name: "parent-uuid",
  13526. in: "path",
  13527. description: "parent resource uuid",
  13528. required: true,
  13529. type: "string"
  13530. },
  13531. {
  13532. name: "uuid",
  13533. in: "path",
  13534. description: "uuid to delete",
  13535. required: true,
  13536. type: "string"
  13537. },
  13538. {
  13539. name: "purge",
  13540. in: "query",
  13541. required: false,
  13542. type: "boolean"
  13543. }
  13544. ],
  13545. responses: {
  13546. 204: {
  13547. description: "Delete successful"
  13548. },
  13549. 401: {
  13550. description: "User not logged in"
  13551. },
  13552. 404: {
  13553. description: "Resource with given uuid doesn't exist"
  13554. }
  13555. }
  13556. }
  13557. },
  13558. /field/{parent-uuid}/answer: {
  13559. get: {
  13560. tags: [
  13561. "field"
  13562. ],
  13563. summary: "Fetch all non-retired answer subresources",
  13564. operationId: "getAllFieldAnswers",
  13565. consumes: [
  13566. "application/json"
  13567. ],
  13568. produces: [
  13569. "application/json"
  13570. ],
  13571. parameters: [
  13572. {
  13573. name: "limit",
  13574. in: "query",
  13575. description: "The number of results to return",
  13576. required: false,
  13577. type: "integer"
  13578. },
  13579. {
  13580. name: "startIndex",
  13581. in: "query",
  13582. description: "The offset at which to start",
  13583. required: false,
  13584. type: "integer"
  13585. },
  13586. {
  13587. name: "parent-uuid",
  13588. in: "path",
  13589. description: "parent resource uuid",
  13590. required: true,
  13591. type: "string"
  13592. },
  13593. {
  13594. name: "v",
  13595. in: "query",
  13596. description: "The representation to return (ref, default, full or custom)",
  13597. required: false,
  13598. type: "string",
  13599. enum: [
  13600. "ref",
  13601. "default",
  13602. "full",
  13603. "custom"
  13604. ]
  13605. }
  13606. ],
  13607. responses: {
  13608. 200: {
  13609. description: "answer response",
  13610. schema: {
  13611. type: "object",
  13612. properties: {
  13613. results: {
  13614. type: "array",
  13615. items: {
  13616. $ref: "#/definitions/FieldAnswerGet"
  13617. }
  13618. }
  13619. }
  13620. }
  13621. },
  13622. 401: {
  13623. description: "User not logged in"
  13624. }
  13625. }
  13626. },
  13627. post: {
  13628. tags: [
  13629. "field"
  13630. ],
  13631. summary: "Create answer subresource with properties in request",
  13632. operationId: "createFieldAnswer",
  13633. consumes: [
  13634. "application/json"
  13635. ],
  13636. produces: [
  13637. "application/json"
  13638. ],
  13639. parameters: [
  13640. {
  13641. name: "parent-uuid",
  13642. in: "path",
  13643. description: "parent resource uuid",
  13644. required: true,
  13645. type: "string"
  13646. },
  13647. {
  13648. in: "body",
  13649. name: "resource",
  13650. description: "Resource to create",
  13651. required: true,
  13652. schema: {
  13653. $ref: "#/definitions/FieldAnswerCreate"
  13654. }
  13655. }
  13656. ],
  13657. responses: {
  13658. 201: {
  13659. description: "answer response"
  13660. },
  13661. 401: {
  13662. description: "User not logged in"
  13663. }
  13664. }
  13665. }
  13666. },
  13667. /field/{parent-uuid}/answer/{uuid}: {
  13668. get: {
  13669. tags: [
  13670. "field"
  13671. ],
  13672. summary: "Fetch answer subresources by uuid",
  13673. operationId: "getFieldAnswer",
  13674. consumes: [
  13675. "application/json"
  13676. ],
  13677. produces: [
  13678. "application/json"
  13679. ],
  13680. parameters: [
  13681. {
  13682. name: "parent-uuid",
  13683. in: "path",
  13684. description: "parent resource uuid",
  13685. required: true,
  13686. type: "string"
  13687. },
  13688. {
  13689. name: "uuid",
  13690. in: "path",
  13691. description: "uuid to filter by",
  13692. required: true,
  13693. type: "string"
  13694. },
  13695. {
  13696. name: "v",
  13697. in: "query",
  13698. description: "The representation to return (ref, default, full or custom)",
  13699. required: false,
  13700. type: "string",
  13701. enum: [
  13702. "ref",
  13703. "default",
  13704. "full",
  13705. "custom"
  13706. ]
  13707. }
  13708. ],
  13709. responses: {
  13710. 200: {
  13711. description: "answer response",
  13712. schema: {
  13713. $ref: "#/definitions/FieldAnswerGet"
  13714. }
  13715. },
  13716. 401: {
  13717. description: "User not logged in"
  13718. },
  13719. 404: {
  13720. description: "Resource with given uuid doesn't exist"
  13721. }
  13722. }
  13723. },
  13724. post: {
  13725. tags: [
  13726. "field"
  13727. ],
  13728. summary: "edit answer subresource with given uuid, only modifying properties in request",
  13729. operationId: "updateFieldAnswer",
  13730. consumes: [
  13731. "application/json"
  13732. ],
  13733. produces: [
  13734. "application/json"
  13735. ],
  13736. parameters: [
  13737. {
  13738. name: "parent-uuid",
  13739. in: "path",
  13740. description: "parent resource uuid",
  13741. required: true,
  13742. type: "string"
  13743. },
  13744. {
  13745. name: "uuid",
  13746. in: "path",
  13747. description: "uuid of resource to update",
  13748. required: true,
  13749. type: "string"
  13750. },
  13751. {
  13752. in: "body",
  13753. name: "resource",
  13754. description: "Resource properties to update",
  13755. required: true,
  13756. schema: {
  13757. $ref: "#/definitions/FieldAnswerUpdate"
  13758. }
  13759. }
  13760. ],
  13761. responses: {
  13762. 201: {
  13763. description: "answer response"
  13764. },
  13765. 401: {
  13766. description: "User not logged in"
  13767. }
  13768. }
  13769. },
  13770. delete: {
  13771. tags: [
  13772. "field"
  13773. ],
  13774. summary: "Delete or purge resource by uuid",
  13775. description: "The resource will be voided/retired unless purge = 'true'",
  13776. operationId: "deleteFieldAnswer",
  13777. consumes: [
  13778. "application/json"
  13779. ],
  13780. produces: [
  13781. "application/json"
  13782. ],
  13783. parameters: [
  13784. {
  13785. name: "parent-uuid",
  13786. in: "path",
  13787. description: "parent resource uuid",
  13788. required: true,
  13789. type: "string"
  13790. },
  13791. {
  13792. name: "uuid",
  13793. in: "path",
  13794. description: "uuid to delete",
  13795. required: true,
  13796. type: "string"
  13797. },
  13798. {
  13799. name: "purge",
  13800. in: "query",
  13801. required: false,
  13802. type: "boolean"
  13803. }
  13804. ],
  13805. responses: {
  13806. 204: {
  13807. description: "Delete successful"
  13808. },
  13809. 401: {
  13810. description: "User not logged in"
  13811. },
  13812. 404: {
  13813. description: "Resource with given uuid doesn't exist"
  13814. }
  13815. }
  13816. }
  13817. },
  13818. /person/{parent-uuid}/name: {
  13819. get: {
  13820. tags: [
  13821. "person"
  13822. ],
  13823. summary: "Fetch all non-retired name subresources",
  13824. operationId: "getAllPersonNames",
  13825. consumes: [
  13826. "application/json"
  13827. ],
  13828. produces: [
  13829. "application/json"
  13830. ],
  13831. parameters: [
  13832. {
  13833. name: "limit",
  13834. in: "query",
  13835. description: "The number of results to return",
  13836. required: false,
  13837. type: "integer"
  13838. },
  13839. {
  13840. name: "startIndex",
  13841. in: "query",
  13842. description: "The offset at which to start",
  13843. required: false,
  13844. type: "integer"
  13845. },
  13846. {
  13847. name: "parent-uuid",
  13848. in: "path",
  13849. description: "parent resource uuid",
  13850. required: true,
  13851. type: "string"
  13852. },
  13853. {
  13854. name: "v",
  13855. in: "query",
  13856. description: "The representation to return (ref, default, full or custom)",
  13857. required: false,
  13858. type: "string",
  13859. enum: [
  13860. "ref",
  13861. "default",
  13862. "full",
  13863. "custom"
  13864. ]
  13865. }
  13866. ],
  13867. responses: {
  13868. 200: {
  13869. description: "name response",
  13870. schema: {
  13871. type: "object",
  13872. properties: {
  13873. results: {
  13874. type: "array",
  13875. items: {
  13876. $ref: "#/definitions/PersonNameGet"
  13877. }
  13878. }
  13879. }
  13880. }
  13881. },
  13882. 401: {
  13883. description: "User not logged in"
  13884. }
  13885. }
  13886. },
  13887. post: {
  13888. tags: [
  13889. "person"
  13890. ],
  13891. summary: "Create name subresource with properties in request",
  13892. operationId: "createPersonName",
  13893. consumes: [
  13894. "application/json"
  13895. ],
  13896. produces: [
  13897. "application/json"
  13898. ],
  13899. parameters: [
  13900. {
  13901. name: "parent-uuid",
  13902. in: "path",
  13903. description: "parent resource uuid",
  13904. required: true,
  13905. type: "string"
  13906. },
  13907. {
  13908. in: "body",
  13909. name: "resource",
  13910. description: "Resource to create",
  13911. required: true,
  13912. schema: {
  13913. $ref: "#/definitions/PersonNameCreate"
  13914. }
  13915. }
  13916. ],
  13917. responses: {
  13918. 201: {
  13919. description: "name response"
  13920. },
  13921. 401: {
  13922. description: "User not logged in"
  13923. }
  13924. }
  13925. }
  13926. },
  13927. /person/{parent-uuid}/name/{uuid}: {
  13928. get: {
  13929. tags: [
  13930. "person"
  13931. ],
  13932. summary: "Fetch name subresources by uuid",
  13933. operationId: "getPersonName",
  13934. consumes: [
  13935. "application/json"
  13936. ],
  13937. produces: [
  13938. "application/json"
  13939. ],
  13940. parameters: [
  13941. {
  13942. name: "parent-uuid",
  13943. in: "path",
  13944. description: "parent resource uuid",
  13945. required: true,
  13946. type: "string"
  13947. },
  13948. {
  13949. name: "uuid",
  13950. in: "path",
  13951. description: "uuid to filter by",
  13952. required: true,
  13953. type: "string"
  13954. },
  13955. {
  13956. name: "v",
  13957. in: "query",
  13958. description: "The representation to return (ref, default, full or custom)",
  13959. required: false,
  13960. type: "string",
  13961. enum: [
  13962. "ref",
  13963. "default",
  13964. "full",
  13965. "custom"
  13966. ]
  13967. }
  13968. ],
  13969. responses: {
  13970. 200: {
  13971. description: "name response",
  13972. schema: {
  13973. $ref: "#/definitions/PersonNameGet"
  13974. }
  13975. },
  13976. 401: {
  13977. description: "User not logged in"
  13978. },
  13979. 404: {
  13980. description: "Resource with given uuid doesn't exist"
  13981. }
  13982. }
  13983. },
  13984. post: {
  13985. tags: [
  13986. "person"
  13987. ],
  13988. summary: "edit name subresource with given uuid, only modifying properties in request",
  13989. operationId: "updatePersonName",
  13990. consumes: [
  13991. "application/json"
  13992. ],
  13993. produces: [
  13994. "application/json"
  13995. ],
  13996. parameters: [
  13997. {
  13998. name: "parent-uuid",
  13999. in: "path",
  14000. description: "parent resource uuid",
  14001. required: true,
  14002. type: "string"
  14003. },
  14004. {
  14005. name: "uuid",
  14006. in: "path",
  14007. description: "uuid of resource to update",
  14008. required: true,
  14009. type: "string"
  14010. },
  14011. {
  14012. in: "body",
  14013. name: "resource",
  14014. description: "Resource properties to update",
  14015. required: true,
  14016. schema: {
  14017. $ref: "#/definitions/PersonNameUpdate"
  14018. }
  14019. }
  14020. ],
  14021. responses: {
  14022. 201: {
  14023. description: "name response"
  14024. },
  14025. 401: {
  14026. description: "User not logged in"
  14027. }
  14028. }
  14029. },
  14030. delete: {
  14031. tags: [
  14032. "person"
  14033. ],
  14034. summary: "Delete or purge resource by uuid",
  14035. description: "The resource will be voided/retired unless purge = 'true'",
  14036. operationId: "deletePersonName",
  14037. consumes: [
  14038. "application/json"
  14039. ],
  14040. produces: [
  14041. "application/json"
  14042. ],
  14043. parameters: [
  14044. {
  14045. name: "parent-uuid",
  14046. in: "path",
  14047. description: "parent resource uuid",
  14048. required: true,
  14049. type: "string"
  14050. },
  14051. {
  14052. name: "uuid",
  14053. in: "path",
  14054. description: "uuid to delete",
  14055. required: true,
  14056. type: "string"
  14057. },
  14058. {
  14059. name: "purge",
  14060. in: "query",
  14061. required: false,
  14062. type: "boolean"
  14063. }
  14064. ],
  14065. responses: {
  14066. 204: {
  14067. description: "Delete successful"
  14068. },
  14069. 401: {
  14070. description: "User not logged in"
  14071. },
  14072. 404: {
  14073. description: "Resource with given uuid doesn't exist"
  14074. }
  14075. }
  14076. }
  14077. },
  14078. /cohort/{parent-uuid}/membership: {
  14079. get: {
  14080. tags: [
  14081. "cohort"
  14082. ],
  14083. summary: "Fetch all non-retired membership subresources",
  14084. operationId: "getAllCohortMemberships",
  14085. consumes: [
  14086. "application/json"
  14087. ],
  14088. produces: [
  14089. "application/json"
  14090. ],
  14091. parameters: [
  14092. {
  14093. name: "limit",
  14094. in: "query",
  14095. description: "The number of results to return",
  14096. required: false,
  14097. type: "integer"
  14098. },
  14099. {
  14100. name: "startIndex",
  14101. in: "query",
  14102. description: "The offset at which to start",
  14103. required: false,
  14104. type: "integer"
  14105. },
  14106. {
  14107. name: "parent-uuid",
  14108. in: "path",
  14109. description: "parent resource uuid",
  14110. required: true,
  14111. type: "string"
  14112. },
  14113. {
  14114. name: "v",
  14115. in: "query",
  14116. description: "The representation to return (ref, default, full or custom)",
  14117. required: false,
  14118. type: "string",
  14119. enum: [
  14120. "ref",
  14121. "default",
  14122. "full",
  14123. "custom"
  14124. ]
  14125. }
  14126. ],
  14127. responses: {
  14128. 200: {
  14129. description: "membership response",
  14130. schema: {
  14131. type: "object",
  14132. properties: {
  14133. results: {
  14134. type: "array",
  14135. items: {
  14136. $ref: "#/definitions/CohortMembershipGet"
  14137. }
  14138. }
  14139. }
  14140. }
  14141. },
  14142. 401: {
  14143. description: "User not logged in"
  14144. }
  14145. }
  14146. },
  14147. post: {
  14148. tags: [
  14149. "cohort"
  14150. ],
  14151. summary: "Create membership subresource with properties in request",
  14152. operationId: "createCohortMembership",
  14153. consumes: [
  14154. "application/json"
  14155. ],
  14156. produces: [
  14157. "application/json"
  14158. ],
  14159. parameters: [
  14160. {
  14161. name: "parent-uuid",
  14162. in: "path",
  14163. description: "parent resource uuid",
  14164. required: true,
  14165. type: "string"
  14166. },
  14167. {
  14168. in: "body",
  14169. name: "resource",
  14170. description: "Resource to create",
  14171. required: true,
  14172. schema: {
  14173. $ref: "#/definitions/CohortMembershipCreate"
  14174. }
  14175. }
  14176. ],
  14177. responses: {
  14178. 201: {
  14179. description: "membership response"
  14180. },
  14181. 401: {
  14182. description: "User not logged in"
  14183. }
  14184. }
  14185. }
  14186. },
  14187. /cohort/{parent-uuid}/membership/{uuid}: {
  14188. get: {
  14189. tags: [
  14190. "cohort"
  14191. ],
  14192. summary: "Fetch membership subresources by uuid",
  14193. operationId: "getCohortMembership",
  14194. consumes: [
  14195. "application/json"
  14196. ],
  14197. produces: [
  14198. "application/json"
  14199. ],
  14200. parameters: [
  14201. {
  14202. name: "parent-uuid",
  14203. in: "path",
  14204. description: "parent resource uuid",
  14205. required: true,
  14206. type: "string"
  14207. },
  14208. {
  14209. name: "uuid",
  14210. in: "path",
  14211. description: "uuid to filter by",
  14212. required: true,
  14213. type: "string"
  14214. },
  14215. {
  14216. name: "v",
  14217. in: "query",
  14218. description: "The representation to return (ref, default, full or custom)",
  14219. required: false,
  14220. type: "string",
  14221. enum: [
  14222. "ref",
  14223. "default",
  14224. "full",
  14225. "custom"
  14226. ]
  14227. }
  14228. ],
  14229. responses: {
  14230. 200: {
  14231. description: "membership response",
  14232. schema: {
  14233. $ref: "#/definitions/CohortMembershipGet"
  14234. }
  14235. },
  14236. 401: {
  14237. description: "User not logged in"
  14238. },
  14239. 404: {
  14240. description: "Resource with given uuid doesn't exist"
  14241. }
  14242. }
  14243. },
  14244. post: {
  14245. tags: [
  14246. "cohort"
  14247. ],
  14248. summary: "edit membership subresource with given uuid, only modifying properties in request",
  14249. operationId: "updateCohortMembership",
  14250. consumes: [
  14251. "application/json"
  14252. ],
  14253. produces: [
  14254. "application/json"
  14255. ],
  14256. parameters: [
  14257. {
  14258. name: "parent-uuid",
  14259. in: "path",
  14260. description: "parent resource uuid",
  14261. required: true,
  14262. type: "string"
  14263. },
  14264. {
  14265. name: "uuid",
  14266. in: "path",
  14267. description: "uuid of resource to update",
  14268. required: true,
  14269. type: "string"
  14270. },
  14271. {
  14272. in: "body",
  14273. name: "resource",
  14274. description: "Resource properties to update",
  14275. required: true,
  14276. schema: {
  14277. $ref: "#/definitions/CohortMembershipUpdate"
  14278. }
  14279. }
  14280. ],
  14281. responses: {
  14282. 201: {
  14283. description: "membership response"
  14284. },
  14285. 401: {
  14286. description: "User not logged in"
  14287. }
  14288. }
  14289. },
  14290. delete: {
  14291. tags: [
  14292. "cohort"
  14293. ],
  14294. summary: "Delete or purge resource by uuid",
  14295. description: "The resource will be voided/retired unless purge = 'true'",
  14296. operationId: "deleteCohortMembership",
  14297. consumes: [
  14298. "application/json"
  14299. ],
  14300. produces: [
  14301. "application/json"
  14302. ],
  14303. parameters: [
  14304. {
  14305. name: "parent-uuid",
  14306. in: "path",
  14307. description: "parent resource uuid",
  14308. required: true,
  14309. type: "string"
  14310. },
  14311. {
  14312. name: "uuid",
  14313. in: "path",
  14314. description: "uuid to delete",
  14315. required: true,
  14316. type: "string"
  14317. },
  14318. {
  14319. name: "purge",
  14320. in: "query",
  14321. required: false,
  14322. type: "boolean"
  14323. }
  14324. ],
  14325. responses: {
  14326. 204: {
  14327. description: "Delete successful"
  14328. },
  14329. 401: {
  14330. description: "User not logged in"
  14331. },
  14332. 404: {
  14333. description: "Resource with given uuid doesn't exist"
  14334. }
  14335. }
  14336. }
  14337. },
  14338. /person/{parent-uuid}/address: {
  14339. get: {
  14340. tags: [
  14341. "person"
  14342. ],
  14343. summary: "Fetch all non-retired address subresources",
  14344. operationId: "getAllPersonAddresses",
  14345. consumes: [
  14346. "application/json"
  14347. ],
  14348. produces: [
  14349. "application/json"
  14350. ],
  14351. parameters: [
  14352. {
  14353. name: "limit",
  14354. in: "query",
  14355. description: "The number of results to return",
  14356. required: false,
  14357. type: "integer"
  14358. },
  14359. {
  14360. name: "startIndex",
  14361. in: "query",
  14362. description: "The offset at which to start",
  14363. required: false,
  14364. type: "integer"
  14365. },
  14366. {
  14367. name: "parent-uuid",
  14368. in: "path",
  14369. description: "parent resource uuid",
  14370. required: true,
  14371. type: "string"
  14372. },
  14373. {
  14374. name: "v",
  14375. in: "query",
  14376. description: "The representation to return (ref, default, full or custom)",
  14377. required: false,
  14378. type: "string",
  14379. enum: [
  14380. "ref",
  14381. "default",
  14382. "full",
  14383. "custom"
  14384. ]
  14385. }
  14386. ],
  14387. responses: {
  14388. 200: {
  14389. description: "address response",
  14390. schema: {
  14391. type: "object",
  14392. properties: {
  14393. results: {
  14394. type: "array",
  14395. items: {
  14396. $ref: "#/definitions/PersonAddressGet"
  14397. }
  14398. }
  14399. }
  14400. }
  14401. },
  14402. 401: {
  14403. description: "User not logged in"
  14404. }
  14405. }
  14406. },
  14407. post: {
  14408. tags: [
  14409. "person"
  14410. ],
  14411. summary: "Create address subresource with properties in request",
  14412. operationId: "createPersonAddress",
  14413. consumes: [
  14414. "application/json"
  14415. ],
  14416. produces: [
  14417. "application/json"
  14418. ],
  14419. parameters: [
  14420. {
  14421. name: "parent-uuid",
  14422. in: "path",
  14423. description: "parent resource uuid",
  14424. required: true,
  14425. type: "string"
  14426. },
  14427. {
  14428. in: "body",
  14429. name: "resource",
  14430. description: "Resource to create",
  14431. required: true,
  14432. schema: {
  14433. $ref: "#/definitions/PersonAddressCreate"
  14434. }
  14435. }
  14436. ],
  14437. responses: {
  14438. 201: {
  14439. description: "address response"
  14440. },
  14441. 401: {
  14442. description: "User not logged in"
  14443. }
  14444. }
  14445. }
  14446. },
  14447. /person/{parent-uuid}/address/{uuid}: {
  14448. get: {
  14449. tags: [
  14450. "person"
  14451. ],
  14452. summary: "Fetch address subresources by uuid",
  14453. operationId: "getPersonAddress",
  14454. consumes: [
  14455. "application/json"
  14456. ],
  14457. produces: [
  14458. "application/json"
  14459. ],
  14460. parameters: [
  14461. {
  14462. name: "parent-uuid",
  14463. in: "path",
  14464. description: "parent resource uuid",
  14465. required: true,
  14466. type: "string"
  14467. },
  14468. {
  14469. name: "uuid",
  14470. in: "path",
  14471. description: "uuid to filter by",
  14472. required: true,
  14473. type: "string"
  14474. },
  14475. {
  14476. name: "v",
  14477. in: "query",
  14478. description: "The representation to return (ref, default, full or custom)",
  14479. required: false,
  14480. type: "string",
  14481. enum: [
  14482. "ref",
  14483. "default",
  14484. "full",
  14485. "custom"
  14486. ]
  14487. }
  14488. ],
  14489. responses: {
  14490. 200: {
  14491. description: "address response",
  14492. schema: {
  14493. $ref: "#/definitions/PersonAddressGet"
  14494. }
  14495. },
  14496. 401: {
  14497. description: "User not logged in"
  14498. },
  14499. 404: {
  14500. description: "Resource with given uuid doesn't exist"
  14501. }
  14502. }
  14503. },
  14504. post: {
  14505. tags: [
  14506. "person"
  14507. ],
  14508. summary: "edit address subresource with given uuid, only modifying properties in request",
  14509. operationId: "updatePersonAddress",
  14510. consumes: [
  14511. "application/json"
  14512. ],
  14513. produces: [
  14514. "application/json"
  14515. ],
  14516. parameters: [
  14517. {
  14518. name: "parent-uuid",
  14519. in: "path",
  14520. description: "parent resource uuid",
  14521. required: true,
  14522. type: "string"
  14523. },
  14524. {
  14525. name: "uuid",
  14526. in: "path",
  14527. description: "uuid of resource to update",
  14528. required: true,
  14529. type: "string"
  14530. },
  14531. {
  14532. in: "body",
  14533. name: "resource",
  14534. description: "Resource properties to update",
  14535. required: true,
  14536. schema: {
  14537. $ref: "#/definitions/PersonAddressUpdate"
  14538. }
  14539. }
  14540. ],
  14541. responses: {
  14542. 201: {
  14543. description: "address response"
  14544. },
  14545. 401: {
  14546. description: "User not logged in"
  14547. }
  14548. }
  14549. },
  14550. delete: {
  14551. tags: [
  14552. "person"
  14553. ],
  14554. summary: "Delete or purge resource by uuid",
  14555. description: "The resource will be voided/retired unless purge = 'true'",
  14556. operationId: "deletePersonAddress",
  14557. consumes: [
  14558. "application/json"
  14559. ],
  14560. produces: [
  14561. "application/json"
  14562. ],
  14563. parameters: [
  14564. {
  14565. name: "parent-uuid",
  14566. in: "path",
  14567. description: "parent resource uuid",
  14568. required: true,
  14569. type: "string"
  14570. },
  14571. {
  14572. name: "uuid",
  14573. in: "path",
  14574. description: "uuid to delete",
  14575. required: true,
  14576. type: "string"
  14577. },
  14578. {
  14579. name: "purge",
  14580. in: "query",
  14581. required: false,
  14582. type: "boolean"
  14583. }
  14584. ],
  14585. responses: {
  14586. 204: {
  14587. description: "Delete successful"
  14588. },
  14589. 401: {
  14590. description: "User not logged in"
  14591. },
  14592. 404: {
  14593. description: "Resource with given uuid doesn't exist"
  14594. }
  14595. }
  14596. }
  14597. },
  14598. /programenrollment/{parent-uuid}/attribute: {
  14599. get: {
  14600. tags: [
  14601. "programenrollment"
  14602. ],
  14603. summary: "Fetch all non-retired attribute subresources",
  14604. operationId: "getAllPatientProgramAttributes",
  14605. consumes: [
  14606. "application/json"
  14607. ],
  14608. produces: [
  14609. "application/json"
  14610. ],
  14611. parameters: [
  14612. {
  14613. name: "limit",
  14614. in: "query",
  14615. description: "The number of results to return",
  14616. required: false,
  14617. type: "integer"
  14618. },
  14619. {
  14620. name: "startIndex",
  14621. in: "query",
  14622. description: "The offset at which to start",
  14623. required: false,
  14624. type: "integer"
  14625. },
  14626. {
  14627. name: "parent-uuid",
  14628. in: "path",
  14629. description: "parent resource uuid",
  14630. required: true,
  14631. type: "string"
  14632. },
  14633. {
  14634. name: "v",
  14635. in: "query",
  14636. description: "The representation to return (ref, default, full or custom)",
  14637. required: false,
  14638. type: "string",
  14639. enum: [
  14640. "ref",
  14641. "default",
  14642. "full",
  14643. "custom"
  14644. ]
  14645. }
  14646. ],
  14647. responses: {
  14648. 200: {
  14649. description: "attribute response",
  14650. schema: {
  14651. type: "object",
  14652. properties: {
  14653. results: {
  14654. type: "array",
  14655. items: {
  14656. $ref: "#/definitions/ProgramenrollmentAttributeGet"
  14657. }
  14658. }
  14659. }
  14660. }
  14661. },
  14662. 401: {
  14663. description: "User not logged in"
  14664. }
  14665. }
  14666. },
  14667. post: {
  14668. tags: [
  14669. "programenrollment"
  14670. ],
  14671. summary: "Create attribute subresource with properties in request",
  14672. operationId: "createPatientProgramAttribute",
  14673. consumes: [
  14674. "application/json"
  14675. ],
  14676. produces: [
  14677. "application/json"
  14678. ],
  14679. parameters: [
  14680. {
  14681. name: "parent-uuid",
  14682. in: "path",
  14683. description: "parent resource uuid",
  14684. required: true,
  14685. type: "string"
  14686. },
  14687. {
  14688. in: "body",
  14689. name: "resource",
  14690. description: "Resource to create",
  14691. required: true,
  14692. schema: {
  14693. $ref: "#/definitions/ProgramenrollmentAttributeCreate"
  14694. }
  14695. }
  14696. ],
  14697. responses: {
  14698. 201: {
  14699. description: "attribute response"
  14700. },
  14701. 401: {
  14702. description: "User not logged in"
  14703. }
  14704. }
  14705. }
  14706. },
  14707. /programenrollment/{parent-uuid}/attribute/{uuid}: {
  14708. get: {
  14709. tags: [
  14710. "programenrollment"
  14711. ],
  14712. summary: "Fetch attribute subresources by uuid",
  14713. operationId: "getPatientProgramAttribute",
  14714. consumes: [
  14715. "application/json"
  14716. ],
  14717. produces: [
  14718. "application/json"
  14719. ],
  14720. parameters: [
  14721. {
  14722. name: "parent-uuid",
  14723. in: "path",
  14724. description: "parent resource uuid",
  14725. required: true,
  14726. type: "string"
  14727. },
  14728. {
  14729. name: "uuid",
  14730. in: "path",
  14731. description: "uuid to filter by",
  14732. required: true,
  14733. type: "string"
  14734. },
  14735. {
  14736. name: "v",
  14737. in: "query",
  14738. description: "The representation to return (ref, default, full or custom)",
  14739. required: false,
  14740. type: "string",
  14741. enum: [
  14742. "ref",
  14743. "default",
  14744. "full",
  14745. "custom"
  14746. ]
  14747. }
  14748. ],
  14749. responses: {
  14750. 200: {
  14751. description: "attribute response",
  14752. schema: {
  14753. $ref: "#/definitions/ProgramenrollmentAttributeGet"
  14754. }
  14755. },
  14756. 401: {
  14757. description: "User not logged in"
  14758. },
  14759. 404: {
  14760. description: "Resource with given uuid doesn't exist"
  14761. }
  14762. }
  14763. },
  14764. post: {
  14765. tags: [
  14766. "programenrollment"
  14767. ],
  14768. summary: "edit attribute subresource with given uuid, only modifying properties in request",
  14769. operationId: "updatePatientProgramAttribute",
  14770. consumes: [
  14771. "application/json"
  14772. ],
  14773. produces: [
  14774. "application/json"
  14775. ],
  14776. parameters: [
  14777. {
  14778. name: "parent-uuid",
  14779. in: "path",
  14780. description: "parent resource uuid",
  14781. required: true,
  14782. type: "string"
  14783. },
  14784. {
  14785. name: "uuid",
  14786. in: "path",
  14787. description: "uuid of resource to update",
  14788. required: true,
  14789. type: "string"
  14790. },
  14791. {
  14792. in: "body",
  14793. name: "resource",
  14794. description: "Resource properties to update",
  14795. required: true,
  14796. schema: {
  14797. $ref: "#/definitions/ProgramenrollmentAttributeUpdate"
  14798. }
  14799. }
  14800. ],
  14801. responses: {
  14802. 201: {
  14803. description: "attribute response"
  14804. },
  14805. 401: {
  14806. description: "User not logged in"
  14807. }
  14808. }
  14809. },
  14810. delete: {
  14811. tags: [
  14812. "programenrollment"
  14813. ],
  14814. summary: "Delete or purge resource by uuid",
  14815. description: "The resource will be voided/retired unless purge = 'true'",
  14816. operationId: "deletePatientProgramAttribute",
  14817. consumes: [
  14818. "application/json"
  14819. ],
  14820. produces: [
  14821. "application/json"
  14822. ],
  14823. parameters: [
  14824. {
  14825. name: "parent-uuid",
  14826. in: "path",
  14827. description: "parent resource uuid",
  14828. required: true,
  14829. type: "string"
  14830. },
  14831. {
  14832. name: "uuid",
  14833. in: "path",
  14834. description: "uuid to delete",
  14835. required: true,
  14836. type: "string"
  14837. },
  14838. {
  14839. name: "purge",
  14840. in: "query",
  14841. required: false,
  14842. type: "boolean"
  14843. }
  14844. ],
  14845. responses: {
  14846. 204: {
  14847. description: "Delete successful"
  14848. },
  14849. 401: {
  14850. description: "User not logged in"
  14851. },
  14852. 404: {
  14853. description: "Resource with given uuid doesn't exist"
  14854. }
  14855. }
  14856. }
  14857. },
  14858. /concept/{parent-uuid}/description: {
  14859. get: {
  14860. tags: [
  14861. "concept"
  14862. ],
  14863. summary: "Fetch all non-retired description subresources",
  14864. operationId: "getAllConceptDescriptions",
  14865. consumes: [
  14866. "application/json"
  14867. ],
  14868. produces: [
  14869. "application/json"
  14870. ],
  14871. parameters: [
  14872. {
  14873. name: "limit",
  14874. in: "query",
  14875. description: "The number of results to return",
  14876. required: false,
  14877. type: "integer"
  14878. },
  14879. {
  14880. name: "startIndex",
  14881. in: "query",
  14882. description: "The offset at which to start",
  14883. required: false,
  14884. type: "integer"
  14885. },
  14886. {
  14887. name: "parent-uuid",
  14888. in: "path",
  14889. description: "parent resource uuid",
  14890. required: true,
  14891. type: "string"
  14892. },
  14893. {
  14894. name: "v",
  14895. in: "query",
  14896. description: "The representation to return (ref, default, full or custom)",
  14897. required: false,
  14898. type: "string",
  14899. enum: [
  14900. "ref",
  14901. "default",
  14902. "full",
  14903. "custom"
  14904. ]
  14905. }
  14906. ],
  14907. responses: {
  14908. 200: {
  14909. description: "description response",
  14910. schema: {
  14911. type: "object",
  14912. properties: {
  14913. results: {
  14914. type: "array",
  14915. items: {
  14916. $ref: "#/definitions/ConceptDescriptionGet"
  14917. }
  14918. }
  14919. }
  14920. }
  14921. },
  14922. 401: {
  14923. description: "User not logged in"
  14924. }
  14925. }
  14926. },
  14927. post: {
  14928. tags: [
  14929. "concept"
  14930. ],
  14931. summary: "Create description subresource with properties in request",
  14932. operationId: "createConceptDescription",
  14933. consumes: [
  14934. "application/json"
  14935. ],
  14936. produces: [
  14937. "application/json"
  14938. ],
  14939. parameters: [
  14940. {
  14941. name: "parent-uuid",
  14942. in: "path",
  14943. description: "parent resource uuid",
  14944. required: true,
  14945. type: "string"
  14946. },
  14947. {
  14948. in: "body",
  14949. name: "resource",
  14950. description: "Resource to create",
  14951. required: true,
  14952. schema: {
  14953. $ref: "#/definitions/ConceptDescriptionCreate"
  14954. }
  14955. }
  14956. ],
  14957. responses: {
  14958. 201: {
  14959. description: "description response"
  14960. },
  14961. 401: {
  14962. description: "User not logged in"
  14963. }
  14964. }
  14965. }
  14966. },
  14967. /concept/{parent-uuid}/description/{uuid}: {
  14968. get: {
  14969. tags: [
  14970. "concept"
  14971. ],
  14972. summary: "Fetch description subresources by uuid",
  14973. operationId: "getConceptDescription",
  14974. consumes: [
  14975. "application/json"
  14976. ],
  14977. produces: [
  14978. "application/json"
  14979. ],
  14980. parameters: [
  14981. {
  14982. name: "parent-uuid",
  14983. in: "path",
  14984. description: "parent resource uuid",
  14985. required: true,
  14986. type: "string"
  14987. },
  14988. {
  14989. name: "uuid",
  14990. in: "path",
  14991. description: "uuid to filter by",
  14992. required: true,
  14993. type: "string"
  14994. },
  14995. {
  14996. name: "v",
  14997. in: "query",
  14998. description: "The representation to return (ref, default, full or custom)",
  14999. required: false,
  15000. type: "string",
  15001. enum: [
  15002. "ref",
  15003. "default",
  15004. "full",
  15005. "custom"
  15006. ]
  15007. }
  15008. ],
  15009. responses: {
  15010. 200: {
  15011. description: "description response",
  15012. schema: {
  15013. $ref: "#/definitions/ConceptDescriptionGet"
  15014. }
  15015. },
  15016. 401: {
  15017. description: "User not logged in"
  15018. },
  15019. 404: {
  15020. description: "Resource with given uuid doesn't exist"
  15021. }
  15022. }
  15023. },
  15024. post: {
  15025. tags: [
  15026. "concept"
  15027. ],
  15028. summary: "edit description subresource with given uuid, only modifying properties in request",
  15029. operationId: "updateConceptDescription",
  15030. consumes: [
  15031. "application/json"
  15032. ],
  15033. produces: [
  15034. "application/json"
  15035. ],
  15036. parameters: [
  15037. {
  15038. name: "parent-uuid",
  15039. in: "path",
  15040. description: "parent resource uuid",
  15041. required: true,
  15042. type: "string"
  15043. },
  15044. {
  15045. name: "uuid",
  15046. in: "path",
  15047. description: "uuid of resource to update",
  15048. required: true,
  15049. type: "string"
  15050. },
  15051. {
  15052. in: "body",
  15053. name: "resource",
  15054. description: "Resource properties to update",
  15055. required: true,
  15056. schema: {
  15057. $ref: "#/definitions/ConceptDescriptionUpdate"
  15058. }
  15059. }
  15060. ],
  15061. responses: {
  15062. 201: {
  15063. description: "description response"
  15064. },
  15065. 401: {
  15066. description: "User not logged in"
  15067. }
  15068. }
  15069. },
  15070. delete: {
  15071. tags: [
  15072. "concept"
  15073. ],
  15074. summary: "Delete or purge resource by uuid",
  15075. description: "The resource will be voided/retired unless purge = 'true'",
  15076. operationId: "deleteConceptDescription",
  15077. consumes: [
  15078. "application/json"
  15079. ],
  15080. produces: [
  15081. "application/json"
  15082. ],
  15083. parameters: [
  15084. {
  15085. name: "parent-uuid",
  15086. in: "path",
  15087. description: "parent resource uuid",
  15088. required: true,
  15089. type: "string"
  15090. },
  15091. {
  15092. name: "uuid",
  15093. in: "path",
  15094. description: "uuid to delete",
  15095. required: true,
  15096. type: "string"
  15097. },
  15098. {
  15099. name: "purge",
  15100. in: "query",
  15101. required: false,
  15102. type: "boolean"
  15103. }
  15104. ],
  15105. responses: {
  15106. 204: {
  15107. description: "Delete successful"
  15108. },
  15109. 401: {
  15110. description: "User not logged in"
  15111. },
  15112. 404: {
  15113. description: "Resource with given uuid doesn't exist"
  15114. }
  15115. }
  15116. }
  15117. },
  15118. /encounter/{parent-uuid}/encounterprovider: {
  15119. get: {
  15120. tags: [
  15121. "encounter"
  15122. ],
  15123. summary: "Fetch all non-retired encounterprovider subresources",
  15124. operationId: "getAllEncounterProviders",
  15125. consumes: [
  15126. "application/json"
  15127. ],
  15128. produces: [
  15129. "application/json"
  15130. ],
  15131. parameters: [
  15132. {
  15133. name: "limit",
  15134. in: "query",
  15135. description: "The number of results to return",
  15136. required: false,
  15137. type: "integer"
  15138. },
  15139. {
  15140. name: "startIndex",
  15141. in: "query",
  15142. description: "The offset at which to start",
  15143. required: false,
  15144. type: "integer"
  15145. },
  15146. {
  15147. name: "parent-uuid",
  15148. in: "path",
  15149. description: "parent resource uuid",
  15150. required: true,
  15151. type: "string"
  15152. },
  15153. {
  15154. name: "v",
  15155. in: "query",
  15156. description: "The representation to return (ref, default, full or custom)",
  15157. required: false,
  15158. type: "string",
  15159. enum: [
  15160. "ref",
  15161. "default",
  15162. "full",
  15163. "custom"
  15164. ]
  15165. }
  15166. ],
  15167. responses: {
  15168. 200: {
  15169. description: "encounterprovider response",
  15170. schema: {
  15171. type: "object",
  15172. properties: {
  15173. results: {
  15174. type: "array",
  15175. items: {
  15176. $ref: "#/definitions/EncounterEncounterproviderGet"
  15177. }
  15178. }
  15179. }
  15180. }
  15181. },
  15182. 401: {
  15183. description: "User not logged in"
  15184. }
  15185. }
  15186. },
  15187. post: {
  15188. tags: [
  15189. "encounter"
  15190. ],
  15191. summary: "Create encounterprovider subresource with properties in request",
  15192. operationId: "createEncounterProvider",
  15193. consumes: [
  15194. "application/json"
  15195. ],
  15196. produces: [
  15197. "application/json"
  15198. ],
  15199. parameters: [
  15200. {
  15201. name: "parent-uuid",
  15202. in: "path",
  15203. description: "parent resource uuid",
  15204. required: true,
  15205. type: "string"
  15206. },
  15207. {
  15208. in: "body",
  15209. name: "resource",
  15210. description: "Resource to create",
  15211. required: true,
  15212. schema: {
  15213. $ref: "#/definitions/EncounterEncounterproviderCreate"
  15214. }
  15215. }
  15216. ],
  15217. responses: {
  15218. 201: {
  15219. description: "encounterprovider response"
  15220. },
  15221. 401: {
  15222. description: "User not logged in"
  15223. }
  15224. }
  15225. }
  15226. },
  15227. /encounter/{parent-uuid}/encounterprovider/{uuid}: {
  15228. get: {
  15229. tags: [
  15230. "encounter"
  15231. ],
  15232. summary: "Fetch encounterprovider subresources by uuid",
  15233. operationId: "getEncounterProvider",
  15234. consumes: [
  15235. "application/json"
  15236. ],
  15237. produces: [
  15238. "application/json"
  15239. ],
  15240. parameters: [
  15241. {
  15242. name: "parent-uuid",
  15243. in: "path",
  15244. description: "parent resource uuid",
  15245. required: true,
  15246. type: "string"
  15247. },
  15248. {
  15249. name: "uuid",
  15250. in: "path",
  15251. description: "uuid to filter by",
  15252. required: true,
  15253. type: "string"
  15254. },
  15255. {
  15256. name: "v",
  15257. in: "query",
  15258. description: "The representation to return (ref, default, full or custom)",
  15259. required: false,
  15260. type: "string",
  15261. enum: [
  15262. "ref",
  15263. "default",
  15264. "full",
  15265. "custom"
  15266. ]
  15267. }
  15268. ],
  15269. responses: {
  15270. 200: {
  15271. description: "encounterprovider response",
  15272. schema: {
  15273. $ref: "#/definitions/EncounterEncounterproviderGet"
  15274. }
  15275. },
  15276. 401: {
  15277. description: "User not logged in"
  15278. },
  15279. 404: {
  15280. description: "Resource with given uuid doesn't exist"
  15281. }
  15282. }
  15283. },
  15284. post: {
  15285. tags: [
  15286. "encounter"
  15287. ],
  15288. summary: "edit encounterprovider subresource with given uuid, only modifying properties in request",
  15289. operationId: "updateEncounterProvider",
  15290. consumes: [
  15291. "application/json"
  15292. ],
  15293. produces: [
  15294. "application/json"
  15295. ],
  15296. parameters: [
  15297. {
  15298. name: "parent-uuid",
  15299. in: "path",
  15300. description: "parent resource uuid",
  15301. required: true,
  15302. type: "string"
  15303. },
  15304. {
  15305. name: "uuid",
  15306. in: "path",
  15307. description: "uuid of resource to update",
  15308. required: true,
  15309. type: "string"
  15310. },
  15311. {
  15312. in: "body",
  15313. name: "resource",
  15314. description: "Resource properties to update",
  15315. required: true,
  15316. schema: {
  15317. $ref: "#/definitions/EncounterEncounterproviderUpdate"
  15318. }
  15319. }
  15320. ],
  15321. responses: {
  15322. 201: {
  15323. description: "encounterprovider response"
  15324. },
  15325. 401: {
  15326. description: "User not logged in"
  15327. }
  15328. }
  15329. },
  15330. delete: {
  15331. tags: [
  15332. "encounter"
  15333. ],
  15334. summary: "Delete or purge resource by uuid",
  15335. description: "The resource will be voided/retired unless purge = 'true'",
  15336. operationId: "deleteEncounterProvider",
  15337. consumes: [
  15338. "application/json"
  15339. ],
  15340. produces: [
  15341. "application/json"
  15342. ],
  15343. parameters: [
  15344. {
  15345. name: "parent-uuid",
  15346. in: "path",
  15347. description: "parent resource uuid",
  15348. required: true,
  15349. type: "string"
  15350. },
  15351. {
  15352. name: "uuid",
  15353. in: "path",
  15354. description: "uuid to delete",
  15355. required: true,
  15356. type: "string"
  15357. },
  15358. {
  15359. name: "purge",
  15360. in: "query",
  15361. required: false,
  15362. type: "boolean"
  15363. }
  15364. ],
  15365. responses: {
  15366. 204: {
  15367. description: "Delete successful"
  15368. },
  15369. 401: {
  15370. description: "User not logged in"
  15371. },
  15372. 404: {
  15373. description: "Resource with given uuid doesn't exist"
  15374. }
  15375. }
  15376. }
  15377. },
  15378. /concept/{parent-uuid}/name: {
  15379. get: {
  15380. tags: [
  15381. "concept"
  15382. ],
  15383. summary: "Fetch all non-retired name subresources",
  15384. operationId: "getAllConceptNames",
  15385. consumes: [
  15386. "application/json"
  15387. ],
  15388. produces: [
  15389. "application/json"
  15390. ],
  15391. parameters: [
  15392. {
  15393. name: "limit",
  15394. in: "query",
  15395. description: "The number of results to return",
  15396. required: false,
  15397. type: "integer"
  15398. },
  15399. {
  15400. name: "startIndex",
  15401. in: "query",
  15402. description: "The offset at which to start",
  15403. required: false,
  15404. type: "integer"
  15405. },
  15406. {
  15407. name: "parent-uuid",
  15408. in: "path",
  15409. description: "parent resource uuid",
  15410. required: true,
  15411. type: "string"
  15412. },
  15413. {
  15414. name: "v",
  15415. in: "query",
  15416. description: "The representation to return (ref, default, full or custom)",
  15417. required: false,
  15418. type: "string",
  15419. enum: [
  15420. "ref",
  15421. "default",
  15422. "full",
  15423. "custom"
  15424. ]
  15425. }
  15426. ],
  15427. responses: {
  15428. 200: {
  15429. description: "name response",
  15430. schema: {
  15431. type: "object",
  15432. properties: {
  15433. results: {
  15434. type: "array",
  15435. items: {
  15436. $ref: "#/definitions/ConceptNameGet"
  15437. }
  15438. }
  15439. }
  15440. }
  15441. },
  15442. 401: {
  15443. description: "User not logged in"
  15444. }
  15445. }
  15446. },
  15447. post: {
  15448. tags: [
  15449. "concept"
  15450. ],
  15451. summary: "Create name subresource with properties in request",
  15452. operationId: "createConceptName",
  15453. consumes: [
  15454. "application/json"
  15455. ],
  15456. produces: [
  15457. "application/json"
  15458. ],
  15459. parameters: [
  15460. {
  15461. name: "parent-uuid",
  15462. in: "path",
  15463. description: "parent resource uuid",
  15464. required: true,
  15465. type: "string"
  15466. },
  15467. {
  15468. in: "body",
  15469. name: "resource",
  15470. description: "Resource to create",
  15471. required: true,
  15472. schema: {
  15473. $ref: "#/definitions/ConceptNameCreate"
  15474. }
  15475. }
  15476. ],
  15477. responses: {
  15478. 201: {
  15479. description: "name response"
  15480. },
  15481. 401: {
  15482. description: "User not logged in"
  15483. }
  15484. }
  15485. }
  15486. },
  15487. /concept/{parent-uuid}/name/{uuid}: {
  15488. get: {
  15489. tags: [
  15490. "concept"
  15491. ],
  15492. summary: "Fetch name subresources by uuid",
  15493. operationId: "getConceptName",
  15494. consumes: [
  15495. "application/json"
  15496. ],
  15497. produces: [
  15498. "application/json"
  15499. ],
  15500. parameters: [
  15501. {
  15502. name: "parent-uuid",
  15503. in: "path",
  15504. description: "parent resource uuid",
  15505. required: true,
  15506. type: "string"
  15507. },
  15508. {
  15509. name: "uuid",
  15510. in: "path",
  15511. description: "uuid to filter by",
  15512. required: true,
  15513. type: "string"
  15514. },
  15515. {
  15516. name: "v",
  15517. in: "query",
  15518. description: "The representation to return (ref, default, full or custom)",
  15519. required: false,
  15520. type: "string",
  15521. enum: [
  15522. "ref",
  15523. "default",
  15524. "full",
  15525. "custom"
  15526. ]
  15527. }
  15528. ],
  15529. responses: {
  15530. 200: {
  15531. description: "name response",
  15532. schema: {
  15533. $ref: "#/definitions/ConceptNameGet"
  15534. }
  15535. },
  15536. 401: {
  15537. description: "User not logged in"
  15538. },
  15539. 404: {
  15540. description: "Resource with given uuid doesn't exist"
  15541. }
  15542. }
  15543. },
  15544. post: {
  15545. tags: [
  15546. "concept"
  15547. ],
  15548. summary: "edit name subresource with given uuid, only modifying properties in request",
  15549. operationId: "updateConceptName",
  15550. consumes: [
  15551. "application/json"
  15552. ],
  15553. produces: [
  15554. "application/json"
  15555. ],
  15556. parameters: [
  15557. {
  15558. name: "parent-uuid",
  15559. in: "path",
  15560. description: "parent resource uuid",
  15561. required: true,
  15562. type: "string"
  15563. },
  15564. {
  15565. name: "uuid",
  15566. in: "path",
  15567. description: "uuid of resource to update",
  15568. required: true,
  15569. type: "string"
  15570. },
  15571. {
  15572. in: "body",
  15573. name: "resource",
  15574. description: "Resource properties to update",
  15575. required: true,
  15576. schema: {
  15577. $ref: "#/definitions/ConceptNameUpdate"
  15578. }
  15579. }
  15580. ],
  15581. responses: {
  15582. 201: {
  15583. description: "name response"
  15584. },
  15585. 401: {
  15586. description: "User not logged in"
  15587. }
  15588. }
  15589. },
  15590. delete: {
  15591. tags: [
  15592. "concept"
  15593. ],
  15594. summary: "Delete or purge resource by uuid",
  15595. description: "The resource will be voided/retired unless purge = 'true'",
  15596. operationId: "deleteConceptName",
  15597. consumes: [
  15598. "application/json"
  15599. ],
  15600. produces: [
  15601. "application/json"
  15602. ],
  15603. parameters: [
  15604. {
  15605. name: "parent-uuid",
  15606. in: "path",
  15607. description: "parent resource uuid",
  15608. required: true,
  15609. type: "string"
  15610. },
  15611. {
  15612. name: "uuid",
  15613. in: "path",
  15614. description: "uuid to delete",
  15615. required: true,
  15616. type: "string"
  15617. },
  15618. {
  15619. name: "purge",
  15620. in: "query",
  15621. required: false,
  15622. type: "boolean"
  15623. }
  15624. ],
  15625. responses: {
  15626. 204: {
  15627. description: "Delete successful"
  15628. },
  15629. 401: {
  15630. description: "User not logged in"
  15631. },
  15632. 404: {
  15633. description: "Resource with given uuid doesn't exist"
  15634. }
  15635. }
  15636. }
  15637. },
  15638. /orderset/{parent-uuid}/ordersetmember: {
  15639. get: {
  15640. tags: [
  15641. "orderset"
  15642. ],
  15643. summary: "Fetch all non-retired ordersetmember subresources",
  15644. operationId: "getAllOrderSetMembers",
  15645. consumes: [
  15646. "application/json"
  15647. ],
  15648. produces: [
  15649. "application/json"
  15650. ],
  15651. parameters: [
  15652. {
  15653. name: "limit",
  15654. in: "query",
  15655. description: "The number of results to return",
  15656. required: false,
  15657. type: "integer"
  15658. },
  15659. {
  15660. name: "startIndex",
  15661. in: "query",
  15662. description: "The offset at which to start",
  15663. required: false,
  15664. type: "integer"
  15665. },
  15666. {
  15667. name: "parent-uuid",
  15668. in: "path",
  15669. description: "parent resource uuid",
  15670. required: true,
  15671. type: "string"
  15672. },
  15673. {
  15674. name: "v",
  15675. in: "query",
  15676. description: "The representation to return (ref, default, full or custom)",
  15677. required: false,
  15678. type: "string",
  15679. enum: [
  15680. "ref",
  15681. "default",
  15682. "full",
  15683. "custom"
  15684. ]
  15685. }
  15686. ],
  15687. responses: {
  15688. 200: {
  15689. description: "ordersetmember response",
  15690. schema: {
  15691. type: "object",
  15692. properties: {
  15693. results: {
  15694. type: "array",
  15695. items: {
  15696. $ref: "#/definitions/OrdersetOrdersetmemberGet"
  15697. }
  15698. }
  15699. }
  15700. }
  15701. },
  15702. 401: {
  15703. description: "User not logged in"
  15704. }
  15705. }
  15706. },
  15707. post: {
  15708. tags: [
  15709. "orderset"
  15710. ],
  15711. summary: "Create ordersetmember subresource with properties in request",
  15712. operationId: "createOrderSetMember",
  15713. consumes: [
  15714. "application/json"
  15715. ],
  15716. produces: [
  15717. "application/json"
  15718. ],
  15719. parameters: [
  15720. {
  15721. name: "parent-uuid",
  15722. in: "path",
  15723. description: "parent resource uuid",
  15724. required: true,
  15725. type: "string"
  15726. },
  15727. {
  15728. in: "body",
  15729. name: "resource",
  15730. description: "Resource to create",
  15731. required: true,
  15732. schema: {
  15733. $ref: "#/definitions/OrdersetOrdersetmemberCreate"
  15734. }
  15735. }
  15736. ],
  15737. responses: {
  15738. 201: {
  15739. description: "ordersetmember response"
  15740. },
  15741. 401: {
  15742. description: "User not logged in"
  15743. }
  15744. }
  15745. }
  15746. },
  15747. /orderset/{parent-uuid}/ordersetmember/{uuid}: {
  15748. get: {
  15749. tags: [
  15750. "orderset"
  15751. ],
  15752. summary: "Fetch ordersetmember subresources by uuid",
  15753. operationId: "getOrderSetMember",
  15754. consumes: [
  15755. "application/json"
  15756. ],
  15757. produces: [
  15758. "application/json"
  15759. ],
  15760. parameters: [
  15761. {
  15762. name: "parent-uuid",
  15763. in: "path",
  15764. description: "parent resource uuid",
  15765. required: true,
  15766. type: "string"
  15767. },
  15768. {
  15769. name: "uuid",
  15770. in: "path",
  15771. description: "uuid to filter by",
  15772. required: true,
  15773. type: "string"
  15774. },
  15775. {
  15776. name: "v",
  15777. in: "query",
  15778. description: "The representation to return (ref, default, full or custom)",
  15779. required: false,
  15780. type: "string",
  15781. enum: [
  15782. "ref",
  15783. "default",
  15784. "full",
  15785. "custom"
  15786. ]
  15787. }
  15788. ],
  15789. responses: {
  15790. 200: {
  15791. description: "ordersetmember response",
  15792. schema: {
  15793. $ref: "#/definitions/OrdersetOrdersetmemberGet"
  15794. }
  15795. },
  15796. 401: {
  15797. description: "User not logged in"
  15798. },
  15799. 404: {
  15800. description: "Resource with given uuid doesn't exist"
  15801. }
  15802. }
  15803. },
  15804. post: {
  15805. tags: [
  15806. "orderset"
  15807. ],
  15808. summary: "edit ordersetmember subresource with given uuid, only modifying properties in request",
  15809. operationId: "updateOrderSetMember",
  15810. consumes: [
  15811. "application/json"
  15812. ],
  15813. produces: [
  15814. "application/json"
  15815. ],
  15816. parameters: [
  15817. {
  15818. name: "parent-uuid",
  15819. in: "path",
  15820. description: "parent resource uuid",
  15821. required: true,
  15822. type: "string"
  15823. },
  15824. {
  15825. name: "uuid",
  15826. in: "path",
  15827. description: "uuid of resource to update",
  15828. required: true,
  15829. type: "string"
  15830. },
  15831. {
  15832. in: "body",
  15833. name: "resource",
  15834. description: "Resource properties to update",
  15835. required: true,
  15836. schema: {
  15837. $ref: "#/definitions/OrdersetOrdersetmemberUpdate"
  15838. }
  15839. }
  15840. ],
  15841. responses: {
  15842. 201: {
  15843. description: "ordersetmember response"
  15844. },
  15845. 401: {
  15846. description: "User not logged in"
  15847. }
  15848. }
  15849. },
  15850. delete: {
  15851. tags: [
  15852. "orderset"
  15853. ],
  15854. summary: "Delete or purge resource by uuid",
  15855. description: "The resource will be voided/retired unless purge = 'true'",
  15856. operationId: "deleteOrderSetMember",
  15857. consumes: [
  15858. "application/json"
  15859. ],
  15860. produces: [
  15861. "application/json"
  15862. ],
  15863. parameters: [
  15864. {
  15865. name: "parent-uuid",
  15866. in: "path",
  15867. description: "parent resource uuid",
  15868. required: true,
  15869. type: "string"
  15870. },
  15871. {
  15872. name: "uuid",
  15873. in: "path",
  15874. description: "uuid to delete",
  15875. required: true,
  15876. type: "string"
  15877. },
  15878. {
  15879. name: "purge",
  15880. in: "query",
  15881. required: false,
  15882. type: "boolean"
  15883. }
  15884. ],
  15885. responses: {
  15886. 204: {
  15887. description: "Delete successful"
  15888. },
  15889. 401: {
  15890. description: "User not logged in"
  15891. },
  15892. 404: {
  15893. description: "Resource with given uuid doesn't exist"
  15894. }
  15895. }
  15896. }
  15897. },
  15898. /concept/{parent-uuid}/attribute: {
  15899. get: {
  15900. tags: [
  15901. "concept"
  15902. ],
  15903. summary: "Fetch all non-retired attribute subresources",
  15904. operationId: "getAllConceptAttributes",
  15905. consumes: [
  15906. "application/json"
  15907. ],
  15908. produces: [
  15909. "application/json"
  15910. ],
  15911. parameters: [
  15912. {
  15913. name: "limit",
  15914. in: "query",
  15915. description: "The number of results to return",
  15916. required: false,
  15917. type: "integer"
  15918. },
  15919. {
  15920. name: "startIndex",
  15921. in: "query",
  15922. description: "The offset at which to start",
  15923. required: false,
  15924. type: "integer"
  15925. },
  15926. {
  15927. name: "parent-uuid",
  15928. in: "path",
  15929. description: "parent resource uuid",
  15930. required: true,
  15931. type: "string"
  15932. },
  15933. {
  15934. name: "v",
  15935. in: "query",
  15936. description: "The representation to return (ref, default, full or custom)",
  15937. required: false,
  15938. type: "string",
  15939. enum: [
  15940. "ref",
  15941. "default",
  15942. "full",
  15943. "custom"
  15944. ]
  15945. }
  15946. ],
  15947. responses: {
  15948. 200: {
  15949. description: "attribute response",
  15950. schema: {
  15951. type: "object",
  15952. properties: {
  15953. results: {
  15954. type: "array",
  15955. items: {
  15956. $ref: "#/definitions/ConceptAttributeGet"
  15957. }
  15958. }
  15959. }
  15960. }
  15961. },
  15962. 401: {
  15963. description: "User not logged in"
  15964. }
  15965. }
  15966. },
  15967. post: {
  15968. tags: [
  15969. "concept"
  15970. ],
  15971. summary: "Create attribute subresource with properties in request",
  15972. operationId: "createConceptAttribute",
  15973. consumes: [
  15974. "application/json"
  15975. ],
  15976. produces: [
  15977. "application/json"
  15978. ],
  15979. parameters: [
  15980. {
  15981. name: "parent-uuid",
  15982. in: "path",
  15983. description: "parent resource uuid",
  15984. required: true,
  15985. type: "string"
  15986. },
  15987. {
  15988. in: "body",
  15989. name: "resource",
  15990. description: "Resource to create",
  15991. required: true,
  15992. schema: {
  15993. $ref: "#/definitions/ConceptAttributeCreate"
  15994. }
  15995. }
  15996. ],
  15997. responses: {
  15998. 201: {
  15999. description: "attribute response"
  16000. },
  16001. 401: {
  16002. description: "User not logged in"
  16003. }
  16004. }
  16005. }
  16006. },
  16007. /concept/{parent-uuid}/attribute/{uuid}: {
  16008. get: {
  16009. tags: [
  16010. "concept"
  16011. ],
  16012. summary: "Fetch attribute subresources by uuid",
  16013. operationId: "getConceptAttribute",
  16014. consumes: [
  16015. "application/json"
  16016. ],
  16017. produces: [
  16018. "application/json"
  16019. ],
  16020. parameters: [
  16021. {
  16022. name: "parent-uuid",
  16023. in: "path",
  16024. description: "parent resource uuid",
  16025. required: true,
  16026. type: "string"
  16027. },
  16028. {
  16029. name: "uuid",
  16030. in: "path",
  16031. description: "uuid to filter by",
  16032. required: true,
  16033. type: "string"
  16034. },
  16035. {
  16036. name: "v",
  16037. in: "query",
  16038. description: "The representation to return (ref, default, full or custom)",
  16039. required: false,
  16040. type: "string",
  16041. enum: [
  16042. "ref",
  16043. "default",
  16044. "full",
  16045. "custom"
  16046. ]
  16047. }
  16048. ],
  16049. responses: {
  16050. 200: {
  16051. description: "attribute response",
  16052. schema: {
  16053. $ref: "#/definitions/ConceptAttributeGet"
  16054. }
  16055. },
  16056. 401: {
  16057. description: "User not logged in"
  16058. },
  16059. 404: {
  16060. description: "Resource with given uuid doesn't exist"
  16061. }
  16062. }
  16063. },
  16064. post: {
  16065. tags: [
  16066. "concept"
  16067. ],
  16068. summary: "edit attribute subresource with given uuid, only modifying properties in request",
  16069. operationId: "updateConceptAttribute",
  16070. consumes: [
  16071. "application/json"
  16072. ],
  16073. produces: [
  16074. "application/json"
  16075. ],
  16076. parameters: [
  16077. {
  16078. name: "parent-uuid",
  16079. in: "path",
  16080. description: "parent resource uuid",
  16081. required: true,
  16082. type: "string"
  16083. },
  16084. {
  16085. name: "uuid",
  16086. in: "path",
  16087. description: "uuid of resource to update",
  16088. required: true,
  16089. type: "string"
  16090. },
  16091. {
  16092. in: "body",
  16093. name: "resource",
  16094. description: "Resource properties to update",
  16095. required: true,
  16096. schema: {
  16097. $ref: "#/definitions/ConceptAttributeUpdate"
  16098. }
  16099. }
  16100. ],
  16101. responses: {
  16102. 201: {
  16103. description: "attribute response"
  16104. },
  16105. 401: {
  16106. description: "User not logged in"
  16107. }
  16108. }
  16109. },
  16110. delete: {
  16111. tags: [
  16112. "concept"
  16113. ],
  16114. summary: "Delete or purge resource by uuid",
  16115. description: "The resource will be voided/retired unless purge = 'true'",
  16116. operationId: "deleteConceptAttribute",
  16117. consumes: [
  16118. "application/json"
  16119. ],
  16120. produces: [
  16121. "application/json"
  16122. ],
  16123. parameters: [
  16124. {
  16125. name: "parent-uuid",
  16126. in: "path",
  16127. description: "parent resource uuid",
  16128. required: true,
  16129. type: "string"
  16130. },
  16131. {
  16132. name: "uuid",
  16133. in: "path",
  16134. description: "uuid to delete",
  16135. required: true,
  16136. type: "string"
  16137. },
  16138. {
  16139. name: "purge",
  16140. in: "query",
  16141. required: false,
  16142. type: "boolean"
  16143. }
  16144. ],
  16145. responses: {
  16146. 204: {
  16147. description: "Delete successful"
  16148. },
  16149. 401: {
  16150. description: "User not logged in"
  16151. },
  16152. 404: {
  16153. description: "Resource with given uuid doesn't exist"
  16154. }
  16155. }
  16156. }
  16157. },
  16158. /workflow/{parent-uuid}/state: {
  16159. get: {
  16160. tags: [
  16161. "workflow"
  16162. ],
  16163. summary: "Fetch all non-retired state subresources",
  16164. operationId: "getAllProgramWorkflowStates",
  16165. consumes: [
  16166. "application/json"
  16167. ],
  16168. produces: [
  16169. "application/json"
  16170. ],
  16171. parameters: [
  16172. {
  16173. name: "limit",
  16174. in: "query",
  16175. description: "The number of results to return",
  16176. required: false,
  16177. type: "integer"
  16178. },
  16179. {
  16180. name: "startIndex",
  16181. in: "query",
  16182. description: "The offset at which to start",
  16183. required: false,
  16184. type: "integer"
  16185. },
  16186. {
  16187. name: "parent-uuid",
  16188. in: "path",
  16189. description: "parent resource uuid",
  16190. required: true,
  16191. type: "string"
  16192. },
  16193. {
  16194. name: "v",
  16195. in: "query",
  16196. description: "The representation to return (ref, default, full or custom)",
  16197. required: false,
  16198. type: "string",
  16199. enum: [
  16200. "ref",
  16201. "default",
  16202. "full",
  16203. "custom"
  16204. ]
  16205. }
  16206. ],
  16207. responses: {
  16208. 200: {
  16209. description: "state response",
  16210. schema: {
  16211. type: "object",
  16212. properties: {
  16213. results: {
  16214. type: "array",
  16215. items: {
  16216. $ref: "#/definitions/WorkflowStateGet"
  16217. }
  16218. }
  16219. }
  16220. }
  16221. },
  16222. 401: {
  16223. description: "User not logged in"
  16224. }
  16225. }
  16226. },
  16227. post: {
  16228. tags: [
  16229. "workflow"
  16230. ],
  16231. summary: "Create state subresource with properties in request",
  16232. operationId: "createProgramWorkflowState",
  16233. consumes: [
  16234. "application/json"
  16235. ],
  16236. produces: [
  16237. "application/json"
  16238. ],
  16239. parameters: [
  16240. {
  16241. name: "parent-uuid",
  16242. in: "path",
  16243. description: "parent resource uuid",
  16244. required: true,
  16245. type: "string"
  16246. },
  16247. {
  16248. in: "body",
  16249. name: "resource",
  16250. description: "Resource to create",
  16251. required: true,
  16252. schema: {
  16253. $ref: "#/definitions/WorkflowStateCreate"
  16254. }
  16255. }
  16256. ],
  16257. responses: {
  16258. 201: {
  16259. description: "state response"
  16260. },
  16261. 401: {
  16262. description: "User not logged in"
  16263. }
  16264. }
  16265. }
  16266. },
  16267. /workflow/{parent-uuid}/state/{uuid}: {
  16268. get: {
  16269. tags: [
  16270. "workflow"
  16271. ],
  16272. summary: "Fetch state subresources by uuid",
  16273. operationId: "getProgramWorkflowState",
  16274. consumes: [
  16275. "application/json"
  16276. ],
  16277. produces: [
  16278. "application/json"
  16279. ],
  16280. parameters: [
  16281. {
  16282. name: "parent-uuid",
  16283. in: "path",
  16284. description: "parent resource uuid",
  16285. required: true,
  16286. type: "string"
  16287. },
  16288. {
  16289. name: "uuid",
  16290. in: "path",
  16291. description: "uuid to filter by",
  16292. required: true,
  16293. type: "string"
  16294. },
  16295. {
  16296. name: "v",
  16297. in: "query",
  16298. description: "The representation to return (ref, default, full or custom)",
  16299. required: false,
  16300. type: "string",
  16301. enum: [
  16302. "ref",
  16303. "default",
  16304. "full",
  16305. "custom"
  16306. ]
  16307. }
  16308. ],
  16309. responses: {
  16310. 200: {
  16311. description: "state response",
  16312. schema: {
  16313. $ref: "#/definitions/WorkflowStateGet"
  16314. }
  16315. },
  16316. 401: {
  16317. description: "User not logged in"
  16318. },
  16319. 404: {
  16320. description: "Resource with given uuid doesn't exist"
  16321. }
  16322. }
  16323. },
  16324. delete: {
  16325. tags: [
  16326. "workflow"
  16327. ],
  16328. summary: "Delete or purge resource by uuid",
  16329. description: "The resource will be voided/retired unless purge = 'true'",
  16330. operationId: "deleteProgramWorkflowState",
  16331. consumes: [
  16332. "application/json"
  16333. ],
  16334. produces: [
  16335. "application/json"
  16336. ],
  16337. parameters: [
  16338. {
  16339. name: "parent-uuid",
  16340. in: "path",
  16341. description: "parent resource uuid",
  16342. required: true,
  16343. type: "string"
  16344. },
  16345. {
  16346. name: "uuid",
  16347. in: "path",
  16348. description: "uuid to delete",
  16349. required: true,
  16350. type: "string"
  16351. },
  16352. {
  16353. name: "purge",
  16354. in: "query",
  16355. required: false,
  16356. type: "boolean"
  16357. }
  16358. ],
  16359. responses: {
  16360. 204: {
  16361. description: "Delete successful"
  16362. },
  16363. 401: {
  16364. description: "User not logged in"
  16365. },
  16366. 404: {
  16367. description: "Resource with given uuid doesn't exist"
  16368. }
  16369. }
  16370. }
  16371. },
  16372. /programenrollment/{parent-uuid}/state: {
  16373. post: {
  16374. tags: [
  16375. "programenrollment"
  16376. ],
  16377. summary: "Create state subresource with properties in request",
  16378. operationId: "createPatientState",
  16379. consumes: [
  16380. "application/json"
  16381. ],
  16382. produces: [
  16383. "application/json"
  16384. ],
  16385. parameters: [
  16386. {
  16387. name: "parent-uuid",
  16388. in: "path",
  16389. description: "parent resource uuid",
  16390. required: true,
  16391. type: "string"
  16392. },
  16393. {
  16394. in: "body",
  16395. name: "resource",
  16396. description: "Resource to create",
  16397. required: true,
  16398. schema: {
  16399. $ref: "#/definitions/ProgramenrollmentStateCreate"
  16400. }
  16401. }
  16402. ],
  16403. responses: {
  16404. 201: {
  16405. description: "state response"
  16406. },
  16407. 401: {
  16408. description: "User not logged in"
  16409. }
  16410. }
  16411. }
  16412. },
  16413. /programenrollment/{parent-uuid}/state/{uuid}: {
  16414. get: {
  16415. tags: [
  16416. "programenrollment"
  16417. ],
  16418. summary: "Fetch state subresources by uuid",
  16419. operationId: "getPatientState",
  16420. consumes: [
  16421. "application/json"
  16422. ],
  16423. produces: [
  16424. "application/json"
  16425. ],
  16426. parameters: [
  16427. {
  16428. name: "parent-uuid",
  16429. in: "path",
  16430. description: "parent resource uuid",
  16431. required: true,
  16432. type: "string"
  16433. },
  16434. {
  16435. name: "uuid",
  16436. in: "path",
  16437. description: "uuid to filter by",
  16438. required: true,
  16439. type: "string"
  16440. },
  16441. {
  16442. name: "v",
  16443. in: "query",
  16444. description: "The representation to return (ref, default, full or custom)",
  16445. required: false,
  16446. type: "string",
  16447. enum: [
  16448. "ref",
  16449. "default",
  16450. "full",
  16451. "custom"
  16452. ]
  16453. }
  16454. ],
  16455. responses: {
  16456. 200: {
  16457. description: "state response",
  16458. schema: {
  16459. $ref: "#/definitions/ProgramenrollmentStateGet"
  16460. }
  16461. },
  16462. 401: {
  16463. description: "User not logged in"
  16464. },
  16465. 404: {
  16466. description: "Resource with given uuid doesn't exist"
  16467. }
  16468. }
  16469. },
  16470. post: {
  16471. tags: [
  16472. "programenrollment"
  16473. ],
  16474. summary: "edit state subresource with given uuid, only modifying properties in request",
  16475. operationId: "updatePatientState",
  16476. consumes: [
  16477. "application/json"
  16478. ],
  16479. produces: [
  16480. "application/json"
  16481. ],
  16482. parameters: [
  16483. {
  16484. name: "parent-uuid",
  16485. in: "path",
  16486. description: "parent resource uuid",
  16487. required: true,
  16488. type: "string"
  16489. },
  16490. {
  16491. name: "uuid",
  16492. in: "path",
  16493. description: "uuid of resource to update",
  16494. required: true,
  16495. type: "string"
  16496. },
  16497. {
  16498. in: "body",
  16499. name: "resource",
  16500. description: "Resource properties to update",
  16501. required: true,
  16502. schema: {
  16503. $ref: "#/definitions/ProgramenrollmentStateUpdate"
  16504. }
  16505. }
  16506. ],
  16507. responses: {
  16508. 201: {
  16509. description: "state response"
  16510. },
  16511. 401: {
  16512. description: "User not logged in"
  16513. }
  16514. }
  16515. },
  16516. delete: {
  16517. tags: [
  16518. "programenrollment"
  16519. ],
  16520. summary: "Delete or purge resource by uuid",
  16521. description: "The resource will be voided/retired unless purge = 'true'",
  16522. operationId: "deletePatientState",
  16523. consumes: [
  16524. "application/json"
  16525. ],
  16526. produces: [
  16527. "application/json"
  16528. ],
  16529. parameters: [
  16530. {
  16531. name: "parent-uuid",
  16532. in: "path",
  16533. description: "parent resource uuid",
  16534. required: true,
  16535. type: "string"
  16536. },
  16537. {
  16538. name: "uuid",
  16539. in: "path",
  16540. description: "uuid to delete",
  16541. required: true,
  16542. type: "string"
  16543. },
  16544. {
  16545. name: "purge",
  16546. in: "query",
  16547. required: false,
  16548. type: "boolean"
  16549. }
  16550. ],
  16551. responses: {
  16552. 204: {
  16553. description: "Delete successful"
  16554. },
  16555. 401: {
  16556. description: "User not logged in"
  16557. },
  16558. 404: {
  16559. description: "Resource with given uuid doesn't exist"
  16560. }
  16561. }
  16562. }
  16563. },
  16564. /person/{parent-uuid}/attribute: {
  16565. get: {
  16566. tags: [
  16567. "person"
  16568. ],
  16569. summary: "Fetch all non-retired attribute subresources",
  16570. operationId: "getAllPersonAttributes",
  16571. consumes: [
  16572. "application/